org.opensha.nshmp.sha.data
Class HazardDataMiner

java.lang.Object
  extended by org.opensha.nshmp.sha.data.HazardDataMiner
All Implemented Interfaces:
HazardDataMinerAPI

public class HazardDataMiner
extends Object
implements HazardDataMinerAPI

Title: HazardDataMiner

Description: This class computes the Ss and S1 based on the location inputs provided by the user in the application.

Version:
1.0
Author:
Ned Field, Nitin Gupta and E.V.Leyendecker

Constructor Summary
HazardDataMiner()
          Class default constructor
 
Method Summary
 XY_DataSetList getApprox_UHSpectrum(ArbitrarilyDiscretizedFunc func)
           
 ArbitrarilyDiscretizedFunc getBasicHazardcurve(String geographicRegion, String dataEdition, double lat, double lon, String hazCurveType)
          Gets the Basic Hazard Curve using the Lat and Lon
 ArbitrarilyDiscretizedFunc getBasicHazardcurve(String geographicRegion, String dataEdition, String zipCode, String hazCurveType)
          Gets the Basic Hazard Curve using the Lat and Lon
 double getExceedProb(double fex, double expTime)
           
 XY_DataSetList getMapSpectrum(ArbitrarilyDiscretizedFunc func)
           
 double getReturnPeriod(double exceedProb, double expTime)
           
 XY_DataSetList getSA(String geographicRegion, String dataEdition, double lat, double lon, String selectedSpectraType)
           
 XY_DataSetList getSA(String geographicRegion, String dataEdition, String zipCode, String spectraType)
          Gets the Ss and S1 when location is provided using the zipCode
 XY_DataSetList getSD_UHSpectrum(ArbitrarilyDiscretizedFunc func, float fa, float fv, String siteClass)
           
 XY_DataSetList getSDSpectrum(ArbitrarilyDiscretizedFunc func, float fa, float fv, String siteClass, String edition)
           
 ArbitrarilyDiscretizedFunc getSDSsS1(ArbitrarilyDiscretizedFunc func, float fa, float fv, String siteClass)
           
 ArbitrarilyDiscretizedFunc getSDSsS1(String edition, String region, String zipCode, String siteClass)
           
 XY_DataSetList getSM_UHSpectrum(ArbitrarilyDiscretizedFunc func, float fa, float fv, String siteClass)
           
 XY_DataSetList getSMSpectrum(ArbitrarilyDiscretizedFunc func, float fa, float fv, String siteClass, String edition)
           
 ArbitrarilyDiscretizedFunc getSMSsS1(ArbitrarilyDiscretizedFunc func, float fa, float fv, String siteClass)
           
 ArbitrarilyDiscretizedFunc getSMSsS1(String edition, String region, String zipCode, String siteClass)
           
 ArbitrarilyDiscretizedFunc getSsS1(String geographicRegion)
          Gets the Ss and S1 when geographic region provided is a territory.
 ArbitrarilyDiscretizedFunc getSsS1(String geographicRegion, String dataEdition, double lat, double lon)
          Gets the Ss and S1 when location is provided using the Lat and Lon
 ArbitrarilyDiscretizedFunc getSsS1(String geographicRegion, String dataEdition, double lat, double lon, String selectedSpectraType)
           
 ArbitrarilyDiscretizedFunc getSsS1(String geographicRegion, String dataEdition, String zipCode)
          Gets the Ss and S1 when location is provided using the zipCode
 ArbitrarilyDiscretizedFunc getSsS1(String geographicRegion, String dataEdition, String zipCode, String spectraType)
          Gets the Ss and S1 when location is provided using the zipCode
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HazardDataMiner

public HazardDataMiner()
Class default constructor

Method Detail

getExceedProb

public double getExceedProb(double fex,
                            double expTime)
                     throws RemoteException
Specified by:
getExceedProb in interface HazardDataMinerAPI
Parameters:
hazardCurveFunction - ArbitrarilyDiscretizedFunc
fex - double Frequency of exceedance = 1/ReturnPd
expTime - double
Returns:
double
Throws:
RemoteException

getReturnPeriod

public double getReturnPeriod(double exceedProb,
                              double expTime)
                       throws RemoteException
Specified by:
getReturnPeriod in interface HazardDataMinerAPI
Parameters:
exceedProb - double
expTime - double
Returns:
double
Throws:
RemoteException

