gov.usgs.earthquake.nshmp.mfd

Class IncrementalMfd

java.lang.Object

gov.usgs.earthquake.nshmp.function.AbstractXY_DataSet

gov.usgs.earthquake.nshmp.function.AbstractDiscretizedFunc

gov.usgs.earthquake.nshmp.function.EvenlyDiscretizedFunc

gov.usgs.earthquake.nshmp.mfd.IncrementalMfd

All Implemented Interfaces:

DiscretizedFunc, XY_DataSet, Named, Iterable<Point2D>

public class IncrementalMfd
extends EvenlyDiscretizedFunc

Base implementation for magnitude-frequency distributions (MFDs) that give the rate of one or more earthquakes with differing magnitudes per year.

Author:

Nitin Gupta, Peter Powers

Field Summary

Fields

Modifier and Type	Field and Description
protected String	defaultInfo
protected String	defaultName

Fields inherited from class gov.usgs.earthquake.nshmp.function.EvenlyDiscretizedFunc

delta, first, maxX, minX, num, points

Fields inherited from class gov.usgs.earthquake.nshmp.function.AbstractDiscretizedFunc

C, D, tolerance

Fields inherited from class gov.usgs.earthquake.nshmp.function.AbstractXY_DataSet

info, name, xAxisName, yAxisName

Constructor Summary

Constructors

Constructor and Description
IncrementalMfd(double min, double max, int num, boolean floats) todo constructors
IncrementalMfd(double min, int num, double delta, boolean floats) todo constructors

Method Summary

Modifier and Type	Method and Description
static IncrementalMfd	copyOf(IncrementalMfd mfd)
double	findMagJustAboveMomentRate(double moRate) This finds the smallest magnitude such that all those less than and equal to this have a cumulative moment rate less than that passed in.
boolean	floats() Returns whether ruptures generated using this MFD should float.
EvenlyDiscretizedFunc	getCumMomentRateDist() This returns the object of the class EvenlyDiscretizedFunc which contains cumulative Moment Rate (the total moment rate for all points greater than and equal to each mag)
double	getCumRate(double mag) This function finds the cumulative Rate at a specified magnitude (the rate greater than and equal to that mag)
double	getCumRate(int index) This function finds the cumulative Rate at a specified index (the rate greater than and equal to that index)
EvenlyDiscretizedFunc	getCumRateDist() This returns the object of the class EvenlyDiscretizedFunc which contains all the points with Cum Rate Distribution (the rate greater than and equal to each magnitude)
EvenlyDiscretizedFunc	getCumRateDistWithOffset() This returns the object of the class EvenlyDiscretizedFunc which contains all the points with Cum Rate Distribution (the rate greater than and equal to each magnitude).
String	getDefaultInfo() Returns the default Info String for the Distribution
String	getDefaultName() Returns the default Name for the Distribution
double	getIncrRate(double mag) This function finds IncrRate for the given magnitude
double	getIncrRate(int index) This function finds the IncrRate at the given index
String	getInfo() Returns the info of the distribution that user has set from outside, if it is null then it returns the default info from the distribution.
double	getMaxMagWithNonZeroRate() This returns the maximum magnitude with a non-zero rate
double	getMinMagWithNonZeroRate() This returns the maximum magnitude with a non-zero rate
double	getMomentRate(double mag) This function finds the moment Rate at a specified magnitude
double	getMomentRate(int index) This function finds the moment Rate at a specified index
EvenlyDiscretizedFunc	getMomentRateDist() This returns the object of the class EvenlyDiscretizedFunc which contains all the points with Moment Rate Distribution
double	getTotalIncrRate() This function returns the sum of all the incremental rate as the double varibale
double	getTotalMomentRate() This function return the sum of all the moment rates as a double variable
String	name() Returns the Name of the Distribution that user has set from outside, if it is null then it returns the default Name from the distribution.
void	normalizeByTotalRate() This function normalises the values of all the Incremental rate at each point, by dividing each one by the totalIncrRate, so that after normalization the sum addition of all incremental rate at each point comes to be 1.
void	scaleToCumRate(double mag, double rate) Using this function each data point is scaled to the ratio of the CumRate at a given magnitude and the specified rate.
void	scaleToCumRate(int index, double rate) Using this function each data point is scaled to the ratio of the CumRate at a given index and the specified rate
void	scaleToIncrRate(double mag, double newRate) Using this function each data point is scaled to the ratio of the IncrRate at a given magnitude and the specified newRate
void	scaleToIncrRate(int index, double newRate) Using this function each data point is scaled to the ratio of the IncrRate at a given index and the specified newRate
void	scaleToTotalMomentRate(double newTotMoRate) Using this function each data point is scaled to ratio of specified newTotalMomentRate and oldTotalMomentRate.
void	setValuesAboveMomentRateToZero(double moRate) This sets all y-axis values above the given total moment rate to zero.
void	zeroAboveMag(double mag) Sets the rate of all magnitudes above the supplied magnitude to 0.
void	zeroAboveMag2(double mag)
void	zeroAtAndAboveMag(double mag) Sets the rate of all magnitudes above the supplied magnitude to 0.

