HiRISE

HiRISE.HiPlan.PTF
Class PTF_Record

java.lang.Object
  extended by HiRISE.HiPlan.PTF.PTF_Record
All Implemented Interfaces:
Cloneable

public class PTF_Record
extends Object
implements Cloneable

A single observation from a payload target file (PTF). This class is tailored towards HiRISE use, in that rules from the PTF software interface specification (SIS) that apply to HiRISE are checked, and those that do not are ignored.

The PTF record fields are not allowed to be null. If a field contains no value, it is the empty string, not a null. Any attempt to set a field value to null will silently set it to the empty string instead.

Version:
1.23
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 CRM_INSTRUMENT_CODE
          The CRISM instrument code.
static String CTX_INSTRUMENT_CODE
          The CTX instrument code.
static String ELE_INSTRUMENT_CODE
          The ELECTRA instrument code.
static String HIR_INSTRUMENT_CODE
          The HiRISE instrument code.
static String HIR_SEQUENCE_FILENAME_PREFIX
          The prefix for a HiRISE observation sequence filename.
static String HIR_SEQUENCE_FILENAME_SUFFIX
          The suffix for a HiRISE observation sequence filename.
static String ID
          Class identification name with source code version and date.
static String MAR_INSTRUMENT_CODE
          The MARCI instrument code.
static String SHA_INSTRUMENT_CODE
          The SHARAD instrument code.
 
Constructor Summary
PTF_Record()
          Creates a new PTF record with empty fields.
PTF_Record(Observation_Record observation_record)
          Creates a new PTF record using field values from an input observation record.
PTF_Record(String ptf_record_text)
          Creates a new PTF record using field values derived from an input comma-separated text record.
 
