public class Rules
extends java.lang.Object
implements java.lang.Cloneable
Modifier and Type | Class and Description |
---|---|
static class |
Rules.Comparator
A comparator for HiSEAS rules.
|
static class |
Rules.CompletionSort |
static class |
Rules.RollSign |
static class |
Rules.RulesException |
Modifier and Type | Field and Description |
---|---|
static Interval |
ALLOWED_CONVERGENCE |
static Interval |
ALLOWED_LATITUDES |
static Interval |
ALLOWED_ROLLS |
static java.lang.String |
AZIMUTH_DIFFERENCE_MAX |
static java.lang.String |
BAND_NAME |
static java.lang.String |
COMPLETION_SORT |
static java.lang.String |
CONVERGENCE_ANGLE_GOOD_INTERVAL |
static double |
CONVERGENCE_ANGLE_GOOD_MAX |
static double |
CONVERGENCE_ANGLE_GOOD_MIN |
static java.lang.String |
CONVERGENCE_ANGLE_OKAY_INTERVAL |
static double |
CONVERGENCE_ANGLE_OKAY_MAX |
static double |
CONVERGENCE_ANGLE_OKAY_MIN |
static double |
CONVERGENCE_MAX
The maxmimum allowed convergence angle.
|
static double |
CONVERGENCE_MIN
The minimum allowed convergence angle.
|
static double |
DEFAULT_AZIMUTH_DIFFERENCE_MAX |
static Rules.CompletionSort |
DEFAULT_COMPLETION_SORT |
static double[] |
DEFAULT_CONVERGENCE_ANGLE_GOOD_INTERVAL |
static double[] |
DEFAULT_CONVERGENCE_ANGLE_OKAY_INTERVAL |
static double |
DEFAULT_INCIDENCE_DIFFERENCE_MAX |
static boolean |
DEFAULT_INCLUDE_OKAY_SPORC_CONVERGENCE |
static double[] |
DEFAULT_LATITUDES |
static Rules.RollSign |
DEFAULT_ROLL_SIGN |
static double |
DEFAULT_SHADOW_TIP_DIFFERENCE_MAX |
static double |
DEFAULT_SOLAR_SEPARATION_ANGLE_MAX |
static double |
DEFAULT_URGENT_THRESHOLD |
static java.lang.String |
ID
Class identification name with source code version and date.
|
static java.lang.String |
INCIDENCE_DIFFERENCE_MAX |
static java.lang.String |
INCLUDE_OKAY_SPORC_CONVERGENCE |
static double |
LATITUDE_MAX
The maximum allowed latitude.
|
static double |
LATITUDE_MIN
The minimum allowed latitude.
|
static java.lang.String |
LATITUDES |
static java.lang.String |
ROLL_SIGN |
static java.lang.String |
SHADOW_TIP_DIFFERENCE_MAX |
static java.lang.String |
SOLAR_SEPARATION_ANGLE_MAX |
static java.lang.String |
URGENT_THRESHOLD |
static java.lang.String |
USER_DEFAULTS |
Constructor and Description |
---|
Rules(PIRL.Configuration.Configuration parameters,
Rules defaults) |
Rules(java.lang.String parameterName,
java.lang.String name,
Interval latitudes,
double shadowTipDifferenceMax,
double azimuthDifferenceMax,
double solarSeparationAngleMax,
double incidenceDifferenceMax,
Interval okayConvergence,
Interval goodConvergence,
boolean includeOkaySporcConvergence,
Rules.RollSign rollSign,
double urgentThreshold,
Rules.CompletionSort completionSort) |
public static final java.lang.String ID
public static final double LATITUDE_MIN
LATITUDE_MAX
.public static final double LATITUDE_MAX
LATITUDE_MIN
.public static final Interval ALLOWED_LATITUDES
public static final double CONVERGENCE_MIN
CONVERGENCE_MAX
. In practice, the min convergence should be larger than
this value, typically greater than 10 degrees.public static final double CONVERGENCE_MAX
CONVERGENCE_MIN
. In practice, the max convergence should be smaller than
this value, typically less than 40 degrees.public static final Interval ALLOWED_CONVERGENCE
public static final Interval ALLOWED_ROLLS
public static final java.lang.String USER_DEFAULTS
public static final java.lang.String BAND_NAME
public static final java.lang.String LATITUDES
public static final double[] DEFAULT_LATITUDES
public static final java.lang.String SHADOW_TIP_DIFFERENCE_MAX
public static final double DEFAULT_SHADOW_TIP_DIFFERENCE_MAX
public static final java.lang.String AZIMUTH_DIFFERENCE_MAX
public static final double DEFAULT_AZIMUTH_DIFFERENCE_MAX
public static final java.lang.String SOLAR_SEPARATION_ANGLE_MAX
public static final double DEFAULT_SOLAR_SEPARATION_ANGLE_MAX
public static final java.lang.String INCIDENCE_DIFFERENCE_MAX
public static final double DEFAULT_INCIDENCE_DIFFERENCE_MAX
public static final java.lang.String CONVERGENCE_ANGLE_GOOD_INTERVAL
public static final double CONVERGENCE_ANGLE_GOOD_MIN
public static final double CONVERGENCE_ANGLE_GOOD_MAX
public static final double[] DEFAULT_CONVERGENCE_ANGLE_GOOD_INTERVAL
public static final java.lang.String CONVERGENCE_ANGLE_OKAY_INTERVAL
public static final double CONVERGENCE_ANGLE_OKAY_MIN
public static final double CONVERGENCE_ANGLE_OKAY_MAX
public static final double[] DEFAULT_CONVERGENCE_ANGLE_OKAY_INTERVAL
public static final java.lang.String INCLUDE_OKAY_SPORC_CONVERGENCE
public static final boolean DEFAULT_INCLUDE_OKAY_SPORC_CONVERGENCE
public static final java.lang.String ROLL_SIGN
public static final Rules.RollSign DEFAULT_ROLL_SIGN
public static final java.lang.String URGENT_THRESHOLD
public static final double DEFAULT_URGENT_THRESHOLD
public static final java.lang.String COMPLETION_SORT
public static final Rules.CompletionSort DEFAULT_COMPLETION_SORT
public Rules(PIRL.Configuration.Configuration parameters, Rules defaults) throws Rules.RulesException
Rules.RulesException
public Rules(java.lang.String parameterName, java.lang.String name, Interval latitudes, double shadowTipDifferenceMax, double azimuthDifferenceMax, double solarSeparationAngleMax, double incidenceDifferenceMax, Interval okayConvergence, Interval goodConvergence, boolean includeOkaySporcConvergence, Rules.RollSign rollSign, double urgentThreshold, Rules.CompletionSort completionSort)
public java.lang.String getParameterName()
public java.lang.String getName()
public void setName(java.lang.String name)
public Interval getLatitudes()
public void setLatitudes(Interval latitudes)
public double getShadowTipDifferenceMax()
public void setShadowTipDifferenceMax(double shadowTipDifferenceMax)
public double getAzimuthDifferenceMax()
public void setAzimuthDifferenceMax(double azimuthDifferenceMax)
public double getSolarSeparationAngleMax()
public void setSolarSeparationAngleMax(double solarSeparationAngleMax)
public double getIncidenceDifferenceMax()
public void setIncidenceDifferenceMax(double incidenceDifferenceMax)
public Interval getOkayConvergence()
public void setOkayConvergence(Interval okayConvergence)
public Interval getGoodConvergence()
public void setGoodConvergence(Interval goodConvergence)
public boolean isOkaySporcConvergenceIncluded()
public void setOkaySporcConvergenceIncluded(boolean includeOkaySporcConvergence)
public Rules.RollSign getRollSign()
public void setRollSign(Rules.RollSign rollSign)
public double getUrgentThreshold()
public void setUrgentThreshold(double urgentThreshold)
public Rules.CompletionSort getCompletionSort()
public void setCompletionSort(Rules.CompletionSort completionSort)
public boolean coversLatitude(double lat)
public boolean isAllowedShadowTipDifference(double val)
public boolean isAllowedAzimuthDifference(double val)
public boolean isAllowedSolarSeparationAngle(double val)
public boolean isAllowedIncidenceDifference(double val)
public boolean isOkayConvergence(double val)
public boolean isGoodConvergence(double val)
public boolean isUrgent(double referenceLs, double ls)
public Rules clone()
clone
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
Copyright \ (C) Arizona Board of Regents on behalf of the \ Planetary Image Research Laboratory, Lunar and \ Planetary Laboratory at the University of Arizona