org.opensha.sha.earthquake.griddedForecast
Class AfterShockHypoMagFreqDistForecast

java.lang.Object
  extended by org.opensha.sha.earthquake.griddedForecast.GriddedHypoMagFreqDistForecast
      extended by org.opensha.sha.earthquake.griddedForecast.AfterShockHypoMagFreqDistForecast
All Implemented Interfaces:
Serializable, Comparable<BaseERF>, EventListener, Named, ParameterChangeListener, BaseERF, HypoMagFreqDistAtMultLocsAPI
Direct Known Subclasses:
STEP_AftershockForecast, STEP_CombineForecastModels

public abstract class AfterShockHypoMagFreqDistForecast
extends GriddedHypoMagFreqDistForecast

Title: AfterShockHypoMagFreqDistForecast

Description: This class represents a poissonian aftershock hypocenter forecast. The indexing over HypMagFreqDistAtLoc objects is exactly the same as the EvenlyGriddedGeographicRegionAPI afterShockZone.

Version:
1.0
Author:
Nitin Gupta, Vipin Gupta and Edward (Ned) Field
See Also:
Serialized Form

Field Summary
protected  ObsEqkRupList afterShocks
           
protected  ObsEqkRupture mainShock
           
 
Fields inherited from class org.opensha.sha.earthquake.griddedForecast.GriddedHypoMagFreqDistForecast
parameterChangeFlag, region
 
Fields inherited from interface org.opensha.sha.earthquake.BaseERF
NAME
 
Constructor Summary
AfterShockHypoMagFreqDistForecast()
          Class no-arg constructor
 
Method Summary
 void addToAftershockList(ObsEqkRupture newAftershock)
          addToAftershockList
 ObsEqkRupList getAfterShocks()
          Gets the Aftershock list for the forecast model.
 GriddedRegion getAfterShockZone()
          Allows the user to set the AfterShockZone as EvelyGriddedGeographicRegion.
 ObsEqkRupture getMainShock()
          Returns the main shock
 void setAfterShocks(ObsEqkRupList aftershockList)
          Sets the list of ObsEqkRuptures for the given AfterShockHypoMagFreqDistForecast.
 void setMainShock(ObsEqkRupture mainShock)
          Sets the mainshock event for the given forecast model.
 
Methods inherited from class org.opensha.sha.earthquake.griddedForecast.GriddedHypoMagFreqDistForecast
compareTo, getAdjustableParameterList, getAdjustableParamsIterator, getApplicableRegion, getIncludedTectonicRegionTypes, getName, getNumHypoLocs, getRegion, getTimeSpan, parameterChange, setParameter, setRegion, setTimeSpan, timeSpanChange, updateAndSaveForecast, updateForecast
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.opensha.sha.earthquake.griddedForecast.HypoMagFreqDistAtMultLocsAPI
getHypoMagFreqDistAtLoc
 

Field Detail

mainShock

protected ObsEqkRupture mainShock

afterShocks

protected ObsEqkRupList afterShocks
Constructor Detail

AfterShockHypoMagFreqDistForecast

public AfterShockHypoMagFreqDistForecast()
Class no-arg constructor

Method Detail

getAfterShocks

public ObsEqkRupList getAfterShocks()
Gets the Aftershock list for the forecast model.

Returns:
ObsEqkRupList

getAfterShockZone

public GriddedRegion getAfterShockZone()
Allows the user to set the AfterShockZone as EvelyGriddedGeographicRegion.

Returns:
EvenlyGriddedGeographicRegionAPI AfterShockZone.

getMainShock

public ObsEqkRupture getMainShock()
Returns the main shock

Returns:
ObsEqkRupture

setAfterShocks

public void setAfterShocks(ObsEqkRupList aftershockList)
Sets the list of ObsEqkRuptures for the given AfterShockHypoMagFreqDistForecast.

Parameters:
afterShocks - ObsEqkRupList

addToAftershockList

public void addToAftershockList(ObsEqkRupture newAftershock)
addToAftershockList


setMainShock

public void setMainShock(ObsEqkRupture mainShock)
Sets the mainshock event for the given forecast model.

Parameters:
mainShock - ObsEqkRupture