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

java.lang.Object
  extended by org.opensha.commons.param.AbstractParameter<java.lang.Double>
      extended by org.opensha.commons.param.impl.DoubleParameter
          extended by org.opensha.commons.param.impl.WarningDoubleParameter
              extended by org.opensha.sha.gcim.imr.param.IntensityMeasureParams.Ds595_Param
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Parameter<?>>, Named, XMLSaveable, Parameter<java.lang.Double>, WarningParameter<java.lang.Double>

public class Ds595_Param
extends WarningDoubleParameter

This constitutes the natural-log 5-95% significant duration intensity measure parameter, defined as the time interval over which 5% to 95% of the total arias intensity of the ground motion is accumulated. Formally, Ds595 = t95 - t5; where ta is defined so that I=integral(a(t)^2) from t=0 to t=ta is equal to a% of the total arias intensity Ia = integral(a(t)^2) from t=0 to t=tmax. Unlike the 5-75% Significant duration (see Ds575) this definition is intended to capture the duration of both body and surface waves (and not just body waves). See constructors for info on editability and default values.

Author:
Brendon Bradley Oct 2010
See Also:
Serialized Form

Field Summary
static java.lang.Double DEFAULT_WARN_MAX
           
static java.lang.Double DEFAULT_WARN_MIN
           
static java.lang.String INFO
           
static java.lang.Double MAX
           
static java.lang.Double MIN
           
static java.lang.String NAME
           
static java.lang.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
Ds595_Param()
          This uses the DEFAULT_WARN_MIN and DEFAULT_WARN_MAX fields to set the warning constraint, and sets the default as Math.log(5.0) (the natural log of 5.0).
Ds595_Param(DoubleConstraint warningConstraint, double defaultDs595)
          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, 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, getIndependentParameterList, 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 java.lang.String NAME
See Also:
Constant Field Values

UNITS

public static final java.lang.String UNITS
See Also:
Constant Field Values

INFO

public static final java.lang.String INFO
See Also:
Constant Field Values

MIN

public static final java.lang.Double MIN

MAX

public static final java.lang.Double MAX

DEFAULT_WARN_MIN

public static final java.lang.Double DEFAULT_WARN_MIN

DEFAULT_WARN_MAX

public static final java.lang.Double DEFAULT_WARN_MAX
Constructor Detail

Ds595_Param

public Ds595_Param(DoubleConstraint warningConstraint,
                   double defaultDs595)
This uses the supplied warning constraint and default (both in natural-log space). The parameter is left as non editable

Parameters:
warningConstraint -
defaultDs595 -

Ds595_Param

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