1.123. undoSidebandGain

Full Name: herschel.hifi.pipeline.generic.UndoSidebandGainTask
Alias: undoSidebandGain
Type: Java Task - Java Task
Import: from herschel.hifi.pipeline.generic import UndoSidebandGainTask
Category

HIFI/Pipeline/Level 2 Pipeline

Description

Brings all the spectra included in the input product to a sideband gain of 0.5 or to 1.0.

It uses the meta parameters (usbGain, lsbGain or usbGain_k, lsbGain_k) that have been used to compute the sideband gains coefficients and reverts the application of the sideband gains correction. If the parameter complete is set to True then the effect of the sideband gains correction is undone (as if sideband gains correction coefficients have been set to 1). Otherwise (default), the intensity scale is brought to sideband gains correction coefficients equal to 0.5. In case the sideband gains correction has not been applied before (DoSidebandGainTask) the task has no effect. Similarly, if not in all datasets parameters are found that specify the correction coefficients the task is not applied. The task works if the wave scale is at the USB/LSB or the IF frequency scale. It is not applicable to spectra at the velocity scale.

Example

Example 1: In HIPE:
undoSidebandGain(htp=htp)
undoSidebandGain(htp=htp, complete=True)

API details

Properties

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

The timeline product (observation) to be passed to the module.

Boolean complete [INPUT, OPTIONAL, default=no default value]

Specifies whether the undo should be done to coefficients 1.0 (True) or 0.5 (False).

PipelineConfiguration params [INPUT, OPTIONAL, default=no default value]

Configuration parameter that can be passed to the product

Boolean ignore [INPUT, OPTIONAL, default=no default value]

Flag to indicate whether the execution of the module should be ignored.

See also

History

  • 2012-03-27 - melchior: : First version.
  • 2014-03-01 - melchior: : Adjust for changes in the Do/MkSidebandGainTask.