gov.usgs.earthquake.nshmp.calc

Class Deaggregation

java.lang.Object

gov.usgs.earthquake.nshmp.calc.Deaggregation

public final class Deaggregation
extends Object

Hazard deaggregation. Given a Hazard result, this class will deaggregate the results at all spectral periods supplied in the result at an intensity measure level or return period of interest.

Author:

Peter Powers

Method Summary

Modifier and Type	Method and Description
static Deaggregation	atIml(Hazard hazard, double iml, Executor exec) Deaggregate hazard at the supplied intensity measure level.
static Deaggregation	atImls(Hazard hazard, Map<Imt,Double> imtImls, Executor exec) Experimental: Deaggregate hazard at a unique intensity measure level for each IMT.
static Deaggregation	atReturnPeriod(Hazard hazard, double returnPeriod, Executor exec) Deaggregate hazard at the intensity measure level corresponding to the supplied returnPeriod.
Object	toJson(Imt imt) Returns an object containing deaggregation results that is suitable for JSON serialization.
Object	toJsonCompact(Imt imt) Deprecated.
String	toString()
Object	εBins() Returns an object containing epsilon bin data suitable for JSON serialization.

Methods inherited from class java.lang.Object

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

Method Detail

atReturnPeriod

public static Deaggregation atReturnPeriod(Hazard hazard,
                                           double returnPeriod,
                                           Executor exec)

Deaggregate hazard at the intensity measure level corresponding to the supplied returnPeriod. Only a single Imt will be processed if supplied.

Parameters:

hazard - to deaggregate.

returnPeriod - at which to deaggregate hazard

deaggImt - to deaggregate; deaggregate all if empty()

atIml

public static Deaggregation atIml(Hazard hazard,
                                  double iml,
                                  Executor exec)

Deaggregate hazard at the supplied intensity measure level. Only a single Imt will be processed if supplied.

Parameters:

hazard - to deaggregate.

iml - intensity measure level at which to deaggregate hazard

deaggImt - to deaggregate; deaggregate all if empty()

atImls

public static Deaggregation atImls(Hazard hazard,
                                   Map<Imt,Double> imtImls,
                                   Executor exec)

Experimental: Deaggregate hazard at a unique intensity measure level for each IMT. Assumes hazard contains results for each IMT identified in the imtImls map.

Parameters:

hazard - to deaggregate.

imtImls - per-IMT intensity measure levels at which to deaggregate hazard

toString

public String toString()

Overrides:

toString in class Object

toJson

public Object toJson(Imt imt)

Returns an object containing deaggregation results that is suitable for JSON serialization.

Parameters:

imt - of the deaggregation to retrieve.

toJsonCompact

@Deprecated
public Object toJsonCompact(Imt imt)

Deprecated.

Experimental

εBins

public Object εBins()

Returns an object containing epsilon bin data suitable for JSON serialization. This is exposed independent of JSON serialization of as web services may need this metadata independent of deaggregation results.