1.97. mkSidebandGain

Full Name:	herschel.hifi.pipeline.generic.MkSidebandGainTask
Alias:	mkSidebandGain
Type:	Java Task -
Import:	from herschel.hifi.pipeline.generic import MkSidebandGainTask
Category:	HIFI/Pipeline/Level 2 Pipeline

Description

Creates an interpolator for computing the IF- and LO-frequency dependent sideband gains ratios.

The output is specified as an interface type (only the interface is needed by the {@link DoSidebandGainTask}-task). This will allow to include different implementations and provide the means to have them easily configured.

Example

Example 1: In HIPE

from herschel.hifi.pipeline.generic import MkSidebandGain
mkSidebandGain = MkSidebandGain()
gains = mkSidebandGain(htp=htp, shape=shapes, level=levels)

API Summary

Properties
`HifiTimelineProduct htp [INPUT, MANDATORY, default=no default value]`
`CalSidebandCoeff cal [OUT, MANDATORY, default=no default value]`
`MapContext calibration [INPUT, OPTIONAL, default=no default value]`
`GenericPipelineContext level [INPUT, MANDATORY, default=no default value]`
`GenericPipelineContext shape [INPUT, MANDATORY, default=no default value]`
`PipelineConfiguration params [INPUT, OPTIONAL, default=no default value]`
`Boolean ignore [INPUT, OPTIONAL, default=no default value]`

API details

Properties

`HifiTimelineProduct htp [INPUT, MANDATORY, default=no default value]`
	The input {@link HifiTimelineProduct} which is used to look up the detector band and the startDate of the observation. This is information is needed to look up the associated information from the 'level' and 'shape' calibration products passed as input parameters to the task (and typically retrieved from the calibration tree).

`CalSidebandCoeff cal [OUT, MANDATORY, default=no default value]`
	Helper object that is provided as output and allows to compute the sideband gains ratios. This object is passed as input parameter to the {@link DoSidebandGainTask}-task.

`MapContext calibration [INPUT, OPTIONAL, default=no default value]`
	Reference to the calibration tree from which shape and level tables for computing sideband gains are obtained.

`GenericPipelineContext level [INPUT, MANDATORY, default=no default value]`
	Calibration product that contains tables with the LO dependent gains coefficients level. Different tables correspond to different observation times (the observations have been taken at). This allows to account for potential instrument drifts.

`GenericPipelineContext shape [INPUT, MANDATORY, default=no default value]`
	The calibration product that contains tables with the IF dependent shape of the gains coefficients. Different tables correspond to different observation times (the observations have been taken at). This allows to account for potential instrument drifts.

`PipelineConfiguration params [INPUT, OPTIONAL, default=no default value]`
	Pipeline configuration parameters that can be passed to the task.

`Boolean ignore [INPUT, OPTIONAL, default=no default value]`
	If set to True task is not executed.

History

2011-07-11 - Melchior: History added.
2011-08-14 - Melchior: Renamed to MkSidebandGainTask.