1.33. doChannelFlags

Full Name: herschel.hifi.pipeline.generic.DoChannelFlagsTask
Alias: doChannelFlags
Type: Java Task - Java Task
Import: from herschel.hifi.pipeline.generic import DoChannelFlagsTask
Category

HIFI/Pipeline/Level 2 Pipeline

Description

Task for the level1 pipeline for flagging data where spurs are known to exist.

This task uses data from the calibration tree to flag the data.

Example

Example 1: In HIPE:
doChannelFlags = DoChannelFlags()
doChannelFlags(htp=htp, cal=obs.calibration))

API details

Properties

HifiTimelineProduct htp [INPUT, MANDATORY, default=no default Value]

The timeline product (observation) to be passed to the module.

HifiTimelineProduct htpOn [INPUT, OPTIONAL, default=no default Value]

An optional ON timeline product, used when flagging off spectra. Use ONLY when one is passing in a OFF HTP as the primary input where the number of ONs and OFFs are different and OFF flagging is desired.

MapContext calibration [INPUT, OPTIONAL, default=no default value]

Parameter to pass a calibration context from which all the calibration input can be found. In this task we are concerned with the spurFlags table.

TableDataset flagTable [INPUT, OPTIONAL, default=no default value]

A user supplied table of flags to be applied by this tool.

Boolean clearFlags [INPUT, OPTIONAL, default=True]

Clear the existing flags before the application of new flags. The clearing of existing flags will only occur if there are new flags supplied by the user or found in the calibration tree. The user could supply an empty flagTable in order to remove all flags from the observation.

PipelineConfiguration params [INPUT, OPTIONAL, default=no default value]

Pipeline configuration parameters that can be passed to the task.

Boolean ignore [INPUT, OPTIONAL, default=no default value]

Flag to indicate whether the execution of the module should be ignored.

Boolean propagateFlag [INPUT, OPTIONAL, default=no default value]

Flag to indicate whether the channel flags should be propagate to all HifiTimilineProduct (valid only for PointingModes).

See also

History

  • 2014-04-09 - KE: : Initial Version