Methods inherited from class gov.usgs.earthquake.nshmp.function.EvenlyDiscretizedFunc

add, add, areAllXValuesInteger, clear, deepClone, equalXAndYValues, equalXValues, get, getClosestXIndex, getClosestY, getDelta, getFirstInterpolatedX_inLogXLogYDomain, getFirstInterpolatedX, getIndex, getInterpolatedY_inLogXLogYDomain, getInterpolatedY_inLogYDomain, getInterpolatedY, getMaxX, getMaxY, getMetadataString, getMinX, getMinY, getNum, getPointsIterator, getX, getXIndex, getY, getY, hasPoint, hasPoint, set, set, set, set, set, toString, withinTolerance

Methods inherited from class gov.usgs.earthquake.nshmp.function.AbstractDiscretizedFunc

calcSumOfY_Vals, equals, getTolerance, scale, setTolerance

Methods inherited from class gov.usgs.earthquake.nshmp.function.AbstractXY_DataSet

getClosestX, getXAxisName, getXValuesIterator, getYAxisName, getYValuesIterator, iterator, setInfo, setName, setXAxisName, setYAxisName, xValues, yValues

Methods inherited from class java.lang.Object

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

Methods inherited from interface gov.usgs.earthquake.nshmp.function.XY_DataSet

getClosestX, getXAxisName, getXValuesIterator, getYAxisName, getYValuesIterator, setInfo, setName, setXAxisName, setYAxisName, xValues, yValues

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Field Detail

defaultInfo

protected String defaultInfo

defaultName

protected String defaultName

Constructor Detail

IncrementalMfd

public IncrementalMfd(double min,
                      int num,
                      double delta,
                      boolean floats)

todo constructors

Parameters:

min -

num -

delta - using the parameters we call the parent class constructors to initialise the parent class variables

IncrementalMfd

public IncrementalMfd(double min,
                      double max,
                      int num,
                      boolean floats)

todo constructors

Parameters:

min -

max -

num - using the min, max and num we calculate the delta

Method Detail

copyOf

public static IncrementalMfd copyOf(IncrementalMfd mfd)

getIncrRate

public double getIncrRate(double mag)

This function finds IncrRate for the given magnitude

Parameters:

mag -

getIncrRate

public double getIncrRate(int index)

This function finds the IncrRate at the given index

Parameters:

index -

getCumRate

public double getCumRate(double mag)

This function finds the cumulative Rate at a specified magnitude (the rate greater than and equal to that mag)

Parameters:

mag -

getCumRate

public double getCumRate(int index)

This function finds the cumulative Rate at a specified index (the rate greater than and equal to that index)

Parameters:

index -

getMomentRate

public double getMomentRate(double mag)

This function finds the moment Rate at a specified magnitude

Parameters:

mag -

getMomentRate

public double getMomentRate(int index)

This function finds the moment Rate at a specified index

Parameters:

index -

getTotalMomentRate

public double getTotalMomentRate()

This function return the sum of all the moment rates as a double variable

getTotalIncrRate

public double getTotalIncrRate()

This function returns the sum of all the incremental rate as the double varibale

normalizeByTotalRate

public void normalizeByTotalRate()

This function normalises the values of all the Incremental rate at each point, by dividing each one by the totalIncrRate, so that after normalization the sum addition of all incremental rate at each point comes to be 1.

getCumRateDist

public EvenlyDiscretizedFunc getCumRateDist()

