1.101. mkFlagSummary

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

HIFI/Pipeline/Level 1 Pipeline

Description

This task creates a summary table with all the row and channel flags

that have been set in the given timeline product. It loops through all SCIENCE ON data, collects this flag information and puts this into a suitable summary table. This contains the following columns:

  • dataset id with the datasets for which any flag (row flag or channel flag) has been set.

  • One column for each row flag that occurs in the timeline product: the value is set to true if the flag occurs in the dataset of the corresponding row or false otherwise.

  • One column for each channel flag that occurs in the timeline product: the value is set to the fraction of the channels for which the flag is set when looping over all dataframes and segments.

Example

Example 1: In HIPE: obs=getObservation('1342235831') htp =
obs.getProduct("level1").getProduct("WBS-H")
bds=mkFlagSummary(htp)

API details

Properties

HifiTimelineProduct htp [INPUT, MANDATORY, default=no default value The]

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

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

Configuration parameter that can be passed to the product

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

indicate whether the execution of the module should be ignored.

GenericPipelineCalibrationOutput result [OUTPUT, OPTIONAL, default=no]

default value Result product with the flags summary table.

See also

History

  • 2012-03-28 - melchior: : First version.