1.99. level2Pipeline

Full Name: herschel.hifi.pipeline.generic.Level2PipelineTask
Alias: level2Pipeline
Type: Jython Task - Jython Task
Import: from herschel.hifi.pipeline.generic import Level2PipelineTask
Category

HIFI/Pipeline/Level 2 Pipeline

Description

Process

Example

Example 1: Level2PipelineTask
<pre>
#    
# Examples:
# level2Pipeline(obs=obs)
# or process only one apid:
# or process an htp:
# level2Pipeline(htp=htp)
#
</pre>

API details

Properties

PyFunction algo [INPUT, OPTIONAL, default=default=]

The algorithm for the level2 part of the generic pipeline.

Integer apid [INPUT, OPTIONAL, default=No default value]

ApID as available in the observation context to be processed. Aspected value: 1028, 1029, 1030, 1031

ObservationContext obs [INPUT, OPTIONAL, default=(alternative to htp)]

No default value, null allowed. The Observation Context processed , in input Level 0, in Output Level 1

HifiTimelineProduct htp [INPUT, OPTIONAL, default=(alternative to obs)]

the HifiTimelineProduct to be processed.

Not yet in use for the default algo applied here cal [INPUT, MANDATORY, default=no default value]
PipelineConfiguration params [INPUT, OPTIONAL, default=No default value]

A map of level 1 and 2 pipeline tasks and their parameters

type palStore [INPUT, MANDATORY, default=no default value]
String sideband [INPUT, OPTIONAL, default=default=both]

the side band to be processed: 'upper', 'lower' or 'both'

MapContext result [INPUT, OPTIONAL, default=default=None]

a MapContext containing the result products for the side bands as well as the cubes produced by the mapping task

Boolean gui [INPUT, OPTIONAL, default=default=False.]

only used for a test progress bar. TBD . If the progress bar is displayed or not.