1.47. doHrsFreq

Full Name: herschel.hifi.pipeline.hrs.DoHrsFreqTask
Alias: doHrsFreq
Type: Java Task - Java Task
Import: from herschel.hifi.pipeline.hrs import DoHrsFreqTask
Category

HIFI/Pipeline/HRS Pipeline

Description

Step11: Task which computes the frequency of the HRS sub-bands.

The parameter "model" of this Task permits to choose between:

  • "model" ==> creation of the HRS frequency Linear Model.

  • "column" ==> creation of the frequency columns.

If the model is Chosen, the parameters of the model are the LOs values and the sampler name for every sub-band. Those parameters can change from scan to scan.

If the columns are chosen, this task will create columns named "frequency_1", "frequency_2", etc.

Example

Example 1: In HIPE
from herschel.hifi.pipeline.hrs import *
htp = HifiTimelineProduct(df, hk)
doHrsSubbands(htp=htp)
doHrsOffsetPow(htp=htp)
doHrsNorm(htp=htp)
doHrsQDCFull(htp=htp, cal=calHrsQDCFull)
doHrsPowCorr(htp=htp, cal=calHrsPowCorr)
doHrsWindow(htp=htp, window="hanning")
doHrsSymm(htp=htp, zeros="multiple")
doHrsFFT(htp=htp, algo="DFT")
doHrsSmooth(htp=htp, smooth="none")
doHrsFreq(htp=htp, model="column")

API details

Properties

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

The HifiTimelineProduct which contains the HRS spectra.

String model [INPUT, OPTIONAL, default="column"]

The indicator to select between frequency columns ("column") or frequency model ("model").

See also

History

  • 2006-03-13 - OCJ: creation
  • 2006-05-17 - OCJ: CompositeDataset replaced by HifiVectorDataset
  • 2006-09-11 - OCJ: HifiVectorDataset replaced by HifiPipelineProduct
  • 2006-12-07 - OCJ: HifiPipelineProduct replaced by HifiTimelineProduct
  • 2010-11-04 - OCJ: Old examples from Jide removed