org.opensha.nshmp.sha.calc.api
Interface HazardDataCalcAPI

All Superinterfaces:
Remote
All Known Implementing Classes:
HazardDataCalc

public interface HazardDataCalcAPI
extends Remote

Title: HazardDataCalcAPI

Description: This interface defines functions that HazardDataCalc muct provide for Hazard Data calculations. It extends Remote as any class implementing this interface can provide a server implemenation of all the functionality.

Version:
1.0
Author:
Ned Field, Nitin Gupta and Vipin Gupta

Method Summary
 XY_DataSetList computeApproxUHSpectrum(ArbitrarilyDiscretizedFunc function)
           
 double computeExceedProb(double fex, double expTime)
           
 ArbitrarilyDiscretizedFunc computeHazardCurve(String selectedRegion, String selectedEdition, double latitude, double longitude, String hazCurveType)
           
 ArbitrarilyDiscretizedFunc computeHazardCurve(String selectedRegion, String selectedEdition, String zipCode, String hazCurveType)
           
 XY_DataSetList computeMapSpectrum(ArbitrarilyDiscretizedFunc function)
           
 double computeReturnPeriod(double exceedProb, double expTime)
           
 XY_DataSetList computeSA(String selectedRegion, String selectedEdition, double latitude, double longitude, String spectraType)
          Used for getting the SA values for the UHS
 XY_DataSetList computeSA(String selectedRegion, String selectedEdition, String zipCode, String spectraType)
          Used for getting the SA values for the UHS
 XY_DataSetList computeSD_UHSpectrum(ArbitrarilyDiscretizedFunc function, float fa, float fv, String siteClass)
           
 XY_DataSetList computeSDSpectrum(ArbitrarilyDiscretizedFunc function, float fa, float fv, String siteClass, String edition)
           
 ArbitrarilyDiscretizedFunc computeSDSsS1(ArbitrarilyDiscretizedFunc function, float fa, float fv, String siteClass)
           
 ArbitrarilyDiscretizedFunc computeSDSsS1(String edition, String region, String zipCode, String siteClass)
           
 XY_DataSetList computeSM_UHSpectrum(ArbitrarilyDiscretizedFunc function, float fa, float fv, String siteClass)
           
 XY_DataSetList computeSMSpectrum(ArbitrarilyDiscretizedFunc function, float fa, float fv, String siteClass, String edition)
           
 ArbitrarilyDiscretizedFunc computeSMSsS1(ArbitrarilyDiscretizedFunc function, float fa, float fv, String siteClass)
           
 ArbitrarilyDiscretizedFunc computeSMSsS1(String edition, String region, String zipCode, String siteClass)
           
 ArbitrarilyDiscretizedFunc computeSsS1(String selectedRegion)
           
 ArbitrarilyDiscretizedFunc computeSsS1(String selectedRegion, String selectedEdition, double latitude, double longitude)
           
 ArbitrarilyDiscretizedFunc computeSsS1(String selectedRegion, String selectedEdition, double latitude, double longitude, String spectraType)
           
 ArbitrarilyDiscretizedFunc computeSsS1(String selectedRegion, String selectedEdition, String zipCode)
           
 ArbitrarilyDiscretizedFunc computeSsS1(String selectedRegion, String selectedEdition, String zipCode, String spectraType)
           
 

Method Detail

computeExceedProb

double computeExceedProb(double fex,
                         double expTime)
                         throws RemoteException
Parameters:
hazardCurveFunction - ArbitrarilyDiscretizedFunc
fex - double Frequency of exceedance = 1/ReturnPd
expTime - double
Returns:
double
Throws:
RemoteException

computeReturnPeriod

double computeReturnPeriod(double exceedProb,
                           double expTime)
                           throws RemoteException
Parameters:
exceedProb - double
expTime - double
Returns:
double
Throws:
RemoteException

computeHazardCurve

ArbitrarilyDiscretizedFunc computeHazardCurve(String selectedRegion,
                                              String selectedEdition,
                                              double latitude,
                                              double longitude,
                                              String hazCurveType)
                                              throws RemoteException
Parameters:
selectedRegion - String
selectedEdition - String
latitude - double
longitude - double
Returns:
ArbitrarilyDiscretizedFunc
Throws:
RemoteException

computeHazardCurve

ArbitrarilyDiscretizedFunc computeHazardCurve(String selectedRegion,
                                              String selectedEdition,
                                              String zipCode,
                                              String hazCurveType)
                                              throws ZipCodeErrorException,
                                                     RemoteException
Parameters:
selectedRegion - String
selectedEdition - String
zipCode - String
Returns:
ArbitrarilyDiscretizedFunc
Throws:
ZipCodeErrorException
RemoteException

computeSsS1

ArbitrarilyDiscretizedFunc computeSsS1(String selectedRegion,
                                       String selectedEdition,
                                       double latitude,
                                       double longitude)
                                       throws RemoteException
Parameters:
selectedRegion - String
selectedEdition - String
latitude - double
longitude - double
Returns:
ArbitrarilyDiscretizedFunc
Throws:
RemoteException

computeSsS1

ArbitrarilyDiscretizedFunc computeSsS1(String selectedRegion,
                                       String selectedEdition,
                                       double latitude,
                                       double longitude,
                                       String spectraType)
                                       throws RemoteException
Parameters:
selectedRegion - String
selectedEdition - String
latitude - double
longitude - double
Returns:
ArbitrarilyDiscretizedFunc
Throws:
RemoteException

