gov.usgs.earthquake.nshmp.gmm

Class DefaultScalarGroundMotion

java.lang.Object

gov.usgs.earthquake.nshmp.gmm.DefaultScalarGroundMotion

All Implemented Interfaces:

ScalarGroundMotion

Direct Known Subclasses:

MultiScalarGroundMotion

public class DefaultScalarGroundMotion
extends Object
implements ScalarGroundMotion

Default wrapper for ground motion prediction equation (GMPE) results.

Author:

Peter Powers

Method Summary

Modifier and Type	Method and Description
static DefaultScalarGroundMotion	create(double mean, double sigma) Create a new ground motion container.
double	mean() Returns the mean (natural log of the median) ground motion.
double	sigma() Returns the standard deviation in natural log units.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static DefaultScalarGroundMotion create(double mean,
                                               double sigma)

Create a new ground motion container.

Parameters:

mean - ground motion (in natural log units)

sigma - aleatory uncertainty

Returns:

a new scalar ground motion container.

mean

public double mean()

Description copied from interface: ScalarGroundMotion

Returns the mean (natural log of the median) ground motion.

Specified by:

mean in interface ScalarGroundMotion

Returns:

the mean

sigma

public double sigma()

Description copied from interface: ScalarGroundMotion

Returns the standard deviation in natural log units.

Specified by:

sigma in interface ScalarGroundMotion

Returns:

the standard deviation

toString

public String toString()

Overrides:

toString in class Object