HiRISE

HiRISE.HiReport.model
Class PhotStats

java.lang.Object
  extended by HiRISE.HiReport.model.PhotStats

public class PhotStats
extends Object

Holds photometry statistics for a filter/binning combo.


Constructor Summary
PhotStats(HiProduct filter, int binning)
          Create a new instance for a combo
 
Method Summary
static String asString(HiProduct filter, int binning)
          Get the key string for an instance
 boolean equals(Object obj)
           
 double getAvg()
          Get the mean DN
 int getBin()
          Get the bin mode
 String getFilterName()
          Get the filter name (RED, IR, BG)
 int getMax()
          Get the maximum DN
 int getMin()
          Get the minimum DN
 double getSnr()
          Get the signal-to-noise ratio
 double getStd()
          Get the standard deviation in DN
 String getTdiModes()
          Get a string representation of the TDI modes used
 boolean getTdiStage(int index)
          Get the setting for a TDI stage
 boolean[] getTdiStages()
          Return an array representing which TDI modes were used
 int hashCode()
           
 void setAvg(double avg)
          Set the mean
 void setMax(int max)
          Set the maximum
 void setMin(int min)
          Set the minimum
 void setSnr(double snr)
          Set the SNR
 void setStd(double std)
          Set the standard deviation
 void setTdiStage(boolean on, int index)
          Set whether or not a TDI stage was commanded
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PhotStats

public PhotStats(HiProduct filter,
                 int binning)
Create a new instance for a combo

Parameters:
filter - The filter ID (RED, IR, BG)
binning - The bin mode
Method Detail

toString

public String toString()
Overrides:
toString in class Object

asString

public static String asString(HiProduct filter,
                              int binning)
Get the key string for an instance

Parameters:
filter - The filter ID (RED, IR, BG)
binning - The bin mode
Returns:
String representation

setTdiStage

public void setTdiStage(boolean on,
                        int index)
Set whether or not a TDI stage was commanded

Parameters:
on - true if commanded
index - TDI stage index

getTdiStage

public boolean getTdiStage(int index)
Get the setting for a TDI stage

Parameters:
index - TDI stage
Returns:
true if commanded

getTdiStages

public boolean[] getTdiStages()
Return an array representing which TDI modes were used

Returns:
array with a value for each TDI stage

getTdiModes

public String getTdiModes()
Get a string representation of the TDI modes used

Returns:
TDI mode string

getFilterName

public String getFilterName()
Get the filter name (RED, IR, BG)

Returns:
filter name

getBin

public int getBin()
Get the bin mode

Returns:
binning

getAvg

public double getAvg()
Get the mean DN

Returns:
mean of images

getStd

public double getStd()
Get the standard deviation in DN

Returns:
STD of images

getSnr

public double getSnr()
Get the signal-to-noise ratio

Returns:
average SNR of images

getMin

public int getMin()
Get the minimum DN

Returns:
min of images

getMax

public int getMax()
Get the maximum DN

Returns:
max of images

setAvg

public void setAvg(double avg)
Set the mean

Parameters:
avg - DN

setStd

public void setStd(double std)
Set the standard deviation

Parameters:
std - DN

setSnr

public void setSnr(double snr)
Set the SNR

Parameters:
snr - signal-to-noise ratio

setMin

public void setMin(int min)
Set the minimum

Parameters:
min - DN

setMax

public void setMax(int max)
Set the maximum

Parameters:
max - DN

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

HiRISE

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