1.65. doSpectrumStatistics

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

HIFI/Pipeline/Level 2 Pipeline

Description

Computes the statistics of the individual spectra.

The computation is delegated to {@link SpectrumStatistics} by using the following parameters:

  • mode = "acrossChannel"

  • ignoreNaNs = True

Example

Example 1: In HIPE:
doSpectrumStatistics = DoSpectrumStatisticsTask()
stats = doSpectrumStatistics(htp=htp)
stats_stitched = doSpectrumStatistics(htp=htp, stitchedSegments=True)
stats_perc = doSpectrumStatistics(htp=htp, percentiles=[0.1,0.9])

API details

Properties

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

The timeline product for which to compute the statistics.

Boolean stitchedSegments [INPUT, OPTIONAL, default=False]

Computes the statistics for stitched segments.

double[] percentiles [INPUT, OPTIONAL, default=double[0].]

Specify what percentiles should be given in the output (a list of probabilities).

Integer flagToIgnore [INPUT, OPTIONAL, default=no default value.]

By setting this parameter you can configure which flags should be ignored and which should be propagated as informative flags. For example, if you want to ignore channels that have the flag 1,4 or 16 set you specify a flagToIgnore=21. By default, the flagToIgnore is set to 0 which means that any flagged channel is ignored. If flagToIgnore is set to a negative value no flags are considered in the statistics computations. Note that, quite obviously, flags can only be considered in the computation of the statistics if channel flags are available in the timeline products.

StatisticsTrendProduct stats [OUTPUT, OPTIONAL, default=no default value.]

The output product that contains for each dataset in the original htp an associated dataset.

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.

See also

History

  • 2011-01-14 - Melchior: Initial implementation.
  • 2011-08-14 - Melchior: Renamed to DoSpectrumStatisticsTask.