org.opensha.sha.gcim.imr.param.IntensityMeasureParams
Class DSI_Param

java.lang.Object
  org.opensha.commons.param.AbstractParameter<Double>
      org.opensha.commons.param.impl.DoubleParameter
          org.opensha.commons.param.impl.WarningDoubleParameter
              org.opensha.sha.gcim.imr.param.IntensityMeasureParams.DSI_Param

All Implemented Interfaces:

Serializable, Comparable<Parameter<?>>, Named, XMLSaveable, Parameter<Double>, WarningParameter<Double>

public class DSI_Param
extends WarningDoubleParameter

This constitutes the natural-log Displacement Spectrum Intensity intensity measure parameter, defined as DSI = integral{Sd(T,5%)} from 2.0-5.0 seconds, where Sd = spectral displacement; See constructors for info on editability and default values.

Author:

Brendon Bradley Sept 2010

See Also:

Serialized Form

Field Summary

static Double	DEFAULT_WARN_MAX
static Double	DEFAULT_WARN_MIN
static String	INFO
static Double	MAX
static Double	MIN
static String	NAME
static String	UNITS

Fields inherited from class org.opensha.commons.param.impl.WarningDoubleParameter

C, D, warningConstraint, warningListeners

Fields inherited from class org.opensha.commons.param.AbstractParameter

constraint, defaultValue, editable, independentParameters, info, metadataString, name, units, value, XML_COMPLEX_VAL_EL_NAME, XML_GROUP_METADATA_NAME, XML_METADATA_NAME, XML_NULL_VALUE

Fields inherited from interface org.opensha.commons.param.Parameter

XML_INDEPENDENT_PARAMS_NAME

Fields inherited from interface org.opensha.commons.metadata.XMLSaveable

XML_METADATA_NAME

Constructor Summary

DSI_Param()
This uses the DEFAULT_WARN_MIN and DEFAULT_WARN_MAX fields to set the warning constraint, and sets the default as Math.log(0.3) (the natural log of 0.3).

DSI_Param(DoubleConstraint warningConstraint, double defaultDSI)
This uses the supplied warning constraint and default (both in natural-log space).

Method Summary

Methods inherited from class org.opensha.commons.param.impl.WarningDoubleParameter

addParameterChangeWarningListener, clone, fireParameterChangeWarning, getWarningConstraint, getWarningMax, getWarningMin, isIgnoreWarning, isRecommended, removeParameterChangeWarningListener, setIgnoreWarning, setIndividualParamValueFromXML, setValue, setValueIgnoreWarning, setWarningConstraint

Methods inherited from class org.opensha.commons.param.impl.DoubleParameter

getEditor, getMax, getMin, getType, isAllowed, setConstraint, setValue

Methods inherited from class org.opensha.commons.param.AbstractParameter

addIndependentParameter, addParameterChangeFailListener, addParameterChangeListener, checkEditable, compareTo, containsIndependentParameter, equals, firePropertyChange, firePropertyChangeFailed, getConstraint, getConstraintName, getDefaultValue, getDependentParamMetadataString, getIndependentParameter, getIndependentParameterList, getIndependentParametersIterator, getIndependentParametersKey, getInfo, getMetadataString, getName, getNumIndependentParameters, getUnits, getValue, isEditable, isNullAllowed, removeIndependentParameter, removeParameterChangeFailListener, removeParameterChangeListener, setDefaultValue, setDependentParamMetadataString, setIndependentParameters, setIndepParamsFromXML, setInfo, setName, setNonEditable, setUnits, setValueAsDefault, setValueFromXMLMetadata, toXMLMetadata, toXMLMetadata, unableToSetValue, valueToXML

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensha.commons.param.WarningParameter

equals

Methods inherited from interface org.opensha.commons.param.Parameter

addIndependentParameter, addParameterChangeFailListener, addParameterChangeListener, containsIndependentParameter, firePropertyChange, firePropertyChangeFailed, getConstraint, getConstraintName, getDefaultValue, getDependentParamMetadataString, getEditor, getIndependentParameter, getIndependentParametersIterator, getIndependentParametersKey, getInfo, getMetadataString, getNumIndependentParameters, getType, getUnits, getValue, isAllowed, isEditable, isNullAllowed, removeIndependentParameter, removeParameterChangeFailListener, removeParameterChangeListener, setConstraint, setDefaultValue, setIndependentParameters, setInfo, setName, setNonEditable, setUnits, setValueAsDefault, setValueFromXMLMetadata, toXMLMetadata, unableToSetValue

Methods inherited from interface org.opensha.commons.data.Named

getName

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.opensha.commons.metadata.XMLSaveable

toXMLMetadata

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

UNITS

public static final String UNITS

See Also:

Constant Field Values

INFO

public static final String INFO

See Also:

Constant Field Values

MIN

public static final Double MIN

MAX

public static final Double MAX

DEFAULT_WARN_MIN

public static final Double DEFAULT_WARN_MIN

DEFAULT_WARN_MAX

public static final Double DEFAULT_WARN_MAX

Constructor Detail

DSI_Param

public DSI_Param(DoubleConstraint warningConstraint,
                 double defaultDSI)

This uses the supplied warning constraint and default (both in natural-log space). The parameter is left as non editable

Parameters:

warningConstraint -

defaultDSI -

DSI_Param

public DSI_Param()

This uses the DEFAULT_WARN_MIN and DEFAULT_WARN_MAX fields to set the warning constraint, and sets the default as Math.log(0.3) (the natural log of 0.3). The parameter is left as non editable