HiRISE

HiRISE.HiPlan.SPICE
Class Time_Utilities.LineTimeAssay

java.lang.Object
  extended by HiRISE.HiPlan.SPICE.Time_Utilities.LineTimeAssay
Enclosing class:
Time_Utilities

public static class Time_Utilities.LineTimeAssay
extends Object

A HiRISE line time and a list of messages that arose during its calculation. Messages may be errors or simply diagnostic messages.

See Also:
Time_Utilities.computeLineTime(Observation_Record)

Constructor Summary
Time_Utilities.LineTimeAssay(Observation_Record observation)
          Creates a new line time assay for an input observation record.
 
Method Summary
 void addDiagnostic(String msg)
           
 void addError(String msg)
           
 List<String> getDiagnostics()
           
 List<String> getErrors()
           
 double getLineTime()
          Gets the computed line time.
 double getPredictShift()
           
 Date getPredictTime()
          Gets the predict time used in the line time calculation.
 Double getRollAngle()
           
 Date getShiftedTime()
          Gets the shifted predict time used in the line time calculation.
 Double getTargetAltitude()
           
 boolean hasErrors()
           
 boolean lineTimeIsUnknown()
           
 void printDiagnostics()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Time_Utilities.LineTimeAssay

public Time_Utilities.LineTimeAssay(Observation_Record observation)
Creates a new line time assay for an input observation record. The line time is computed through this construction if possible, but the observation record itself is not updated.

If the observation uses manual delay, its predict time is offset appropriately based on the delay duration. Otherwise, the predict time is used directly. Note that if the predict time is null, the resulting line time is also null, regardless of the delay settings.

The offset center altitude of the target site is used, if non-null; otherwise the altitude is used. If both altitudes are null, an altitude of 0 km is assumed.

The roll angle is used directly; if null, the roll angle is assumed to be 0.

Parameters:
observation - the observation for which line time is to be computed; may not be null, although its relevant parameters may be.
Method Detail

getLineTime

public double getLineTime()
Gets the computed line time. If the line time could not be computed, the unknown number value (-9999) is returned.

Returns:
the computed line time or -9999.

getPredictTime

public Date getPredictTime()
Gets the predict time used in the line time calculation. This value is the original value from the observation, unmodified by delay duration. If the observation has a null predict time, this value is null (and the line time is -9999).

Returns:
the predict time used in the calculation of line time.

getShiftedTime

public Date getShiftedTime()
Gets the shifted predict time used in the line time calculation. This value is the original value from the observation, shifted accordingly due to manual delay if used. If the original predict time is null, this value is also null (and the line time is -9999). If manual delay is not used, this value is the same as the unshifted predict time.

Returns:
the shifted predict time used in the calculation of line time.

getPredictShift

public double getPredictShift()

getRollAngle

public Double getRollAngle()

getTargetAltitude

public Double getTargetAltitude()

getErrors

public List<String> getErrors()

getDiagnostics

public List<String> getDiagnostics()

addError

public void addError(String msg)

addDiagnostic

public void addDiagnostic(String msg)

lineTimeIsUnknown

public boolean lineTimeIsUnknown()

hasErrors

public boolean hasErrors()

printDiagnostics

public void printDiagnostics()

HiRISE

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