1.31. doAntennaTemp

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

Description

Translates to the antenna temperature scale.

It changes the label for the intensity axis to "Antenna Temperature" or "Antenna Temperature DBS" (default) - depending on whether the sideband gains correction has been applied or not, respectively.

Example

Example 1: In HIPE:

doAntennaTemp(htp=htp, cal=my_forw_eff)
doAntennaTemp(htp=htp, forwardEff=0.68)
doAntennaTemp(htp=htp, calibration=obs.calibration)

API Summary

Jython Syntax
`See example below.`

Properties
`HifiTimelineProduct htp [INOUT, MANDATORY, default=no default value]`
`GenericPipelineCalProduct cal [INPUT, OPTIONAL, default=no default value]`
`MapContext calibration [INPUT, OPTIONAL, default=no default value]`
`Double forwardEff [INPUT, OPTIONAL, default=no default value]`
`PipelineConfiguration params [INPUT, OPTIONAL, default=no default value]`
`Boolean ignore [INPUT, OPTIONAL, default=no default value]`
`Boolean useCalTree [INPUT, OPTIONAL, default=no default value]`

API details

Properties

`HifiTimelineProduct htp [INOUT, MANDATORY, default=no default value]`
	The timeline product (observation) to be passed to the module.

`GenericPipelineCalProduct cal [INPUT, OPTIONAL, default=no default value]`
	A calibration product that provides the forward efficiencies. The product allows for LO-specific parameters.

`MapContext calibration [INPUT, OPTIONAL, default=no default value]`
	Parameter to pass a calibration context from which all the calibration input, here the forward efficiencies, can be retrieved.

`Double forwardEff [INPUT, OPTIONAL, default=no default value]`
	The forward efficiency to apply.

`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.

`Boolean useCalTree [INPUT, OPTIONAL, default=no default value]`
	Parameter to specify whether the calibration tree should be used as primary source of information. It plays a role for task parameters that can explicitly be set as task parameter value (here, for the `forwardEff`-parameter) or, alternatively, retrieved from the calibration tree (see parameter `calibration`). If `useCalTree=True` but no reference to the calibration tree is provided the `forwardEff` parameter is used.

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

Parameter to specify whether the calibration tree should be used as primary source of information. It plays a role for task parameters that can explicitly be set as task parameter value (here, for the forwardEff-parameter) or, alternatively, retrieved from the calibration tree (see parameter calibration). If useCalTree=True but no reference to the calibration tree is provided the forwardEff parameter is used.

History

2011-07-17 - melchior: : History added.
2011-08-14 - melchior: : Renamed to DoAntennaTemperatureTask.