HiRISE

HiRISE.HiReport.product
Class EdrInfo

java.lang.Object
  extended by HiRISE.HiReport.product.EdrInfo

public class EdrInfo
extends Object

Structure containing EDR meta-data


Field Summary
 double avg
          Average of DN
 int bin
          Binning mode
 Dimension dim
          Pixel width and height
 int dns
          Number of distinct DN levels
 double fcr
          compression (1 = uncompressed, 0 = unknown)
 long gpx
          Count of gapped or null pixels
 String hcv
          HiCal version string
 int his
          high instrument saturation
 int lis
          low instrument saturation
 int lut
          LUT number
 int max
          Max DN
 int min
          Min DN
 int orb
          orbit number
 Timestamp pct
          product creation time
 double snr
          signal to noise ratio
 double std
          Standard deviation of DN
 int tdi
          TDI mode
 
Constructor Summary
EdrInfo(String obs, HiProduct id, Dimension dim)
          Create a new EDR info structure
EdrInfo(String obs, HiProduct id, int w, int h)
          Create a new EDR info structure
 
Method Summary
 boolean equals(Object obj)
           
 boolean findProblems()
          When true, problem finding enabled.
 void findProblems(boolean find)
          Set to true to enable problem finding (default false)
 boolean findWarnings()
          When true, warning finding enabled.
 void findWarnings(boolean find)
          Set to true to enable warning finding (default false)
 double getGapPercent()
          Returns the percentage of gapped pixels
 HiProduct getId()
          Get the product ID
 String getObservation()
          Get the observation ID
 Set<EdrProblem> getProblems()
          Get the set of problems for this EDR
 ProductState getState()
          Get the state of the EDR
 Validation getValidation()
          Get the validation information
 int getVersion()
          Returns the version number (0 if unset)
 Set<EdrProblem> getWarnings()
          Get the set of warnings for this EDR
 int hashCode()
           
 void setCompression(float fcr)
          Set the compression factor, 1 = uncompressed, 0 = unknown
 void setCreationTime(Timestamp pct)
          Set the product creation time
 void setFurrows(boolean furrows)
          Add or remove furrows from the problem set
 void setGaps(long gpx)
          Set the gapped pixel count
 void setHiCal(String hcv)
           
 void setSaturation(int lis, int his)
          Set the saturated pixel count
 void setSettings(int tdi, int bin, int lut, int orb)
          Set various mode settings
 void setSNR(double snr)
          Set the signal-to-noise ratio
 void setState(ProductState is)
          Set the EDR state
 void setStats(int dns, int min, int max, double avg, double std)
          Set statistical values
 void setValidation(Validation val)
          Set the validation information
 void setVersion(int version)
          Set the version number
 String toString()
           
static EdrInfo updateFromRow(ResultSet rs, EdrInfo edr)
          Fill-in values from result set
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

dim

public Dimension dim
Pixel width and height


gpx

public long gpx
Count of gapped or null pixels


snr

public double snr
signal to noise ratio


fcr

public double fcr
compression (1 = uncompressed, 0 = unknown)


lis

public int lis
low instrument saturation


his

public int his
high instrument saturation


tdi

public int tdi
TDI mode


bin

public int bin
Binning mode


lut

public int lut
LUT number


min

public int min
Min DN


max

public int max
Max DN


avg

public double avg
Average of DN


std

public double std
Standard deviation of DN


dns

public int dns
Number of distinct DN levels


hcv

public String hcv
HiCal version string


pct

public Timestamp pct
product creation time


orb

public int orb
orbit number

Constructor Detail

EdrInfo

public EdrInfo(String obs,
               HiProduct id,
               int w,
               int h)
Create a new EDR info structure

Parameters:
obs - observation ID
id - product
w - pixel width (samples)
h - pixel height (lines)

EdrInfo

public EdrInfo(String obs,
               HiProduct id,
               Dimension dim)
Create a new EDR info structure

Parameters:
obs - observation ID
id - product
dim - (samples, lines)
Method Detail

findProblems

public boolean findProblems()
When true, problem finding enabled.

Returns:
true if problem finding enabled.

findWarnings

public boolean findWarnings()
When true, warning finding enabled.

Returns:
true if warning finding enabled.

findProblems

public void findProblems(boolean find)
Set to true to enable problem finding (default false)

Parameters:
find -

findWarnings

public void findWarnings(boolean find)
Set to true to enable warning finding (default false)

Parameters:
find -

setVersion

public void setVersion(int version)
Set the version number

Parameters:
version - the version number

getVersion

public int getVersion()
Returns the version number (0 if unset)

Returns:
version number

getState

public ProductState getState()
Get the state of the EDR

Returns:
state

getGapPercent

public double getGapPercent()
Returns the percentage of gapped pixels

Returns:
percent gapped

setState

public void setState(ProductState is)
Set the EDR state

Parameters:
is - state

toString

public String toString()
Overrides:
toString in class Object

equals

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

hashCode

public int hashCode()
Overrides:
hashCode in class Object

getId

public HiProduct getId()
Get the product ID

Returns:
product ID

getValidation

public Validation getValidation()
Get the validation information

Returns:
validation instance

setValidation

public void setValidation(Validation val)
Set the validation information

Parameters:
val - validation instance

setCompression

public void setCompression(float fcr)
Set the compression factor, 1 = uncompressed, 0 = unknown

Parameters:
fcr - compression factor

setCreationTime

public void setCreationTime(Timestamp pct)
Set the product creation time

Parameters:
pct - time

setGaps

public void setGaps(long gpx)
Set the gapped pixel count

Parameters:
gpx - gapped pixel count

setSNR

public void setSNR(double snr)
Set the signal-to-noise ratio

Parameters:
snr - signal-to-noise ratio

setSaturation

public void setSaturation(int lis,
                          int his)
Set the saturated pixel count

Parameters:
lis - low instrument saturation pixel count
his - high instrument saturation pixel count

setStats

public void setStats(int dns,
                     int min,
                     int max,
                     double avg,
                     double std)
Set statistical values

Parameters:
dns - number of DN levels
min - lowest DN
max - highest DN
avg - mean DN
std - standard deviation in DN

setSettings

public void setSettings(int tdi,
                        int bin,
                        int lut,
                        int orb)
Set various mode settings

Parameters:
tdi - TDI mode
bin - binning mode
lut - LUT number
orb - orbit number (used for LUT verification)

getProblems

public Set<EdrProblem> getProblems()
Get the set of problems for this EDR

Returns:
set

getWarnings

public Set<EdrProblem> getWarnings()
Get the set of warnings for this EDR

Returns:
set

setFurrows

public void setFurrows(boolean furrows)
Add or remove furrows from the problem set

Parameters:
furrows - true for furrows

updateFromRow

public static EdrInfo updateFromRow(ResultSet rs,
                                    EdrInfo edr)
                             throws SQLException
Fill-in values from result set

Parameters:
rs - result from database
edr - structure to fill-in
Returns:
the instance
Throws:
SQLException - failed to fetch info

setHiCal

public void setHiCal(String hcv)
Parameters:
hcv - HiCal Version

getObservation

public String getObservation()
Get the observation ID

Returns:
observation ID

HiRISE

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