Method Summary
 String ancillary_data()
          Gets the ancillary data for this observation.
 void ancillary_data(String ancillary_data)
          Sets the ancillary data for this observation.
 Object clone()
          Returns a clone of this PTF record.
 String comment()
          Gets the comment for this observation.
 void comment(String comment)
          Sets the comment for this observation.
 String compression()
          Gets the compression for this observation.
 void compression(String compression)
          Sets the compression for this observation.
 String coordinated_track_history()
          Gets the coordinated track history for this observation.
 void coordinated_track_history(String coordinated_track_history)
          Sets the coordinated track history for this observation.
 String downlink_priority()
          Gets the downlink priority for this observation.
 void downlink_priority(String downlink_priority)
          Sets the downlink priority for this observation.
 String elevation()
          Gets the elevation for this observation.
 void elevation(Double elevation)
          Sets the elevation for this observation.
 void elevation(String elevation)
          Sets the elevation for this observation.
 boolean equals(Object o)
          Indicates whether some other object is "equal to" this one.
 int hashCode()
          Returns a hash code value for this PTF record.
 String instrument_set()
          Gets the instrument set for this observation.
 void instrument_set(String instrument_set)
          Sets the instrument set for this observation.
 String instrument_spare_field_1()
          Gets the instrument spare field 1 for this observation.
 void instrument_spare_field_1(Double instrument_spare_field_1)
          Sets the instrument spare field 1 for this observation.
 void instrument_spare_field_1(String instrument_spare_field_1)
          Sets the instrument spare field 1 for this observation.
 String instrument_spare_field_2()
          Gets the instrument spare field 2 for this observation.
 void instrument_spare_field_2(Double instrument_spare_field_2)
          Sets the instrument spare field 2 for this observation.
 void instrument_spare_field_2(String instrument_spare_field_2)
          Sets the instrument spare field 2 for this observation.
 String instrument_spare_field_3()
          Gets the instrument spare field 3 for this observation.
 void instrument_spare_field_3(Integer instrument_spare_field_3)
          Sets the instrument spare field 3 for this observation.
 void instrument_spare_field_3(String instrument_spare_field_3)
          Sets the instrument spare field 3 for this observation.
 String instrument_spare_field_4()
          Gets the instrument spare field 4 for this observation.
 void instrument_spare_field_4(String instrument_spare_field_4)
          Sets the instrument spare field 4 for this observation.
 String latitude()
          Gets the latitude for this observation.
 void latitude(Double latitude)
          Sets the latitude for this observation.
 void latitude(String latitude)
          Sets the latitude for this observation.
 String longitude()
          Gets the longitude for this observation.
 void longitude(Double longitude)
          Sets the longitude for this observation.
 void longitude(String longitude)
          Sets the longitude for this observation.
 String lsubs()
          Gets the lsubs for this observation.
 void lsubs(Double lsubs)
          Sets the lsubs for this observation.
 void lsubs(String lsubs)
          Sets the lsubs for this observation.
 String observation_duration()
          Gets the observation duration for this observation.
 void observation_duration(Double observation_duration)
          Sets the observation duration for this observation.
 void observation_duration(String observation_duration)
          Sets the observation duration for this observation.
 String observation_mode()
          Gets the observation mode for this observation.
 void observation_mode(Observation_Record observation_record)
          Sets the observation mode for this observation.
 void observation_mode(String observation_mode)
          Sets the observation mode for this observation.
 void observation_record(Observation_Record observation_record)
          Sets the values for this PTF record to those from the given observation record.
 String observation_type()
          Gets the observation type for this observation.
 void observation_type(Integer observation_type)
          Sets the observation type for this observation.
 void observation_type(String observation_type)
          Sets the observation type for this observation.
 String orbit_alternatives()
          Gets the orbit alternatives for this observation.
 void orbit_alternatives(String orbit_alternatives)
          Sets the orbit alternatives for this observation.
 String orbit_number()
          Gets the orbit number for this observation.
 void orbit_number(Integer orbit_number, String orbit_pass)
          Sets the orbit number for this observation.
 void orbit_number(String orbit_number)
          Sets the orbit number for this observation.
 String orbital_data_table()
          Gets the orbital data table for this observation.
 void orbital_data_table(String orbital_data_table)
          Sets the orbital data table for this observation.
 Parameter parameter()
          Gets the PTF record are a PVL parameter.
 String parameters_table()
          Gets the parameters table for this observation.
 void parameters_table(String parameters_table)
          Sets the parameters table for this observation.
 String pixel_scale()
          Gets the pixel scale for this observation.
 void pixel_scale(String pixel_scale)
          Sets the pixel scale for this observation.
 String predict_time()
          Gets the predict time for this observation.
 void predict_time(String predict_time)
          Sets the predict time for this observation.
 String product_id()
          Gets the product ID for this observation.
 void product_id(String product_id)
          Sets the product ID for this observation.
 String raw_data_volume()
          Gets the raw data volume in megabits for this observation.
 void raw_data_volume(Double raw_data_volume)
          Sets the raw data volume for this observation.
 void raw_data_volume(String raw_data_volume)
          Sets the raw data volume for this observation.
 String request_category()
          Gets the request category for this observation.
 void request_category(String request_category)
          Sets the request category for this observation.
 String request_priority()
          Gets the request priority for this observation.
 void request_priority(Integer request_priority)
          Sets the request priority for this observation.
 void request_priority(String request_priority)
          Sets the request priority for this observation.
 String roll_angle()
          Gets the roll angle for this observation.
 void roll_angle(Double roll_angle)
          Sets the roll angle for this observation.
 void roll_angle(String roll_angle)
          Sets the roll angle for this observation.
 String sequence_filename()
          Gets the sequence filename for this observation's MRO sequence file.
 String sequence_filename(boolean generate_filename)
          Gets the sequence filename for this observation's MRO sequence file, optionally generating it from the HiRISE team database ID if applicable.
static String sequence_filename(String observation_id)
          Generates an MRO sequence filename for a HiRISE observation command file.
 String setup_duration()
          Gets the setup duration for this observation.
 void setup_duration(Double setup_duration)
          Sets the setup duration for this observation.
 void setup_duration(String setup_duration)
          Sets the setup duration for this observation.
 String team_database_id()
          Gets the team database id for this observation.
 void team_database_id(String team_database_id)
          Sets the team database id for this observation.
