org.roverguild.pdsutil
Class PDSFilenameTranslator

java.lang.Object
  |
  +--org.roverguild.pdsutil.PDSFilenameTranslator

public class PDSFilenameTranslator

extends java.lang.Object

The PDSFilenameTranslator class provides a set of utility methods, which permit metadata contained within the NASA PDS filename format to be extracted, and translated into useful, human readable strings, per the guide located on page 13 of the document at: http://pds-imaging.jpl.nasa.gov/Atlas/MER/documents/pancam_ug.pdf

Usage example:

PDSFilenameTranslator example = new PDSFilenameTranslator("2F127262938EFF0218P1003R0M1");
// Get the Spacecraft Identifier field name and translated value
String scidFieldName = example.getSCIDName();
String scidValue = example.getSCIDTranslation();
// Print out the information
System.out.println(scidFieldName + ": " + scidValue);


Version:

0.1 / 2004-08-15

Author:

Rupert Scammell
Project site: PDS Utilities Project Site

Constructor Summary

PDSFilenameTranslator(java.lang.String pdsFN)
Constructor specifying PDS filename.

Method Summary

java.lang.String	getEXTName() Getter method for PDS product type field name (ext)
java.lang.String	getEXTRaw() Getter method for PDS product type raw value (ext)
java.lang.String	getEXTTranslation() Getter method for PDS product type extension (ext)
java.lang.String	getEYEName() Getter method for Camera Eye field name (eye)
java.lang.String	getEYERaw() Getter method for Camera Eye raw value (eye)
java.lang.String	getEYETranslation() Getter method for Camera Eye translated value (eye)
java.lang.String	getFILTName() Getter method for Spectral filter position field name (filt)
java.lang.String	getFILTRaw() Getter method for Spectral filter position raw value (filt)
java.lang.String	getFILTTranslation() Getter method for Spectral filter position translated value (filt)
java.lang.String	getINSTName() Getter method for MER science instrument Identifier field name (inst)
java.lang.String	getINSTRaw() Getter method for MER Science Instrument Identifier raw value (inst)
java.lang.String	getINSTTranslation() Getter method for MER science instrument ident translated value (inst)
java.lang.String	getPOSName() Getter method for Site location count field name (site)
java.lang.String	getPOSRaw() Getter method for Position-within-Site count raw value (pos)
java.lang.String	getPOSTranslation() Getter method for Position-within-Site count translated value (pos)
java.lang.String	getPRODName() Getter method for Product Type identifier field name (prod)
java.lang.String	getPRODRaw() Getter method for Product Type identifier raw value (prod)
java.lang.String	getPRODTranslation() Getter method for Product Type identifier translated value (prod)
java.lang.String	getSCIDName() Getter method for Spacecraft Identifier field name (scid)
java.lang.String	getSCIDRaw() Getter method for Spacecraft Identifier raw value (scid)
java.lang.String	getSCIDTranslation() Getter method for Spacecraft Identifier translated value (scid)
java.lang.String	getSCLKName() Getter method for Starting Spacecraft Clock Time field name (sclk)
java.lang.String	getSCLKRaw() Getter method for Starting Spacecraft Clock Time raw value (sclk)
java.lang.String	getSCLKTranslation() Getter method for Starting Spacecraft Clock Time translated value (sclk)
java.lang.String	getSeqOpName() Getter method for Sequence Operation field name (seqOp)
java.lang.String	getSeqOpRaw() Getter method for Sequence Operation raw value (seqOp)
java.lang.String	getSeqOpTranslation() Getter method for Sequence Operation translated value (seqOp)
java.lang.String	getSeqTypeName() Getter method for Sequence Type field name (seqType)
java.lang.String	getSeqTypeRaw() Getter method for Sequence Type raw value (seqType)
java.lang.String	getSeqTypeTranslation() Getter method for Sequence Type translated value (seqType)
java.lang.String	getSITEName() Getter method for Site location count field name (site)
java.lang.String	getSITERaw() Getter method for Site location count raw value (site)
java.lang.String	getSITETranslation() Getter method for Site location count translated value (site)
java.lang.String	getVERName() Getter method for Version identifier field name (ver)
java.lang.String	getVERRaw() Getter method for Version identifier raw value (ver)
java.lang.String	getVERTranslation() Getter method for Version identifier translated value (ver)
java.lang.String	getWHOName() Getter method for Product Creator indicator field name (who)
java.lang.String	getWHORaw() Getter method for Product Creator indicator raw value (who)
java.lang.String	getWHOTranslation() Getter method for Product Creator indicator (who)
void	translate(java.lang.String filenameString) Populate the PDSData hashtable with human readable strings derived from the provided PDS filename string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PDSFilenameTranslator

