Package jpl.mipl.tlm.sirtf

SIRTF Telemetry Processor for APID's: 11, 13, 15, 20, 21, 23, 30, 31, 40, 41, 51, and 52 (Whew!).

See:
Description

Interface Summary

SirtfOutputProduct

All SIRTF products generated by SirtfTlmProc must implement this interface.

Class Summary

AASGen	AASGen is a standalone program that creates the Attitude and Attitude Supplement files as described in SIS FES-014.
AccountingBean	Accounts for a set of statistics based upon the XML persistence files and SFDU's processed during a downlink.
AORStats	Convenience class to allow for the tracking of Lists of products that are related by their AORkey.
APID12Packet	Encapsulates telemetry for the Rate Bias and Star Tracker Assembly (STA) to PCRS alignment characteristics.
APID13Packet	Parses and encapsulates telemetry data found in the pointing reconstruction APID.
APID14Packet	Encapsulates telemetry for all the pre-channelized data that is used for both momentum history file processing.
APID15Packet	Encapsulates telemetry for all the pre-channelized data that is used for both PHF and IPF processing.
APID16Packet	Encapsulates telemetry for all the pre-channelized data that is used for momentum history file processing.
CEOutputProduct	SIRTF output product in ESS format that is designed for the MIPS/IRS CE (Combined Electronics) Memory Dump and Engineering Diagnostic data.
DatabaseOutputProduct	Implements the SirtfOutputProduct interface to a database.
DesatBean	Encapsulates characteristics for the spacecraft tachometer found in APID 14.
DownlinkSummary	Compiles a set of statistics based upon the XML persistence files found under a downlink directory.
EphemS2SPosBean	Encapsulates characteristics for the spacecraft tachometer found in APID 14.
ESSOutputProduct	Orders packets into destination file according to their group.
FieldWorkerHelper	Replaces the necessary elements of the TPS system with fieldable elements.
GetCpt
IRACOutputProduct	A SirtfOutputProduct dedicated to IRAC instrument data using the DCE packing convention.
IRSOutputProduct	A SirtfOutputProduct dedicated to IRS instrument data using the DCE packing convention.
jqi	The jqi (Java Query Inferface) class contains database utility functions for use with the MIPL database system.
MHFGen	MHFGen is a standalone program that creates the momentum history file Supplement files as described in SIS FES-014.
MIPSOutputProduct	Implements the DCE packing convention for the Multiband Imaging Photometer for SIRTF (MIPS) instrument.
PacketTimeStats	Accounts for a set of statistics based upon the time (SCLK, SCET, ERT, RCT) of SFDU's processed during a downlink.
PAPFileGenerator
PAPRecord	Bean to encapsulate salient information to tell PAP which packets not to delete from the spacecraft MMC (Mass Memory Card).
ParseCPT	A parser that ingests the Channel Parameter Table, populating an internal TreeMap with the desired channel information.
PEWrapper	Wrapper class that interfaces with the Pointing History Engine (PHE) supplied by David Bayard and his group.
PHFGen	PHFGen is a standalone program that creates the Pointing History File as described in SIS 3030.
RateBiasBean	Encapsulates characteristics for the spacecraft Rate bias estimates found in APID 15.
RateDataBean	Encapsulates characteristics for the spacecraft Rate data found in APID 13.
RiceCMDecompression	This is based on the Rice Compression algorithm and was implemented by Matt Klimesh.
RssSelBean	Encapsulates characteristics for the spacecraft tachometer found in APID 14.
SCMomentumBean	Encapsulates characteristics for the spacecraft tachometer found in APID 14.
SirtfCcsdsPkt	SIRTF CHDO for SFDU data CHDO, type 10.
SirtfDB	JDBC Interface class for SIRTF.
SirtfDOMUtils
SirtfDOMWorker
SirtfDownlinkInfo	Collects downlink info that is used to generated the Nominal and Expedited Processing Reports.
SirtfEnv	Encapsulates various environment resources that might be needed to process SIRTF telemetry.
SirtfFEIWorker
SirtfFileProduct	Provides a great deal of common behavior for the standard products MIPL is responsible for.
SirtfFitsHdr	Implements the necessary functionality to mange the DCE FITS header.
SirtfFlip	SIRTF MIPS Data Pixel Flipper Filter (say that fast three times ;-) ).
SirtfLog	Contains all aspects of application logging used during SIRTF TLM processing.
SirtfMetaData	Encapsulates a set of characteristics describing a SirtfFileProduct.
SirtfNotification
SirtfPacketStore	Assigns an SFDU to a particular destination, usually a file or set of files, based upon information found within that SFDU.
SirtfProcessingReport	This class is used for generating Sirtf processing reports.
SirtfSFDU	A class that encapsulates a SIRTF SFDU (whether it be a data SFDU, a CDR or an ECDR).
SirtfTlmProc	Main program for processing SIRTF telemetry data.
SoftwareConfig	Encapsulates configuration parameters that are used to configure the software across multiple runs.
STA2PCRSBean	Encapsulates characteristics for the spacecraft Star Tracker Assembly (STA) to PCRS alignment found in APID 15.
STADataBean	Encapsulates characteristics for the spacecraft STA data found in APID 13.
TachometerBean	Encapsulates characteristics for the spacecraft tachometer found in APID 14.
TimeoutTask	Implements the TimerTask Thread for use in both Expedited and Nominal timeouts for SIRTF.
VelocityBean	Encapsulates characteristics for the spacecraft velocity found in APID 15.

