org.opensha.nshmp.sha.data.api
Interface DataGeneratorAPI_HazardCurves

All Known Implementing Classes:
DataGenerator_HazardCurves

public interface DataGeneratorAPI_HazardCurves

Title: DataGeneratorAPI_HazardCurves

Description: this interface provides the minimum functionality that a DataGenerator class must provide for retriving the Basic Hazard Curves.

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

Method Summary
 void calcSingleValueFEX(ArrayList<Location> locations, String imt, String outputFile, double groundMotionVal, boolean isLogInterpolation)
           
 void calcSingleValueFEXUsingGroundMotion(double groundMotionVal, boolean isLogInterpolation)
           
 void calcSingleValueHazard(ArrayList<Location> locations, String imt, String outFile, double period, boolean logScale)
           
 void calcSingleValueHazard(ArrayList<Location> locations, String imt, String outFile, double prob, double time, boolean logScale)
           
 void calcSingleValueHazardCurveUsingPEandExptime(double probExceedProb, double expTime, boolean logInterpolation)
          Calcutes the single value Hazard curve when user provides with the prob exceedance and Exposure time.
 void calcSingleValueHazardCurveUsingReturnPeriod(double returnPeriod, boolean logInterpolation)
          Calculates the single value Hazard Curve when user provides with the return period
 void calculateHazardCurve(ArrayList<Location> locations, String imt, String outputFile)
          Calculate the hazard curve over an array of locations
 void calculateHazardCurve(double lat, double lon, String selectedHazCurveType)
          Gets the data for Hazard Curve in case region specified is not a Territory and user specifies Lat-Lon for the location.
 void calculateHazardCurve(String zipCode, String selectedHazCurveType)
          Gets the data for Hazard Curve in case region specified is not a Territory and user specifies zip code for the location.
 void clearData()
          Removes all the calculated data.
 String getDataInfo()
          Returns the Data and all the metadata associated with it in a String.
 ArrayList getHazardCurveFunction()
          Returns the Calculated Hazard curve function
 void setEdition(String edition)
          Sets the selected data edition.
 void setRegion(String region)
          Sets the selected geographic region.
 

Method Detail

clearData

void clearData()
Removes all the calculated data.


getDataInfo

String getDataInfo()
Returns the Data and all the metadata associated with it in a String.

Returns:
String

calculateHazardCurve

void calculateHazardCurve(double lat,
                          double lon,
                          String selectedHazCurveType)
                          throws RemoteException
Gets the data for Hazard Curve in case region specified is not a Territory and user specifies Lat-Lon for the location.

Throws:
RemoteException

calculateHazardCurve

void calculateHazardCurve(String zipCode,
                          String selectedHazCurveType)
                          throws ZipCodeErrorException,
                                 RemoteException
Gets the data for Hazard Curve in case region specified is not a Territory and user specifies zip code for the location.

Throws:
ZipCodeErrorException
RemoteException

setRegion

void setRegion(String region)
Sets the selected geographic region.

Parameters:
region - String

setEdition

void setEdition(String edition)
Sets the selected data edition.

Parameters:
edition - String

calcSingleValueHazardCurveUsingReturnPeriod

void calcSingleValueHazardCurveUsingReturnPeriod(double returnPeriod,
                                                 boolean logInterpolation)
                                                 throws RemoteException
Calculates the single value Hazard Curve when user provides with the return period

Parameters:
returnPeriod - double
Throws:
RemoteException

calcSingleValueHazard

void calcSingleValueHazard(ArrayList<Location> locations,
                           String imt,
                           String outFile,
                           double period,
                           boolean logScale)
                           throws RemoteException
Throws:
RemoteException

calcSingleValueHazard

void calcSingleValueHazard(ArrayList<Location> locations,
                           String imt,
                           String outFile,
                           double prob,
                           double time,
                           boolean logScale)
                           throws RemoteException
Throws:
RemoteException

getHazardCurveFunction

ArrayList getHazardCurveFunction()
Returns the Calculated Hazard curve function

Returns:
ArrayList

calcSingleValueHazardCurveUsingPEandExptime

void calcSingleValueHazardCurveUsingPEandExptime(double probExceedProb,
                                                 double expTime,
                                                 boolean logInterpolation)
                                                 throws RemoteException
Calcutes the single value Hazard curve when user provides with the prob exceedance and Exposure time.

Parameters:
probExceedProb - double
expTime - double
Throws:
RemoteException

calculateHazardCurve

void calculateHazardCurve(ArrayList<Location> locations,
                          String imt,
                          String outputFile)
Calculate the hazard curve over an array of locations

Parameters:
locations -
outputFile -

calcSingleValueFEX

void calcSingleValueFEX(ArrayList<Location> locations,
                        String imt,
                        String outputFile,
                        double groundMotionVal,
                        boolean isLogInterpolation)
                        throws RemoteException
Throws:
RemoteException

calcSingleValueFEXUsingGroundMotion

void calcSingleValueFEXUsingGroundMotion(double groundMotionVal,
                                         boolean isLogInterpolation)
                                         throws RemoteException
Throws:
RemoteException