HiRISE

HiRISE.HiPlan.Utilities
Class Constants

java.lang.Object
  extended by HiRISE.HiPlan.Utilities.Constants

public class Constants
extends Object

A collection of constants common to all HiPlan applications.

Version:
1.12
Author:
Christian Schaller - UA/PIRL

Field Summary
static String[] BASE_CONFIGURATION_GROUPS
          The base set of groups (akin to paths) used for holding HiPlan-specific parameters in a configuration file.
static String BUNDLE_FILE_EXTENSION
          The filename extension for an automated sequence processor (ASP) bundle file.
static String[] CCD_NAMES_BY_CCD
          CCD names ordered by CCD number, not by CPMM number.
static String[] CONFIGURATION_FILENAMES
           
static String CONFIGURATION_PROPERTY
          The system property that may hold the configuration filename.
static String DEFAULT_CONFIGURATION_FILENAME
          The default configuration filename for the HiPlan suite of applications.
static String DLINK_FILE_EXTENSION
           
static String ID
          Class identification name with source code version and date.
static String IPTF_FILE_EXTENSION
           
static int[] MAX_IMAGE_LINES_BY_BINNING
          The maximum number of image lines by binning.
static int[] MAX_LUTTED_IMAGE_LINES_BY_BINNING
          The maximum number of image lines by binning when the data are LUT compressed.
static double MAX_TIME
           
static double MIN_TIME
           
static String OLD_DEFAULT_CONFIGURATION_FILENAME
          The historical default configuration filename for the HiPlan suite of applications.
static String PTF_FILE_EXTENSION
           
static String RESOURCES_DIRECTORY
          The name of the directory containing application resources.
static String SASF_FILE_EXTENSION
           
static String SATF_FILE_EXTENSION
           
static String STATE_FILE_EXTENSION
           
static String WRAPPER_NAME_PROPERTY
          The system property whose value is the name of the wrapper that launched the Java application.
 
Method Summary
 
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

CONFIGURATION_PROPERTY

public static final String CONFIGURATION_PROPERTY
The system property that may hold the configuration filename. This property is needed for third-party applications, such as MTT, to pass the name of a configuration file to the HOGG (or some other application that uses the Configuration file).

See Also:
Constant Field Values

DEFAULT_CONFIGURATION_FILENAME

public static final String DEFAULT_CONFIGURATION_FILENAME
The default configuration filename for the HiPlan suite of applications.

See Also:
Configuration, Constant Field Values

OLD_DEFAULT_CONFIGURATION_FILENAME

public static final String OLD_DEFAULT_CONFIGURATION_FILENAME
The historical default configuration filename for the HiPlan suite of applications. Early development of HiPlan used HOGG.conf as the default filename.

See Also:
Configuration, Constant Field Values

CONFIGURATION_FILENAMES

public static final String[] CONFIGURATION_FILENAMES

BASE_CONFIGURATION_GROUPS

public static final String[] BASE_CONFIGURATION_GROUPS
The base set of groups (akin to paths) used for holding HiPlan-specific parameters in a configuration file. These groups are HiPlan, HOGG, the configuration file root, and anywhere, in that order.

See Also:
Configuration_Helper, Configuration

RESOURCES_DIRECTORY

public static final String RESOURCES_DIRECTORY
The name of the directory containing application resources. This directory is expected to be found at the same location as a representative compiled class file.

For example, in the case of the HOGG, this directory is expected to be at the path defined by HiRISE.HiPlan.HOGG.HOGG.

See Also:
Constant Field Values

WRAPPER_NAME_PROPERTY

public static final String WRAPPER_NAME_PROPERTY
The system property whose value is the name of the wrapper that launched the Java application.

See Also:
Constant Field Values

CCD_NAMES_BY_CCD

public static final String[] CCD_NAMES_BY_CCD
CCD names ordered by CCD number, not by CPMM number. This ordering is the common-use ordering of the HiRISE CCDs.


MIN_TIME

public static final double MIN_TIME
See Also:
Constant Field Values

MAX_TIME

public static final double MAX_TIME
See Also:
Constant Field Values

MAX_IMAGE_LINES_BY_BINNING

public static final int[] MAX_IMAGE_LINES_BY_BINNING
The maximum number of image lines by binning. These values are indexed in the same manner as the Instrument.BINNING_FACTORS integer array.

See Also:
MAX_LUTTED_IMAGE_LINES_BY_BINNING

MAX_LUTTED_IMAGE_LINES_BY_BINNING

public static final int[] MAX_LUTTED_IMAGE_LINES_BY_BINNING
The maximum number of image lines by binning when the data are LUT compressed. These values are indexed in the same manner as the Instrument.BINNING_FACTORS integer array.

See Also:
MAX_IMAGE_LINES_BY_BINNING

STATE_FILE_EXTENSION

public static final String STATE_FILE_EXTENSION
See Also:
Constant Field Values

DLINK_FILE_EXTENSION

public static final String DLINK_FILE_EXTENSION
See Also:
Constant Field Values

PTF_FILE_EXTENSION

public static final String PTF_FILE_EXTENSION
See Also:
Constant Field Values

IPTF_FILE_EXTENSION

public static final String IPTF_FILE_EXTENSION
See Also:
Constant Field Values

SATF_FILE_EXTENSION

public static final String SATF_FILE_EXTENSION
See Also:
Constant Field Values

SASF_FILE_EXTENSION

public static final String SASF_FILE_EXTENSION
See Also:
Constant Field Values

BUNDLE_FILE_EXTENSION

public static final String BUNDLE_FILE_EXTENSION
The filename extension for an automated sequence processor (ASP) bundle file. This extension is specified in section 4.1 of the Automated Sequence Software (ASP) Bundle File Software Interface Specification, JPL document MRO SEQ044.

See Also:
"Automated Sequence Software (ASP) Bundle File Software Interface Specification, JPL MRO SEQ044", Constant Field Values

HiRISE

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