Exception Summary

DecompressionException	An exception that is thrown when a failure occurs while trying to decompress a SIRTF science packet.
FitsCreationException	An exception that is thrown when a failure occurs while trying to initialize a product FITS header cache.
FitsECDRStoreException	An exception that is thrown when a failure occurs while attempting to store ECDRs into the FITS header.
InvalidUPFException	Exception used to denote that the UPF supplied by the user has some incorrect and/or inconsistent entries.
NoSecondaryHeaderException	An exception that is thrown when a packet has been received that has no secondary header.
ProductInconsistentException	An Exception that designates an inconsistency between the state of a DCE on disk vs what the database contains.
ProductNotCachedException

Package jpl.mipl.tlm.sirtf Description

SIRTF Telemetry Processor for APID's: 11, 13, 15, 20, 21, 23, 30, 31, 40, 41, 51, and 52 (Whew!).

The current state of this software is such that one can process SIRTF SFDU packets for the following APID's:

• 13 PCS
• 15 REC_NOM_MED (11, RT_NOM_MED, also accepted), ECDRs only
• 20 IRAC (Expedited)
• 21 IRAC
• 23 IRAC Dump
• 30 IRS (Expedited)
• 31 IRS
• 40 MIPS (Expedited)
• 41 MIPS
• 51 CE Memory Dump
• 52 CE Engineering Diagnostic

Decompression of science packets is also supported.

The products generated with the above data are:

• FITS formatted DCE's, analagous to REDR's
• Raw groups of associated memory dump and egr. diagnostic data, the format of which is colloquially called ESS
• Raw binary files describing the spacecraft pointing history, also known as a Pointing History File (PHF). A database is used to store the incoming data and, upon timeout, any necessary PHF files are generated via query to this database.
• Various reports and logs

This code requires a Java Virtual Machine (JVM), version 1.4 or better. The software is packaged into the common format known as a 'jar', a Java Archive. The name of this jar is 'sirtf.jar'.

The operation of this code is straightforward. The user must create a User Parameter File (UPF) that specifies at least the following parameters:

