org.opensha.sha.calc
Interface SpectrumCalculatorAPI

All Known Implementing Classes:
SpectrumCalculator

public interface SpectrumCalculatorAPI


Method Summary
 ParameterList getAdjustableParams()
           
 java.util.ListIterator getAdjustableParamsIterator()
          get the adjustable parameters
 int getCurrRuptures()
           
 DiscretizedFunc getDeterministicSpectrumCurve(Site site, ScalarIMR imr, EqkRupture rupture, boolean probAtIML, double imlProbVal)
          This function computes a deterministic exceedance curve for the given Site, IMR, and ProbEqkrupture.
 DiscretizedFunc getIML_SpectrumCurve(DiscretizedFunc spectrumFunction, Site site, ScalarIMR imr, ERF eqkRupForecast, double probVal, java.util.List supportedSA_Periods)
          This function computes a spectrum curve for all SA Period supported by the IMR and then interpolates the IML value from all the computed curves.
 double getMaxSourceDistance()
           
 PtSrcDistCorr.Type getPtSrcDistCorrType()
          This gets the type of point-source distance correction that is desired (see the class PtSrcDistCorr for options)
 DiscretizedFunc getSpectrumCurve(Site site, ScalarIMR imr, ERF eqkRupForecast, double imlVal, java.util.List supportedSA_Periods)
          This function computes a spectrum curve for the given Site, IMR, and ERF.
 int getTotRuptures()
           
 void setAdjustableParams(ParameterList paramList)
           
 void setMaxSourceDistance(double distance)
          This sets the maximum distance of sources to be considered in the calculation (as determined by the getMinDistance(Site) method of ProbEqkSource subclasses).
 void setPtSrcDistCorrType(PtSrcDistCorr.Type ptSrcDistCorrType)
          This sets the type of point-source distance correction that is desired (see the class PtSrcDistCorr for options)
 

Method Detail

getCurrRuptures

int getCurrRuptures()
Returns:
the current rupture being traversed

getDeterministicSpectrumCurve

DiscretizedFunc getDeterministicSpectrumCurve(Site site,
                                              ScalarIMR imr,
                                              EqkRupture rupture,
                                              boolean probAtIML,
                                              double imlProbVal)
This function computes a deterministic exceedance curve for the given Site, IMR, and ProbEqkrupture. The curve in place in the passed in hazFunction (with the X-axis values being the IMLs for which exceedance probabilites are desired).

Parameters:
hazFunction: - This function is where the hazard curve is placed
site: - site object
imr: - selected IMR object
rupture: - Single Earthquake Rupture
Returns:

getIML_SpectrumCurve

DiscretizedFunc getIML_SpectrumCurve(DiscretizedFunc spectrumFunction,
                                     Site site,
                                     ScalarIMR imr,
                                     ERF eqkRupForecast,
                                     double probVal,
                                     java.util.List supportedSA_Periods)
This function computes a spectrum curve for all SA Period supported by the IMR and then interpolates the IML value from all the computed curves. The curve in place in the passed in hazFunction (with the X-axis values being the IMLs for which exceedance probabilites are desired).

Parameters:
specFunction: - This function is where the final interplotaed spectrum for the IML@prob curve is placed.
site: - site object
imr: - selected IMR object
eqkRupForecast: - selected Earthquake rup forecast
Returns:

getSpectrumCurve

DiscretizedFunc getSpectrumCurve(Site site,
                                 ScalarIMR imr,
                                 ERF eqkRupForecast,
                                 double imlVal,
                                 java.util.List supportedSA_Periods)
This function computes a spectrum curve for the given Site, IMR, and ERF. The curve in place in the passed in hazFunction (with the X-axis values being the SA Periods for which exceedance probabilites are desired).

Parameters:
hazFunction: - This function is where the hazard curve is placed
site: - site object
imr: - selected IMR object
eqkRupForecast: - selected Earthquake rup forecast
Returns:

getTotRuptures

int getTotRuptures()
Returns:
the total number of ruptures in the earthquake rupture forecast model

setMaxSourceDistance

void setMaxSourceDistance(double distance)
This sets the maximum distance of sources to be considered in the calculation (as determined by the getMinDistance(Site) method of ProbEqkSource subclasses). Sources more than this distance away are ignored. Default value is 250 km.

Parameters:
distance: - the maximum distance in km

getMaxSourceDistance

double getMaxSourceDistance()

setAdjustableParams

void setAdjustableParams(ParameterList paramList)

getAdjustableParams

ParameterList getAdjustableParams()
Returns:
the adjustable ParameterList

getAdjustableParamsIterator

java.util.ListIterator getAdjustableParamsIterator()
get the adjustable parameters

Returns:

setPtSrcDistCorrType

void setPtSrcDistCorrType(PtSrcDistCorr.Type ptSrcDistCorrType)
This sets the type of point-source distance correction that is desired (see the class PtSrcDistCorr for options)

Parameters:
ptSrcDistCorrType -

getPtSrcDistCorrType

PtSrcDistCorr.Type getPtSrcDistCorrType()
This gets the type of point-source distance correction that is desired (see the class PtSrcDistCorr for options)

Parameters:
ptSrcDistCorrType -