public class CCD_Data
extends java.lang.Object
WARNING: This API is under development and is not stable.
Modifier and Type | Class and Description |
---|---|
static class |
CCD_Data.Data_Plane
An enumeration of the valid data planes.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ID
Class identification name with source code version and date.
|
Constructor and Description |
---|
CCD_Data()
Creates a new set of CCD data.
|
CCD_Data(CCD_Data ccdData)
Creates a copy of the input CCD data.
|
Modifier and Type | Method and Description |
---|---|
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) |
public static final java.lang.String ID
public CCD_Data()
Instrument.UNKNOWN_NUMBER
.public CCD_Data(CCD_Data ccdData)
public double getSnr(int binIndex, int tdiIndex)
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
.binIndex
- the binning index.tdiIndex
- the TDI index.Instrument.NOT_APPLICABLE_NUMBER
.Utilities.getBinningIndex(int)
,
Utilities.getTdiIndex(int)
public void setSnr(int binIndex, int tdiIndex, double snr)
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.binIndex
- the binning index.tdiIndex
- the TDI index.snr
- the new SNR value.Utilities.getBinningIndex(int)
,
Utilities.getTdiIndex(int)
public double getDn(int binIndex, int tdiIndex)
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
.binIndex
- the binning index.tdiIndex
- the TDI index.Instrument.NOT_APPLICABLE_NUMBER
.Utilities.getBinningIndex(int)
,
Utilities.getTdiIndex(int)
public void setDn(int binIndex, int tdiIndex, double dn)
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.binIndex
- the binning index.tdiIndex
- the TDI index.dn
- the new DN value.Utilities.getBinningIndex(int)
,
Utilities.getTdiIndex(int)
public double getElectronCount(int binIndex, int tdiIndex)
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
.binIndex
- the binning index.tdiIndex
- the TDI index.Instrument.NOT_APPLICABLE_NUMBER
.Utilities.getBinningIndex(int)
,
Utilities.getTdiIndex(int)
public void setElectronCount(int binIndex, int tdiIndex, double electronCount)
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.binIndex
- the binning index.tdiIndex
- the TDI index.electronCount
- the new electron count value.Utilities.getBinningIndex(int)
,
Utilities.getTdiIndex(int)
public double getOffset(int binIndex, int tdiIndex)
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
.binIndex
- the binning index.tdiIndex
- the TDI index.Instrument.NOT_APPLICABLE_NUMBER
.Utilities.getBinningIndex(int)
,
Utilities.getTdiIndex(int)
public void setOffset(int binIndex, int tdiIndex, double offset)
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.binIndex
- the binning index.tdiIndex
- the TDI index.offset
- the new offset value.Utilities.getBinningIndex(int)
,
Utilities.getTdiIndex(int)
public double getDnNoise(int binIndex, int tdiIndex)
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
.binIndex
- the binning index.tdiIndex
- the TDI index.Instrument.NOT_APPLICABLE_NUMBER
.Utilities.getBinningIndex(int)
,
Utilities.getTdiIndex(int)
public void setDnNoise(int binIndex, int tdiIndex, double dnNoise)
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.binIndex
- the binning index.tdiIndex
- the TDI index.dnNoise
- the new DN noise value.Utilities.getBinningIndex(int)
,
Utilities.getTdiIndex(int)
public double getValue(int binIndex, int tdiIndex, CCD_Data.Data_Plane dataPlane)
public void setValue(int binIndex, int tdiIndex, CCD_Data.Data_Plane dataPlane, double value)
public void copyData(CCD_Data ccdData)
Instrument.UNKNOWN_NUMBER
.ccdData
- the data to be copied.Copyright \ (C) Arizona Board of Regents on behalf of the \ Planetary Image Research Laboratory, Lunar and \ Planetary Laboratory at the University of Arizona