1.78. getHifiCal

1.78. getHifiCal

Full Name:	herschel.hifi.pipeline.GetHifiCalTask
Alias:	getHifiCal
Type:	Java Task -
Import:	from herschel.hifi.pipeline import GetHifiCalTask
Category:	HIFI/Pipeline

Description

A task to retrieve the calibration data from an external source and save it locally on one's disk (lstore). The

two possible sources for HIFI calibration data are the HSA and the HIFI-ICC databases.

API Summary

Properties
`ProductPool palPool [OUTPUT, OPTIONAL, default=None]`
`String calName [INPUT, OPTIONAL, default='hifi-cal']`
`BOOLEAN useHsa [INPUT, OPTIONAL, default=True]`
`BOOLEAN showGuiPopUpBox [INPUT, OPTIONAL, default=True]`
`BOOLEAN overWrite [INPUT, OPTIONAL, default=False]`

API details

Properties

`ProductPool palPool [OUTPUT, OPTIONAL, default=None]`
	ProductPool for HIFI calibration data

`String calName [INPUT, OPTIONAL, default='hifi-cal']`
	The name of the product pool to be created.

`BOOLEAN useHsa [INPUT, OPTIONAL, default=True]`
	Select the HSA as the calibration / auxiliary data source. If false the code will attempt a connection to the HIFI-ICC calibration database. This is intended for internal HIFI-ICC users only.

`BOOLEAN showGuiPopUpBox [INPUT, OPTIONAL, default=True]`
	Toggles the GUI pop-up boxes shown as the task is run

`BOOLEAN overWrite [INPUT, OPTIONAL, default=False]`
	Overwrite the existing calibration data in a given product pool

History

2010-11-10 - KE: Created this task to provide a solution to HIFI-3789
2011-01-24 - KE: Updated description of task and changed name see HIFI-3897