1.75. doWbsNonlin

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

HIFI/Pipeline/WBS Pipeline

Description

Step5:

perform nonlinearity correction for even and odd WBS pixels.

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
spectra =DoWbsDarkTask()(htp=spectra,darkKind=DoWbsDarkTask.DARK1_2)  #step 4
spectra =DoWbsNonlinTask()(htp=spectra,cal=DefaultValues.getLinearCoeff())#step 5
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
DoWbsDarkTask()(spectra)   #step 4
DoWbsNonlinTask()(spectra) #step 5

API details

Properties

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

Provides the SpectrumDataSet that will be corrected for the nonlinearity. *

CalWbsLinearCoeff cal [INPUT, OPTIONAL, default=CalWbsLinearCoeff()]

Provides the parameters of the polynomials per band and pixel type for the pixel non linearity corrections.

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