HiCat Data Dictionary

Catalog: HiRISE
The main HiRISE catalog contains all the information used in operating the HiRISE camera after it is attached to the MRO spacecraft. The information is divided into those related to suggesting, planning, commanding, retrieving, processing, validating, and distributing the observations. The tag that follows an observation through all these catalogs (and from Earth to Mars and back) is the unique Observation_ID. This text representation also forms the core of the product names. The HiRISE catalog also contains ancillary information needed in various uplink and downlink activities, such as the people making image suggestions, MRO project uplink files, SPICE and engineering data, and public image releases.
Table:Planned_Observations
Holds information about parameters of planned observations. The parameters in this table are organized at the observation level. Parameters at the CCD level are stored in the Planned_CCD table. The values of these two tables will be manipulated (insert, update, and delete) by HiPlan, and HiCommand will retrieve the parameter values in these two tables to generate command files. HiCommand will also input some flag values back into this table, such as the various COMMAND_FILE_* fields. HiDOG will also input observation SUCCESS_ACQUIRED_TIME back into this table. This table is related to the Suggested_Observations table by the mapping table Suggested_Observations_Planned_Observations_map, and is related to the Sequence_Plan table by the mapping table ?, and related to most of other tables by Observation_ID.

Field Description Type Null Limits Size Key Default Authority Source
ID This is the unique ID for each Planned Observation. The values here should not be assigned by external programs. Instead it can either be ignored, or NULL can be inserted, and the database will automatically assign the next ID. INT(10) unsigned auto_increment Not Null Primary Key db server
OBSERVATION_ID This is the very specific HiRISE Observation ID for this Planned Observation. VARCHAR(25) Not Null unique index HiPlan
VERSION Version number of this record. If needed by HiPlan. VARCHAR(255) Not Null HiPlan
SEQUENCE_ID Unique identifier for 14-day sequencing cycle that this Planned Observation will be acquired in. Format and originator of ID are currently unknown. VARCHAR(64) HiPlan
PLANNER The username of the person running HiPlan VARCHAR(32) Not Null HiPlan
COMMANDER The username of the person running HiCommand VARCHAR(32) Not Null HiCommand
OBSERVATION_TYPE This represents the kind of target observation being planned. It can be a value from zero to five. 0 = Nadir looking, normal - no high stability needed. 1 = Small Off-Nadir roll, normal stability. 2 = Large Off-Nadir roll, normal stability. 3 = Small Off-Nadir roll, high stability. 4 = Large Off_Nadir roll, high stability. 5 = Nadir looking, high stability. TINYINT(1) unsigned 0 to 5 HiPlan
STABILITY This is the stability required for this observation. ENUM("NORMAL", "HIGH") HiPlan
INSTRUMENT_SET A copy of the PTF instrument set field. VARCHAR(6) HiPlan
COORDINATION This indicates what other instruments this observation is coordinated with. SET("CTX", "CRISM", "OTHER") HiPlan
CENTER_PLANETOGRAPHIC_LATITUDE The center planetographic latitude of this observation. Applications or users that insert or update this table are responsible for doing the same for CENTER_PLANETOCENTRIC_LATITUDE. FLOAT -90 to 90 HiPlan
CENTER_PLANETOCENTRIC_LATITUDE The center planetocentric latitude of this observation. Applications or users that insert or update this table are responsible for doing the same for CENTER_PLANETOGRAPHIC_LATITUDE. FLOAT -90 to 90 HiPlan
CENTER_LONGITUDE The center east longitude of this observation. FLOAT 0 to 360 HiPlan
FOOTPRINT_PLANETOGRAPHIC_VERTICES A list of up to 4 longitudue and latitude pairs which are the vertices of a polygon specifying the footprint of the observation in planetographic coordinates. TEXT HiPlan
FOOTPRINT_PLANETOCENTRIC_VERTICES A list of up to 4 longitudue and latitude pairs which are the vertices of a polygon specifying the footprint of the observation in planetocentric coordinates. TEXT HiPlan
OFFSET_CENTER_PLANETOGRAPHIC_LATITUDE The latitude of the center of the observation in planetographic coordinates if a manual delay has been added to this observation. If there is no added delay, this coordinate will be the same as the CENTER_PLANETOGRAPHIC_LATITUDE. FLOAT HiPlan
OFFSET_CENTER_PLANETOCENTRIC_LATITUDE The latitude of the center of the observation in planetocentric coordinates if a manual delay has been added to this observation. If there is no added delay, this coordinate will be the same as the CENTER_PLANETOCENTRIC_LATITUDE. FLOAT HiPlan
OFFSET_CENTER_LONGITUDE The longitude of the center of the observation in if a manual delay has been added to this observation. If there is no added delay, this coordinate will be the same as the CENTER_LONGITUDE. FLOAT HiPlan
ALTITUDE The Areodetic altitude (at the target) of the center of the observation in kilometers. This field represents the center altitude for the observation on the MRO ellipsoid reference. FLOAT HiPlan
OFFSET_CENTER_ALTITUDE The Areodetic altitude (at the target) of the center of the observation in kilometers, including any manual delay that may have been added to this observation. This field represents the center altitude for the observation on the MRO ellipsoid reference. If there is no added delay, this coordinate will probably be the same as the ALTITUDE. FLOAT HiPlan
START_PLANETOGRAPHIC_LATITUDE The beginning planetographic latitude of the observation. Applications or users that insert or update this table are responsible for doing the same for START_PLANETOCENTRIC_LATITUDE. FLOAT -90 to 90 HiPlan
START_PLANETOCENTRIC_LATITUDE The beginning planetocentric latitude of the observation. Applications or users that insert or update this table are responsible for doing the same for START_PLANETOGRAPHIC_LATITUDE. FLOAT -90 to 90 HiPlan
END_PLANETOGRAPHIC_LATITUDE The end planetographic latitude of the observation. Applications or users that insert or update this table are responsible for doing the same for END_PLANETOCENTRIC_LATITUDE. FLOAT -90 to 90 HiPlan
END_PLANETOCENTRIC_LATITUDE The end planetocentric latitude of the observation. Applications or users that insert or update this table are responsible for doing the same for END_PLANETOGRAPHIC_LATITUDE. FLOAT -90 to 90 HiPlan
COMMENT Miscellaneous comment about this observation. VARCHAR(255) HiPlan
NOTES A field for additional notes about this observation. TEXT HiPlan
HISTORY A field for storing history information about an observation. TEXT HiPlan
IMAGE_WIDTH Width of the observation in meters. FLOAT HiPlan
ESTIMATED_ROLL_ANGLE Roll angle of the spacecraft for this observation in degrees. Negative values indicate a roll towards the right, which would be eastwards on the ascending pass of the orbit. FLOAT -90 to 90 HiPlan
PLAYBACK_MODE Mode that the data will be played back in for this observation. ENUM("X_BAND", "KA_BAND") HiPlan
ESTIMATED_PHASE_ANGLE The estimated value of the phase angle for this observation in degrees. FLOAT 0 to 180 HiPlan
ESTIMATED_EMISSION_ANGLE The estimated value of the emission angle for this observation in degrees. FLOAT 0 to 90 HiPlan
ESTIMATED_INCIDENCE_ANGLE The estimated value of the incidence angle for this observation in degrees. FLOAT 0 to 90 HiPlan
CPMM_00_ON This indicates whether the number 0 CPMM should be on for this observation. ENUM("OFF", "ON") Not Null HiPlan
CPMM_01_ON This indicates whether the number 1 CPMM should be on for this observation. ENUM("OFF", "ON") Not Null HiPlan
CPMM_02_ON This indicates whether the number 2 CPMM should be on for this observation. ENUM("OFF", "ON") Not Null HiPlan
CPMM_03_ON This indicates whether the number 3 CPMM should be on for this observation. ENUM("OFF", "ON") Not Null HiPlan
CPMM_04_ON This indicates whether the number 4 CPMM should be on for this observation. ENUM("OFF", "ON") Not Null HiPlan
CPMM_05_ON This indicates whether the number 5 CPMM should be on for this observation. ENUM("OFF", "ON") Not Null HiPlan
CPMM_06_ON This indicates whether the number 6 CPMM should be on for this observation. ENUM("OFF", "ON") Not Null HiPlan
CPMM_07_ON This indicates whether the number 7 CPMM should be on for this observation. ENUM("OFF", "ON") Not Null HiPlan
CPMM_08_ON This indicates whether the number 8 CPMM should be on for this observation. ENUM("OFF", "ON") Not Null HiPlan
CPMM_09_ON This indicates whether the number 9 CPMM should be on for this observation. ENUM("OFF", "ON") Not Null HiPlan
CPMM_10_ON This indicates whether the number 10 CPMM should be on for this observation. ENUM("OFF", "ON") Not Null HiPlan
CPMM_11_ON This indicates whether the number 11 CPMM should be on for this observation. ENUM("OFF", "ON") Not Null HiPlan
CPMM_12_ON This indicates whether the number 12 CPMM should be on for this observation. ENUM("OFF", "ON") Not Null HiPlan
CPMM_13_ON This indicates whether the number 13 CPMM should be on for this observation. ENUM("OFF", "ON") Not Null HiPlan
ESTIMATED_RECEIVE_TIME This is an estimate of when the data will get to HiROC. This time is in UTC. DATETIME HiPlan
DELAY_BY The number of seconds used for fine-tuning the start of a HiRISE Observation. FLOAT unsigned HiPlan
MANUAL_DELAY_BY_FLAG Was the DELAY_BY field manually set? ENUM("NO","YES") Not Null HiPlan
RELATIVE_TIMED_SEQUENCE_FLAG Indicates whether this observation is part of a relative-timed sequence. ENUM("NO","YES") Not Null NO HiPlan
SCAN_EXPOSURE_DURATION This time in microseconds specifies the time between the generation of successive lines. This is the value that was supplied to the EXP_LINETIME command in the command upload. FLOAT(11,5) unsigned HiPlan
ORBIT_NUMBER The orbit number that this observation will be acquired during. MEDIUMINT(4) unsigned HiPlan
ORBIT_PASS This field should contain either the letter "a" to denote the ascending pass of the orbit, or the letter "d" for the descending pass of the orbit. VARCHAR(1) HiPlan
ORBIT_ALTERNATIVES Other orbits that this can be acquired on. This is a space separated list of orbit numbers. The orbit numbers here consist of an integer followed by the letter "a" or the letter "d" indicating the ascending or descending portion of the orbit. TEXT HiPlan
RAW_DATA_VOLUME_BYTES The amount of expected raw data volume produced by this observation in units of bytes, post compression (if any). INT(10) unsigned HiPlan
FELICS_COMPRESSION_FLAG Is this observation going to be compressed with FELICS. ENUM("NO", "YES") Not Null HiPlan
FELICS_COMPRESSION_RATIO The compression ratio to be used by FELICS. FLOAT unsigned HiPlan
STATUS The status of this observation through the MRO project. Plan = not yet uplinked. Request = uplinked but not yet executed. Incomplete = executed, but observation data has only been partially received. Complete = executed, and all observation data received. Defunct = an abandoned observation, may be deleted in the future. ENUM("PLAN", "REQUEST", "EXECUTED", "INCOMPLETE", "COMPLETE","DEFUNCT") HiPlan, HiCommand, EDRgen
COORDINATED_TRACK_HISTORY This field is the "status" field in a PTF record. VARCHAR(255) HiPlan
TARGET_NAME The name of the target for this observation. ENUM("MARS", "STARS", "PHOBOS", "DEIMOS", "SKY", "CAL", "LUNA", "MOON", "NOOP", "CRC_CHECK", "NOPROC") HiPlan
COMMAND_FILE_GENERATION_TIME The date and time at which the command file was generated from this Planned Observation. DATETIME HiCommand
COMMAND_FILE_ASP_RECEIPT_TIME The date and time at which the command file for this Planned Observation was uplinked to the DOM server at JPL. DATETIME HiCommand
COMMAND_FILE_DOM_RECEIPT_TIME The date and time at which the DOM server at JPL indicated receipt of the command file for this Planned Observation. DATETIME HiCommand
COMMAND_FILE_MRO_UPLINK_TIME The date and time at which the command file for this Planned Observation was uplinked from JPL to the spacecraft. DATETIME HiCommand
COMMAND_FILE_PATHNAME The full, logical path (filename included) of the Command File within the HiRISE filesystem that was generated from this Planned Observation. TEXT HiCommand
SCMF The name of the SCMF built by the ASP for transmission to the spacecraft. VARCHAR(32) HiPlan email processor thingy
SUCCESS_ACQUIRED_TIME The date and time when this Planned Observation was successfully acquired. DATETIME EDRgen
STIMULATION_LAMP_RED_ON Is the red stim lamp supposed to be on for this observation. ENUM("OFF", "ON") Not Null HiPlan
STIMULATION_LAMP_NIR_ON Is the near-infrared stim lamp supposed to be on for this observation. ENUM("OFF", "ON") Not Null HiPlan
STIMULATION_LAMP_BLG_ON Is the blue-green stim lamp supposed to be on for this observation. ENUM("OFF", "ON") Not Null HiPlan
KEEP_STIM_LAMPS_ON_FLAG Override the turn off of the stim lamps prior to an observation. Used for calibration images. ENUM("NO","YES") Not Null NO HiPlan
PREDICT_TIME Time in SCET (ISOD format, "YYYY-DOYTHH:MM:SS.sss"), predicting when the center of the target will be observed. VARCHAR(25) HiPlan
SETUP_DURATION The amount of time in seconds by which loading of the sequence precedes the start of actual data acquisition. This will be a number between 0.0 to 120.0. FLOAT unsigned 0.0 to 120.0 HiPlan
OBSERVATION_DURATION The duration in seconds for which the instrument should expose the target. This value ranges from 0.01 to 360.00. FLOAT unsigned 0.01 to 360.00 HiPlan
REQUEST_PRIORITY The priority for this observation. This is an integer value. INT HiPlan
REQUEST_CATEGORY

