1.84. getChannelFlags

Full Name: herschel.hifi.dp.tools.GetChannelFlagsTask
Alias: getChannelFlags
Type: Java Task - Java Task
Import: from herschel.hifi.dp.tools import GetChannelFlagsTask
Category

HIFI/Conversion

Description

A task to generate a table of channel flags set in level 2 HIFI data.

This task scans the channel flags in level 2 HIFI data and generates a table dataset in the same format as the spur table

Channel flags scanned SPUR_CANDIDATE, LINE, BRIGHT_LINE, IGNORE_DATA

Example

Example 1: In HIPE:
getChannelFlags = getChannelFlags()
flagTable = getLevel2ChannelFlags(obs=obs)

API details

Properties

ObservationContext obs [INPUT, MANDATORY, default=No default value]

The observation context to process.

String source [INPUT, OPTIONAL, default='DoChannelFlagsTask']

The text to put in the 'source' column of the table (i.e. HEXOS, etc.)

TableDataset result [OUTPUT, OPTIONAL, default=No default value]

The table of flags set in level 2.

See also

History

  • 2014-04-22 - CB: : Converted to a task and distributed to ICC.
  • 2014-04-25 - KE: : Converted to Java