1.95. mkHrsBadChans

Full Name: herschel.hifi.pipeline.hrs.MkHrsBadChansTask
Alias: mkHrsBadChans
Type: Java Task -
Import: from herschel.hifi.pipeline.hrs import MkHrsBadChansTask
Category:

HIFI/Pipeline/HRS Pipeline

Description

Step2b: Task which creates the correction table for bad channels with use of NON scientific data.

Gets the comparison thresholds values, and compares the internal correlation functions to their theoretical values for internal tests. This Task can not be run on science Datasets.

This Task should be run after every Short Functional Tests engineering campaign, and should populate the calibration database with the CalHrsBadChans product outside the standard running pipeline.

IMPORTANT NOTE: This Task has not been yet implemented.

Remarks: This module will strongly depend on the AOT. For instance only one Internal Test can be done, or maybe the 3 (Sine, SquareS, SquareM) corresponding to the current resolution. If all tests are done, then the errorFlag columns will be errorFlag1[Ntest], errorFlag2[Ntest]. The values into errorFlags can be boolean values, or integer values with internal bits which correspond to the boolean value of each Internal Test. If the errorFlags columns are created, meaning that some channels are in error, then the rawCF of the "science" DS have to be truncated (TBD). The determination of the bad channels could be improved in "correlation" mode, by using a special test (all channels cascaded in one face of HRS, the same in the other face, and comparison between both faces). Then one could be sure that the Correlation mode does not introduce new bad channels compared to Internal Tests.

Example

Example 1: In HIPE
 
from herschel.hifi.pipeline.hrs import *
htp = HifiTimelineProduct(df, hk)
doHrsSubbands(htp=htp)
calHrsBadChans = mkHrsBadChans(htp=htp, "threshold"=4)
doHrsBadChans(htp=htp, cal=calHrsBadChans)

API Summary

Jython Syntax

calHrsBadChans = mkHrsBadChans(htp=htp, "threshold"=4)

Limitations

IMPORTANT NOTE: This task has not been yet implemented, and use only NON scientific data.

API details

Properties

HifiTimelineProduct htp [INOUT, MANDATORY, default=No default value]
 

The HifiTimelineProduct which contains the HRS correlation functions of Functional Tests.

Integer threshold [INPUT, OPTIONAL, default=2]
 

A modifier for defining the threshold values of the comparison.

CalHrsBadChans cal [OUTPUT, MANDATORY, default=No default value]
 

The calibration output product which provides the correction table for bad channels.

History

  • 2005-04-29 - OCJ: creation
  • 2006-09-11 - OCJ: HifiVectorDataset replaced by HifiPipelineProduct
  • 2006-12-07 - OCJ: HifiPipelineProduct replaced by HifiTimelineProduct
  • 2010-11-04 - OCJ: Old examples from Jide removed