10.3. Column rowflags

Column rowflags (the "rowflag" column in the HIFI spectrum TableDataset) apply to the complete DataFrames (DF) or rows in a HifiSpectrumDataset (HSD).

For bit n, the value is computed according to value=2n. The first 5 bits are about the packets from which the DataFrame (DF) is reconstructed, and are unlikely to ever occur.

Below is a table showing the current names and values of HIFI rowflags. As for the channel flags, there is a class defined to make scripting with rowflags easier.

Flag Name Bit Software Name Description
PacketOrder 0 RowMask.PACKET_ORDER Error in the packet order while constructing the DataFrame.
PacketLength 1 RowMask.PACKET_LENGTH Error in the packet length while constructing the DataFrame.
TooMuchData 2 RowMask.TOO_MUCH_DATA More data than can be fit in a DataFrame.
FirstPacket 3 RowMask.FIRST_PACKET Error in the start packet while constructing the DataFrame.
NoBlocks 4 RowMask.NO_BLOCK No block information present while constructing the DataFrame.
Spare 5 Not defined  
Spare 6 Not defined  
Spare 7 Not defined  
UnalignedHK 8 RowMask.UNALIGNED_HK HK could not be aligned with DataFrames. When the columns "df_transfer" and "hk_transfer" in the TableDataset are different, bit 8 is set.
noChopper 9 RowMask.NO_CHOPPER No valid Chopper information. Set when the flagbit is zero in the DFs, extracted from the HK packets if possible.
noComChop 10 RowMask.NO_COM_CHOP No valid Commanded Chopper information. Set when the flagbit is zero in the DFs, extracted from the HK packets if possible.
noFreqMon 11 RowMask.NO_FREQ_MON No valid Frequency Monitor information. Set when the flagbit is zero in the DFs, extracted from the HK packets if possible.
noLoCodeOffset 12 RowMask.NO_LO_OFF No valid LO code offset information. Set when the flagbit is zero in the DFs, extracted from the HK packets if possible.
noLoCodeMain 13 RowMask.NO_LO_MAIN No valid LO code main information. Set when the flagbit is zero in the DFs, extracted from the HK packets if possible.
MixerCurrentDeviation (ref) 14 RowMask.MCD_REF Difference in mixer currents exceeds tolerance when applying DoRefSubtract.
MixerCurrentDeviation (off) 15 RowMask.MCD_OFF Difference in mixer currents exceeds tolerance when applying DoOffSubtract.
MixerCurrentDeviation (load) 16 RowMask.MCD_HOT Difference in mixer currents exceeds tolerance when applying DoFluxHotCold or MkFluxHotCold.
NoHotColdCalibration 17 RowMask.NO_HOT_COLD Division by the bandpass has not been carried through.
SuspectLO 18 RowMask.SUSPECT_LO LO Frequency is listed in the Bad Frequency Table. Data is not necessarily corrupted.
Spare 19 Not defined  
IgnoreData 20 RowMask.IGNORE_DATA User has the option to set this flag. Some tools (e.g. doDeconvolution) will honour it.
BadData 22 RowMask.BAD_DATA Corrupted data in this data-frame. Data will be ignored when building the Level 2 products.
BbidCorrection 28 RowMask.BBID_CORR Correction of BBID. No longer relevant. (It was during ground-based testing, but the onboard software has been corrected since.)
Row flags in a HIFI spectrum

Example of a HIFI spectrum TableDataset, which contains the "rowflag" column with a value of 256 (28= UNALIGNED_HK), and a few other rowflag columns.

Figure 10.1. Row flags in a HIFI spectrum