1.61. doPointing

Full Name: herschel.hifi.pipeline.level0.DoPointingTask
Alias: doPointing
Type: Java Task - Java Task
Import: from herschel.hifi.pipeline.level0 import DoPointingTask
Category

HIFI/Pipeline/Level 0 Pipeline

Description

doPointing

Add or update pointing information to the HifiTimelineProduct.

The MetaData parameter "attitudeQuaternion" will contain the type of column used in point reconstruction based on the user input, possible values are: "filterQuat","gyroPropQuat","commandQuat","simpleCorrFilterQuat"

The MetaData parameter "gyroAttSuspicious" will be set to true in any of the following cases:

"gyroAttQuality" < "probBad"

"gyroAttCoverage" < "coverageThresh"

"gyroAttQuality" < 0.2

Where "gyroAttQuality","probBad" ,"gyroAttCoverage" ,"coverageThresh" are values retrieved from the PointingProduct used.

Examples

Example 1: In HIPE:
#USE SIAM to compute Chopper offset
doPointing.setUseSiam(1)
htph2=doPointing(htp=htp,aux=obs.auxiliary,useIntegration=1)
Example 2: In HIPE:
#USE  chopperThrow to compute Chopper offset
ChopperPosition.initialize( obs.calibration, obs.getStartDate() )
chopperThrow=obs.calibration.getCalNode( "Downlink" ).getCalNode( "Generic" )
   .getProduct("chopperThrows").getByStartDate(obs.getStartDate(), "ChopperThrows").getProduct().getTable()
htph2=doPointing(htp=htph2,aux=obs.auxiliary,useIntegration=1,chopperThrows=chopperThrow)

API details

Properties

HifiTimelineProduct htp [INOUT, MANDATORY, default=No default value]

The HifiTimelineProduct which will be updated with the hk flag.

AuxiliaryContext aux [INPUT, OPTIONAL, default=No default value]

The Auxiliary product where to retrieve pointing information.

Boolean useGyro [INPUT, OPTIONAL, default=False]

Decide if the pointing should be computed with the GyroPropagate or Filtered:

useGyro=false ---> use PointingItem.getFiltered()

useGyro= true ---> use PointingItem.getGyroPropagated()

Boolean useCommanded [INPUT, OPTIONAL, default=False]

Decide if the pointing should be computed with the Commanded points:

useCommanded=false ---> use PointingItem.getFiltered() or PointingItem.getGyroPropagated()

useCommanded= true ---> use PointingItem.getCommanded()

Boolean useSimpleFilter [INPUT, OPTIONAL, default=False]

A three state boolean that decide if the pointing should be computed with the old simple filter quaternion points:

useSimpleFilter=true use simpleFilter

useSimpleFilter=false use new Filter

useSimpleFilter=null or not present (default): decide in function of gyroAttQuality parameter in PointingProduct, if gyroAttQuality < 0.2 use simple filter otherwise use new filter

Boolean useIntegration [INPUT, OPTIONAL, default=False]

(In the hifi-pipeline the value is set = True) decide if the pointing value for each spectrum is computed at the start of the integration time or as average of all points during the integration time.

Ephemerides eph [INPUT, OPTIONAL, default=No default value]

The Ephemeris product to retrieve values for de-aberration of SOO. Overwrite the values passed in the "aux" input. Not used if

PointingProduct pointing [INPUT, OPTIONAL, default=No default value]

The PointingProduct containing the PointingItem values for the spacecraft

OrbitEphemerisProduct orbit [INPUT, OPTIONAL, default=No default value]

The OrbitEphemerisProduct product to retrieve values for de-aberration of SOO. Overwrite the values passed in the "aux" input.

SiamProduct siam [INPUT, OPTIONAL, default=No default value]

The SiamProduct containing the siam matrixes for the HIFI aperture.

Integer errorType [INPUT, OPTIONAL, default=VARIANCE]

How the error are computed when averaging points. Possible values are:

WEIGHTED=0 ; weighted average of the error of each single point

VARIANCE=1; the variance of the points used in the average (Default)

RANGE=2 ; the difference between the minimum and the maximum value used

TableDataset chopperThrows [INPUT, OPTIONAL, default=No default value]

The ChopperThrows retrieved from the calibration-tree, used to compute chopped position Used only when the Task is in the status setUseSiam=false (default)

See also