getBasicHazardcurve

public ArbitrarilyDiscretizedFunc getBasicHazardcurve(String geographicRegion,
                                                      String dataEdition,
                                                      double lat,
                                                      double lon,
                                                      String hazCurveType)
                                               throws RemoteException
Gets the Basic Hazard Curve using the Lat and Lon

Specified by:
getBasicHazardcurve in interface HazardDataMinerAPI
Parameters:
geographicRegion - String
dataEdition - String
lat - double
lon - double
Returns:
ArbitrarilyDiscretizedFunc
Throws:
RemoteException

getBasicHazardcurve

public ArbitrarilyDiscretizedFunc getBasicHazardcurve(String geographicRegion,
                                                      String dataEdition,
                                                      String zipCode,
                                                      String hazCurveType)
                                               throws ZipCodeErrorException,
                                                      RemoteException
Gets the Basic Hazard Curve using the Lat and Lon

Specified by:
getBasicHazardcurve in interface HazardDataMinerAPI
Parameters:
geographicRegion - String
dataEdition - String
zipCode - String
Returns:
DiscretizedFuncList
Throws:
ZipCodeErrorException
RemoteException

getSsS1

public ArbitrarilyDiscretizedFunc getSsS1(String geographicRegion,
                                          String dataEdition,
                                          double lat,
                                          double lon)
                                   throws RemoteException
Gets the Ss and S1 when location is provided using the Lat and Lon

Specified by:
getSsS1 in interface HazardDataMinerAPI
Parameters:
geographicRegion - String
dataEdition - String
lat - double
lon - double
Returns:
ArbitrarilyDiscretizedFunc
Throws:
RemoteException

getSsS1

public ArbitrarilyDiscretizedFunc getSsS1(String geographicRegion,
                                          String dataEdition,
                                          double lat,
                                          double lon,
                                          String selectedSpectraType)
                                   throws RemoteException
Specified by:
getSsS1 in interface HazardDataMinerAPI
Parameters:
geographicRegion - String
dataEdition - String
lat - double
lon - double
selectedSpectraType - String
Returns:
ArbitrarilyDiscretizedFunc
Throws:
RemoteException

getSA

public XY_DataSetList getSA(String geographicRegion,
                            String dataEdition,
                            double lat,
                            double lon,
                            String selectedSpectraType)
                     throws RemoteException
Specified by:
getSA in interface HazardDataMinerAPI
Parameters:
geographicRegion - String
dataEdition - String
lat - double
lon - double
selectedSpectraType - String
Returns:
DiscretizedFuncList
Throws:
RemoteException

getSA

public XY_DataSetList getSA(String geographicRegion,
                            String dataEdition,
                            String zipCode,
                            String spectraType)
                     throws ZipCodeErrorException,
                            RemoteException
Gets the Ss and S1 when location is provided using the zipCode

Specified by:
getSA in interface HazardDataMinerAPI
Parameters:
geographicRegion - String
dataEdition - String
zipCode - String
Returns:
DiscretizedFuncList
Throws:
ZipCodeErrorException
RemoteException

getSsS1

public ArbitrarilyDiscretizedFunc getSsS1(String geographicRegion,
                                          String dataEdition,
                                          String zipCode,
                                          String spectraType)
                                   throws ZipCodeErrorException,
                                          RemoteException
Gets the Ss and S1 when location is provided using the zipCode

Specified by:
getSsS1 in interface HazardDataMinerAPI
Parameters:
geographicRegion - String
dataEdition - String
zipCode - String
Returns:
DiscretizedFuncList
Throws:
ZipCodeErrorException
RemoteException

getSsS1

public ArbitrarilyDiscretizedFunc getSsS1(String geographicRegion,
                                          String dataEdition,
                                          String zipCode)
                                   throws ZipCodeErrorException,
                                          RemoteException
Gets the Ss and S1 when location is provided using the zipCode

Specified by:
getSsS1 in interface HazardDataMinerAPI
Parameters:
geographicRegion - String
dataEdition - String
zipCode - String
Returns:
DiscretizedFuncList
Throws:
ZipCodeErrorException
RemoteException

getSsS1

public ArbitrarilyDiscretizedFunc getSsS1(String geographicRegion)
                                   throws RemoteException
Gets the Ss and S1 when geographic region provided is a territory.