MISSION = SIRTF
INSTRUMENT = CE_PHF
SFDU_SOURCE = TDS
TDS_HOST = stftds1.fltops.jpl.nasa.gov
TDS_PORT = 6666
PVL_FILE = /path/to/pvl/location/file.pvl
PAGE = OFF
TOP_DIR = /path/to/top/directory/
CAT_UPDATE = ON
CAT_USER = jmm
CAT_PASSWORD = password
CAT_DATABASE = jmm
CAT_SERVER = miplDev
PHF_UPDATE = OFF
PHF_USER = jmm
PHF_PASSWORD = password
PHF_DATABASE = jmm
PHF_SERVER = miplDev
FEI_DELIVERY = ON
CPT = /export/sirtf/cpt/V3.0.40.wcpt
VERBOSE_FLAG = 2
NOM_TIMEOUT = 7
EXP_TIMEOUT = 7
NAMING_CONVENTION = SIRTF
UNSIGNED_SCALING = OFF
MODE = PROCESS
APID_LIST =  20, 21, 23, 30, 31, 40, 41, 51, 52

The keyword descriptions follow (defaults are in bold):

SFDU_SOURCE possible values: ( FILE || TDS )

If this software is run without benefit of the TPS, then only a value of FILE will work. This is known as standalone mode. In order to use a TDS for input, this code must be run under the TPS.

SFDU_FILE

Path and file specification pointing to the file containing the SFDU's

VERBOSE_FLAG possible values: ( ON || OFF || 0 || 1 || 2 || 3 )

• OFF is equavalent to 0.
• ON is equivalent to 1. Higher numbers imply more verbose logging.
• 3 will produce an enourmous amount of debug and status information. Probably shouldn't use this level unless you're debugging SirtfTlmProc or the received TLM data.

TOP_DIR

Path to the top of the directory tree where output products will be placed. Within this directory, SirtfTlmProc will collate the files into the appropriate subdirectories (which it will create as needed). Also, STP will "walk" the directories as needed, one per downlink, within TOP_DIR.

CPT

Path to the Channel Parameter Table. This file is not required for CE processing (APID's 51 and 52).

APID_LIST

A comma separated list of APID's that are to be processed to an actual output file in OUT_DIR. This is used in cases where a file of SFDU's might contain data other than that desired for processing. APID's encountered that aren't listed in APID_LIST will be ignored.

PACKING_CONVENTION possible values: ( DCE || ESS )

DCE packing convention creates the typical FITS organization where multiple groups are placed into the same DCE. The ESS convention creates files similar to those created by the AMMOS ESS tool. This places the ancilliary packet and the packets within a single group contiguously within the file.

NAMING_CONVENTION possible values: ( SIRTF || BALL )

The naming convention used for the final products placed into OUT_DIR.

UNSIGNED_SCALING possible values: ( OFF || ON )

Enables unsigned scaling before writing data to certain instruments' FITS files to conform with FITS standard. This parameter is ignored when PACKING_CONVENTION is ESS and when processing CE data.

MODE possible values: ( PROCESS || ANALYZE || REPROCESS || GAPFILL )

• PROCESS mode will create products in the directory specified by OUT_DIR by processing the SFDU's found in the file specified by SFDU_FILE.
• ANALYZE mode will simply run though the SFDU file specified by SFDU_FILE and, if VERBOSE_FLAG is ON will print out useful information.
• REPROCESS overrides SirtfTlmProc's natural tendency to ignore duplicate packets, allowing new packets into DCE's. This is necessary, for example, when a product has been affected by the FULDL memory corruption. Retransmitted packets, it is hoped, won't have this corruption and should be used instead.
• GAPFILL is similar to PROCESS except that that you can specify exactly the AORKey, Exposure, and DCE ID for those products to process. This mode is supplied for those cases where a relatively small set of data needs to be processed (e.g. due to a gap in the TDS that is missed by the standard NOW - FOREVER NERT query). Typically, in this case, one wishes to mitigate the possibility of a timed query running beyond the time at which the standard stream is awoken to process new incoming data.

default values are implied if the keyword is missing from the UPF altogether.

Once this UPF file is created the user runs the following command:

java -jar sirtf.jar <UPF file>