HiRISE

HiRISE.HiPlan.HIPHOP
Class CCD_Data

java.lang.Object
  extended by HiRISE.HiPlan.HIPHOP.CCD_Data

public class CCD_Data
extends Object

A set of HIPHOP model data for a particular CCD or CCD set.

WARNING: This API is under development and is not stable.

Version:
1.7
Author:
Christian Schaller - UA/PIRL

Nested Class Summary
static class CCD_Data.Data_Plane
          An enumeration of the valid data planes.
 
Field Summary
static String ID
          Class identification name with source code version and date.
 
Constructor Summary
CCD_Data()
          Creates a new set of CCD data.
CCD_Data(CCD_Data ccdData)
          Creates a copy of the input CCD data.
 
Method Summary
 void copyData(CCD_Data ccdData)
          Copies the data from the input CCD data to this set.
 double getDn(int binIndex, int tdiIndex)
          Gets the DN for a given binning index and TDI index.
 double getDnNoise(int binIndex, int tdiIndex)
          Gets the DN noise for a given binning index and TDI index.
 double getElectronCount(int binIndex, int tdiIndex)
          Gets the electron count for a given binning index and TDI index.
 double getOffset(int binIndex, int tdiIndex)
          Gets the offset for a given binning index and TDI index.
 double getSnr(int binIndex, int tdiIndex)
          Gets the SNR for a given binning index and TDI index.
 double getValue(int binIndex, int tdiIndex, CCD_Data.Data_Plane dataPlane)
           
 void setDn(int binIndex, int tdiIndex, double dn)
          Sets the DN for a given binning index and TDI index.
 void setDnNoise(int binIndex, int tdiIndex, double dnNoise)
          Sets the DN noise for a given binning index and TDI index.
 void setElectronCount(int binIndex, int tdiIndex, double electronCount)
          Sets the electron count for a given binning index and TDI index.
 void setOffset(int binIndex, int tdiIndex, double offset)
          Sets the offset for a given binning index and TDI index.
 void setSnr(int binIndex, int tdiIndex, double snr)
          Sets the SNR for a given binning index and TDI index.
 void setValue(int binIndex, int tdiIndex, CCD_Data.Data_Plane dataPlane, double value)
           
 
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
Constructor Detail

CCD_Data

public CCD_Data()
Creates a new set of CCD data. All values are initialized to Instrument.UNKNOWN_NUMBER.


CCD_Data

public CCD_Data(CCD_Data ccdData)
Creates a copy of the input CCD data.

Method Detail

getSnr

public double getSnr(int binIndex,
                     int tdiIndex)
Gets the SNR for a given binning index and TDI index. The binning index is the index of the binning factor in the Instrument.BINNING_FACTORS array; the TDI index is likewise the index of the TDI setting in the Instrument.TDI_STAGES array. If either is not a valid index, this method returns Instrument.NOT_APPLICABLE_NUMBER.

Parameters:
binIndex - the binning index.
tdiIndex - the TDI index.
Returns:
the SNR value for the given binning, TDI index combination or Instrument.NOT_APPLICABLE_NUMBER.
See Also:
Utilities.getBinningIndex(int), Utilities.getTdiIndex(int)

setSnr

public void setSnr(int binIndex,
                   int tdiIndex,
                   double snr)
Sets the SNR for a given binning index and TDI index. The binning index is the index of the binning factor in the Instrument.BINNING_FACTORS array; the TDI index is likewise the index of the TDI setting in the Instrument.TDI_STAGES array. If either is not a valid index, this method silently does nothing.

Parameters:
binIndex - the binning index.
tdiIndex - the TDI index.
snr - the new SNR value.
See Also:
Utilities.getBinningIndex(int), Utilities.getTdiIndex(int)

getDn

public double getDn(int binIndex,
                    int tdiIndex)
Gets the DN for a given binning index and TDI index. The binning index is the index of the binning factor in the Instrument.BINNING_FACTORS array; the TDI index is likewise the index of the TDI setting in the Instrument.TDI_STAGES array. If either is not a valid index, this method returns Instrument.NOT_APPLICABLE_NUMBER.

Parameters:
binIndex - the binning index.
tdiIndex - the TDI index.
Returns:
the DN value for the given binning, TDI index combination or Instrument.NOT_APPLICABLE_NUMBER.
See Also:
Utilities.getBinningIndex(int), Utilities.getTdiIndex(int)

setDn

public void setDn(int binIndex,
                  int tdiIndex,
                  double dn)
