1.121. SetHifiChannelFlagsTask

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

Description

A task to set channel flags in HIFI data.

This task simplifies setting the channel flags in a HIFI HTP. Given a dataset index and a start/stop frequency, the task will set the IGNORE_DATA flag for all relevant channels in all datasets.

The user can optionally set another flag if they wish.

It is up to the user to enter a frequency range in the same units as the data. The task will issue a warning if no match was found.

Example

Example 1: Simple example.
setHifiChannelFlags(htp=htp,idx=4,startFreq=645.0,stopFreq=672.1,flagValue=HifiMask.SPUR_CANDIDATE)

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 startFreq [INPUT, MANDATORY, default=No default value]

The frequency at which to start flagging

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

The frequency at which to stopflagging

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

The value of the flag to set.

History

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