Chapter 5. SPIRE Products Description

Table of Contents

5.1. SPIRE observational products
5.1.1. SPIRE Observation Context metadata
5.1.2. Level-0 products
5.1.3. Level-0.5 products
5.1.4. Level-1 products
5.1.5. Level-2 products
5.1.6. Level-2.5 products
5.1.7. Level-3 products
5.2. SPIRE calibration products
5.2.1. Calibration History Products
5.2.2. Photometer Calibration Products
5.2.3. Spectrometer Calibration Products

5.1. SPIRE observational products

5.1.1. SPIRE Observation Context metadata

The SPIRE Observation Context Product contains a list of metadata keywords which give the majority of the parameters that identify the observation. These are examples for the three SPIRE modes:

5.1.1.1. ObservationContext for SPIRE Photometry

Table 5.1. Example of the metadata keywords contained in a SPIRE Photometry observation.

StringParameter  type (description="Product Type Identification")
StringParameter  creator (description="Generator of this product")
DateParameter  creationDate (description="Creation date of this product")
StringParameter  description (description="Name of this product")
StringParameter  instrument (description="Instrument attached to this product")
StringParameter  modelName (description="Model name attached to this product")
DateParameter  startDate (description="Start date of the observation")
DateParameter  endDate (description="End date of the observation")
StringParameter  formatVersion (description="Version of product format")
StringParameter  obsState (description="One of CREATED, LEVEL0_PROCESSED, LEVEL0_5_PROCESSED, LEVEL1_PROCESSED, LEVEL2_PROCESSED, LEVEL2_5_PROCESSED, LEVEL3_PROCESSED")
StringParameter  telescope (description="Name of telescope")
StringParameter  object (description="Target name")
StringParameter  naifId (description="SSO NAIF identifier")
StringParameter  observer (description="Observer name")
StringParameter  proposal (description="Proposal name")
LongParameter  obsid (description="Observation identifier")
LongParameter  odNumber (description="Operational day number")
StringParameter  aot (description="AOT Identifier")
StringParameter  aorLabel (description="AOR Label as entered in HSpot")
StringParameter  cusMode (description="CUS observation mode")
StringParameter  instMode (description="Instrument Mode")
StringParameter  obsMode (description="Observation mode name")
StringParameter  pointingMode (description="Pointing mode")
StringParameter  biasMode (description="Bias mode")
LongParameter  numRepetitions (description="Number of times to repeat the basic unit of the observation")
StringParameter  missionConfig (description="Mission configuration")
DoubleParameter  equinox (description="Equinox of celestial coordinate system")
StringParameter  raDeSys (description="Coordinate reference frame for the RA and DEC")
DoubleParameter  ra (description="Actual Right Ascension of pointing", quantity="deg")
DoubleParameter  raNominal (description="Requested Right Ascension of pointing", quantity="deg")
DoubleParameter  dec (description="Actual Declination of pointing", quantity="deg")
DoubleParameter  decNominal (description="Requested Declination of pointing", quantity="deg")
DoubleParameter  posAngle (description="Spacecraft pointing Position angle", quantity="deg")
DoubleParameter  radialVelocity (description="Spacecraft velocity along the l-of-s of the telescope wrt the LSR", quantity="km s-1")
StringParameter  velocityDefinition (description="The velocity definition and frame")
StringParameter  origin (description="Site that created the product")
StringParameter  processingMode (description="Processing mode selected to execute the pipeline")
StringParameter  calVersion (description="Version of the cal tree")
DateParameter  slewTime (description="Predicted start time for slew before the observation")
StringParameter  scanDirection (description="nominal, orthogonal or scanab")
StringParameter  scanSpeed (description="Speed of scan")
StringParameter  aperture (description="Instrument aperture in use")
BooleanParameter  coolerBurpDetected (description="Indicates a cooler burp")
DoubleParameter  solarAspectAngleMean (description="Mean Solar Aspect Angle", quantity="deg")
DoubleParameter  solarAspectAngleRms (description="RMS Solar Aspect Angle", quantity="deg")
                             


5.1.1.2. ObservationContext for SPIRE Spectroscopy

Table 5.2. Example of the metadata keywords contained in a SPIRE Spectroscopy observation.

