HiRISE

HiRISE.HiPlan.HiSEAS
Class RulesCollection

java.lang.Object
  extended by HiRISE.HiPlan.HiSEAS.RulesCollection

public class RulesCollection
extends Object

A collection of rules by latitude. Latitudinal gaps between sets of rules are allowed, which are filled in by the defaults, but overlaps between sets are not allowed.

Note that this class is not an implementation of the Collection interface.


Field Summary
static Rules APPLICATION_DEFAULT_RULES
           
static String ID
          Class identification name with source code version and date.
 
Constructor Summary
RulesCollection()
           
RulesCollection(Configuration configuration)
           
 
Method Summary
 List<Rules> getAllRules()
           
 Rules getRules(double lat)
           
 Rules getRules(StereoPair pair)
           
 Rules getRules(Target targetSite)
           
 Rules getUserDefaultRules()
           
 boolean isAllowedAzimuthDifference(MroStereoPair pair)
           
 boolean isAllowedIncidenceDifference(MroStereoPair pair)
           
 boolean isAllowedShadowTipDifference(MroStereoPair pair)
           
 boolean isAllowedSolarSeparationAngle(MroStereoPair pair)
           
 boolean isGoodConvergence(MroStereoPair pair)
           
 boolean isOkayConvergence(MroStereoPair pair)
           
 boolean isRollSignCompatible(MroStereoPair pair, boolean isSporc)
          Tests the roll signs of the stereo pair against the desired roll sign rule for the pair's latitude.
 boolean isUrgent(MroStereoPair pair)
           
 boolean isWithGaps()
           
 RulesCollection makeSingleRulesCollection(String identifier)
           
 void printRulesReport(PrintStream out)
          Prints a formatted report of this collection's rules to an indicated print stream.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

APPLICATION_DEFAULT_RULES

public static final Rules APPLICATION_DEFAULT_RULES
Constructor Detail

RulesCollection

public RulesCollection(Configuration configuration)
                throws Rules.RulesException
Throws:
Rules.RulesException

RulesCollection

public RulesCollection()
Method Detail

getAllRules

public List<Rules> getAllRules()

getUserDefaultRules

public Rules getUserDefaultRules()

isWithGaps

public boolean isWithGaps()

getRules

public Rules getRules(double lat)

getRules

public Rules getRules(StereoPair pair)

getRules

public Rules getRules(Target targetSite)

isAllowedShadowTipDifference

public boolean isAllowedShadowTipDifference(MroStereoPair pair)

isAllowedAzimuthDifference

public boolean isAllowedAzimuthDifference(MroStereoPair pair)

isAllowedSolarSeparationAngle

public boolean isAllowedSolarSeparationAngle(MroStereoPair pair)

isAllowedIncidenceDifference

public boolean isAllowedIncidenceDifference(MroStereoPair pair)

isOkayConvergence

public boolean isOkayConvergence(MroStereoPair pair)

isGoodConvergence

public boolean isGoodConvergence(MroStereoPair pair)

isRollSignCompatible

public boolean isRollSignCompatible(MroStereoPair pair,
                                    boolean isSporc)
Tests the roll signs of the stereo pair against the desired roll sign rule for the pair's latitude. Nadir observations are treated as neither positive nor negative rolls, and this distinction is strictly enforced in the tests; the only test that will return true with a nadir observation is ANY.

For SPORCs, the OPPOSITE and SAME rules are treated as ANY. Indicate that a pair is part of a SPORC set with the isSporc flag.

Parameters:
pair - a stereo pair to be tested.
isSporc - indicates whether the pair is a SPORC pair, which may modify the roll sign rule for the pair.
Returns:
true if the pair's roll signs meet the rule's criteria; false otherwise.

isUrgent

public boolean isUrgent(MroStereoPair pair)

printRulesReport

public void printRulesReport(PrintStream out)
Prints a formatted report of this collection's rules to an indicated print stream.

Parameters:
out - the output print stream; if null, System.out is used.

makeSingleRulesCollection

public RulesCollection makeSingleRulesCollection(String identifier)
                                          throws Rules.RulesException
Throws:
Rules.RulesException

HiRISE

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