gov.usgs.earthquake.nshmp.eq.model

Class GridSourceSet

java.lang.Object

gov.usgs.earthquake.nshmp.eq.model.GridSourceSet

All Implemented Interfaces:

SourceSet<gov.usgs.earthquake.nshmp.eq.model.PointSource>, Named, Comparable<SourceSet<gov.usgs.earthquake.nshmp.eq.model.PointSource>>, Iterable<gov.usgs.earthquake.nshmp.eq.model.PointSource>

public class GridSourceSet
extends Object

A container class for related, evenly-spaced PointSources with varying magnitudes and/or rates derived from an IncrementalMfd at each grid node.

Author:

Peter Powers

Method Summary

Modifier and Type	Method and Description
int	compareTo(SourceSet<T> other)
Predicate<gov.usgs.earthquake.nshmp.eq.model.PointSource>	distanceFilter(Location loc, double distance) Return a Predicate that evaluates to true if this source is within distance of the supplied Location.
GmmSet	groundMotionModels() Return the GroundMotionModels associated with this SourceSet as a GmmSet.
int	id() A unique integer id.
Iterable<T>	iterableForLocation(Location loc) Return an Iterable over those Sources that are within the cutoff distance of the supplied Location.
Iterable<T>	iterableForLocation(Location loc, double distance) Return an Iterable over those Sources that are within distance of the supplied Location.
Iterator<gov.usgs.earthquake.nshmp.eq.model.PointSource>	iterator()
String	name() Returns an object's display name.
boolean	optimizable() Whether this source set is capable of being optimized.
static Function<GridSourceSet,SourceSet<? extends Source>>	optimizer(Location loc) Create a Function for a location the condenses a GridSourceSet into tabular form (distance, magnitude and azimuth bins) for speedier iteration.
int	size() The number of Sources in this SourceSet.
static String	sizeString(SourceSet<? extends Source> sourceSet, int size) For internal use only.
PointSourceType	sourceType() The PointSource representation used by this source set.
String	toString()
SourceType	type() The SourceType identifier.
double	weight() The weight applicable to this SourceSet.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

type

public SourceType type()

Description copied from interface: SourceSet

The SourceType identifier.

sourceType

public PointSourceType sourceType()

The PointSource representation used by this source set.

optimizable

public boolean optimizable()

Whether this source set is capable of being optimized. There are circumstances under which a grid optimization table can not be built.

size

public int size()

Description copied from interface: SourceSet

The number of Sources in this SourceSet.

sizeString

public static String sizeString(SourceSet<? extends Source> sourceSet,
                                int size)

For internal use only. Public for access outside of package.

distanceFilter

public Predicate<gov.usgs.earthquake.nshmp.eq.model.PointSource> distanceFilter(Location loc,
                                                                                double distance)

Description copied from interface: SourceSet

Return a Predicate that evaluates to true if this source is within distance of the supplied Location. This Predicate performs a quick distance calculation and is used to determine whether this source should be included in a hazard calculation.

Parameters:

loc - Location of interest

distance - limit

iterator

public Iterator<gov.usgs.earthquake.nshmp.eq.model.PointSource> iterator()

optimizer

public static Function<GridSourceSet,SourceSet<? extends Source>> optimizer(Location loc)

Create a Function for a location the condenses a GridSourceSet into tabular form (distance, magnitude and azimuth bins) for speedier iteration.

Parameters:

loc - reference point for table

compareTo

public int compareTo(SourceSet<T> other)

Specified by:

compareTo in interface Comparable<SourceSet<T extends Source>>

name

public String name()

Description copied from interface: Named

Returns an object's display name.

Specified by:

name in interface Named

Returns:

the name

toString

public String toString()

Overrides:

toString in class Object

id

public int id()

Description copied from interface: SourceSet

A unique integer id.

Specified by:

id in interface SourceSet<T extends Source>

weight

public double weight()

Description copied from interface: SourceSet

The weight applicable to this SourceSet.

Specified by:

weight in interface SourceSet<T extends Source>

groundMotionModels

public GmmSet groundMotionModels()

Description copied from interface: SourceSet

Return the GroundMotionModels associated with this SourceSet as a GmmSet.

Specified by:

groundMotionModels in interface SourceSet<T extends Source>

See Also:

GmmSet

iterableForLocation

public Iterable<T> iterableForLocation(Location loc)

Description copied from interface: SourceSet

Return an Iterable over those Sources that are within the cutoff distance of the supplied Location. The cutoff distance is derived from the GroundMotionModels associated with this SourceSet.

Specified by:

iterableForLocation in interface SourceSet<T extends Source>

Parameters:

loc - Location of interest

iterableForLocation

public Iterable<T> iterableForLocation(Location loc,
                                       double distance)

Description copied from interface: SourceSet

Return an Iterable over those Sources that are within distance of the supplied Location.

Specified by:

iterableForLocation in interface SourceSet<T extends Source>

Parameters:

loc - Location of interest

distance - limit