HiRISE

HiRISE.HiReport.uplink
Class StereoPair

java.lang.Object
  extended by HiRISE.HiReport.uplink.StereoPair

public class StereoPair
extends Object

Represents a pair of observations for a stereo image.


Nested Class Summary
static class StereoPair.Completion
          Identifies the possible states of stereo pair completion
 
Field Summary
static String ID
          CVS ID
 
Constructor Summary
StereoPair(String description, float latitude, float longitude)
          Create a new stereo pair object with the specified description.
 
Method Summary
 boolean equals(Object obj)
           
 String getAnaglyph()
          Get the product ID for the Anaglyph, null if there is none.
 StereoPair.Completion getCompletion()
          Get the state of the pair.
 String getDescription()
          Get the description for the pair.
 String getDtm()
          Get the product ID for the DTM, null if there is none.
 Float getIncidenceAngle1()
          Get the incidence angle of the 1st half.
 Float getIncidenceAngle2()
          Get the incidence angle of the 2nd half.
 Float getIncidenceDelta()
          Get the difference (absolute value) between the incidence angles, or null if either is null.
 boolean getIsRetired1()
          Get the retired state of the 1st half.
 boolean getIsRetired2()
          Get the retired state of the 2nd half.
 float getLatitude()
          Get the center latitude in degrees
 float getLongitude()
          Get the center longitude in degrees (0-360)
 String getObservationID1()
          Get the observation ID of the first half.
 String getObservationID2()
          Get the observation ID of the second half.
 Float getRollAngle1()
          Get the roll angle of the 1st half.
 Float getRollAngle2()
          Get the roll angle of the 2nd half.
 Float getRollDelta()
          Get the difference (absolute value) between the roll angles, or null if either is null.
 Double getStereoAngle()
          Get the stereo separation angle or null if it is not defined
 int getSuggestionID1()
          Get the suggestion ID of the 1st half.
 int getSuggestionID2()
          Get the suggestion ID of the 2nd half.
 Double getTimeDelta()
          Get the difference (absolute value) in time between the halves, in decimal days.
 boolean isAnaglyph()
          True if pair has produced an anaglyph
 boolean isDtm()
          True if the pair has produced a DTM
 void setHalf(StereoHalf half, int idx)
          Update the pair with a new half.
 void setLatitude(float latitude)
          Set the center latitude
 void setLongitude(float longitude)
          Set the center longitude
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ID

public static final String ID
CVS ID

See Also:
Constant Field Values
Constructor Detail

StereoPair

public StereoPair(String description,
                  float latitude,
                  float longitude)
Create a new stereo pair object with the specified description.

Parameters:
description - Short description of the pair
latitude - center latitude in degrees
longitude - center longitude in degrees
Method Detail

toString

public String toString()
Overrides:
toString in class Object

getLatitude

public float getLatitude()
Get the center latitude in degrees

Returns:
center latitude

setLatitude

public void setLatitude(float latitude)
Set the center latitude

Parameters:
latitude - degrees

getLongitude

public float getLongitude()
Get the center longitude in degrees (0-360)

Returns:
center longitude

setLongitude

public void setLongitude(float longitude)
Set the center longitude

Parameters:
longitude - degrees

getObservationID1

public String getObservationID1()
Get the observation ID of the first half.

Returns:
1st half observation ID

getObservationID2

public String getObservationID2()
Get the observation ID of the second half.

Returns:
2nd half observation ID

getSuggestionID1

public int getSuggestionID1()
Get the suggestion ID of the 1st half.

Returns:
1st half suggestion ID

getSuggestionID2

public int getSuggestionID2()
Get the suggestion ID of the 2nd half.

Returns:
2nd half suggestion ID

getRollAngle1

public Float getRollAngle1()
Get the roll angle of the 1st half.

Returns:
1st half roll angle

getRollAngle2

public Float getRollAngle2()
Get the roll angle of the 2nd half.

Returns:
2nd half roll angle

getIncidenceAngle1

public Float getIncidenceAngle1()
Get the incidence angle of the 1st half.

Returns:
1st half incidence angle

getIncidenceAngle2

public Float getIncidenceAngle2()
Get the incidence angle of the 2nd half.

Returns:
2nd half incidence angle

getIsRetired1

public boolean getIsRetired1()
Get the retired state of the 1st half.

Returns:
1st half retirement state

getIsRetired2

public boolean getIsRetired2()
Get the retired state of the 2nd half.

Returns:
2nd half retirement state

setHalf

public void setHalf(StereoHalf half,
                    int idx)
Update the pair with a new half.

Parameters:
half - The half
idx - The index, must be 0 (first) or 1 (second).

getDescription

public String getDescription()
Get the description for the pair.

Returns:
short text description

getTimeDelta

public Double getTimeDelta()
Get the difference (absolute value) in time between the halves, in decimal days. If a half has not been received (null timestamp), the difference is from the received half and the current time. If neither have been received, the result is null.

Returns:
time delta in days

getIncidenceDelta

public Float getIncidenceDelta()
Get the difference (absolute value) between the incidence angles, or null if either is null.

Returns:
Incidence angle delta

getRollDelta

public Float getRollDelta()
Get the difference (absolute value) between the roll angles, or null if either is null.

Returns:
Roll angle delta

getCompletion

public StereoPair.Completion getCompletion()
Get the state of the pair. There are five possibilities.

Returns:
integer corresponding to state definition

getAnaglyph

public String getAnaglyph()
Get the product ID for the Anaglyph, null if there is none.

Returns:
product ID

getDtm

public String getDtm()
Get the product ID for the DTM, null if there is none.

Returns:
product ID

getStereoAngle

public Double getStereoAngle()
Get the stereo separation angle or null if it is not defined

Returns:
degrees

isDtm

public boolean isDtm()
True if the pair has produced a DTM

Returns:
true if DTM made

isAnaglyph

public boolean isAnaglyph()
True if pair has produced an anaglyph

Returns:
true if anaglyph made

equals

public boolean equals(Object obj)
Overrides:
equals 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