CalcConfig.Hazard (nshmp-haz)

java.lang.Object
- gov.usgs.earthquake.nshmp.calc.CalcConfig.Hazard

Enclosing class:: CalcConfig

public static final class CalcConfig.Hazard
extends Object

Hazard calculation configuration.

Field Summary

Fields
Modifier and Type	Field and Description
`ExceedanceModel`	`exceedanceModel` The probability distribution model to use when computing hazard curves.
`double`	`gmmDampingRatio` Viscous damping ratio.
`boolean`	`gmmDampingSigma` Whether or not `GroundMotionModel` (GMM) sigmas are also modified according to the Rezaeian et al.
`List<GmmPostProcessor.Model>`	`gmmPostProcessors` The post processors used to adjust ground motions derived from `GroundMotionModel`s (GMMs).
`boolean`	`gmmUncertainty` Whether to consider additional ground motion model uncertainty, or not.
`Set<Imt>`	`imts` The `Set` of IMTs for which calculations should be performed.
`double`	`truncationLevel` The number of standard deviations (σ) at which to truncate a distribution.
`ValueFormat`	`valueFormat` The value format for hazard curves.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<Imt,XySequence>`	`logModelCurves()` An immutable map of model curves where x-values are in natural-log space.
`XySequence`	`modelCurve(Imt imt)` An empty linear curve for the requested `Imt`.
`Map<Imt,XySequence>`	`modelCurves()` An immutable map of model curves where x-values are in linear space.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - exceedanceModel
```
public final ExceedanceModel exceedanceModel
```
    The probability distribution model to use when computing hazard curves.
    Default: ExceedanceModel.TRUNCATION_UPPER_ONLY
  - truncationLevel
```
public final double truncationLevel
```
    The number of standard deviations (σ) at which to truncate a distribution. This field is ignored if an ExceedanceModel does not implement truncation.
    Default: 3.0
  - imts
```
public final Set<Imt> imts
```
    The Set of IMTs for which calculations should be performed.
    Default: [Imt.PGA, Imt.SA0P2, Imt.SA1P0 ]
  - gmmPostProcessors
```
public final List<GmmPostProcessor.Model> gmmPostProcessors
```
    The post processors used to adjust ground motions derived from GroundMotionModels (GMMs). The models may apply corrections or scale factors to GMM-derived μ- and σ-values. For example, see RezaeianDamping_2014. If multiple post processors are specified, they are executed in the order listed.
    Default: [ (empty) ]
  - gmmDampingRatio
```
public final double gmmDampingRatio
```
    Viscous damping ratio. The default value is consistent with that used in GroundMotionModel most (GMM) development. Values other than 5% will apply a damping scale factor (DSF) to adjust the 5% damped spectral ordinates predicted by GMMs.
    Default: 5.0%
    Range: 0.5% to 30.0%
    Note: At this time, the damping scaling factor (DSF) model (Rezaeian et al., 2014) is only applicable to active continental crust GMMs and will not be applied to ground motion values from GMMs for other tectonic regions.
    
    See Also:
    
    RezaeianDamping_2014
  - gmmDampingSigma
```
public final boolean gmmDampingSigma
```
    Whether or not GroundMotionModel (GMM) sigmas are also modified according to the Rezaeian et al. (2014) model when applying damping scaling factors (DSF).
  - gmmUncertainty
```
public final boolean gmmUncertainty
```
    Whether to consider additional ground motion model uncertainty, or not. Currently this is only applicable when using the PEER NGA-West or NGA-West2 Gmms with USGS hazard models.
    Default: false
  - valueFormat
```
public final ValueFormat valueFormat
```
    The value format for hazard curves.
    Default: ValueFormat.ANNUAL_RATE
- Method Detail
  - modelCurve
```
public XySequence modelCurve(Imt imt)
```
    An empty linear curve for the requested Imt.
    
    Parameters:
    
    imt - to get curve for
    
    See Also:
    
    defaults
  - modelCurves
```
public Map<Imt,XySequence> modelCurves()
```
    An immutable map of model curves where x-values are in linear space. In the absence of specific values being provided in a config file, the following defaults are used:
    PGA and SA: [0.0025, 0.0045, 0.0075, 0.0113, 0.0169, 0.0253, 0.0380, 0.0570, 0.0854, 0.128, 0.192, 0.288, 0.432, 0.649, 0.973, 1.46, 2.19, 3.28, 4.92, 7.38]
    PGV: [0.0100, 0.0177, 0.0312, 0.0552, 0.0976, 0.173, 0.305, 0.539, 0.953, 1.68, 2.98, 5.26, 9.30, 16.4, 29.1, 51.3, 90.8, 160, 284, 501]
  - logModelCurves
```
public Map<Imt,XySequence> logModelCurves()
```
    An immutable map of model curves where x-values are in natural-log space.
    
    See Also:
    
    linear space defaults

Class CalcConfig.Hazard

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

exceedanceModel

truncationLevel

imts

gmmPostProcessors

gmmDampingRatio

gmmDampingSigma

gmmUncertainty

valueFormat

Method Detail

modelCurve

modelCurves

logModelCurves