ExceedanceModel (nshmp-haz)

java.lang.Object
- java.lang.Enum<ExceedanceModel>
- - gov.usgs.earthquake.nshmp.calc.ExceedanceModel

All Implemented Interfaces:

Serializable, Comparable<ExceedanceModel>
```
public enum ExceedanceModel
extends Enum<ExceedanceModel>
```
Uncertainty models govern how the values of a complementary cumulative normal distribution (or probability of exceedence) are computed given a mean, μ, standard deviation, σ, and other possibly relevant arguments.
Each model implements methods that compute the probability of exceeding a single value or a XySequence of values. Some arguments are only used by some models; for example, NONE ignores σ, but it must be supplied for consistency. See individual models for details.
Internally, models use a high precision approximation of the Gauss error function (see Abramowitz and Stegun 7.1.26) when computing exceedances.

Author:

Peter Powers

Enum Constant Summary

Enum Constants
Enum Constant and Description
`NONE` No uncertainty.
`NSHM_CEUS_3SIGMA_MAX_INTENSITY` Same as `NSHM_CEUS_MAX_INTENSITY`, except that `n = 3`.
`NSHM_CEUS_MAX_INTENSITY` Model provides `Imt`-dependent maxima and exists to support clamps on ground motions that have historically been applied in the CEUS NSHM due to sometimes unreasonably high ground motions implied by `μ + 3σ`.
`PEER_MIXTURE_MODEL` Model accomodates the heavy tails observed in earthquake data that are not well matched by a purely normal distribution at high ε by combining two distributions (with 50% weight each) created using modulated σ-values (0.8σ and 1.2σ).
`PEER_MIXTURE_REFERENCE` Deprecated.
`TRUNCATION_3SIGMA_UPPER` Fast implementation of upper truncation fixed at 3σ.
`TRUNCATION_LOWER_UPPER` Upper and lower truncation at `μ ± σ * n`.
`TRUNCATION_OFF` No truncation.
`TRUNCATION_UPPER_ONLY` Upper truncation only at `μ + σ * n`.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static ExceedanceModel`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ExceedanceModel[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - NONE
```
public static final ExceedanceModel NONE
```
    No uncertainty. Any σ supplied to methods is ignored yielding a complementary unit step function for a range of values spanning μ.
    Model ignores σ, truncation level,n, and imt.
  - TRUNCATION_OFF
```
public static final ExceedanceModel TRUNCATION_OFF
```
    No truncation.
    Model ignores truncation level, n, and imt.
  - TRUNCATION_UPPER_ONLY
```
public static final ExceedanceModel TRUNCATION_UPPER_ONLY
```
    Upper truncation only at μ + σ * n.
    Model ignores imt.
  - TRUNCATION_LOWER_UPPER
```
public static final ExceedanceModel TRUNCATION_LOWER_UPPER
```
    Upper and lower truncation at μ ± σ * n.
    Model ignores imt.
  - TRUNCATION_3SIGMA_UPPER
```
public static final ExceedanceModel TRUNCATION_3SIGMA_UPPER
```
    Fast implementation of upper truncation fixed at 3σ.
    Model ignores truncation level, n, and imt.
  - PEER_MIXTURE_REFERENCE
```
@Deprecated
public static final ExceedanceModel PEER_MIXTURE_REFERENCE
```
    Deprecated.
  - PEER_MIXTURE_MODEL
```
public static final ExceedanceModel PEER_MIXTURE_MODEL
```
    Model accomodates the heavy tails observed in earthquake data that are not well matched by a purely normal distribution at high ε by combining two distributions (with 50% weight each) created using modulated σ-values (0.8σ and 1.2σ). Model does not impose any truncation.
    Model ignores truncation level, n, and imt.
  - NSHM_CEUS_MAX_INTENSITY
```
public static final ExceedanceModel NSHM_CEUS_MAX_INTENSITY
```
    Model provides Imt-dependent maxima and exists to support clamps on ground motions that have historically been applied in the CEUS NSHM due to sometimes unreasonably high ground motions implied by μ + 3σ. Model imposes one-sided (upper) truncation at μ + nσ if clamp is not exceeded.
  - NSHM_CEUS_3SIGMA_MAX_INTENSITY
```
public static final ExceedanceModel NSHM_CEUS_3SIGMA_MAX_INTENSITY
```
    Same as NSHM_CEUS_MAX_INTENSITY, except that n = 3.
    Model ignores truncation level, n, and imt.
- Method Detail
  - values
```
public static ExceedanceModel[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ExceedanceModel c : ExceedanceModel.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ExceedanceModel valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum ExceedanceModel

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NONE

TRUNCATION_OFF

TRUNCATION_UPPER_ONLY

TRUNCATION_LOWER_UPPER

TRUNCATION_3SIGMA_UPPER

PEER_MIXTURE_REFERENCE

PEER_MIXTURE_MODEL

NSHM_CEUS_MAX_INTENSITY

NSHM_CEUS_3SIGMA_MAX_INTENSITY

Method Detail

values

valueOf