HiRISE

HiRISE.HiPlan.PTF
Class PTF_Fields

java.lang.Object
  extended by HiRISE.HiPlan.PTF.PTF_Fields

public class PTF_Fields
extends Object

A set of constants defining the fields of a PTF record. The fields may have different meanings for different MRO instruments; they are described below in terms of HiRISE's specific use.

Version:
1.8
Author:
Christian Schaller - UA/PIRL
See Also:
"Payload Target File and Integrated Payload Target File Software Interface Specification (JPL MRO SEQ032)"

Field Summary
static String ANCILLARY_DATA
          The field containing an indication of this observation's use in stereo planning.
static String COMMENT
          The field containing the brief comment describing the observation.
static String COMPRESSION
          The field indicating whether HiRISE is to use FELICS compression or not.
static String COORDINATED_TRACK_HISTORY
          The field containing the observation's coordinated tracking history.
static String DOWNLINK_PRIORITY
          The downlink band (X or Ka) on which the observation data are to be returned to Earth.
static String ELEVATION
          The field indicating the elevation of the observation in kilometers.
static int FIELD_COUNT
          The total number of fields in the PTF record.
static String[] FIELD_NAMES
          The collection of PTF field names in the order in which they appear in the PTF SIS.
static String ID
          Class identification name with source code version and date.
static String INSTRUMENT_SET
          The field containing one to six characters indicating which instruments are involved in the observation.
static String INSTRUMENT_SPARE_FIELD_1
          A field that allows a single-precision floating point number.
static String INSTRUMENT_SPARE_FIELD_2
          A field that allows a double-precision floating point number.
static String INSTRUMENT_SPARE_FIELD_3
          A field that allows an integer number.
static String INSTRUMENT_SPARE_FIELD_4
          A field that allows a short, 40-character string.
static String LATITUDE
          The field indicating the center planetographic latitude of the observation.
static String LONGITUDE
          The field indicating the center longitude of the observation.
static String LSUBS
          The field containing the heliocentric longitude of Mars at the predicted time of the observation.
static String OBSERVATION_DURATION
          The field indicating the duration of the observation in seconds.
static String OBSERVATION_MODE
          The field containing a string identifying the color bands used by HiRISE.
static String OBSERVATION_TYPE
          The field containing an integer describing the kind of observation being performed.
static String ORBIT_ALTERNATIVES
          The field containing alternate orbit numbers for the observation.
static String ORBIT_NUMBER
          The field containing the orbit number of the observation.
static String ORBITAL_DATA_TABLE
          This field is unused by HiRISE.
static String PARAMETERS_TABLE
          This field is unused by HiRISE.
static String PIXEL_SCALE
          The field indicating the binning mode range for HiRISE.
static String PREDICT_TIME
          The field containing the prediction of the observation's center time-on-target in SCET (spacecraft ephemeris time).
static String PRODUCT_ID
          This field is unused by HiRISE.
static String RAW_DATA_VOLUME
          The field containing the data volume of the observation in megabits.
static String REQUEST_CATEGORY
          The field containing the string representing the category of this observation request.
static String REQUEST_PRIORITY
          The field containing the team-defined priority level.
static String ROLL_ANGLE
          The field containing the estimated roll angle for the observation.
static String SEQUENCE_FILENAME
          The field containing the full pathname for the onboard sequence file to be loaded for the observation.
static String SETUP_DURATION
          The field containing the setup time for the observation in seconds.
static String TEAM_DATABASE_ID
          The field containing the unique team ID for this observation.
 
Method Summary
static int getFieldIndex(String field)
          Gets the index of field in the FIELD_NAMES array.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ID

public static final String ID
Class identification name with source code version and date.

See Also:
Constant Field Values

INSTRUMENT_SET

public static final String INSTRUMENT_SET
The field containing one to six characters indicating which instruments are involved in the observation. The first character in the field indicates the driving instrument. Other PTF records following the one in question will define the observations for the remaining participating instruments.

See Also:
Constant Field Values

PREDICT_TIME

public static final String PREDICT_TIME
The field containing the prediction of the observation's center time-on-target in SCET (spacecraft ephemeris time).

See Also:
Constant Field Values

LATITUDE

public static final String LATITUDE
The field indicating the center planetographic latitude of the observation. The latitude is in reference to the MRO reference ellipsoid.

See Also:
Constant Field Values

LONGITUDE

public static final String LONGITUDE
The field indicating the center longitude of the observation. If the value ends with "E" or "W," it is treated as east or west longitude, respectively. By default, it is treated as east longitude. The longitude is in reference to the MRO reference ellipsoid.

See Also:
Constant Field Values

ELEVATION

public static final String ELEVATION
The field indicating the elevation of the observation in kilometers. It is in reference to the MRO reference ellipsoid.

See Also:
Constant Field Values

OBSERVATION_TYPE

public static final String OBSERVATION_TYPE
The field containing an integer describing the kind of observation being performed. It indicates normal or high-stability ("HSTABLE") and a general roll angle category (nadir, small off-nadir, large off-nadir).