StringParameter  type (description="Product Type Identification")
StringParameter  creator (description="Generator of this product")
DateParameter  creationDate (description="Creation date of this product")
StringParameter  description (description="Name of this product")
StringParameter  instrument (description="Instrument attached to this product")
StringParameter  modelName (description="Model name attached to this product")
DateParameter  startDate (description="Start date of the observation")
DateParameter  endDate (description="End date of the observation")
StringParameter  formatVersion (description="Version of product format")
StringParameter  obsState (description="One of CREATED, LEVEL0_PROCESSED, LEVEL0_5_PROCESSED, LEVEL1_PROCESSED, LEVEL2_PROCESSED, LEVEL2_5_PROCESSED, LEVEL3_PROCESSED")
StringParameter  telescope (description="Name of telescope")
StringParameter  object (description="Target name")
StringParameter  observer (description="Observer name")
StringParameter  proposal (description="Proposal name")
LongParameter  obsid (description="Observation identifier")
LongParameter  odNumber (description="Operational day number")
StringParameter  aot (description="AOT Identifier")
StringParameter  aorLabel (description="AOR Label as entered in HSpot")
StringParameter  cusMode (description="CUS observation mode")
StringParameter  instMode (description="Instrument Mode")
StringParameter  obsMode (description="Observation mode name")
StringParameter  pointingMode (description="Pointing mode")
StringParameter  mapSampling (description="Spatial sampling of map")
StringParameter  biasMode (description="Bias mode")
LongParameter  numRepetitions (description="Number of times to repeat the basic unit of the observation")
LongParameter  numHRepetitions (description="Number of HR repetitions")
LongParameter  numLRepetitions (description="Number of LR repetitions")
StringParameter  commandedResolution (description="Commanded Spectral Resolution")
StringParameter  missionConfig (description="Mission configuration")
DoubleParameter  equinox (description="Equinox of celestial coordinate system")
StringParameter  raDeSys (description="Coordinate reference frame for the RA and DEC")
DoubleParameter  ra (description="Actual Right Ascension of pointing", quantity="deg")
DoubleParameter  raNominal (description="Requested Right Ascension of pointing", quantity="deg")
DoubleParameter  dec (description="Actual Declination of pointing", quantity="deg")
DoubleParameter  decNominal (description="Requested Declination of pointing", quantity="deg")
DoubleParameter  posAngle (description="Spacecraft pointing Position angle", quantity="deg")
DoubleParameter  pmRA (description="Target's proper motion RA (arcsec/yr) as given by the observer", quantity="arcsec a-1")
DoubleParameter  pmDEC (description="Target's proper motion Dec (arcsec/yr) as given by the observer", quantity="arcsec a-1")
DoubleParameter  raDecOffset (description="The offset between the commanded position and the actual reconstructed pointing, which includes any systematic BSM offset (bsmOffset), but not the APE", quantity="arcsec")
DoubleParameter  bsmOffset (description="BSM offset position (0.0 or 1.7 arcsec), which is corrected for by the point-source calibration. This systematic offset is included in the raDecOffset value", quantity="arcsec")
DoubleParameter  radialVelocity (description="Spacecraft velocity along the l-of-s of the telescope wrt the LSR", quantity="km s-1")
StringParameter  velocityDefinition (description="The velocity definition and frame")
StringParameter  origin (description="Site that created the product")
StringParameter  processingMode (description="Processing mode selected to execute the pipeline")
StringParameter  calVersion (description="Version of the cal tree")
DateParameter  slewTime (description="Predicted start time for slew before the observation")
StringParameter  processedAs (description="The spectral resolution that was used to process the data (HR, LR, or H+LR).")
StringParameter  aperture (description="Instrument aperture in use")
DoubleParameter  solarAspectAngleMean (description="Mean Solar Aspect Angle", quantity="deg")
DoubleParameter  solarAspectAngleRms (description="RMS Solar Aspect Angle", quantity="deg")
StringParameter  ConcatenatedOBSIDs (description="Sequence of comma separated OBSIDs, length is equal to the number of concatenated AORs to which the given OBSID belongs to")
LongParameter  photObsid000 (description="SPIRE photometer map obsid that overlaps with this observation - 000")
LongParameter  photObsid001 (description="SPIRE photometer map obsid that overlaps with this observation - 001")
                             


5.1.2. Level-0 products

The generic Herschel definition of Level-0 data products is the following:

  • Raw telemetry data (TMPackets) as measured by the instrument, minimally manipulated and ingested as data frames into the mission data base/archive. Typically, readings are in binary units versus detector pixel number

The SPIRE definition of Level-0 data products differs from the Herschel-wide definition in the format. In fact, SPIRE Level-0 data products are implemented as HIPE products (or subclasses) that contain raw telemetry values as extracted from SPIRE Data Frames.

The format of Level-0 data products is defined to be as simple as possible. Each product contains data coming from only one building block of a specified observation with the data from each TM packet type in a separate table dataset. All Level-0 products are made from the BuildingBlockProduct Java class. Note that different table datasets will be present depending on the type of building block (in other words, only the table dataset for the actual TM packets generated in the building block will be saved).

