1.55. doHrsSymm

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

HIFI/Pipeline/HRS Pipeline

Description

Step8: Task which symmetries the correlation function of HRS to prepare the FFT.

Gets the correlation functions, duplicates the channels except channel0, and inverse them.

A modifier allows the user to define the zero filling:

  • "multiple" = multiple of 2 (DFT)

  • "power" = power of 2 (FFT)

For a wide-band resolution sub-band, max number of zeroes can be 5 (1024 - (2*510 - 1)), for a high-resolution sub-band, max number of zeros can be 17.

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

Limitations

The option zeros = "power" is not yet available.

API details

Properties

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

The HifiTimelineProduct which contains the HrsSpectrumDatasets.

String zeros [INPUT, OPTIONAL, default="multiple"]

A parameter to select the zero filling : "multiple" or "power".

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