gov.usgs.earthquake.nshmp.calc

Class Hazard

java.lang.Object

gov.usgs.earthquake.nshmp.calc.Hazard

public final class Hazard
extends Object

The result of a hazard calculation. This container class is public for reference by external packages but is not directly modifiable, nor its fields accessible. The HazardExport class provides Hazard exporting and processing utilities.

Author:

Peter Powers

See Also:

HazardExport

Method Summary

Modifier and Type	Method and Description
CalcConfig	config() The original configuration used to generate this result.
Map<Imt,XySequence>	curves() The total mean hazard curves for each calculated Imt.
static Hazard	merge(Hazard... hazards) Combine hazard from multiple independent models.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

toString

public String toString()

Overrides:

toString in class Object

curves

public Map<Imt,XySequence> curves()

The total mean hazard curves for each calculated Imt.

config

public CalcConfig config()

The original configuration used to generate this result.

merge

public static Hazard merge(Hazard... hazards)

Combine hazard from multiple independent models. The hazard object returned by this method will only specify a parent 'model' if varargs only included one model.

Note: When combining hazard results, the combined result inherits the CalcConfig from the first model supplied in varargs. This may mean that in the deaggregation of a combined model, the ExceedanceModel used to compute hazard may not be the same as that used to compute source contributions.

Returns:

a combined Hazard that probably has a null parent model. If only 1 Hazard is supplied, method returns that supplied.