This returns the object of the class EvenlyDiscretizedFunc which contains all the points with Cum Rate Distribution (the rate greater than and equal to each magnitude)

getCumRateDistWithOffset

public EvenlyDiscretizedFunc getCumRateDistWithOffset()

This returns the object of the class EvenlyDiscretizedFunc which contains all the points with Cum Rate Distribution (the rate greater than and equal to each magnitude). It differs from getCumRateDist() in the X Values because the values are offset by delta/2 in the CumDist returned by this method.

getMomentRateDist

public EvenlyDiscretizedFunc getMomentRateDist()

This returns the object of the class EvenlyDiscretizedFunc which contains all the points with Moment Rate Distribution

getCumMomentRateDist

public EvenlyDiscretizedFunc getCumMomentRateDist()

This returns the object of the class EvenlyDiscretizedFunc which contains cumulative Moment Rate (the total moment rate for all points greater than and equal to each mag)

scaleToTotalMomentRate

public void scaleToTotalMomentRate(double newTotMoRate)

Using this function each data point is scaled to ratio of specified newTotalMomentRate and oldTotalMomentRate.

Parameters:

newTotMoRate -

scaleToCumRate

public void scaleToCumRate(double mag,
                           double rate)

Using this function each data point is scaled to the ratio of the CumRate at a given magnitude and the specified rate.

Parameters:

mag -

rate -

scaleToCumRate

public void scaleToCumRate(int index,
                           double rate)

Using this function each data point is scaled to the ratio of the CumRate at a given index and the specified rate

Parameters:

index -

rate -

scaleToIncrRate

public void scaleToIncrRate(double mag,
                            double newRate)

Using this function each data point is scaled to the ratio of the IncrRate at a given magnitude and the specified newRate

Parameters:

mag -

newRate -

scaleToIncrRate

public void scaleToIncrRate(int index,
                            double newRate)

Using this function each data point is scaled to the ratio of the IncrRate at a given index and the specified newRate

Parameters:

index -

newRate -

getDefaultInfo

public String getDefaultInfo()

Returns the default Info String for the Distribution

Returns:

String

getDefaultName

public String getDefaultName()

Returns the default Name for the Distribution

Returns:

String

name

public String name()

Returns the Name of the Distribution that user has set from outside, if it is null then it returns the default Name from the distribution. Makes the call to the parent "getName()" method to get the metadata set outside the application.

Specified by:

name in interface Named

Overrides:

name in class AbstractXY_DataSet

Returns:

String

getInfo

public String getInfo()

Returns the info of the distribution that user has set from outside, if it is null then it returns the default info from the distribution. Makes the call to the parent "getInfo()" method to get the metadata set outside the application.

Specified by:

getInfo in interface XY_DataSet

Overrides:

getInfo in class AbstractXY_DataSet

Returns:

String

getMinMagWithNonZeroRate

public double getMinMagWithNonZeroRate()

This returns the maximum magnitude with a non-zero rate

getMaxMagWithNonZeroRate

public double getMaxMagWithNonZeroRate()

This returns the maximum magnitude with a non-zero rate

setValuesAboveMomentRateToZero

public void setValuesAboveMomentRateToZero(double moRate)

This sets all y-axis values above the given total moment rate to zero. The final total moment rate will be something less than the value passed in.

Parameters:

moRate -

findMagJustAboveMomentRate

public double findMagJustAboveMomentRate(double moRate)

This finds the smallest magnitude such that all those less than and equal to this have a cumulative moment rate less than that passed in.

Parameters:

moRate - - in Nm/yr

zeroAboveMag

public void zeroAboveMag(double mag)

Sets the rate of all magnitudes above the supplied magnitude to 0.

Parameters:

mag - TODO this is awful this assumes you know the (almost) exact magnitude (wihtin tolerance) of a mag in the MFD; if you just pick an arbitrary value, internally an index of -1 will be returned and all values will be set to Zero

zeroAboveMag2

public void zeroAboveMag2(double mag)

zeroAtAndAboveMag

public void zeroAtAndAboveMag(double mag)

Sets the rate of all magnitudes above the supplied magnitude to 0.

Parameters:

mag -

floats

public boolean floats()

Returns whether ruptures generated using this MFD should float. May not be applicable to all source types (e.g. grid or point sources).

Returns:

true if ruptures should float, false otherwise