static List<String> tokenize(String text)
          Produces a list of strings from comma-separated value text.
 String toString()
          Gets a string representation of this PTF record.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, 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

HIR_SEQUENCE_FILENAME_PREFIX

public static final String HIR_SEQUENCE_FILENAME_PREFIX
The prefix for a HiRISE observation sequence filename.

See Also:
Constant Field Values

HIR_SEQUENCE_FILENAME_SUFFIX

public static final String HIR_SEQUENCE_FILENAME_SUFFIX
The suffix for a HiRISE observation sequence filename.

See Also:
Constant Field Values

HIR_INSTRUMENT_CODE

public static final String HIR_INSTRUMENT_CODE
The HiRISE instrument code.

See Also:
Constant Field Values

CRM_INSTRUMENT_CODE

public static final String CRM_INSTRUMENT_CODE
The CRISM instrument code.

See Also:
Constant Field Values

CTX_INSTRUMENT_CODE

public static final String CTX_INSTRUMENT_CODE
The CTX instrument code.

See Also:
Constant Field Values

MAR_INSTRUMENT_CODE

public static final String MAR_INSTRUMENT_CODE
The MARCI instrument code.

See Also:
Constant Field Values

SHA_INSTRUMENT_CODE

public static final String SHA_INSTRUMENT_CODE
The SHARAD instrument code.

See Also:
Constant Field Values

ELE_INSTRUMENT_CODE

public static final String ELE_INSTRUMENT_CODE
The ELECTRA instrument code.

See Also:
Constant Field Values
Constructor Detail

PTF_Record

public PTF_Record()
Creates a new PTF record with empty fields.


PTF_Record

public PTF_Record(String ptf_record_text)
           throws Invalid_Argument_Exception
Creates a new PTF record using field values derived from an input comma-separated text record. If the text contains too many fields, an Invalid_Argument_Exception is thrown. If it contains too few, empty fields are added to fill out the record, as per the PTF SIS.

Parameters:
ptf_record_text - the comma-separated text representation of the PTF record.
Throws:
Invalid_Argument_Exception - if the input text is not a valid PTF record.

PTF_Record

public PTF_Record(Observation_Record observation_record)
Creates a new PTF record using field values from an input observation record.

Parameters:
observation_record - the observation record from which PTF record field values are taken.
Method Detail

instrument_set

public String instrument_set()
Gets the instrument set for this observation.

Returns:
the instrument set.

instrument_set

public void instrument_set(String instrument_set)
Sets the instrument set for this observation. Some fields must be "blank" (the empty string) if the instrument set indicates a HiRISE observation. A HiRISE observation is one in which the first character of the instrument set is "H." In this case, the orbital_data_table, parameters_table, and product_id will be set to the empty string.

Parameters:
instrument_set - the new instrument set.

predict_time

public String predict_time()
Gets the predict time for this observation.

Returns:
the predict time.

predict_time

public void predict_time(String predict_time)
Sets the predict time for this observation.

Parameters:
predict_time - the new predict time.

latitude

public String latitude()
Gets the latitude for this observation.

Returns:
the latitude.

latitude

public void latitude(String latitude)
Sets the latitude for this observation.

Parameters:
latitude - the new latitude.

latitude

public void latitude(Double latitude)
Sets the latitude for this observation. The text is formatted to three decimal places.

Parameters:
latitude - the new latitude.

longitude

public String longitude()
Gets the longitude for this observation.

Returns:
the longitude.

longitude

public void longitude(String longitude)
Sets the longitude for this observation.

Parameters:
longitude - the new longitude.

longitude

public void longitude(Double longitude)
Sets the longitude for this observation. The text is formatted to three decimal places.

Parameters:
longitude - the new longitude.

elevation

public String elevation()
Gets the elevation for this observation.

Returns:
the elevation.

elevation

public void elevation(String elevation)
Sets the elevation for this observation.

