1.20. configureHifiPipeline

Full Name: herschel.hifi.pipeline.ConfigureHifiPipelineTask
Alias: configureHifiPipeline
Type: Java Task - Java Task
Import: from herschel.hifi.pipeline import ConfigureHifiPipelineTask
Category

HIFI/Pipeline

Description

A convenience task to configure the external inputs to the hifiPipeline task.

The inputs may consist of new calibration and/or auxiliary data sources need to (re)processing an observation or set of observations. The output of this task can be used directly as the input for the task parameter palStore in the hifiPipeline task.

General User Settings

Task Parameter settings (only non-default options shown)

Default

Product Storage

Yes

[pipeline-out, hsa]

poolName="myCal"

Yes

[pipeline-out, hsa]

poolName="myCal", storageName="myStore"

Yes

[pipeline-out, hsa]

useHsa=False

No

[standard]

useHsa=False, storageName="cal-local"

No

[pipeline-out, hifi-cal]

useHsa=False, poolName="myCal", storageName="cal-local"

No

[pipeline-out, myCal]

useHsa=False, poolName="myCal", storageName="cal-local-hsa"

No

[pipeline-out, myCal, hsa]

useHsa=False, storageName="default"

No

[pipeline-out]

useHsa=False, calName="myCal", storageName="default"

No

[myCal]

HIFI-ICC User Settings

Task Parameter settings (only non-default options shown)

Default

Product Storage

useHsa=False

Yes

[pipeline-out, hsa]

useHsa=False, storageName="icc"

No

[pipeline-out, hifi_ops_cal, hifi_ops_aux]

useHsa=False, storageName="spgstore"

Yes

[pipeline-out, hsa]

useHsa=False, storageName="spgstore-int"

No

[pipeline-out, hsa]

<id="configureHifiPipeline">

Example

Example 1: Default setup for the HifiPipeline (using HSA)
store = configureHifiPipeline()

API details

Properties

ProductStorage palStore [INOUT, OPTIONAL, default=None]

Returns a configured ProductStorage. To be used as input for the 'palStore' task parameter in the hifiPipeline task.

String storageName [INPUT, OPTIONAL, default=None]

An HCSS property exists as defined by "hcss.ia.pal.store.${storageName}" which defines a set of product pools

String poolName [INPUT, OPTIONAL, default=hifi-cal]

Allows users to specify the name of the local calibration pool, which is different from the default

BOOLEAN useHsa [INPUT, OPTIONAL, default=True]

Select the HSA as the calibration / auxiliary data source

See also

History

  • 2010-10-11 - KE: Created this task to provide a solution to HIFI-3740
  • 2011-11-18 - KE: Added additional functionality and updated documentation