public PDSFilenameTranslator(java.lang.String pdsFN)

Constructor specifying PDS filename.

Parameters:

pdsFN - PDS filename string.

Method Detail

translate

public void translate(java.lang.String filenameString)

Populate the PDSData hashtable with human readable strings derived from the provided PDS filename string.

Parameters:

filenameString - PDS filename to translate.

getSCIDTranslation

public java.lang.String getSCIDTranslation()

Getter method for Spacecraft Identifier translated value (scid)

Returns:

a String containing the translated value of the Spacecraft identifier.

getSCIDRaw

public java.lang.String getSCIDRaw()

Getter method for Spacecraft Identifier raw value (scid)

Returns:

a String containing the raw value of the Spacecraft ident.

getSCIDName

public java.lang.String getSCIDName()

Getter method for Spacecraft Identifier field name (scid)

Returns:

a String containing the field name for the Spacecraft Identifier

getINSTTranslation

public java.lang.String getINSTTranslation()

Getter method for MER science instrument ident translated value (inst)

Returns:

a String containing the translated value of the MER science instrument identifier

getINSTRaw

public java.lang.String getINSTRaw()

Getter method for MER Science Instrument Identifier raw value (inst)

Returns:

a String containing the raw value of the MER science instrument identifier

getINSTName

public java.lang.String getINSTName()

Getter method for MER science instrument Identifier field name (inst)

Returns:

a String containing the field name for the MER science instrument identifier

getSCLKTranslation

public java.lang.String getSCLKTranslation()

Getter method for Starting Spacecraft Clock Time translated value (sclk)

Returns:

a String containing the translated value of the Starting Spacecraft Clock Time

getSCLKRaw

public java.lang.String getSCLKRaw()

Getter method for Starting Spacecraft Clock Time raw value (sclk)

Returns:

a String containing the raw value of the Starting Spacecraft Clock Time

getSCLKName

public java.lang.String getSCLKName()

Getter method for Starting Spacecraft Clock Time field name (sclk)

Returns:

a String containing the field name for the Starting Spacecraft Clock Time

getPRODTranslation

public java.lang.String getPRODTranslation()

Getter method for Product Type identifier translated value (prod)

Returns:

a String containing the translated value of the Product Type identifier

getPRODRaw

public java.lang.String getPRODRaw()

Getter method for Product Type identifier raw value (prod)

Returns:

a String containing the raw value of the Product Type identifier

getPRODName

public java.lang.String getPRODName()

Getter method for Product Type identifier field name (prod)

Returns:

a String containing the field name for the Product Type identifier

getSITETranslation

public java.lang.String getSITETranslation()

Getter method for Site location count translated value (site)

Returns:

a String containing the translated value of the Site location count, which indicates the rover's location.

getSITERaw

public java.lang.String getSITERaw()

Getter method for Site location count raw value (site)

Returns:

a String containing the raw value of the Site location count, which indicates the rover's location.

getSITEName

public java.lang.String getSITEName()

Getter method for Site location count field name (site)

Returns:

a String containing the field name for the Site location count.

getPOSTranslation

public java.lang.String getPOSTranslation()

Getter method for Position-within-Site count translated value (pos)

Returns:

a String containing the translated value of the Position-within-site count, which indicates the rover's position within a particular site.

getPOSRaw

public java.lang.String getPOSRaw()

Getter method for Position-within-Site count raw value (pos)

Returns:

a String containing the raw value of the Position-within-Site count, which indicates the rover's position within a particular site.

getPOSName

public java.lang.String getPOSName()

Getter method for Site location count field name (site)

Returns:

a String containing the field name for the Position-within-Site count.

getSeqTypeTranslation

public java.lang.String getSeqTypeTranslation()

Getter method for Sequence Type translated value (seqType)

Returns:

a String containing the translated value of the Sequence Type, which describes the type of command sequence which was executed.

getSeqTypeRaw

public java.lang.String getSeqTypeRaw()

Getter method for Sequence Type raw value (seqType)

Returns:

a String containing the raw value of the Sequence Type, which indicates the type of command sequence which was executed.

getSeqTypeName

public java.lang.String getSeqTypeName()

Getter method for Sequence Type field name (seqType)

Returns:

a String containing the field name for the Sequence Type.

getSeqOpTranslation

public java.lang.String getSeqOpTranslation()

Getter method for Sequence Operation translated value (seqOp)

Returns:

a String containing the translated value of the Sequence Operation, which describes the MER science instrument used to obtain data within this PDS file.

getSeqOpRaw

public java.lang.String getSeqOpRaw()

Getter method for Sequence Operation raw value (seqOp)

Returns:

a String containing the raw value of the Sequence Operation, which describes the MER science instrument used to obtain data within this PDS file.

getSeqOpName

public java.lang.String getSeqOpName()

Getter method for Sequence Operation field name (seqOp)

Returns:

a String containing the field name for the Sequence Operation.

getEYETranslation

public java.lang.String getEYETranslation()

Getter method for Camera Eye translated value (eye)

Returns:

a String containing the translated value of the Camera Eye, which specifies whether the left or right camera was used to obtain the data within the PDS file (or whether the camera is monoscopic, like the MI)

getEYERaw

public java.lang.String getEYERaw()

Getter method for Camera Eye raw value (eye)

Returns:

a String containing the raw value of the Camera Eye, which specifies whether the left or right camera was used to obtain the data within the PDS file (or whether the camera is monoscopic, like the MI)

getEYEName

public java.lang.String getEYEName()

Getter method for Camera Eye field name (eye)

Returns:

a String containing the field name for the Camera Eye.

getFILTTranslation

public java.lang.String getFILTTranslation()

Getter method for Spectral filter position translated value (filt)

Returns:

a String containing the translated value of the Spectral filter position, which describes the filter on the MER PanCam used to obtain the data within this PDS file, if it's a PanCam image, or in cases where the file contains data from the Microscopic Imager, whether the MI window was open or closed. In cases where the PDS data within the file is not from either the PanCam or the MI, this function will return "No Filter - N/A".

getFILTRaw

public java.lang.String getFILTRaw()

Getter method for Spectral filter position raw value (filt)

Returns:

a String containing the raw value of the Spectral filter position, which describes the filter on the MER PanCam used to obtain the data within this PDS file, if it's a PanCam image, or in cases where the file contains data from the Microscopic Imager, whether the MI window was open or closed. In cases where the PDS data within the file is not from either the PanCam or the MI, this function will return a filter value of 0.

getFILTName

public java.lang.String getFILTName()

Getter method for Spectral filter position field name (filt)

Returns:

a String containing the field name for the Spectral filter position.

getWHOTranslation

public java.lang.String getWHOTranslation()

Getter method for Product Creator indicator (who)

Returns:

a String containing the translated value of the Product Creator indicator, which describes the creator of this PDS product.

getWHORaw

public java.lang.String getWHORaw()

Getter method for Product Creator indicator raw value (who)

Returns:

a String containing the raw value of the Product Creator indicator, which describes the creator of this PDS product.

getWHOName

public java.lang.String getWHOName()

Getter method for Product Creator indicator field name (who)

Returns:

a String containing the field name for the Product Creator indicator.

getVERTranslation

public java.lang.String getVERTranslation()

Getter method for Version identifier translated value (ver)

Returns:

a String containing the translated value of the Version identifier, which describes the version of this PDS product. For now, the raw and translated versions of the Version identifier are the same, but this method is here for the sake of completeness.

getVERRaw

public java.lang.String getVERRaw()

Getter method for Version identifier raw value (ver)

Returns:

a String containing the raw value of the Version identifier, which describes the version of this PDS product.

getVERName

public java.lang.String getVERName()

Getter method for Version identifier field name (ver)

Returns:

a String containing the field name for the Version identifier.

getEXTTranslation

public java.lang.String getEXTTranslation()

Getter method for PDS product type extension (ext)

Returns:

a String containing the translated value of the PDS product type extension, describing the type of data product contained within the file.

getEXTRaw

public java.lang.String getEXTRaw()

Getter method for PDS product type raw value (ext)

Returns:

a String containing the raw value of the PDS product type, describing the type of data product contained within the file.

getEXTName

public java.lang.String getEXTName()

Getter method for PDS product type field name (ext)

Returns:

a String containing the field name for the PDS product type.