computeSA

XY_DataSetList computeSA(String selectedRegion,
                         String selectedEdition,
                         double latitude,
                         double longitude,
                         String spectraType)
                         throws RemoteException
Used for getting the SA values for the UHS

Parameters:
selectedRegion - String
selectedEdition - String
latitude - double
longitude - double
spectraType - String
Returns:
DiscretizedFuncList
Throws:
RemoteException

computeSA

XY_DataSetList computeSA(String selectedRegion,
                         String selectedEdition,
                         String zipCode,
                         String spectraType)
                         throws ZipCodeErrorException,
                                RemoteException
Used for getting the SA values for the UHS

Parameters:
selectedRegion - String
selectedEdition - String
latitude - double
longitude - double
spectraType - String
Returns:
DiscretizedFuncList
Throws:
ZipCodeErrorException
RemoteException

computeSsS1

ArbitrarilyDiscretizedFunc computeSsS1(String selectedRegion,
                                       String selectedEdition,
                                       String zipCode)
                                       throws ZipCodeErrorException,
                                              RemoteException
Parameters:
selectedRegion - String
selectedEdition - String
zipCode - String
Returns:
DiscretizedFuncList
Throws:
ZipCodeErrorException
RemoteException

computeSsS1

ArbitrarilyDiscretizedFunc computeSsS1(String selectedRegion,
                                       String selectedEdition,
                                       String zipCode,
                                       String spectraType)
                                       throws ZipCodeErrorException,
                                              RemoteException
Parameters:
selectedRegion - String
selectedEdition - String
zipCode - String
Returns:
DiscretizedFuncList
Throws:
ZipCodeErrorException
RemoteException

computeSsS1

ArbitrarilyDiscretizedFunc computeSsS1(String selectedRegion)
                                       throws RemoteException
Parameters:
selectedRegion - String
Returns:
ArbitrarilyDiscretizedFunc
Throws:
RemoteException

computeSMSsS1

ArbitrarilyDiscretizedFunc computeSMSsS1(ArbitrarilyDiscretizedFunc function,
                                         float fa,
                                         float fv,
                                         String siteClass)
                                         throws RemoteException
Parameters:
function - ArbitrarilyDiscretizedFunc
fa - float
fv - float
Returns:
ArbitrarilyDiscretizedFunc
Throws:
RemoteException

computeSMSsS1

ArbitrarilyDiscretizedFunc computeSMSsS1(String edition,
                                         String region,
                                         String zipCode,
                                         String siteClass)
                                         throws RemoteException
Throws:
RemoteException

computeSDSsS1

ArbitrarilyDiscretizedFunc computeSDSsS1(ArbitrarilyDiscretizedFunc function,
                                         float fa,
                                         float fv,
                                         String siteClass)
                                         throws RemoteException
Parameters:
function - ArbitrarilyDiscretizedFunc
fa - float
fv - float
Returns:
ArbitrarilyDiscretizedFunc
Throws:
RemoteException

computeSDSsS1

ArbitrarilyDiscretizedFunc computeSDSsS1(String edition,
                                         String region,
                                         String zipCode,
                                         String siteClass)
                                         throws RemoteException
Parameters:
edition -
region -
zipCode -
siteClass -
Returns:
Throws:
RemoteException

computeMapSpectrum

XY_DataSetList computeMapSpectrum(ArbitrarilyDiscretizedFunc function)
                                  throws RemoteException
Parameters:
function - ArbitrarilyDiscretizedFunc
fa - float
fv - float
Returns:
DiscretizedFuncList
Throws:
RemoteException

computeSMSpectrum

XY_DataSetList computeSMSpectrum(ArbitrarilyDiscretizedFunc function,
                                 float fa,
                                 float fv,
                                 String siteClass,
                                 String edition)
                                 throws RemoteException
Parameters:
function - ArbitrarilyDiscretizedFunc
fa - float
fv - float
Returns:
DiscretizedFuncList
Throws:
RemoteException

computeSDSpectrum

XY_DataSetList computeSDSpectrum(ArbitrarilyDiscretizedFunc function,
                                 float fa,
                                 float fv,
                                 String siteClass,
                                 String edition)
                                 throws RemoteException
Parameters:
function - ArbitrarilyDiscretizedFunc
fa - float
fv - float
Returns:
DiscretizedFuncList
Throws:
RemoteException

computeApproxUHSpectrum

XY_DataSetList computeApproxUHSpectrum(ArbitrarilyDiscretizedFunc function)
                                       throws RemoteException
Parameters:
function - ArbitrarilyDiscretizedFunc
Returns:
DiscretizedFuncList
Throws:
RemoteException

computeSM_UHSpectrum

XY_DataSetList computeSM_UHSpectrum(ArbitrarilyDiscretizedFunc function,
                                    float fa,
                                    float fv,
                                    String siteClass)
                                    throws RemoteException
Parameters:
function - ArbitrarilyDiscretizedFunc
fa - float
fv - float
Returns:
DiscretizedFuncList
Throws:
RemoteException

computeSD_UHSpectrum

XY_DataSetList computeSD_UHSpectrum(ArbitrarilyDiscretizedFunc function,
                                    float fa,
                                    float fv,
                                    String siteClass)
                                    throws RemoteException
Parameters:
function - ArbitrarilyDiscretizedFunc
fa - float
fv - float
Returns:
DiscretizedFuncList
Throws:
RemoteException