1.73. doWbsDark

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

HIFI/Pipeline/WBS Pipeline

Description

Step4: perform subtraction of dark values for all scans in the HifiSpectrumDataset.

DARK1_2 =0; Use pixel 0 (first) for even Dark and pixel 1(second) for odd Dark

DARK3_4=1; Use pixel 2 (third) for even Dark and pixel 3(fourth) for odd Dark

DARK_AVERAGE=2; Use the average of pixels 0 and 2 for even Dark and pixels 1 and 3 for odd Dark

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=MyBadPixelMask)             #step 2
spectra = DoWbsBadPixelsTask()(htp=spectra,cal=calPixel,apply=1 )  #step 3
dd=DoWbsDarkTask()                                                             #step 4
spectra  = dd(htp=spectra,darkKind=DoWbsDarkTask.DARK1_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
MkWbsBadPixelsTask()(spectra,calPixel)  #step 3
DoWbsDarkTask()(spectra)                #step 4

API details

Properties

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

Provides the SpectrumDataSet that will be corrected for the dark.

Integer darkKind [INPUT, OPTIONAL, default=DoWbsDarkTask.DARK1_2. ]

Provides the Parameters used to decide which kind of dark subtraction is applied.

Boolean usePixel [INPUT, OPTIONAL, default=false]

Decide that in case of differences between the first Pixels of a CCD and the relative Dark the one to be used are the pixel ( usePixel=true) or the dark (usePixel=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