1.57. doMainBeamTemp

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

HIFI/Pipeline/Level 2 Pipeline

Description

Translates to the main beam temperature scale.

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

Example

Example 1: In HIPE:
doMainBeamTemp(htp=htp, cal=my_beam_eff)
doMainBeamTemp(htp=htp, beamEff=0.68)

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 beam efficiencies. The product allows for LO-specific parameters.

Double beamEff [INPUT, OPTIONAL, default=no default value]

The beam efficiency to apply.

MapContext calibration [INPUT, OPTIONAL, default=no default value]

Parameter to pass a calibration context from which all the calibration input, here the beam efficiencies, can be retrieved.

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]

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 beamEff-parameter) or, alternatively, retrieved from the calibration tree (see parameter calibration). If useCalTree=True but no reference to the calibration tree is provided the beamEff parameter is used.

See also

History

  • 2011-07-11 - melchior: : history added.
  • 2011-08-14 - melchior: : renamed to DoMainBeamTemperatureTask.