See Also:
Constant Field Values

ORBIT_NUMBER

public static final String ORBIT_NUMBER
The field containing the orbit number of the observation.

See Also:
Constant Field Values

ORBIT_ALTERNATIVES

public static final String ORBIT_ALTERNATIVES
The field containing alternate orbit numbers for the observation.

See Also:
Constant Field Values

OBSERVATION_DURATION

public static final String OBSERVATION_DURATION
The field indicating the duration of the observation in seconds.

See Also:
Constant Field Values

SETUP_DURATION

public static final String SETUP_DURATION
The field containing the setup time for the observation in seconds. For HiRISE, the value is always 52 seconds.

See Also:
Constant Field Values

ORBITAL_DATA_TABLE

public static final String ORBITAL_DATA_TABLE
This field is unused by HiRISE.

See Also:
Constant Field Values

PARAMETERS_TABLE

public static final String PARAMETERS_TABLE
This field is unused by HiRISE.

See Also:
Constant Field Values

SEQUENCE_FILENAME

public static final String SEQUENCE_FILENAME
The field containing the full pathname for the onboard sequence file to be loaded for the observation.

See Also:
Constant Field Values

DOWNLINK_PRIORITY

public static final String DOWNLINK_PRIORITY
The downlink band (X or Ka) on which the observation data are to be returned to Earth.

See Also:
Constant Field Values

PRODUCT_ID

public static final String PRODUCT_ID
This field is unused by HiRISE.

See Also:
Constant Field Values

INSTRUMENT_SPARE_FIELD_1

public static final String INSTRUMENT_SPARE_FIELD_1
A field that allows a single-precision floating point number.

See Also:
Constant Field Values

INSTRUMENT_SPARE_FIELD_2

public static final String INSTRUMENT_SPARE_FIELD_2
A field that allows a double-precision floating point number.

See Also:
Constant Field Values

INSTRUMENT_SPARE_FIELD_3

public static final String INSTRUMENT_SPARE_FIELD_3
A field that allows an integer number.

See Also:
Constant Field Values

INSTRUMENT_SPARE_FIELD_4

public static final String INSTRUMENT_SPARE_FIELD_4
A field that allows a short, 40-character string.

See Also:
Constant Field Values

COMMENT

public static final String COMMENT
The field containing the brief comment describing the observation.

See Also:
Constant Field Values

REQUEST_PRIORITY

public static final String REQUEST_PRIORITY
The field containing the team-defined priority level.

See Also:
Constant Field Values

COORDINATED_TRACK_HISTORY

public static final String COORDINATED_TRACK_HISTORY
The field containing the observation's coordinated tracking history. This field represents the desired coordination and status for tracking purposes.

See Also:
Constant Field Values

RAW_DATA_VOLUME

public static final String RAW_DATA_VOLUME
The field containing the data volume of the observation in megabits. One megabit is defined as 1024 x 1024 bits. For HiRISE, this volume includes the estimated compression factor for the FELICS compressor.

See Also:
Constant Field Values

TEAM_DATABASE_ID

public static final String TEAM_DATABASE_ID
The field containing the unique team ID for this observation. For HiRISE, it is an Observation_ID.

See Also:
Constant Field Values

REQUEST_CATEGORY

public static final String REQUEST_CATEGORY
The field containing the string representing the category of this observation request.

See Also:
Constant Field Values

COMPRESSION

public static final String COMPRESSION
The field indicating whether HiRISE is to use FELICS compression or not.

See Also:
Constant Field Values

PIXEL_SCALE

public static final String PIXEL_SCALE
The field indicating the binning mode range for HiRISE. HiRISE doesn't use this field at all, and it may optionally be left blank.

See Also:
Constant Field Values

OBSERVATION_MODE

public static final String OBSERVATION_MODE
The field containing a string identifying the color bands used by HiRISE.

See Also:
Constant Field Values

ANCILLARY_DATA

public static final String ANCILLARY_DATA
The field containing an indication of this observation's use in stereo planning.

See Also:
Constant Field Values

LSUBS

public static final String LSUBS
The field containing the heliocentric longitude of Mars at the predicted time of the observation.

See Also:
Constant Field Values

ROLL_ANGLE

public static final String ROLL_ANGLE
The field containing the estimated roll angle for the observation.

See Also:
Constant Field Values

FIELD_NAMES

public static final String[] FIELD_NAMES
The collection of PTF field names in the order in which they appear in the PTF SIS.


FIELD_COUNT

public static final int FIELD_COUNT
The total number of fields in the PTF record.

Method Detail

getFieldIndex

public static int getFieldIndex(String field)
Gets the index of field in the FIELD_NAMES array. If field is not a valid field name, a -1 is returned instead. The test is done in a case-insensitive manner.

Parameters:
field - the putative field name.
Returns:
the field index or -1 if it is not a valid field or is null.

HiRISE

Copyright (C) Arizona Board of Regents on behalf of the Planetary Image Research Laboratory, Lunar and Planetary Laboratory at the University of Arizona