1.71. doWbsBadPixels

Full Name: herschel.hifi.pipeline.wbs.DoWbsBadPixelsTask
Alias: doWbsBadPixels
Type: Java Task - Java Task
Import: from herschel.hifi.pipeline.wbs import DoWbsBadPixelsTask
Category

HIFI/Pipeline/WBS Pipeline

Description

Step3: Task that apply the masking pixel list.Configurable to select/unselect masks.

SpectrumDataset output:bad pixel are masked out

Calibration object output:-CalWbsBadPixel

Framework functionality needed: Remarks: This module can be reused between each step to decide which pixel should be used or not. HifiSpectrumDataset request field: Name/position of flags

Examples

Example 1: In HIPE:
from herschel.hifi.pipeline.wbs import *
hdf=AccessDataFrameTask()(obsid=obsid,apid=1030)
spectra=WbsSpectrumDataset(hdf)
spectra = DoWbsScanCountTask()(htp=spectra)                                      #step 1
calPixel=MkWbsBadPixelsTask()(htp=spectra,badPixel=MyBadPixelMask)             #step 2
spectra = DoWbsBadPixelsTask()(htp=spectra,cal=calPixel,apply=1)  #step 3
Example 2: In HIPE:
from herschel.hifi.pipeline.wbs import *
hdf=AccessDataFrameTask()(obsid=obsid,apid=1030)
spectra=WbsSpectrumDataset(hdf)
DoWbsScanCountTask()(spectra)             #step 1
calPixel=MkWbsBadPixelsTask()(spectra)  #step 2
DoWbsBadPixelsTask()(spectra,calPixel)  #step 3

API details

Properties

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

Provides the HifiTimelineProduct that will be masked.

CalWbsBadPixel cal [INPUT, MANDATORY, default=no default value .]

Provides the CalWbsBadPixel that will be applied to mask the HifiTimelineProduct

Boolean apply [INPUT, OPTIONAL, default=true.]

Provides the commands parameters to change the masked pixels in the SpectrumDataSet = BooleanParameter(false). .

See also

History

  • 2005-05-15 - AL: Javadoc and help completed parameter renamed for more compatibility with hrs
  • 2005-07-14 - AL: First implementation completed.
  • 2006-12-07 - AL: converted to HifiTimelineProduct and Calibration Product.
  • 2006-12-21 - AL: Uniformed api to generic branch. Updated documentation