Parameters:
elevation - the new elevation.

elevation

public void elevation(Double elevation)
Sets the elevation for this observation. The text is formatted to three decimal places.

Parameters:
elevation - the new elevation.

observation_type

public String observation_type()
Gets the observation type for this observation.

Returns:
the observation type.

observation_type

public void observation_type(String observation_type)
Sets the observation type for this observation.

Parameters:
observation_type - the new observation type.

observation_type

public void observation_type(Integer observation_type)
Sets the observation type for this observation.

Parameters:
observation_type - the new observation type.

orbit_number

public String orbit_number()
Gets the orbit number for this observation.

Returns:
the orbit number.

orbit_number

public void orbit_number(String orbit_number)
Sets the orbit number for this observation.

Parameters:
orbit_number - the new orbit number.

orbit_number

public void orbit_number(Integer orbit_number,
                         String orbit_pass)
Sets the orbit number for this observation. The orbit number consists of an integer number and a text token indicating the orbit pass.

Parameters:
orbit_number - the integral component orbit number.
orbit_pass - the orbit pass component.

orbit_alternatives

public String orbit_alternatives()
Gets the orbit alternatives for this observation.

Returns:
the orbit alternatives.

orbit_alternatives

public void orbit_alternatives(String orbit_alternatives)
Sets the orbit alternatives for this observation.

Parameters:
orbit_alternatives - the new orbit alternatives.

observation_duration

public String observation_duration()
Gets the observation duration for this observation.

Returns:
the observation duration.

observation_duration

public void observation_duration(String observation_duration)
Sets the observation duration for this observation.

Parameters:
observation_duration - the new observation duration.

observation_duration

public void observation_duration(Double observation_duration)
Sets the observation duration for this observation. The text is formatted to two decimal places.

Parameters:
observation_duration - the new observation duration.

setup_duration

public String setup_duration()
Gets the setup duration for this observation.

Returns:
the setup duration.

setup_duration

public void setup_duration(String setup_duration)
Sets the setup duration for this observation.

Parameters:
setup_duration - the new setup duration.

setup_duration

public void setup_duration(Double setup_duration)
Sets the setup duration for this observation. The text is formatted to one decimal place.

Parameters:
setup_duration - the new setup duration.

orbital_data_table

public String orbital_data_table()
Gets the orbital data table for this observation. For HiRISE observations, this value is always "blank" (the empty string).

A PTF record is for a HiRISE observation if and only if the first character of the instrument_set is "H."

Returns:
the orbital data table.

orbital_data_table

public void orbital_data_table(String orbital_data_table)
                        throws Invalid_Argument_Exception
Sets the orbital data table for this observation. For HiRISE observations, the value of orbital_data_table must always be the empty string or null (in which case the orbital data tabe will be set to the empty string). Attempts to set it to any other value will result in an Invalid_Argument_Exception being thrown.

A PTF record is for a HiRISE observation if and only if the first character of the instrument_set is "H."

Parameters:
orbital_data_table - the new orbital data table.
Throws:
Invalid_Argument_Exception - if the observation is for HiRISE and orbital_data_table is not null or the empty string.

parameters_table

public String parameters_table()
Gets the parameters table for this observation. For HiRISE observations, this value is always "blank" (the empty string).

A PTF record is for a HiRISE observation if and only if the first character of the instrument_set is "H."

Returns:
the parameters table.

parameters_table

public void parameters_table(String parameters_table)
                      throws Invalid_Argument_Exception
Sets the parameters table for this observation. For HiRISE observations, the value of parameters_table must always be the empty string or null (in which case the orbital data tabe will be set to the empty string). Attempts to set it to any other value will result in an Invalid_Argument_Exception being thrown.

A PTF record is for a HiRISE observation if and only if the first character of the instrument_set is "H."

Parameters:
parameters_table - the new parameters table.
Throws:
Invalid_Argument_Exception - if the observation is for HiRISE and parameters_table is not null or the empty string.

sequence_filename

