1.363. saveObservation

Full Name:	herschel.ia.toolbox.util.jython.saveobs
Alias:	saveObservation
Type:	Jython Task -
Import:	from herschel.ia.toolbox.util.jython import saveObservation
Category	Input-output

Description

Save an observation into a local pool.

The observation is saved into a pool on your local system. If only the observation is given as an argument, a local pool will be created in the default location, i.e. ~/.hcss/lstore. The default name of the pool is the OBSID for the given observation.

The calibration tree that is attached to the observation is not saved by default. If you want to save the calibration tree with the observation, set the argument saveCalTree=True.

Beware that saving an observation might take a long time since all the products associated to the observation will be saved locally, except the calibration tree.

Example

Example 1: Saving an observation from your HIPE session

saveObservation(obs)
saveObservation(obs, poolName="od144")

API Summary

Jython Syntax
`saveObservation(obs[, verbose=False\|True]`
`[, poolLocation=<directory>] [, poolName=<pool name>]`
`[, saveCalTree=False\|True])`

Properties
`ObservationContext obs [INPUT, MANDATORY, default=no default]`
`boolean verbose [INPUT, OPTIONAL, default=False]`
`String poolName [INPUT, OPTIONAL, default=see description]`
`String poolLocation [INPUT, OPTIONAL, default=see description]`
`boolean saveCalTree [INPUT, OPTIONAL, default=False]`

API details

Properties

`ObservationContext obs [INPUT, MANDATORY, default=no default]`
	The observation that must be saved

`boolean verbose [INPUT, OPTIONAL, default=False]`
	A flag for more verbose output.

`String poolName [INPUT, OPTIONAL, default=see description]`
	The name of the pool to be used to save the requested observation

`String poolLocation [INPUT, OPTIONAL, default=see description]`
	The directory where the pool for the given observation must be created

`boolean saveCalTree [INPUT, OPTIONAL, default=False]`
	Indicates whether the calibration tree associated with the observation must be saved as well. By default the calTree is not saved in the local pool.