org.opensha.sha.earthquake
Interface ERF

All Superinterfaces:

BaseERF, Comparable<BaseERF>, Iterable<ProbEqkSource>, Named, Serializable

All Known Implementing Classes:

AbstractERF, ClusterERF, CyberShakeERF, CyberShakeUCERFWrapper_ERF, FakeFrankel96, FaultERF, FloatingPoissonFaultERF, Frankel02_AdjustableEqkRupForecast, Frankel96_AdjustableEqkRupForecast, Frankel96_EqkRupForecast, GEM1_CEUS_ERF, GEM1_GlobalSS_ERF, GEM1_GSHAP_Africa_ERF, GEM1_GSHAP_SE_Asia_ERF, GEM1_NSHMP_SE_Asia_ERF, GEM1_US_ERF, GEM1_WEUS_ERF, GEM1ERF, GEM1ERF, GEM1SouthAmericaERF, GridERF, MeanUCERF2, MeanUCERF2_FM2pt1, MeanUCERF2_FM2pt2, NewZealandERF0909, NSHMP_ERF, NSHMP08_CEUS_ERF, PEER_AreaForecast, PEER_MultiSourceForecast, PEER_NonPlanarFaultForecast, Point2MultVertSS_FaultERF, PointPoissonSourceERF, PointSourceERF, PointToLineSourceERF, PoissonFaultERF, PuenteHillsFaultERF, SingleFaultRuptureERF, STEP_AlaskanPipeForecast, STEP_EqkRupForecast, SubductionERF, TestGEM_ERF, TestSubductionZoneERF, UCERF2, WG02_EqkRupForecast, WGCEP_UCERF1_EqkRupForecast, YuccaMountainERF

public interface ERF
extends BaseERF, Iterable<ProbEqkSource>

This is the base interface for an Earthquake Rupture Forecast

Version:

$Id: ERF.java 8283 2011-10-21 20:44:06Z pmpowers $

Author:

Nitin Gupta, Vipin Gupta

Field Summary

Fields inherited from interface org.opensha.sha.earthquake.BaseERF

NAME

Method Summary

List<EqkRupture>	drawRandomEventSet() Returns a random set of ruptures.
int	getNumRuptures(int idx) Returns the number of ruptures associated wit the source at the supplied index.
int	getNumSources()
ProbEqkRupture	getRupture(int srcIdx, int rupIdx) Returns the rupture at the supplied source index and rupture index.
ProbEqkSource	getSource(int idx) Returns the earthquake source at the supplied index.
List<ProbEqkSource>	getSourceList() Returns the list of all earthquake sources.

Methods inherited from interface org.opensha.sha.earthquake.BaseERF

getAdjustableParameterList, getApplicableRegion, getIncludedTectonicRegionTypes, getTimeSpan, setParameter, setTimeSpan, updateAndSaveForecast, updateForecast

Methods inherited from interface org.opensha.commons.data.Named

getName

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

getNumSources

int getNumSources()

Returns:

the total number os sources

getSourceList

List<ProbEqkSource> getSourceList()

Returns the list of all earthquake sources.

Returns:

list of all possible earthquake sources

getSource

ProbEqkSource getSource(int idx)

Returns the earthquake source at the supplied index.

Parameters:

idx - the index requested

Returns:

the source at idx

getNumRuptures

int getNumRuptures(int idx)

Returns the number of ruptures associated wit the source at the supplied index.

Parameters:

idx - the index requested

Returns:

the number of ruptures associated with the source at idx

getRupture

ProbEqkRupture getRupture(int srcIdx,
                          int rupIdx)

Returns the rupture at the supplied source index and rupture index.

Parameters:

srcIdx - source index requested

rupIdx - rupture index requested

Returns:

the rupture at rupIdx associated with the source at srcIdx

drawRandomEventSet

List<EqkRupture> drawRandomEventSet()

Returns a random set of ruptures.

Returns:

a random set of ruptures