1.34. doChannelWeights

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

HIFI/Pipeline/Level 1 Pipeline

Description

Computes the (channel-dependent) weights and fills them into the science datasets.

Different options are available:

  • Radiometric formula (definition = "radiometric").

  • Integration time only (definition = "integrTime").

  • Sample variance obtained from a moving window in the flux data (definition = "variance").

Example

Example 1: In HIPE:
doWeights = DoChannelWeights()
doWeights(htp=htp, definition="radiometric", interp="linear"))

API details

Properties

HifiTimelineProduct htp [INPUT, MANDATORY, default=no default Value]

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

CalFluxHotCold cal [INPUT, OPTIONAL, default=no default value]

The product containing the sysytem temperature and the band pass of the black body calibrators as obtained in the MkFluxHotCold-module.

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

Pipeline configuration parameters that can be passed to the task.

String definition [INPUT, OPTIONAL, default=no default value]

Definition of the weights to be used: 'radiometric', 'tsys', 'integrTime', 'variance'

String smoothing [INPUT, OPTIONAL, default=no default value]

The smoothing operation applied in case a width > 1 is specified. By default a Gaussian filter is used.

Integer width [INPUT, OPTIONAL, default=no default value]

The window width used when computing the (local) sample variance or when smoothing the radiometric formula output.

String interpolator [INPUT, OPTIONAL, default=no default value]

The interpolator used when interpolating the system temperature.

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

Indicate whether extrapolation is allowed at the boundaries when using moving variance to define the weights.

Integer rowFlagMask [INPUT, OPTIONAL, default=RowMask.IGNORE_DATA.getValue() | RowMask.BAD_DATA.getValue()]

Mask to identify the tsys spectra that should be discarded when interpolating tsys-spectra in the radiometric definition of the weights. Flagged rows that are not masked by this integer will be used in the interpolation and propagated as informative flags. For example, if you want to ignore rows that have the flag 1,4 or 16 set you specify a rowFlagMask=21. By default, the rowFlagMask is set to discard rows with the flags RowMask.IGNORE_DATA or RowMask.BAD_DATA set. If in a given frequency group all tsys spectra are flagged (i.e. the configured bits set) ... TODO: specify the strategy here such as setting an appropriate row flag to indicate that the weights are crap --> follow up strategy (doAvg, mkOffSmooth, etc)?? raining a quality flag to indicate that the weights in some of the spectra are crap --> better don't use them... If some of the bandpass spectra are discarded a badHcDataDiscarded-flag is raised. Associated entries are added to the meta data of the htp. If you want to disregard rows with any flag set specify a rowFlagMask = 0. If you want to include all rows irrespective of the row flag set specify a negative rowFlagMask.

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

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

See also

History

  • 2011-07-17 - Melchior: : History added
  • 2011-08-14 - Melchior: : Renamed to DoChannelWeightsTask
  • 2012-05-05 - Melchior: : Included handling of row flags to be ignored