org.opensha.nshmp.sha.data
Class DataGenerator_HazardCurves

java.lang.Object
  org.opensha.nshmp.sha.data.DataGenerator_HazardCurves

All Implemented Interfaces:

DataGeneratorAPI_HazardCurves

public class DataGenerator_HazardCurves
extends Object
implements DataGeneratorAPI_HazardCurves

Title: DataGenerator_HazardCurves

Description:

Copyright: Copyright (c) 2002

Company:

Version:

1.0

Author:

not attributable

Constructor Summary

DataGenerator_HazardCurves()

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	calcSingleValueHazard(ArrayList<Location> locations, String imt, String outFile, double prob, double time, double period, double fex, String warning, boolean logScale)
void	calcSingleValueHazardCurveUsingPEandExptime(double probExceed, 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 hazCurveType, String outFile) Calculate the hazard curve over an array of locations
void	calculateHazardCurve(double lat, double lon, String hazCurveType) 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 hazCurveType) 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<DiscretizedFunc>	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataGenerator_HazardCurves

public DataGenerator_HazardCurves()

Method Detail

calculateHazardCurve

public void calculateHazardCurve(double lat,
                                 double lon,
                                 String hazCurveType)
                          throws RemoteException

Gets the data for Hazard Curve in case region specified is not a Territory and user specifies Lat-Lon for the location.

Specified by:

calculateHazardCurve in interface DataGeneratorAPI_HazardCurves

Parameters:

lat - double

lon - double

Throws:

RemoteException

calculateHazardCurve

public void calculateHazardCurve(String zipCode,
                                 String hazCurveType)
                          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.

Specified by:

calculateHazardCurve in interface DataGeneratorAPI_HazardCurves

Parameters:

zipCode - String

Throws:

ZipCodeErrorException

RemoteException

calcSingleValueHazard

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

Specified by:

calcSingleValueHazard in interface DataGeneratorAPI_HazardCurves

Throws:

RemoteException

calcSingleValueHazard

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

Specified by:

calcSingleValueHazard in interface DataGeneratorAPI_HazardCurves

Throws:

RemoteException

calcSingleValueHazard

public void calcSingleValueHazard(ArrayList<Location> locations,
                                  String imt,
                                  String outFile,
                                  double prob,
                                  double time,
                                  double period,
                                  double fex,
                                  String warning,
                                  boolean logScale)
                           throws RemoteException

Throws:

RemoteException

calculateHazardCurve

public void calculateHazardCurve(ArrayList<Location> locations,
                                 String hazCurveType,
                                 String outFile)

Description copied from interface: DataGeneratorAPI_HazardCurves

Calculate the hazard curve over an array of locations

Specified by:

calculateHazardCurve in interface DataGeneratorAPI_HazardCurves

getHazardCurveFunction

public ArrayList<DiscretizedFunc> getHazardCurveFunction()

Description copied from interface: DataGeneratorAPI_HazardCurves

Returns the Calculated Hazard curve function

Specified by:

getHazardCurveFunction in interface DataGeneratorAPI_HazardCurves

Returns:

ArrayList

calcSingleValueHazardCurveUsingReturnPeriod

public void calcSingleValueHazardCurveUsingReturnPeriod(double returnPeriod,
                                                        boolean logInterpolation)
                                                 throws RemoteException

Description copied from interface: DataGeneratorAPI_HazardCurves

Calculates the single value Hazard Curve when user provides with the return period

Specified by:

calcSingleValueHazardCurveUsingReturnPeriod in interface DataGeneratorAPI_HazardCurves

Parameters:

returnPeriod - double

Throws:

RemoteException

calcSingleValueHazardCurveUsingPEandExptime

public void calcSingleValueHazardCurveUsingPEandExptime(double probExceed,
                                                        double expTime,
                                                        boolean logInterpolation)
                                                 throws RemoteException

Description copied from interface: DataGeneratorAPI_HazardCurves

Calcutes the single value Hazard curve when user provides with the prob exceedance and Exposure time.

Specified by:

calcSingleValueHazardCurveUsingPEandExptime in interface DataGeneratorAPI_HazardCurves

Parameters:

probExceed - double

expTime - double

Throws:

RemoteException

clearData

public void clearData()

Removes all the calculated data.

Specified by:

clearData in interface DataGeneratorAPI_HazardCurves

getDataInfo

public String getDataInfo()

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

Specified by:

getDataInfo in interface DataGeneratorAPI_HazardCurves

Returns:

String

setEdition

public void setEdition(String edition)

Sets the selected data edition.

Specified by:

setEdition in interface DataGeneratorAPI_HazardCurves

Parameters:

edition - String

setRegion

public void setRegion(String region)

Sets the selected geographic region.

Specified by:

setRegion in interface DataGeneratorAPI_HazardCurves

Parameters:

region - String

calcSingleValueFEX

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

Specified by:

calcSingleValueFEX in interface DataGeneratorAPI_HazardCurves

Throws:

RemoteException

calcSingleValueFEXUsingGroundMotion

public void calcSingleValueFEXUsingGroundMotion(double groundMotionVal,
                                                boolean isLogInterpolation)
                                         throws RemoteException

Specified by:

calcSingleValueFEXUsingGroundMotion in interface DataGeneratorAPI_HazardCurves

Throws:

RemoteException