1.19. ClearHifiFlagsTask

Full Name: herschel.hifi.dp.tools.scripts.ClearHifiFlagsTask
Type: Jython Task - Jython Task
Import: from herschel.hifi.dp.tools.scripts import ClearHifiFlagsTask

Description

A task to wipe flags in HIFI data.

This task clears the channel and/or row flags in a HIFI HTP. It only unsets flags that are relevent to DP. Other flags are preserved.

Rowflags affected: SUSPECT_LO and IGNORE_DATA

Channel flags affected: SPUR_CANDIDATE, LINE, BRIGHT_LINE, IGNORE_DATA

By default, ALL data is treated. With the 'idx' parameter, the user can specify just a single dataset index within the HTP to clear.

Example

Example 1: Simple example.
clearHifiFlags(htp=htp)

API details

Properties

INPUT htp [INPUT, MANDATORY, default=No default value]

The HTP to process.

INPUT idx [INPUT, MANDATORY, default=no default value]

The dataset index to process.

INPUT skipRowFlags [INPUT, MANDATORY, default=False]

If set, rowFlags are not reset.

INPUT skipChannelFlags [INPUT, MANDATORY, default=False]

If set, channel Flags are not reset.

History

  • Version 1.0: (CB) Converted to a task and distributed to ICC.