gov.usgs.earthquake.nshmp.calc

Class EqRate

java.lang.Object

gov.usgs.earthquake.nshmp.calc.EqRate

public class EqRate
extends Object

General purpose earthquake rate and probability data container. This class makes no distinction between incremental or cumulative MFDs, or whether values are stored as annual-rate or poisson probability.

Author:

Peter Powers

Field Summary

Fields

Modifier and Type	Field and Description
Site	site The site of interest.
XySequence	totalMfd The total MFD of interest.
Map<SourceType,XySequence>	typeMfds The MFDs for each contributing source type.

Method Summary

Modifier and Type	Method and Description
static Callable<EqRate>	callable(HazardModel model, CalcConfig config, Site site) Wraps create(HazardModel, CalcConfig, Site) in a Callable for processing multiple sites concurrently.
static EqRate	combine(EqRate... rates) Create a new earthquake rate container with the sum of the supplied rates.
static EqRate	create(HazardModel model, CalcConfig config, Site site) Create a new earthquake rate data container at a site for the supplied model and config.
static EqRate	toCumulative(EqRate incremental) Create a new earthquake rate container with cumulative values.
static EqRate	toPoissonProbability(EqRate annualRates, double timespan) Create a new earthquake rate container with Poisson probability values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

site

public final Site site

The site of interest.

totalMfd

public final XySequence totalMfd

The total MFD of interest.

typeMfds

public final Map<SourceType,XySequence> typeMfds

The MFDs for each contributing source type.

Method Detail

create

public static EqRate create(HazardModel model,
                            CalcConfig config,
                            Site site)

Create a new earthquake rate data container at a site for the supplied model and config.

Note: any model initialization settings in config will be ignored as the supplied model will already have been initialized.

Parameters:

model - of interest

config - calculation configuration

site - of interest

callable

public static Callable<EqRate> callable(HazardModel model,
                                        CalcConfig config,
                                        Site site)

Wraps create(HazardModel, CalcConfig, Site) in a Callable for processing multiple sites concurrently.

Parameters:

model - to process

config - calculation configuration

site - of interest

toCumulative

public static EqRate toCumulative(EqRate incremental)

Create a new earthquake rate container with cumulative values.

Parameters:

incremental - rate source to convert

toPoissonProbability

public static EqRate toPoissonProbability(EqRate annualRates,
                                          double timespan)

Create a new earthquake rate container with Poisson probability values.

Parameters:

annualRates - source to convert

timespan - of interest for annual rate to Poisson probability conversion

combine

public static EqRate combine(EqRate... rates)

Create a new earthquake rate container with the sum of the supplied rates.

NOTE: This operation is additive and will produce meaningless results if rates have already been converted to probabilities, or are not all of DistributionFormat.INCREMENTAL or DistributionFormat.CUMULATIVE distribution format.

Buyer beware.

Parameters:

rates - to combine