1.42. doHrsCorrSP

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

HIFI/Pipeline/HRS Pipeline

Description

Step12: Task which corrects HRS spectra from IF non-linearity errors.

Gets the spectra and applies the following correcting factors:

  • divide each value by #channels, except for 0 : divide by (#channels * 2)

  • get the power value vSigma

  • multiply each spectrum by Math.pow(HrsDefaultValues.THRESHOLDS_VALUE / vSigma, 2)

An additional parameter is provided to convert the spectrum in dB relatively to the mean spectrum.

  • in_db = 1: convert the spectrum in dB

  • in_db = 0: no conversion

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")
doHrsCorrSP(htp=htp, in_db=0)

API Summary

Jython Syntax

doHrsCorrSP(htp=htp, in_db=0)
Properties
HifiTimelineProduct htp [INOUT, MANDATORY, default=No default value]
Integer in_db [INPUT, OPTIONAL, default=0]

API details

Properties

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

The HifiTimelineProduct which contains the HRS spectra.

Integer in_db [INPUT, OPTIONAL, default=0]
 

The indicator to select if spectrum is converted in dB (in_db=1) or not (in_db=0).

History

  • 2005-04-29 - OCJ: creation
  • 2005-11-15 - OCJ: conversion in dB suppressed, see DoHrsDbSP
  • 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