1.69. doUplink

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

HIFI/Pipeline/Level 0 Pipeline

Description

Copies meta data parameters from the HifiUplinkProduct into the HTP and HSD.

The following items may appear in the MetaData of the HTP or HSD. For mapping mode some extra meta data is copied if available. These items may include, mapLineStep, mapReadoutSep, superSampling, and scanRate.

  • nyquistSampling: Map is Nyquist sampled.

    Taken from: flyNyquistSel | rasterNyquist | fsNyquist | LoadRasterNyquist

  • frame: the name of the reference frame.

    Taken from: frame

  • redshiftType: Redshift Type.

    Taken from: redshiftType

  • redshiftFrame: Redshift frame.

    Taken from: redShiftFrame

  • naifId: Solar System NAIF identifier.

    Taken from: naifid

  • loadInterval: Load period in seconds.

    Taken from: load_interval

  • vlsr: the Vlsr, Velocity in the frame of reference.

    Taken from: redshift

  • pattAngle: Map rotation angle.

    Taken from: flyAngle | rasterAngle | fsAngle | LoadRasterAngle

  • crossStep: Separation between scans of the map.

    Taken from: flyCrossStep | flyCrossScanStep | rasterCrossScanStep | fsCrossScanStep | crossStepSize

  • mapWidthCommanded: Size of the map along the horizontal axis of the map.

    Taken from: flyX

  • mapHeightCommanded: Size of the map along the vertical axis of the map.

    Taken from: flyY

  • decoff: Declination of the reference point.

    Taken from: decoff

  • raoff: Right ascension of the reference point.

    Taken from: raoff

  • dataTime: Data dump interval.

    Taken from: data_time

Example

Example 1: dpUplink
doUplink( htp=htp, auxiliary=aux )

API details

Properties

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

The timeline product (observation) to be passed to the module.

AuxiliaryContext auxiliary [INPUT, OPTIONAL, default=no default value]

When present the info is copied from the UplinkProduct inside this AuxiliaryContext.

See also

History

  • 2009-11-10 - DK: creation
  • 2012-09-01 - KE: Resigned task to read the HifiUplinkProduct