public class Transfer_File_Parameters
extends java.lang.Object
Parameter
s required to be in a
HIPHOP transfer file. An input transfer file is created by HiPlan for use by
HIPHOP; and output transfer file is created by HIPHOP for use by HiPlan.
Both sets of parameters are included in this utility class, as are methods
to verify that a transfer file is of the correct form.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
BG_CCD_GROUP
Deprecated.
As of 1.3, replaced by
BG12_CCD_GROUP and BG13_CCD_GROUP . |
static java.lang.String |
BG_IF
The name of the
Parameter that holds the value of the I/F ratio for
the blue-green CCDs. |
static java.lang.String |
BG_IF_WITH_ATMOS
The name of the
Parameter that holds the value of the I/F ratio for
the blue-green CCDs with atmospheric effects. |
static java.lang.String |
BG12_CCD_GROUP
The name of the aggregate
Parameter containing the data for the
BG12 CCD. |
static java.lang.String |
BG13_CCD_GROUP
The name of the aggregate
Parameter containing the data for the
BG13 CCD. |
static java.lang.String |
BIG_P
The name of the
Parameter that holds the value for "big P" used in
modeling the photometry of the observation. |
static java.lang.String |
BIN
The name of the
Parameter that holds the binning value for the
detector used to model the photometry of the observation. |
static java.lang.String |
CBOE_AMPLITUDE
The name of the
Parameter that holds the value for the "CBOE
amplitude" used in modeling the photometry of the observation. |
static java.lang.String |
CHANNEL
The name of the
Parameter that holds the channel number for the
detector used to model the photometry of the observation. |
static java.lang.String |
CONTRAST_RATIO
The name of the
Parameter that holds the contrast ratio used in
modeling the photometry of the observation. |
static java.lang.String |
DCA
The name of the
Parameter that holds DCA ("CCD") number for the
detector used to model the photometry of the observation. |
static java.lang.String |
DN_FROST
The name of the
Parameter tha tholds the predicted peak frost 14-bit
DN value for the detector used to model the photometry of the observation. |
static java.lang.String |
DN_SURFACE
The name of the
Parameter that holds the predicted peak surface
14-bit DN value for the detector used to model the photometry of the
observation. |
static java.lang.String |
ELECTRON_FROST
The name of the
Parameter that holds the predicted peak frost signal
value for the detector used to model the photometry of the observation. |
static java.lang.String |
ELECTRON_SURFACE
The name of the
Parameter that holds the predicted peak surface
signal value for the detector used to model the photometry of the
observation. |
static java.lang.String |
EMISSION_ANGLE
The name of the
Parameter that holds the emission angle for the
observation. |
static java.lang.String |
FROST_PERCENTAGE
The name of the
Parameter that holds the frost percentage used in
modeling the photometry of the observation. |
static java.lang.String |
GAIN
The name of the
Parameter that holds the inverse gain for the
detector used to model the photometry of the observation. |
static java.lang.String |
GENERIC_GROUP
The name of the aggregate
Parameter containing so-called "generic"
member parameters. |
static java.lang.String |
H_G_ASYMMETRY
The name of the
Parameter that holds the value for the "H-G
asymmetry" used in modeling the photometry of the observation. |
static java.lang.String |
H_G_WEIGHTING
The name of the
Parameter that holds the value for the "H-G
weighting" used in modeling the photometry of the observation. |
static java.lang.String |
HAPKE_GROUP
The name of the aggregate
Parameter containing Hapke-related
parameters. |
static java.lang.String |
HELIOCENTRIC_DISTANCE
The name of the
Parameter that holds the distance between Mars and
the Sun. |
static java.lang.String |
HIST
The name of the
Parameter that holds the histogram data for the
detector used to model the photometry of the observation. |
static java.lang.String |
HS_PARAMETER
The name of the
Parameter that holds the value for the "HS"
parameter used in modeling the photometry of the observation. |
static java.lang.String |
ID
Class identification name with source code version and date.
|
static java.lang.String |
INCIDENCE_ANGLE
The name of the
Parameter that holds the incidence angle for the
observation. |
static java.lang.String |
INPUT_GROUP |
static java.lang.String |
IR_CCD_GROUP
The name of the aggregate
Parameter containing the data for the
near-infrared CCDs. |
static java.lang.String |
L_SUB_S |
static java.lang.String |
LINE_TIME
The name of the
Parameter that holds the line time used in the
observation. |
static java.lang.String |
MACROSCOPIC_ROUGHNESS
The name of the
Parameter that holds the value for macroscopic
roughness used in modeling the photometry of the observation. |
static java.lang.String |
MEAN_COS_SCATTERING_ANGLE
The name of the
Parameter that holds the value of the cosine of the
mean scattering angle. |
static java.lang.String |
MINIMUM_VALUE_IN_HISTOGRAM
The name of the
Parameter that holds the lowest 14-bit DN value in
the HIST histogram data for the detector used to model the
photometry of the observation. |
static java.lang.String |
NIR_IF
The name of the
Parameter that holds the value of the I/F ratio for
the near-infrared CCDs. |
static java.lang.String |
NIR_IF_WITH_ATMOS
The name of the
Parameter that holds the value of the I/F ratio for
the near-infrared CCDs with atmospheric effects. |
static java.lang.String |
NUMBER_OF_HISTOGRAM_PIXELS
The name of the
Parameter that holds the number of pixels in the
HIST histogram data for the detector used to model the photometry
of the observation. |
static java.lang.String |
NUMBER_OF_HISTOGRAM_VALUES
The name of the
Parameter that holds the number of values in the
HIST histogram data for the detector used to model the photometry
of the observation. |
static java.lang.String |
OBSERVATION_ID |
static java.lang.String |
OFFSET
The name of the
Parameter that holds the offset value for the
detector used to model the photometry of the observation. |
static java.lang.String |
OPPOSITION_EFFECT
The name of the
Parameter that holds the value for the "opposition
effect" used in modeling the photometry of the observation. |
static java.lang.String |
OPTICAL_DEPTH
The name of the
Parameter that holds the optical depth used in
modeling the photometry of the observation. |
static java.lang.String |
PARTICLE_CROSS_SECTIONAL_AREA
The name of the
Parameter that holds the value of the particle
scattering cross sectional area. |
static java.lang.String |
PARTICLE_NUMBER_DENSITY
The name of the
Parameter that holds the value of the particle
number density. |
static java.lang.String |
PARTICLE_SCATTERING_EFFICIENCY
The name of the
Parameter that holds the value of the particle
scattering efficiency. |
static java.lang.String |
PHASE_ANGLE
The name of the
Parameter that holds the phase angle for the
observation. |
static java.lang.String |
RED_CCD_GROUP
Deprecated.
As of 1.3, replaced by
REDL_CCD_GROUP and REDH_CCD_GROUP . |
static java.lang.String |
RED_IF
The name of the
Parameter that holds the value of the I/F ratio for
the red CCDs. |
static java.lang.String |
RED_IF_WITH_ATMOS
The name of the
Parameter that holds the value of the I/F ratio for
the red CCDs with atmospheric effects. |
static java.lang.String |
REDH_CCD_GROUP
The name of the aggregate
Parameter containing the data for the
high-bin red CCDs. |
static java.lang.String |
REDL_CCD_GROUP
The name of the aggregate
Parameter containing the data for the
low-bin red CCDs. |
static java.lang.String |
ROUGHNESS
The name of the
Parameter that holds the surface roughness used in
modeling the photometry of the observation. |
static java.lang.String |
SATURATION
The name of the
Parameter that holds the predicted saturation
percent for the detector used to model the photometry of the observation. |
static java.lang.String |
SCATTERING_AEROSOL_TYPE
The name of the
Parameter that holds the type of aerosol scattering
used in modeling the photometry of the observation. |
static java.lang.String |
SCATTERING_FUNCTION
The name of the
Parameter that holds the value for the scattering
function used in modeling the photometry of the observation. |
static java.lang.String |
SHOE_AMPLITUDE
The name of the
Parameter that holds the value for the "SHOE
amplitude" used in modeling the photometry of the observation. |
static java.lang.String |
SINGLE_SCATTERING_ALBEDO
The name of the
Parameter that holds the single-scattering albedo
value used in modeling the photometry of the observation. |
static java.lang.String |
SLOPE
The name of the
Parameter that holds the value for slope used in
modeling the photometry of the observation. |
static java.lang.String |
SNR_FROST
The name of the
Parameter that holds the predicted frost SNR for the
detector used to model the photometry of the observation. |
static java.lang.String |
SNR_SURFACE
The name of the
Parameter that holds the predicted surface SNR for
the detector used to model the photometry of the observation. |
static java.lang.String |
SURFACE_REFLECTANCE_SLIDER
The name of the
Parameter that holds the surface reflectance slider
setting used in modeling the photometry of the observation. |
static java.lang.String |
TDI
The name of the
Parameter that holds the TDI value for the detector
used to model the photometry of the observation. |
static java.lang.String |
WAVELENGTH
The name of the
Parameter that holds the value for the wavelength
used in modeling the photometry of the observation. |
Modifier and Type | Method and Description |
---|---|
static java.util.Vector |
output_ccd_parameters()
Gets the vector of names of the
Parameter s required to be in the CCD
groups in a HIPHOP output transfer file. |
static java.util.Vector |
output_generic_parameters()
Gets the vector of names of the
Parameter s required to be in the
so-called "generic" group in a HIPHOP output transfer file. |
static java.util.Vector |
output_groups()
Gets the vector of names of the aggregate
Parameter s required to be
in a HIPHOP output transfer file. |
static java.util.Vector |
output_hapke_parameters()
Gets the vector of names of the
Parameter s required to be in the
Hapke group in a HIPHOP output transfer file. |
static boolean |
verify_input_parameters(PIRL.PVL.Parameter input)
Verifies that the required data in a HIPHOP input transfer file are present.
|
static boolean |
verify_output_parameters(PIRL.PVL.Parameter output)
Verifies that the required data in a HIPHOP output transfer file are
present.
|
public static final java.lang.String ID
public static final java.lang.String INPUT_GROUP
public static final java.lang.String OBSERVATION_ID
public static final java.lang.String L_SUB_S
public static final java.lang.String GENERIC_GROUP
Parameter
containing so-called "generic"
member parameters. These parameters define the overall settings used to
generate the data. This parameter forms part of the output transfer file.public static final java.lang.String HAPKE_GROUP
Parameter
containing Hapke-related
parameters. This parameter forms part of the output transfer file.public static final java.lang.String BG12_CCD_GROUP
Parameter
containing the data for the
BG12 CCD. BG12 and BG13 must be handled separately due to electronic
problems with BG13. This parameter forms part of the output transfer file.public static final java.lang.String BG13_CCD_GROUP
Parameter
containing the data for the
BG13 CCD. BG12 and BG13 must be handled separately due to electronic
problems with BG13. This parameter forms part of the output transfer file.public static final java.lang.String BG_CCD_GROUP
BG12_CCD_GROUP
and BG13_CCD_GROUP
.Parameter
containing the data for the
blue-green CCDs. This parmeter forms part of the output transfer file.public static final java.lang.String REDL_CCD_GROUP
Parameter
containing the data for the
low-bin red CCDs. HIPHOP allows the operator to work with two classes of
red CCDs: low-bin and high-bin; it is expected that the camera will not be
configured with more than two different red binnings for a given
observation.public static final java.lang.String REDH_CCD_GROUP
Parameter
containing the data for the
high-bin red CCDs. HIPHOP allows the operator to work with two classes of
red CCDs: low-bin and high-bin; it is expected that the camera will not be
configured with more than two different red binnings for a given
observation.public static final java.lang.String RED_CCD_GROUP
REDL_CCD_GROUP
and REDH_CCD_GROUP
.Parameter
containing the data for the
red CCDs. This parameter forms part of the ouput transfer file.public static final java.lang.String IR_CCD_GROUP
Parameter
containing the data for the
near-infrared CCDs. This parameter forms part of the output transfer file.public static final java.lang.String HELIOCENTRIC_DISTANCE
Parameter
that holds the distance between Mars and
the Sun. This parameter is part of the GENERIC_GROUP
aggregate.public static final java.lang.String LINE_TIME
Parameter
that holds the line time used in the
observation. This parameter is part of the GENERIC_GROUP
aggregate.public static final java.lang.String EMISSION_ANGLE
Parameter
that holds the emission angle for the
observation. This parameter is part of the GENERIC_GROUP
aggregate.public static final java.lang.String INCIDENCE_ANGLE
Parameter
that holds the incidence angle for the
observation. This parameter is part of the GENERIC_GROUP
aggregate.public static final java.lang.String PHASE_ANGLE
Parameter
that holds the phase angle for the
observation. This parameter is part of the GENERIC_GROUP
aggregate.public static final java.lang.String SURFACE_REFLECTANCE_SLIDER
Parameter
that holds the surface reflectance slider
setting used in modeling the photometry of the observation. This parameter
is part of the GENERIC_GROUP
aggregate.public static final java.lang.String ROUGHNESS
Parameter
that holds the surface roughness used in
modeling the photometry of the observation. This parameter is part of the
GENERIC_GROUP
aggregate.public static final java.lang.String CONTRAST_RATIO
Parameter
that holds the contrast ratio used in
modeling the photometry of the observation. This parameter is part of the
GENERIC_GROUP
aggregate.public static final java.lang.String FROST_PERCENTAGE
Parameter
that holds the frost percentage used in
modeling the photometry of the observation. This parameter is part of the
GENERIC_GROUP
aggregate.public static final java.lang.String OPTICAL_DEPTH
Parameter
that holds the optical depth used in
modeling the photometry of the observation. This parameter is part of the
GENERIC_GROUP
aggregate.public static final java.lang.String SCATTERING_AEROSOL_TYPE
Parameter
that holds the type of aerosol scattering
used in modeling the photometry of the observation. This parameter is part
of the GENERIC_GROUP
aggregate.public static final java.lang.String SINGLE_SCATTERING_ALBEDO
Parameter
that holds the single-scattering albedo
value used in modeling the photometry of the observation. This parameter is
part of the HAPKE_GROUP
aggregate.public static final java.lang.String MACROSCOPIC_ROUGHNESS
Parameter
that holds the value for macroscopic
roughness used in modeling the photometry of the observation. This parameter
is part of the HAPKE_GROUP
aggregate.public static final java.lang.String SLOPE
Parameter
that holds the value for slope used in
modeling the photometry of the observation. This parameter is part of the
HAPKE_GROUP
aggregate.public static final java.lang.String BIG_P
Parameter
that holds the value for "big P" used in
modeling the photometry of the observation. This parameter is part of the
HAPKE_GROUP
aggregate.public static final java.lang.String SCATTERING_FUNCTION
Parameter
that holds the value for the scattering
function used in modeling the photometry of the observation. This parameter
is part of the HAPKE_GROUP
aggregate.public static final java.lang.String H_G_ASYMMETRY
Parameter
that holds the value for the "H-G
asymmetry" used in modeling the photometry of the observation. This
parameter is part of the HAPKE_GROUP
aggregate.public static final java.lang.String H_G_WEIGHTING
Parameter
that holds the value for the "H-G
weighting" used in modeling the photometry of the observation. This
parameter is part of the HAPKE_GROUP
aggregate.public static final java.lang.String OPPOSITION_EFFECT
Parameter
that holds the value for the "opposition
effect" used in modeling the photometry of the observation. This
parameter is part of the HAPKE_GROUP
aggregate.public static final java.lang.String WAVELENGTH
Parameter
that holds the value for the wavelength
used in modeling the photometry of the observation. This parameter is part
of the HAPKE_GROUP
aggregate.public static final java.lang.String CBOE_AMPLITUDE
Parameter
that holds the value for the "CBOE
amplitude" used in modeling the photometry of the observation. This
parameter is part of the HAPKE_GROUP
aggregate.public static final java.lang.String SHOE_AMPLITUDE
Parameter
that holds the value for the "SHOE
amplitude" used in modeling the photometry of the observation. This
parameter is part of the HAPKE_GROUP
aggregate.public static final java.lang.String HS_PARAMETER
Parameter
that holds the value for the "HS"
parameter used in modeling the photometry of the observation. This parameter
is part of the HAPKE_GROUP
aggregate.public static final java.lang.String PARTICLE_CROSS_SECTIONAL_AREA
Parameter
that holds the value of the particle
scattering cross sectional area. This parameter is part of the HAPKE_GROUP
aggregate.public static final java.lang.String PARTICLE_SCATTERING_EFFICIENCY
Parameter
that holds the value of the particle
scattering efficiency. This parameter is part of the HAPKE_GROUP
aggregate.public static final java.lang.String MEAN_COS_SCATTERING_ANGLE
Parameter
that holds the value of the cosine of the
mean scattering angle. This parameter is part of the HAPKE_GROUP
aggregate.public static final java.lang.String PARTICLE_NUMBER_DENSITY
Parameter
that holds the value of the particle
number density. This parameter is part of the HAPKE_GROUP
aggregate.public static final java.lang.String BG_IF
Parameter
that holds the value of the I/F ratio for
the blue-green CCDs. This parameter is part of the HAPKE_GROUP
aggregate. Currently not checked.public static final java.lang.String RED_IF
Parameter
that holds the value of the I/F ratio for
the red CCDs. This parameter is part of the HAPKE_GROUP
aggregate.
Currently not checked.public static final java.lang.String NIR_IF
Parameter
that holds the value of the I/F ratio for
the near-infrared CCDs. This parameter is part of the HAPKE_GROUP
aggregate. Currently not checked.public static final java.lang.String BG_IF_WITH_ATMOS
Parameter
that holds the value of the I/F ratio for
the blue-green CCDs with atmospheric effects. This parameter is part of the
HAPKE_GROUP
aggregate. Currently not checked.public static final java.lang.String RED_IF_WITH_ATMOS
Parameter
that holds the value of the I/F ratio for
the red CCDs with atmospheric effects. This parameter is part of the HAPKE_GROUP
aggregate. Currently not checked.public static final java.lang.String NIR_IF_WITH_ATMOS
Parameter
that holds the value of the I/F ratio for
the near-infrared CCDs with atmospheric effects. This parameter is part of
the HAPKE_GROUP
aggregate. Currently not checked.public static final java.lang.String DCA
Parameter
that holds DCA ("CCD") number for the
detector used to model the photometry of the observation. This parameter is
part of the output CCD aggregates. Note that the CCD number is not the same
as the CPMM number; in general, HiRISE ground data system software refers
to the latter, not the former, but this is an exception to that rule.public static final java.lang.String CHANNEL
Parameter
that holds the channel number for the
detector used to model the photometry of the observation. This parameter is
part of the output CCD aggregates.public static final java.lang.String GAIN
Parameter
that holds the inverse gain for the
detector used to model the photometry of the observation. This parameter is
part of the output CCD aggregates.public static final java.lang.String OFFSET
Parameter
that holds the offset value for the
detector used to model the photometry of the observation. This parameter is
part of the output CCD aggregates.public static final java.lang.String BIN
Parameter
that holds the binning value for the
detector used to model the photometry of the observation. This parameter is
part of the output CCD aggregates. This parameter is one of the results of
the modeling.public static final java.lang.String TDI
Parameter
that holds the TDI value for the detector
used to model the photometry of the observation. This parameter is part of
the output CCD aggregates. This parameter is one of the results of the
modeling.public static final java.lang.String SNR_SURFACE
Parameter
that holds the predicted surface SNR for
the detector used to model the photometry of the observation. This parameter
is part of the output CCD aggregates.public static final java.lang.String SNR_FROST
Parameter
that holds the predicted frost SNR for the
detector used to model the photometry of the observation. This parameter is
part of the output CCD aggregates.public static final java.lang.String DN_SURFACE
Parameter
that holds the predicted peak surface
14-bit DN value for the detector used to model the photometry of the
observation. This parameter is part of the output CCD aggregates.public static final java.lang.String DN_FROST
Parameter
tha tholds the predicted peak frost 14-bit
DN value for the detector used to model the photometry of the observation.
This parameter is part of the output CCD aggregates.public static final java.lang.String ELECTRON_SURFACE
Parameter
that holds the predicted peak surface
signal value for the detector used to model the photometry of the
observation. This parameter is part of the output CCD aggregates.public static final java.lang.String ELECTRON_FROST
Parameter
that holds the predicted peak frost signal
value for the detector used to model the photometry of the observation. This
parameter is part of the output CCD aggregates.public static final java.lang.String SATURATION
Parameter
that holds the predicted saturation
percent for the detector used to model the photometry of the observation.
This parameter is part of the output CCD aggregates.public static final java.lang.String NUMBER_OF_HISTOGRAM_VALUES
Parameter
that holds the number of values in the
HIST
histogram data for the detector used to model the photometry
of the observation. This parameter is part of the output CCD aggregates.public static final java.lang.String MINIMUM_VALUE_IN_HISTOGRAM
Parameter
that holds the lowest 14-bit DN value in
the HIST
histogram data for the detector used to model the
photometry of the observation. This parameter is part of the output CCD
aggregates.public static final java.lang.String NUMBER_OF_HISTOGRAM_PIXELS
Parameter
that holds the number of pixels in the
HIST
histogram data for the detector used to model the photometry
of the observation. This parameter is part of the output CCD aggregates.public static final java.lang.String HIST
Parameter
that holds the histogram data for the
detector used to model the photometry of the observation. This parameter is
part of the output CCD aggregates. Its value is an array-type Value
.public static java.util.Vector output_groups()
Parameter
s required to be
in a HIPHOP output transfer file.public static java.util.Vector output_generic_parameters()
Parameter
s required to be in the
so-called "generic" group in a HIPHOP output transfer file. The parameters
with these names must be members of the GENERIC_GROUP
aggregate.public static java.util.Vector output_hapke_parameters()
Parameter
s required to be in the
Hapke group in a HIPHOP output transfer file. The parameters with these
names must be members of the HAPKE_GROUP
aggregate.public static java.util.Vector output_ccd_parameters()
Parameter
s required to be in the CCD
groups in a HIPHOP output transfer file. The parameters with these names
must be members of the BG_CCD_GROUP
, RED_CCD_GROUP
, and
the IR_CCD_GROUP
aggregates.public static boolean verify_input_parameters(PIRL.PVL.Parameter input)
input
- the HIPHOP input transfer file parameter set.public static boolean verify_output_parameters(PIRL.PVL.Parameter output)
output
- the HIPHOP output transfer file parmeter set.Copyright \ (C) Arizona Board of Regents on behalf of the \ Planetary Image Research Laboratory, Lunar and \ Planetary Laboratory at the University of Arizona