public String sequence_filename(boolean generate_filename)
Gets the sequence filename for this observation's MRO sequence file, optionally generating it from the HiRISE team database ID if applicable.

If generate_filename is true and this PTF record represents a HiRISE observation (i.e., its instrument_set() field starts with H), this method generates the sequence filename based on the value of the team_database_id() field: If the field contains a formal HiRISE observation ID, the sequence filename is derived from it according to the PTF SIS (d:/hir/<OBSERVAITON_ID>.mod, where the observation ID's integer form is used). If it does not contain a formal HiRISE observation ID, Instrument.NOT_APPLICABLE_STRING is returned.

If generate_filename is false or if this PTF record represents another instrument's observation (the instrument set field does not start with H), then the returned filename is the original used in the construction of this PTF record. For HiRISE observations, this value may not be a correct HiRISE MRO sequence filename.

Parameters:
generate_filename - If true, generate a HiRISE MRO sequence filename based on the team database ID (for HiRISE observations only); if false, do not generate a filename.
Returns:
the sequence filename, optionally generated from the team database ID as determined by the generate_filename parameter.

sequence_filename

public String sequence_filename()
Gets the sequence filename for this observation's MRO sequence file.

If this PTF record represents a HiRISE observation (i.e., its instrument_set() field starts with H), this method generates the sequence filename based on the value of the team_database_id() field: If the field contains a formal HiRISE observation ID, the sequence filename is derived from it according to the PTF SIS (d:/hir/<OBSERVAITON_ID>.mod, where the observation ID's integer form is used). If it does not contain a formal HiRISE observation ID, Instrument.NOT_APPLICABLE_STRING is returned.

If this PTF record represents another instrument's observation (the instrument set field does not start with H), then the returned filename is the original used in the construction of this PTF record.

Returns:
the sequence filename, which may be derived (for HiRISE observations).
See Also:
sequence_filename(boolean), sequence_filename(String)

downlink_priority

public String downlink_priority()
Gets the downlink priority for this observation.

Returns:
the downlink priority.

downlink_priority

public void downlink_priority(String downlink_priority)
Sets the downlink priority for this observation.

Parameters:
downlink_priority - the new downlink priority.

product_id

public String product_id()
Gets the product ID for this observation. For HiRISE observations, this value is always "blank" (the empty string).

A PTF record is for a HiRISE observation if and only if the first character of the instrument_set is "H."

The product ID should not be confused with the HiRISE observation ID. The latter is found in the team_database_id field.

Returns:
the product ID.

product_id

public void product_id(String product_id)
                throws Invalid_Argument_Exception
Sets the product ID for this observation. For HiRISE observations, the value of product_id must always be the empty string or null (in which case the product ID will be set to the empty string). Attempts to set it to any other value will result in an Invalid_Argument_Exception being thrown.

A PTF record is for a HiRISE observation if and only if the first character of the instrument_set is "H."

The product ID should not be confused with the HiRISE observation ID. The latter is found in the team_database_id field.

Parameters:
product_id - the new product ID.
Throws:
Invalid_Argument_Exception - if the observation is for HiRISE and product_id is not null or the empty string.

instrument_spare_field_1

public String instrument_spare_field_1()
Gets the instrument spare field 1 for this observation.

Returns:
the instrument spare field 1.

instrument_spare_field_1

public void instrument_spare_field_1(String instrument_spare_field_1)
Sets the instrument spare field 1 for this observation.

Parameters:
instrument_spare_field_1 - the new instrument spare field 1.

instrument_spare_field_1

public void instrument_spare_field_1(Double instrument_spare_field_1)
Sets the instrument spare field 1 for this observation.

Parameters:
instrument_spare_field_1 - the new instrument spare field 1.

instrument_spare_field_2

public String instrument_spare_field_2()
Gets the instrument spare field 2 for this observation.

Returns:
the instrument spare field 2.

instrument_spare_field_2

public void instrument_spare_field_2(String instrument_spare_field_2)
Sets the instrument spare field 2 for this observation.

Parameters:
instrument_spare_field_2 - the new instrument spare field 2.

instrument_spare_field_2

public void instrument_spare_field_2(Double instrument_spare_field_2)
Sets the instrument spare field 2 for this observation.

Parameters:
instrument_spare_field_2 - the new instrument spare field 2.

instrument_spare_field_3

public String instrument_spare_field_3()
Gets the instrument spare field 3 for this observation.

Returns:
the instrument spare field 3.

instrument_spare_field_3

public void instrument_spare_field_3(String instrument_spare_field_3)
Sets the instrument spare field 3 for this observation.

Parameters:
instrument_spare_field_3 - the new instrument spare field 3.

instrument_spare_field_3

public void instrument_spare_field_3(Integer instrument_spare_field_3)
Sets the instrument spare field 3 for this observation.

Parameters:
instrument_spare_field_3 - the new instrument spare field 3.

instrument_spare_field_4

public String instrument_spare_field_4()
Gets the instrument spare field 4 for this observation.

Returns:
the instrument spare field 4.

instrument_spare_field_4

public void instrument_spare_field_4(String instrument_spare_field_4)
Sets the instrument spare field 4 for this observation.

Parameters:
instrument_spare_field_4 - the new instrument spare field 4.

comment

public String comment()
Gets the comment for this observation. The comment will already have been escaped.

Returns:
the comment.

comment

public void comment(String comment)
Sets the comment for this observation. The comment will be escaped as appropriate.

Parameters:
comment - the new comment.

request_priority

public String request_priority()
Gets the request priority for this observation.

Returns:
the request priority.

request_priority

public void request_priority(String request_priority)
Sets the request priority for this observation.

Parameters:
request_priority - the new request priority.

request_priority

public void request_priority(Integer request_priority)
Sets the request priority for this observation.

Parameters:
request_priority - the new request priority.

coordinated_track_history

public String coordinated_track_history()
Gets the coordinated track history for this observation.

Returns:
the status.

coordinated_track_history

public void coordinated_track_history(String coordinated_track_history)
Sets the coordinated track history for this observation.

Parameters:
coordinated_track_history - the new coordinated track history.

raw_data_volume

public String raw_data_volume()
Gets the raw data volume in megabits for this observation.

Returns:
the raw data volume.

raw_data_volume

public void raw_data_volume(String raw_data_volume)
Sets the raw data volume for this observation.

Parameters:
raw_data_volume - the new raw data volume in megabits.

raw_data_volume

public void raw_data_volume(Double raw_data_volume)
Sets the raw data volume for this observation. The text is formatted to three decimal places.

Parameters:
raw_data_volume - the new raw data volume in megabits.

team_database_id

public String team_database_id()
Gets the team database id for this observation.

Returns:
the team database id.

team_database_id

public void team_database_id(String team_database_id)
Sets the team database id for this observation.

Parameters:
team_database_id - the new team database id.

request_category

public String request_category()
Gets the request category for this observation.

Returns:
the request category.

request_category

public void request_category(String request_category)
Sets the request category for this observation.

Parameters:
request_category - the new request category.

compression

public String compression()
Gets the compression for this observation.

Returns:
the compression.

compression

public void compression(String compression)
Sets the compression for this observation.

Parameters:
compression - the new compression.

pixel_scale

public String pixel_scale()
Gets the pixel scale for this observation.

Returns:
the pixel scale.

pixel_scale

public void pixel_scale(String pixel_scale)
Sets the pixel scale for this observation.

Parameters:
pixel_scale - the new pixel scale.

observation_mode

public String observation_mode()
Gets the observation mode for this observation.

Returns:
the observation mode.

observation_mode

public void observation_mode(String observation_mode)
Sets the observation mode for this observation.

Parameters:
observation_mode - the new observation mode.

observation_mode

public void observation_mode(Observation_Record observation_record)
Sets the observation mode for this observation. The mode is derived from the observation record.

Parameters:
observation_record - the observation record.

ancillary_data

public String ancillary_data()
Gets the ancillary data for this observation.

Returns:
the ancillary data.

ancillary_data

public void ancillary_data(String ancillary_data)
Sets the ancillary data for this observation.

Parameters:
ancillary_data - the new ancillary data.

lsubs

public String lsubs()
Gets the lsubs for this observation.

Returns:
the lsubs.

lsubs

public void lsubs(String lsubs)
Sets the lsubs for this observation.

Parameters:
lsubs - the new lsubs.

lsubs

public void lsubs(Double lsubs)
Sets the lsubs for this observation. The text is formatted to one decimal place.

Parameters:
lsubs - the new lsubs.

roll_angle

public String roll_angle()
Gets the roll angle for this observation.

Returns:
the roll angle.

roll_angle

public void roll_angle(String roll_angle)
Sets the roll angle for this observation.

Parameters:
roll_angle - the new roll angle.

roll_angle

public void roll_angle(Double roll_angle)
Sets the roll angle for this observation. The text is formatted to three decimal places.

Parameters:
roll_angle - the new roll angle.

observation_record

public void observation_record(Observation_Record observation_record)
Sets the values for this PTF record to those from the given observation record. This method is HiRISE-centric, so fields that are not used by HiRISE are made empty; these include the orbital data table, parameters table, and product ID fields. Instrument spare fields that HiRISE uses for auxiliary data are set accordingly, and the other spare fields are made empty. Spare fields that are set are field 1, which takes the HiRISE estimated FELICS compression ratio if FELICS compression is enabled, and field 4, which contains relational information.

The sequence filename is not set; it is derived from the HiRISE team database ID (the HiRISE observation ID) when read.

Parameters:
observation_record - the observation record from which PTF record field values will be taken.

parameter

public Parameter parameter()
Gets the PTF record are a PVL parameter. The aggregate parameter's name is the value of the team database ID field or Instrument.UNKNOWN_STRING if the team database ID field is empty.

The value of the sequence filename field is that used in the construction of this PTF record; it is not necessarily the correct HiRISE sequence filename as derived from a formal HiRISE observation ID.

Returns:
a parameter representation of this PTF record.

clone

public Object clone()
Returns a clone of this PTF record.

Overrides:
clone in class Object
Returns:
a clone of this PTF record.

toString

public String toString()
Gets a string representation of this PTF record.

The sequence filename reported by this method is the correctly derived HiRISE filename as generated by the sequence_filename(String) method. It is not necessarily the sequence filename used in the construction of this record, which is not guaranteed to be correct for HiRISE observations.

Overrides:
toString in class Object
Returns:
the string representation.

hashCode

public int hashCode()
Returns a hash code value for this PTF record.

The hash code is based on the sequence filename used in the construction of this record, which is not necessarily the sequence filename derived via the sequence_filename(String) method.

Overrides:
hashCode in class Object
Returns:
a hash code value for this PTF record.

equals

public boolean equals(Object o)
Indicates whether some other object is "equal to" this one. A PTF record is equal to another if and only if the individual fields are the same.

This method compares the sequence filename used in the construction of the PTF record, not the sequence filename derived from the HiRISE team database ID.

Overrides:
equals in class Object
Parameters:
o - the object to which this object is compared.
Returns:
true if the objects are equal; false otherwise.

tokenize

public static List<String> tokenize(String text)
Produces a list of strings from comma-separated value text. Commas may be escaped by being preceded by the '\' character.

Parameters:
text - the comma-separated value text.
Returns:
a list of strings.

sequence_filename

public static String sequence_filename(String observation_id)
Generates an MRO sequence filename for a HiRISE observation command file. If observation_id is not a formal HiRISE observation ID (that is, it cannot be managed by Observation_ID), this method returns Instrument.NOT_APPLICABLE_STRING.

Parameters:
observation_id - the HiRISE observation ID.
Returns:
the generated HiRISE sequence filename or Instrument.NOT_APPLICABLE_STRING.

HiRISE

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