org.opensha.commons.data.estimate
Class MinMaxPrefEstimate

java.lang.Object
  extended by org.opensha.commons.data.estimate.Estimate
      extended by org.opensha.commons.data.estimate.MinMaxPrefEstimate

public class MinMaxPrefEstimate
extends Estimate

Title: MinMaxPrefEstimate.java

Description: This stores min, max, and preferred values, and the corresonding probabilites that the true value is less than or equal to each. Though this is not a complete estimate, this is needed for Ref Fault paramter database GUI.

Copyright: Copyright (c) 2002

Company:

Version:
1.0
Author:
not attributable

Field Summary
static String NAME
           
 
Fields inherited from class org.opensha.commons.data.estimate.Estimate
comments, EST_MSG_FIRST_LAST_PROB_ZERO, EST_MSG_INVLID_RANGE, EST_MSG_MAX_LT_MIN, EST_MSG_NOT_NORMALIZED, EST_MSG_PROB_POSITIVE, EST_MSG_PROBS_NOT_INCREASING, FRACTILE_UNDEFINED, max, MEDIAN_UNDEFINED, min, MSG_ALL_PROB_ZERO, MSG_INVALID_STDDEV, units
 
Constructor Summary
MinMaxPrefEstimate(double min, double max, double pref, double minProb, double maxProb, double prefProb)
           
 
Method Summary
 double getMax()
          Get the maximum value among min, preferred, and max (i.e., NaNs excluded)
 double getMaximum()
          This returns the original Max (even if it's NaN)
 double getMaximumProb()
           
 double getMin()
          Get the minimum value (on X axis) among min, preferred, and max (i.e., NaNs excluded)
 double getMinimum()
          This returns the original Min (even if it's NaN)
 double getMinimumProb()
           
 String getName()
          Get the name.
 double getPreferred()
           
 double getPreferredProb()
           
 String toString()
           
 
Methods inherited from class org.opensha.commons.data.estimate.Estimate
getCDF_Test, getCDF_TestUsingFractile, getComments, getFractile, getMean, getMedian, getMode, getPDF_Test, getProbLessThanEqual, getStdDev, getUnits, isNegativeValuePresent, setComments, setUnits
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NAME

public static final String NAME
See Also:
Constant Field Values
Constructor Detail

MinMaxPrefEstimate

public MinMaxPrefEstimate(double min,
                          double max,
                          double pref,
                          double minProb,
                          double maxProb,
                          double prefProb)
Parameters:
min -
max -
pref -
minProb -
maxProb -
prefProb -
Method Detail

toString

public String toString()
Overrides:
toString in class Estimate

getMinimum

public double getMinimum()
This returns the original Min (even if it's NaN)

Returns:
double

getMaximum

public double getMaximum()
This returns the original Max (even if it's NaN)

Returns:
double

getPreferred

public double getPreferred()

getMinimumProb

public double getMinimumProb()

getMaximumProb

public double getMaximumProb()

getPreferredProb

public double getPreferredProb()

getMax

public double getMax()
Get the maximum value among min, preferred, and max (i.e., NaNs excluded)

Overrides:
getMax in class Estimate
Returns:
maximum value (on X axis)

getMin

public double getMin()
Get the minimum value (on X axis) among min, preferred, and max (i.e., NaNs excluded)

Overrides:
getMin in class Estimate
Returns:
minimum value (on X axis)

getName

public String getName()
Description copied from class: Estimate
Get the name. this is the name displayed to the user in the estimate type chooser.

Specified by:
getName in class Estimate
Returns: