public final class HazardModel extends Object implements Iterable<SourceSet<? extends Source>>, Named
HazardModel is the top-level wrapper for earthquake Source
definitions and attendant GroundMotionModels used in probabilisitic
seismic hazard analyses (PSHAs) and related calculations. A
HazardModel contains of a number of SourceSets that define
logical groupings of sources by SourceType. Each SourceSet
carries with it references to the GroundMotionModels and associated
weights to be used when evaluating hazard.Source,
SourceSet,
SourceType| Modifier and Type | Method and Description |
|---|---|
CalcConfig |
config()
Return the default calculation configuration.
|
Set<Gmm> |
gmms()
The set of
Gmms used by this model. |
Iterator<SourceSet<? extends Source>> |
iterator() |
static HazardModel |
load(Path path)
Load a
HazardModel from a directory or Zip file specified by the
supplied path. |
String |
name()
Returns an object's display name.
|
int |
size()
The number of
SourceSets in this HazardModel. |
String |
toString() |
Set<SourceType> |
types()
The set of
SourceTypes included in this model. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitforEach, spliteratorpublic static HazardModel load(Path path) throws SAXException, IOException
HazardModel from a directory or Zip file specified by the
supplied path.
For more information on a HazardModel directory and file structure, see the nshmp-haz wiki.
Notes: HazardModel loading is not thread safe. There are also a wide variety of exceptions that may be encountered when loading a model. Exceptions are generally logged and propagated back to calling application to handle termination.
path - to HazardModel directory or Zip fileHazardModelSAXExceptionIOExceptionpublic int size()
SourceSets in this HazardModel.public String name()
Namedpublic Set<SourceType> types()
SourceTypes included in this model.public CalcConfig config()