1.32. doBadLo

Full Name: herschel.hifi.pipeline.level0.DoBadLoTask
Alias: doBadLo
Type: Java Task - Java Task
Import: from herschel.hifi.pipeline.level0 import DoBadLoTask
Category

HIFI/Pipeline/Level 0 Pipeline

Description

Task to flag in a HifiTimelineProduct the bands in the spectra that have a bad LO values due foreseen Spurs,

instabilities , saturations or for any generic reason the LO is marked as Bad. The Task expect that the "cal" input Product will contain a TableDatset with the Columns: "frequency","lo_width", "affected_subbands", "problem".

The "frequency" contains the central frequency where the LO is not good. Repeated value is possible if the same frequency has more then one type of problems.

The "lo_width" contains the width of the range of bad frequencies.

The "problem" contains one type of problem at the specified frequencies.

The "affected_subbands" contains the bands that have the problem at that specified frequency.

A new Column with name "badLo" is added to all the HifiSpectrumDataset contained in the HifiTimelineProduct. For each spectrum it contains a set of values (one for each subband) correspondent to the flag that have been raised for that band. The value is equivalent to a binary number where each bit is a flag. The correspondence between flag and bit is the flag position in the FLAG_NAMES vector.

If some bands in the HifiSpectrumDataset are flagged, a StringParameter containing all the flag raised in the specific subband is added to the MetaData of the HifiSpectrumDataset. The String Parameter name is "badLoBand_N" where N is the specific subband.

Example

Example 1: doBadLo
spurs= obs.calibration.getCalNode("downlink").getCalNode("generic").getProduct("spurs");
  doBadLo(htp=htp, cal=spurs)

API details

Properties

HifiTimelineProduct htp [INOUT, MANDATORY, default=No default value]

The HifiTimelineProduct which will be updated with the flag

Product cal [INPUT, MANDATORY, default=No default value]

Contains a TableDatset dataset which contains the Columns:

"frequency", "lo_width", "affected_subbands", "problem"

See also

History

  • 2015-07-11 - KE: : history added.