1.56. doHrsWindow

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

HIFI/Pipeline/HRS Pipeline

Description

Step7: Task which applies a Hanning windowing to the correlation functions of HRS,

which is equivalent to a Hanning smoothing on spectra.

An additional parameter is provided to define the type of smoothing to apply:

  • "hanning": Hanning window on correlation function

  • "none": keep HifiTimelineProduct without any change

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")

API details

Properties

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

The HifiTimelineProduct which contains the HRS correlation functions.

String window [INPUT, OPTIONAL, default="hanning"]

A parameter to select the type of window: "hanning" or "none".

See also

History

  • 2005-04-28 - OCJ: jide example corrected
  • 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