HiRISE

HiRISE.HiPlan.HiSEAS
Class SimpleObservation

java.lang.Object
  extended by HiRISE.HiPlan.HiSEAS.AbstractObservation
      extended by HiRISE.HiPlan.HiSEAS.SimpleObservation
All Implemented Interfaces:
Observation

public final class SimpleObservation
extends AbstractObservation

A simple, immutable implementation of the abstract observation for an observer, target site, and ephemeris time.

To instantiate a new simple observation, use the SimpleObservation.Builder. Create a new builder with the oberver, target, and ephemeris time of interest, optionally set a label and/or comment, and invoke its build method. For example, to create a new observation with an Observer called mro of a Target called aramChaos, use the following code:

        SimpleObservation observation = new SimpleObservation.Builder (
                mro,
                aramChaos,
                295272514.521
        ).label ("ESP_013158_1830").comment ("Stereo-1 of Aram Chaos").build ();

At construction, the location of the observer with respect to the target's body at that time is calculated, as are the subsolar point on the target's body, the photometric angles (phase, incidence, and emission), and the solar longitude, Ls.

It is assumed that all necessary SPICE kernels are loaded into the SPICE kernel pool when the observation is constructed; if not, a SpiceException will be thrown.

If the builder's optional label (or comment) is null, the simple observation's label (or comment) will be set to the empty string ("") at construction; neither will be null.

Version:
1.5
Author:
Christian Schaller - UA/PIRL

Nested Class Summary
static class SimpleObservation.Builder
          A builder for an immutable simple observation.
 
Field Summary
static String ID
          Class identification name with source code version and date.
 
Fields inherited from class HiRISE.HiPlan.HiSEAS.AbstractObservation
basicObservationData
 
Method Summary
 boolean equals(Object o)
          Indicates whether some other object is "equal to" this one.
 String getComment()
          Gets the observation's optional comment.
 String getLabel()
          Gets the observation's optional label.
 int hashCode()
          Returns a hash code value for this stereo target.
 String toString()
          Gets a string representation of this simple observation.
 
Methods inherited from class HiRISE.HiPlan.HiSEAS.AbstractObservation
getAltitude, getEmissionAngle, getEt, getIncidenceAngle, getLatitude, getLongitude, getObserver, getPhaseAngle, getPositionVector, getSolarAltitude, getSolarAzimuth, getSolarDeclination, getSolarLongitude, getSolarRightAscension, getSubsolarLatitude, getSubsolarLatitudeSlope, getSubsolarLongitude, getSubsolarLongitudeSlope, getTarget, getVelocityVector, getViewVector
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, 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
Method Detail

getLabel

public String getLabel()
Gets the observation's optional label. The label is guaranteed not to be null.

Specified by:
getLabel in interface Observation
Specified by:
getLabel in class AbstractObservation
Returns:
the observation's optional label, which will not be null but which may be the empty string.

getComment

public String getComment()
Gets the observation's optional comment. The comment is guaranteed not to be null.

Specified by:
getComment in interface Observation
Specified by:
getComment in class AbstractObservation
Returns:
the observation's optional comment, which will not be null but which may be the empty string.

toString

public String toString()
Gets a string representation of this simple observation.

Overrides:
toString in class Object
Returns:
a string representation of this simple observation.

hashCode

public int hashCode()
Returns a hash code value for this stereo target.

Overrides:
hashCode in class Object
Returns:
a hash code value for this stereo target.

equals

public boolean equals(Object o)
Indicates whether some other object is "equal to" this one. A simple observation is equal to another if and only if the observation data, label, and comment are the same.

Overrides:
equals in class Object
Parameters:
o - the object to which this object is compared.
Returns:
true if the objects are equal; false otherwise.

HiRISE

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