1.112. mkWbsFluxAtten

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

HIFI/Pipeline/WBS Pipeline

Description

Step10: Attenuator settings analysis.

Provides the technical SpectrumDataSet that will be used to calculated the Intensity calibration in function of the attenuator settings .

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
dd=DoWbsDarkTask() #step 4
spectra = dd(htp=spectra,darkKind=LongParameter(DoWbsDarkTask.DARK1_2))
spectra = DoWbsNonlinTask()(htp=spectra,cal=MyTablePolyn) #step 5
mkz=MkWbsZeroTask() #step 6
zeroCal=mkz(htp=spectra,interp=LongParameter(zeroCal.NONE))
zerocheck=mkz.zeroCheck
spectra =DoWbsZeroTask()(htp=spectra,cal=zeroCal) #step 7
mkf=MkWbsFreqTask() #step 8
freqCal=mkf(htp=spectra,interp="PREVIOUS")
combCheck=mkf.combCheck #equivalent to: combCheck=freqCal.check
DoWbsFreqTask()(htp=spectra,cal=freqCal) #step 9
att=MkWbsFluxAttenTask()(htp=spectra,cal=CalWbsAttSpecific()) #step 10
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
DoWbsNonlinTask()(spectra) #step 5
zeroCal=MkWbsZeroTask()(spectra) #step 6
DoWbsZeroTask()(spectra,zeroCal) #step 7
freqCal=MkWbsFreqTask(spectra) #step 8
DoWbsFreqTask()(spectra,freqCal) #step 9
att=MkWbsFluxAttenTask()(spectra) #step 10

API details

Properties

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

Provides the HifiTimelineProduct to be analyzed.

CalWbsAttSpecific calL [OUTPUT, OPTIONAL, default=No.]

Provides an IntensityCalibration that can be applied to the SpectrumDataset

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