1.125. wbsPipeline

Full Name: herschel.hifi.pipeline.wbs.WbsPipelineTask
Alias: wbsPipeline
Type: Jython Task - Jython Task
Import: from herschel.hifi.pipeline.wbs import WbsPipelineTask
Category

HIFI/Pipeline/WBS Pipeline

Description

Process

Example

Example 1: #
# Examples:
from herschel.hifi.pipeline.wbs.WbsPipelineTask import *
wbsPipelineTask(obs=obs, palStore=palStore) 
# or process only one apid:
wbsPipelineTask(apid=1030, obs=obs, palStore=palStore)
# or process an htp:
wbsPipelineTask(htp=htp)
# or load df and hk
htp = wbsPipelineTask(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 observation to be processed. Aspected value: 1030 , 1031

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

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

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

if the pipeline should be run step by step

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 Used cal [INPUT, MANDATORY, default=no default value]
type palStore [INPUT, MANDATORY, default=no default value]
Boolean gui [INPUT, OPTIONAL, default=default=False.]

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