The category of this observation request. For either CRISM or HIRISE the string categories may have concatenated on it: "-REQ-CTX-NN" where NN is a 2 digit number indicating the type of CTX support imaging requested "-WXSUP-NN" where NN is a 2 digit number indicating the type of CTX support imaging acquired.

The categories are:
MH-MEP
MH-SCI
MSS-EZ
ATM-EZ
POL-EZ
IO
COORD-IO
TEAM-IO
NIO
NIO-SI
IO-RA
IO-SI
NIO-SI
VARCHAR(64) Not Null HiPlan
MTL_DATABASE_ID This is a unique label identifying this observation in the MRO project's Master Target List database that is maintained by the Project Scientist. This field is deprecated. VARCHAR(64) HiPlan
LSUBS The LS value, or heliocentric longitude of Mars, for this observation, between 0 and 360. FLOAT(3) 0 to 360 HiPlan
HELIOCENTRIC_DISTANCE The distance between the center of Mars and the center of the Sun in astronomical units. FLOAT HiPlan
ANCILLARY_DATA This field in the PTF flags whether this observation is a participant in a stereo pair. This value ranges from zero to two. 0 = the observation is not part of a stereo pair. 1 = first half stereo, angle unspecified 1s = first half, small angle 1l = first half, large angle 2 = second half stereo, angle unspecified 2s = second half, small angle 2l = second half, large angle VARCHAR(4) 0 to 2 HiPlan
SPARE_3 A copy of the PTF instrument spare 3 field, which is an integer. Currently used to indicate a WTH (value "1"). INT(4) HiPlan
RELATIONAL_DATA Arbitrary data relating one observation to another. Examples include seasonal relations and stereo pairs. Will be copied to instrument spare field 4. VARCHAR(255) HiTList, HiPlan
PI_APPROVAL_TO_RELEASE_FLAG Does this observation require special approval from the PI prior to public release? ENUM("NO","YES") Not Null NO Unused
CONTRAST_RATIO The contrast ratio used by HiPHOP. FLOAT HIPHOP
OPTICAL_DEPTH The estimated atmospheric optical depth for the observation. FLOAT HIPHOP
SURFACE_ROUGHNESS The estimated surface roughness of the target. FLOAT HIPHOP
FROST_COVER The estimated amount of frost at the target site. FLOAT HIPHOP
FROST_ALBEDO The estimated albedo of the frost. FLOAT HIPHOP
SURFACE_TYPE The surface type. FLOAT HIPHOP
SCATTERING_SOURCE The source of light scattering. ENUM("DUST","ICE") HIPHOP
LUT_SELECTOR_RED_FUDGE_FACTOR The fudge factor applied by HIPHOP for the RED CCDs. Should normally be in the range of +/-30. INT(3) HIPHOP
LUT_SELECTOR_IR_FUDGE_FACTOR The fudge factor applied by HIPHOP for the IR CCDs. Should normally be in the range of +/-30. INT(3) HIPHOP
LUT_SELECTOR_BG_FUDGE_FACTOR The fudge factor applied by HIPHOP for the BG CCDs. Should normally be in the range of +/-30. INT(3) HIPHOP
LAST_UPDATE This column records the last time that a record was updated. TIMESTAMP db server

Table Options:

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

This page was generated from the XML HiCat Data Dictionary. HEAD

Contact

Please send comments to: HiCat@pirlmail.lpl.arizona.edu.