1.79. exportLines

Full Name: herschel.hifi.dp.tools.ExportLinesTask
Alias: exportLines
Type: Jython Task - Jython Task
Import: from herschel.hifi.dp.tools import ExportLinesTask

Description

Export of detected or identified lines to a dictionary of HSLL.

This tool exports the output of identifyLines or detectLines to a dictionary of SpectralLineLists.

Examples

Example 1: Export the lines using default calibration.
hslls = ExportLinesTask()(lines, obs, spectrum, author)
Example 2: Export the lines.
hslls = ExportLinesTask()(lines, obs, spectrum, author, calibration)
Example 3: Get the SpectralLinelists
detectedHsll = hslls["detected"]
# Identified and unidentified SpectralLinelists are available only when
# the parameter lines is the output of identifyLines
identifiedHsll = hslls["identified"]
unidentifiedHsll = hslls["identified"]

API details

Properties

PyDictionary lines [INPUT, MANDATORY, default=no default value]

The output of identifyLines or detectLines.

ObservationContext obs [INPUT, MANDATORY, default=no default value]

The observation context containing the data.

Spectrum1d spectrum [INPUT, MANDATORY, default=no default value]

The original data from obs.

String author [INPUT, MANDATORY, default=no default value]

The author of the product.

Double calibration [INPUT, OPTIONAL, default=0.1]

The calibration of the instrument used in the computation of the noise flux.

PyDictionary hslls [OUTPUT, MANDATORY, default=no default value]

The dictionary of SpectralLineLists.

History

  • MB-19/05/2015: Initial version