1.94. hrsPipeline

Full Name: herschel.hifi.pipeline.hrs.HrsPipelineTask
Alias: hrsPipeline
Type: Jython Task - Jython Task
Import: from herschel.hifi.pipeline.hrs import HrsPipelineTask
Category

HIFI/Pipeline/HRS Pipeline

Description

Process

Example

Example 1: HrsPipelineTask
#                                                                             
# Examples:  
hrsPipelineTask(obs=obs, palStore=palStore)
# or process only one apid:
hrsPipelineTask(apid=1028, obs=obs, palStore=palStore)
# or process an htp:
hrsPipelineTask(htp=htp)
# or load df and hk 
htp = hrsPipelineTask(obsid=268516902)
#

API details

Properties

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

The algorithm of the pipeline.

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

ApID of HRS spectrometer. Expected value: 1028, 1029

ObservationContext obs [INPUT, OPTIONAL, default=No default value]

Alternative to htp. Null allowed. The Observation Context processed in input Level 0 and Output Level 1.

Long obsid [INPUT, OPTIONAL, default=No default value]

Alternative input for the observation to be processed. HifiTimelineProduct ObservationContext created on the fly

String cal [INPUT, OPTIONAL, default=No default value]

Not Used

HifiTimelineProduct htp [INPUT, OPTIONAL, default=No default value]

(alternative to obs)The HifiTimelineProduct to be processed.

Boolean step [INPUT, OPTIONAL, default=No default value]

If the pipeline should be run step by step

ProductStorage palStore [INPUT, OPTIONAL, default=No default value]

Product storage used to grep calibration products from, default applies binstruct properties

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

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