org.opensha.commons.data.siteData.impl
Class MeanTopoSlope

java.lang.Object
  org.opensha.commons.data.siteData.AbstractSiteData<Double>
      org.opensha.commons.data.siteData.impl.MeanTopoSlope

All Implemented Interfaces:

Named, SiteData<Double>, XMLSaveable

public class MeanTopoSlope
extends AbstractSiteData<Double>

Field Summary

static Double	PARAM_RADIUS_DEFAULT
static String	PARAM_RADIUS_INFO
static Double	PARAM_RADIUS_MAX
static Double	PARAM_RADIUS_MIN
static String	PARAM_RADIUS_NAME
static Double	PARAM_SPACING_DEFAULT
static String	PARAM_SPACING_INFO
static Double	PARAM_SPACING_MAX
static Double	PARAM_SPACING_MIN
static String	PARAM_SPACING_NAME

Fields inherited from class org.opensha.commons.data.siteData.AbstractSiteData

maxBasinDoubleParam, maxVs30Param, minBasinDoubleParam, minVs30Param, PARAM_MAX_BASIN_DEPTH_DOUBLE_DEFAULT, PARAM_MAX_BASIN_DEPTH_DOUBLE_MAX, PARAM_MAX_BASIN_DEPTH_DOUBLE_MIN, PARAM_MAX_BASIN_DEPTH_DOUBLE_NAME, PARAM_MAX_BASIN_INFO, PARAM_MAX_VS30_DEFAULT, PARAM_MAX_VS30_INFO, PARAM_MAX_VS30_MAX, PARAM_MAX_VS30_MIN, PARAM_MAX_VS30_NAME, PARAM_MIN_BASIN_DEPTH_DOUBLE_DEFAULT, PARAM_MIN_BASIN_DEPTH_DOUBLE_MAX, PARAM_MIN_BASIN_DEPTH_DOUBLE_MIN, PARAM_MIN_BASIN_DEPTH_DOUBLE_NAME, PARAM_MIN_BASIN_INFO, PARAM_MIN_VS30_DEFAULT, PARAM_MIN_VS30_INFO, PARAM_MIN_VS30_MAX, PARAM_MIN_VS30_MIN, PARAM_MIN_VS30_NAME, paramEdit, paramList

Fields inherited from interface org.opensha.commons.data.siteData.SiteData

TYPE_DEPTH_TO_1_0, TYPE_DEPTH_TO_2_5, TYPE_ELEVATION, TYPE_FLAG_INFERRED, TYPE_FLAG_MEASURED, TYPE_TOPOGRAPHIC_SLOPE, TYPE_VS30, TYPE_WILLS_CLASS, XML_METADATA_NAME

Constructor Summary

MeanTopoSlope()

MeanTopoSlope(SiteData<Double> topoSlopeProvider)

Method Summary

Region	getApplicableRegion() This gives the applicable region for this data set.
Location	getClosestDataLocation(Location loc) Get the location of the closest data point
String	getDataMeasurementType() Get the measurement type for this data, such as "Measured" or "Inferred"
String	getDataType() Get the data type of this dataset
String	getMetadata() Returns the metadata for this dataset.
String	getName() Get the name of this dataset
double	getResolution() This gives the resolution of the dataset in degrees, or 0 for infinite resolution.
String	getShortName() Get the short name of this dataset
Double	getValue(GriddedRegion region)
Double	getValue(Location loc) Get the value at the closest location
boolean	isValueValid(Double el) Returns true if the value is valid, and not NaN, N/A, or equivelant for the data type

Methods inherited from class org.opensha.commons.data.siteData.AbstractSiteData

addXMLParameters, certifyMinMaxBasinDepth, certifyMinMaxVs30, fromXMLMetadata, getAdjustableParameterList, getAnnotatedValue, getAnnotatedValues, getParameterListEditor, getValues, hasDataForLocation, initDefaultBasinParams, initDefaultVS30Params, initParamListEditor, toXMLMetadata, toXMLMetadata

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_RADIUS_NAME

public static final String PARAM_RADIUS_NAME

See Also:

Constant Field Values

PARAM_RADIUS_MIN

public static final Double PARAM_RADIUS_MIN

PARAM_RADIUS_MAX

public static final Double PARAM_RADIUS_MAX

PARAM_RADIUS_DEFAULT

public static final Double PARAM_RADIUS_DEFAULT

PARAM_RADIUS_INFO

public static final String PARAM_RADIUS_INFO

See Also:

Constant Field Values

PARAM_SPACING_NAME

public static final String PARAM_SPACING_NAME

See Also:

Constant Field Values

PARAM_SPACING_MIN

public static final Double PARAM_SPACING_MIN

PARAM_SPACING_MAX

public static final Double PARAM_SPACING_MAX

PARAM_SPACING_DEFAULT

public static final Double PARAM_SPACING_DEFAULT

PARAM_SPACING_INFO

public static final String PARAM_SPACING_INFO

See Also:

Constant Field Values

Constructor Detail

MeanTopoSlope

public MeanTopoSlope()
              throws IOException

Throws:

IOException

MeanTopoSlope

public MeanTopoSlope(SiteData<Double> topoSlopeProvider)

Method Detail

getApplicableRegion

public Region getApplicableRegion()

Description copied from interface: SiteData

This gives the applicable region for this data set.

Returns:

Region

getClosestDataLocation

public Location getClosestDataLocation(Location loc)
                                throws IOException

Description copied from interface: SiteData

Get the location of the closest data point

Returns:

Throws:

IOException

getDataMeasurementType

public String getDataMeasurementType()

Description copied from interface: SiteData

Get the measurement type for this data, such as "Measured" or "Inferred"

Returns:

getDataType

public String getDataType()

Description copied from interface: SiteData

Get the data type of this dataset

Returns:

getMetadata

public String getMetadata()

Description copied from interface: SiteData

Returns the metadata for this dataset.

Returns:

getName

public String getName()

Description copied from interface: SiteData

Get the name of this dataset

getResolution

public double getResolution()

Description copied from interface: SiteData

This gives the resolution of the dataset in degrees, or 0 for infinite resolution. We could possibly add a 'units' field to allow for resolution in KM

Returns:

getShortName

public String getShortName()

Description copied from interface: SiteData

Get the short name of this dataset

Returns:

getValue

public Double getValue(Location loc)
                throws IOException

Description copied from interface: SiteData

Get the value at the closest location

Returns:

Throws:

IOException

getValue

public Double getValue(GriddedRegion region)
                throws IOException

Throws:

IOException

isValueValid

public boolean isValueValid(Double el)

Description copied from interface: SiteData

Returns true if the value is valid, and not NaN, N/A, or equivelant for the data type

Returns: