1.124. userFlag

Full Name: herschel.hifi.pipeline.product.UserFlagTask
Alias: userFlag
Type: Java Task - Java Task
Import: from herschel.hifi.pipeline.product import UserFlagTask
Category

HIFI/Pipeline/Interactive Pipeline Steps

Description

UserFlagTask

Task to set or erase user-defined rowflags. A rowflag flags a complete dataframe, i.e. one row in a HifiSpectrumDataset (SDS).

Ultimately the Task will work on a SDS. It can also work on a HTP, as long as the path to the SDS is defined with the sdsnr. This is not to flag individual pixels.

Example

Example 1: UserFlagTask
# Assume that htp and sds exist
uft = UserFlagTask()
uft.sds = sds                      # choose a HifiSpectrumDataset
uft.dataframes = Int1d([2,4,6])    # define the dataframes
uft()                  # flag them with USERFLAG = 2^21 (RowFlag.IGNORE_DATA)
uft = UserFlagTask()
uft.sds = sds                      # choose a HifiSpectrumDataset
uft.dataframes = Int1d([2,4,6])    # define the dataframes
uft.erase = True
uft()                              # erase them again

API details

Properties

HifiTimelineProduct htp [INPUT, OPTIONAL, default=null]

to be selected

HifiSpectrumDataset sds [INPUT, OPTIONAL, default=null]

to be selected

Integer sdsnr [INPUT, OPTIONAL, default=null]

select this SDS from the htp ( >= 1 )

Int1d dataframes [INPUT, MANDATORY, default=null]

set the flag in these dataframes ( >= 1 )

Integer flag [INPUT, OPTIONAL, default=21]

Use 2^flag as value in rowflag in stead of the USERFLAG (2^21)

Boolean erase [INPUT, OPTIONAL, default=false]

Erase the flag in stead of setting

See also

History

  • 2011-10-03 - DK: Initial Version