Sets the DN for a given binning index and TDI index. The binning index is the index of the binning factor in the Instrument.BINNING_FACTORS array; the TDI index is likewise the index of the TDI setting in the Instrument.TDI_STAGES array. If either is not a valid index, this method silently does nothing.

Parameters:
binIndex - the binning index.
tdiIndex - the TDI index.
dn - the new DN value.
See Also:
Utilities.getBinningIndex(int), Utilities.getTdiIndex(int)

getElectronCount

public double getElectronCount(int binIndex,
                               int tdiIndex)
Gets the electron count for a given binning index and TDI index. The binning index is the index of the binning factor in the Instrument.BINNING_FACTORS array; the TDI index is likewise the index of the TDI setting in the Instrument.TDI_STAGES array. If either is not a valid index, this method returns Instrument.NOT_APPLICABLE_NUMBER.

Parameters:
binIndex - the binning index.
tdiIndex - the TDI index.
Returns:
the electron count value for the given binning, TDI index combination or Instrument.NOT_APPLICABLE_NUMBER.
See Also:
Utilities.getBinningIndex(int), Utilities.getTdiIndex(int)

setElectronCount

public void setElectronCount(int binIndex,
                             int tdiIndex,
                             double electronCount)
Sets the electron count for a given binning index and TDI index. The binning index is the index of the binning factor in the Instrument.BINNING_FACTORS array; the TDI index is likewise the index of the TDI setting in the Instrument.TDI_STAGES array. If either is not a valid index, this method silently does nothing.

Parameters:
binIndex - the binning index.
tdiIndex - the TDI index.
electronCount - the new electron count value.
See Also:
Utilities.getBinningIndex(int), Utilities.getTdiIndex(int)

getOffset

public double getOffset(int binIndex,
                        int tdiIndex)
Gets the offset for a given binning index and TDI index. The binning index is the index of the binning factor in the Instrument.BINNING_FACTORS array; the TDI index is likewise the index of the TDI setting in the Instrument.TDI_STAGES array. If either is not a valid index, this method returns Instrument.NOT_APPLICABLE_NUMBER.

Parameters:
binIndex - the binning index.
tdiIndex - the TDI index.
Returns:
the offset value for the given binning, TDI index combination or Instrument.NOT_APPLICABLE_NUMBER.
See Also:
Utilities.getBinningIndex(int), Utilities.getTdiIndex(int)

setOffset

public void setOffset(int binIndex,
                      int tdiIndex,
                      double offset)
Sets the offset for a given binning index and TDI index. The binning index is the index of the binning factor in the Instrument.BINNING_FACTORS array; the TDI index is likewise the index of the TDI setting in the Instrument.TDI_STAGES array. If either is not a valid index, this method silently does nothing.

Parameters:
binIndex - the binning index.
tdiIndex - the TDI index.
offset - the new offset value.
See Also:
Utilities.getBinningIndex(int), Utilities.getTdiIndex(int)

getDnNoise

public double getDnNoise(int binIndex,
                         int tdiIndex)
Gets the DN noise for a given binning index and TDI index. The binning index is the index of the binning factor in the Instrument.BINNING_FACTORS array; the TDI index is likewise the index of the TDI setting in the Instrument.TDI_STAGES array. If either is not a valid index, this method returns Instrument.NOT_APPLICABLE_NUMBER.

Parameters:
binIndex - the binning index.
tdiIndex - the TDI index.
Returns:
the DN noise value for the given binning, TDI index combination or Instrument.NOT_APPLICABLE_NUMBER.
See Also:
Utilities.getBinningIndex(int), Utilities.getTdiIndex(int)

setDnNoise

public void setDnNoise(int binIndex,
                       int tdiIndex,
                       double dnNoise)
Sets the DN noise for a given binning index and TDI index. The binning index is the index of the binning factor in the Instrument.BINNING_FACTORS array; the TDI index is likewise the index of the TDI setting in the Instrument.TDI_STAGES array. If either is not a valid index, this method silently does nothing.

Parameters:
binIndex - the binning index.
tdiIndex - the TDI index.
dnNoise - the new DN noise value.
See Also:
Utilities.getBinningIndex(int), Utilities.getTdiIndex(int)

getValue

public double getValue(int binIndex,
                       int tdiIndex,
                       CCD_Data.Data_Plane dataPlane)

setValue

public void setValue(int binIndex,
                     int tdiIndex,
                     CCD_Data.Data_Plane dataPlane,
                     double value)

copyData

public void copyData(CCD_Data ccdData)
Copies the data from the input CCD data to this set. If ccdData is null, this set's data are initialized to Instrument.UNKNOWN_NUMBER.

Parameters:
ccdData - the data to be copied.

HiRISE

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