1.99. mkWbsBadPixels

Full Name:	herschel.hifi.pipeline.wbs.MkWbsBadPixelsTask
Alias:	mkWbsBadPixels
Type:	Java Task -
Import:	from herschel.hifi.pipeline.wbs import MkWbsBadPixelsTask
Category:	HIFI/Pipeline/WBS Pipeline

Description

Step2: Task that check for saturated pixels

in the SpectrumDataset.

A CalWbsBadPixel can be passed as supplementary parameter through the input output StringKeyWords.CAL.

The CalWbsBadPixel contains: value for the maximum pixel level, the threshold values for saturation, and the BadPixel mask to be applied to the HifiSpectrumDataset.

If a CalWbsBadPixel is not passed a new one is created.

After the calculation, the saturated pixel position are stored in the flag.

Then, if a channel is saturated a number of time greater then the values CalWbsBadPixel.getThresholdRepetition(), it is marked as new bad pixel. The new bad pixels are merged with the initial mask passed with CalWbsBadPixel .

Examples

Example 1: In HIPE:

from herschel.hifi.pipeline.wbs import *
hdf=AccessDataFrameTask()(obsid=obsid,apid=1030)
hk=AccessPacketTask()(obsid=obsid,apid=1026)
spectra=HifiTimelineProduct(hdf,hk) 
spectra = DoWbsScanCountTask(htp=spectra)       #step 1
calPixel=MkWbsBadPixelsTask()(htp=spectra,badPixel=Bool1d(8192,1)) #step 2

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

API Summary

Jython Syntax
`See example above.`

Properties
`HifiTimelineProduct htp [INPUT, MANDATORY, default=No default value.]`
`CalWbsBadPixel cal [INOUT, MANDATORY, default=no default value.]`

API details

Properties

`HifiTimelineProduct htp [INPUT, MANDATORY, default=No default value.]`
	Provides the HifiTimelineProduct to be analyzed.

`CalWbsBadPixel cal [INOUT, MANDATORY, default=no default value.]`
	Provides the initial bad PixelList, the parameters for the saturation thresholds and return a bad pixel in function of the saturated pixels.

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