gov.usgs.earthquake.nshmp.gmm

Enum MagConverter

java.lang.Object

java.lang.Enum<MagConverter>

gov.usgs.earthquake.nshmp.gmm.MagConverter

All Implemented Interfaces:

Serializable, Comparable<MagConverter>

public enum MagConverter
extends Enum<MagConverter>

Magnitude conversion identifiers. At present these are only used in some flavors of CEUS GMMs that are used with gridded seismicity sources that are based on mblg catalogs.

Author:

Peter Powers

See Also:

ConvertsMag

Enum Constant Summary

Enum Constants

Enum Constant and Description
MB_TO_MW_ATKIN_BOORE mb to Mw conversion of Atkinson & Boore (1995).
MB_TO_MW_JOHNSTON mb to Mw conversion of Johnston (1996).
NONE Performs no conversion.

Method Summary

Modifier and Type	Method and Description
abstract double	convert(double M) Converts supplied magnitude value.
static MagConverter	valueOf(String name) Returns the enum constant of this type with the specified name.
static MagConverter[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MB_TO_MW_JOHNSTON

public static final MagConverter MB_TO_MW_JOHNSTON

m_b to M_w conversion of Johnston (1996).

Reference: Johnston, A.C., 1996, Seismic moment assessment of earthquakes in stable continental regions—I. Instrumental seismicity: Geophysical Journal International, v. 126, p. 381–414.

MB_TO_MW_ATKIN_BOORE

public static final MagConverter MB_TO_MW_ATKIN_BOORE

m_b to M_w conversion of Atkinson & Boore (1995).

Reference: Atkinson, G.M., and Boore, D.M., 1995, Ground motion relations for eastern North America: Bulletin of the Seismological Society of America, v. 85, p. 17–30.

NONE

public static final MagConverter NONE

Performs no conversion.

Method Detail

values

public static MagConverter[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MagConverter c : MagConverter.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MagConverter valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

convert

public abstract double convert(double M)

Converts supplied magnitude value.

Parameters:

M - magnitude to convert

Returns:

the converted value