Specified by:
getSsS1 in interface HazardDataMinerAPI
Parameters:
geographicRegion - String
Returns:
ArbitrarilyDiscretizedFunc
Throws:
RemoteException

getSDSsS1

public ArbitrarilyDiscretizedFunc getSDSsS1(ArbitrarilyDiscretizedFunc func,
                                            float fa,
                                            float fv,
                                            String siteClass)
                                     throws RemoteException
Specified by:
getSDSsS1 in interface HazardDataMinerAPI
Parameters:
func - ArbitrarilyDiscretizedFunc
fa - double
fv - double
Returns:
ArbitrarilyDiscretizedFunc
Throws:
RemoteException

getSDSsS1

public ArbitrarilyDiscretizedFunc getSDSsS1(String edition,
                                            String region,
                                            String zipCode,
                                            String siteClass)
                                     throws RemoteException
Specified by:
getSDSsS1 in interface HazardDataMinerAPI
Throws:
RemoteException

getSMSsS1

public ArbitrarilyDiscretizedFunc getSMSsS1(ArbitrarilyDiscretizedFunc func,
                                            float fa,
                                            float fv,
                                            String siteClass)
                                     throws RemoteException
Specified by:
getSMSsS1 in interface HazardDataMinerAPI
Parameters:
func - ArbitrarilyDiscretizedFunc
fa - double
fv - double
Returns:
ArbitrarilyDiscretizedFunc
Throws:
RemoteException

getSMSsS1

public ArbitrarilyDiscretizedFunc getSMSsS1(String edition,
                                            String region,
                                            String zipCode,
                                            String siteClass)
                                     throws RemoteException
Specified by:
getSMSsS1 in interface HazardDataMinerAPI
Throws:
RemoteException

getSMSpectrum

public XY_DataSetList getSMSpectrum(ArbitrarilyDiscretizedFunc func,
                                    float fa,
                                    float fv,
                                    String siteClass,
                                    String edition)
                             throws RemoteException
Specified by:
getSMSpectrum in interface HazardDataMinerAPI
Parameters:
func - ArbitrarilyDiscretizedFunc
fa - double
fv - double
Returns:
DiscretizedFuncList
Throws:
RemoteException

getSDSpectrum

public XY_DataSetList getSDSpectrum(ArbitrarilyDiscretizedFunc func,
                                    float fa,
                                    float fv,
                                    String siteClass,
                                    String edition)
                             throws RemoteException
Specified by:
getSDSpectrum in interface HazardDataMinerAPI
Parameters:
func - ArbitrarilyDiscretizedFunc
fa - double
fv - double
Returns:
DiscretizedFuncList
Throws:
RemoteException

getMapSpectrum

public XY_DataSetList getMapSpectrum(ArbitrarilyDiscretizedFunc func)
                              throws RemoteException
Specified by:
getMapSpectrum in interface HazardDataMinerAPI
Parameters:
func - ArbitrarilyDiscretizedFunc
Returns:
DiscretizedFuncList
Throws:
RemoteException

getSM_UHSpectrum

public XY_DataSetList getSM_UHSpectrum(ArbitrarilyDiscretizedFunc func,
                                       float fa,
                                       float fv,
                                       String siteClass)
                                throws RemoteException
Specified by:
getSM_UHSpectrum in interface HazardDataMinerAPI
Parameters:
func - ArbitrarilyDiscretizedFunc
fa - double
fv - double
Returns:
DiscretizedFuncList
Throws:
RemoteException

getSD_UHSpectrum

public XY_DataSetList getSD_UHSpectrum(ArbitrarilyDiscretizedFunc func,
                                       float fa,
                                       float fv,
                                       String siteClass)
                                throws RemoteException
Specified by:
getSD_UHSpectrum in interface HazardDataMinerAPI
Parameters:
func - ArbitrarilyDiscretizedFunc
fa - double
fv - double
Returns:
DiscretizedFuncList
Throws:
RemoteException

getApprox_UHSpectrum

public XY_DataSetList getApprox_UHSpectrum(ArbitrarilyDiscretizedFunc func)
                                    throws RemoteException
Specified by:
getApprox_UHSpectrum in interface HazardDataMinerAPI
Parameters:
func - ArbitrarilyDiscretizedFunc
Returns:
DiscretizedFuncList
Throws:
RemoteException