Within each product, the table datasets are identified with the name of the TM packet type. Each table dataset has a number of columns, one for each quantity stored in SpireDataFrames of the specified TM packet, that is, a column for each TM parameter contained in the specified TM packet. However, some TM parameters that are not useful for data processing (such as FrameIDs) are not stored in SpireDataFrames and will be not present in Level-0 data products. The "sdfTime", "packetTime" and "seqCount" are defined as the SpireDataFrame time, the TM packet time and the TM packet Sequence Count — these quantities are used to compute the sample time, to check its validity and to check the correct time ordering of the telemetry.

The last columns in the following table defines which in pipeline each product is used. The pipelines for different observing modes are defined as follows:

  • POF2: Photometer Point Source (7-point jiggle)
  • POF5: Photometer Large Map
  • POF10: Photometer Small Map
  • PARALLEL: SPIRE/PACS Parallel Mode (PAR for short)
  • SOF1: Spectrometer single pointing (sparse sampling)
  • SOF2: Spectrometer single pointing (intermediate or full sampling)
  • ROF1: Spectrometer raster (sparse sampling)
  • ROF2: Spectrometer raster (intermediate or full sampling)

Note that ROF1 and ROF2 products are similar to SOF2 products.

Dataset description Product type POF2 POF5 POF10 PAR SOF1 SOF2
Photometer Detector Timeline PHOTF, PHOTSW, PHOTMW, PHOTLW y y y y    
Photometer Offset Timeline PHOTOFF y y y y    
Spectrometer Detector Timeline SPECF, SPECSW, SPECLW         y y
Spectrometer Offset Timeline SPECOFF         y y
Nominal Housekeeping Timeline NHK y y y y y y
Critical Housekeeping Timeline CHK y y y y y y
Beam Steering Mirror Timeline BSMNOMINAL y y y y y y
Spectrometer Mechanism Timeline SMECSELECT, SMECSCAN         y y
Subsystem Control Unit Timeline SCUNOMINAL y y y y y y

The SPIRE level-0 context is defined as follows:

Product description Product type
SPIRE Level-0 Context Level0Context
  Level-0 Building Block product (contents as given above) BuildingBlockProduct

5.1.3. Level-0.5 products

Product description Product type POF2 POF5 POF10 PAR SOF1 SOF2
Photometer Detector Timeline PDT y y y y    
Photometer Offset Timeline POT y y y y    
Spectrometer Detector Timeline SDT         y y
Spectrometer Offset Timeline SOT         y y
Nominal Housekeeping Timeline NHKT y y y y y y
Critical Housekeeping Timeline CHKT y y y y y y
Beam Steering Mirror Timeline BSMT y       y y
Spectrometer Mechanism Timeline SMECT         y y
Subsystem Control Unit Timeline SCUT y y y y y y

The SPIRE level-0.5 Engineering Data Processing (EDP) context is defined as follows:

Product description Product type
SPIRE Level-0.5 EDP block context  
  Level-0.5 building block context (each block is generated per observation building block)  
    Level-0.5 product (as given in the table above)  

5.1.4. Level-1 products

Product description Product type POF2 POF5 POF10 PAR SOF1 SOF2
Averaged Pointed Photometer Product APPP y          
Photometer Scan Product PSP   y y y    
Spectrometer Detector Interferogram Product SDI         y y

5.1.5. Level-2 products

Product description Product type POF2 POF5 POF10 PAR SOF1 SOF2
Jiggled Photometer Product JPP y          
Photometer Destriper Diagnostic Product PDD   y y y    
Photometer Map Product PMP   y y y    
SSO Photometer Map Product (*) ssoPMP   y y      
Photometer Extended Map Product PXMP   y y y    
Spectrometer Point Source Spectrum SPSS         y  
Spectrometer Detector Spectrum SDS         y  
SPIRE Preprocessed Cube SPC           y
Spectral Simple Cube SSC           y

(*) ssoPMP are PMP in the reference frame of the Solar System Object, they are only present for SSOs.

5.1.6. Level-2.5 products

Product description Product type POF2 POF5 POF10 PAR SOF1 SOF2
Photometer Map Product PMP   y   y    
Photometer Extended Map Product PXMP   y   y    
Photometer Hi-resolution Extended Map Product(*) hiresPXP   y   y    

(*) Hi-resolution maps are only available for a subset of level2.5 observations.

5.1.7. Level-3 products

Product description Product type POF2 POF5 POF10 PAR SOF1 SOF2
Photometer Extended Map Product PXMP   y y y