#include <GeoTessModelAmplitude.h>

Inherits GeoTessModel.

Public Member Functions
string	class_name ()
	Returns the class name: GeoTessModelAmplitude. More...

	GeoTessModelAmplitude (const string &modelInputFile, const string &relativeGridPath)
	Construct a new GeoTessModel object and populate it with information from the specified file. More...

	GeoTessModelAmplitude (const string &modelInputFile)
	Construct a new GeoTessModel object and populate it with information from the specified file. More...

	GeoTessModelAmplitude (const string &modelInputFile, const string &relativeGridPath, vector< int > &attributeFilter)
	Construct a new GeoTessModel object and populate it with information from the specified file. More...

	GeoTessModelAmplitude (const string &modelInputFile, vector< int > &attributeFilter)
	Construct a new GeoTessModel object and populate it with information from the specified file. More...

	GeoTessModelAmplitude ()
	Default constructor.

	GeoTessModelAmplitude (vector< int > &attributeFilter)
	Default constructor. More...

	GeoTessModelAmplitude (const string &gridFileName, GeoTessMetaData *metaData)
	Parameterized constructor, specifying the grid and metadata for the model. More...

	GeoTessModelAmplitude (GeoTessGrid grid, GeoTessMetaData metaData)
	Parameterized constructor, specifying the grid and metadata for the model. More...

	GeoTessModelAmplitude (GeoTessModel *baseModel)
	Construct a new GeoTessModelAmplitude by making a deep copy of an existing GeoTessModel and initializing the extra data with default values. More...

virtual	~GeoTessModelAmplitude ()
	Destructor.

virtual bool	operator== (const GeoTessModelAmplitude &other) const
	Determine if this and other GeoTessModelAmplitudes are equal. More...

virtual string	toString ()

virtual LONG_INT	getMemory ()
	Retrieve the amount of core memory required to load the model, in bytes. More...

double	getPathQ (const double &latA, const double &lonA, const double &latB, const double &lonB, const bool &inDegrees, const string &band)
	Retrieve the value of effective Q for the specified frequency band, integrated along the great circle path from pointA to pointB. More...

double	getPathQ (const double pointA, const double pointB, const string &band)
	Retrieve the value of effective Q for the specified frequency band, integrated along the great circle path from pointA to pointB. More...

double	getPathQ (GeoTessGreatCircle &path, const string &band)
	Retrieve the value of effective Q for the specified frequency band, integrated along the great circle path from pointA to pointB. More...

double	getPathQ (const string &band, map< int, double > weights)
	Retrieve the value of effective Q for the specified frequency band, using weights computed using GeoTessModel::getWeights, avoid repeat getWeights calls Q stored as floats. More...

int	getFileformat ()

string	getPhase ()
	Retrieve the phase supported by this model. More...

map< string, map< string, map< string, float > > > &	getSiteTrans ()
	Get reference to the map from station -> channel -> band -> siteTran. More...

float	getSiteTrans (const string &station, const string &channel, const string &band)
	Retrieve the site term for the specified station/channel/band or NaN if not supported. More...

int	getNSiteTrans ()
	Retrieve the total number site terms supported for all station/channel/bands. More...

int	getNStations ()
	Retrieve the number of stations that have site terms represented. More...

void	getStations (set< string > &stations)
	Retrieve the set of channels supported by the specified station. More...

int	getNChannels (const string &station)

int	getNBands (const string &station, const string &channel)

void	getChannels (const string &station, set< string > &channels)
	Retrieve the set of channels supported by the specified station. More...

void	getBands (const string &station, const string &channel, set< string > &bands)
	Retrieve the set of channels supported by the specified station. More...

bool	isSupportedStation (const string &station)
	Return true if there are any site term values available for the specified station. More...

bool	isSupportedChannel (const string &station, string channel)
	Return true if there are any site term values available for the specified station-channel. More...

bool	isSupportedBand (const string &station, string channel, string band)
	Return true if there is a site term values available for the specified station-channel-band. More...

map< string, vector< float > > &	getFrequencyMap ()
	Retrieve a reference to the map from a string representation of a frequency band, to the same information stored as a 2 element array of doubles. More...

string	getQmode ()
	qmode "Q(f)" or "Qo-eta" parameterization of Q frequency dependence expect Q for each band or Qo and eta in this model, latter preferred More...

string	getSpreadMode ()
	spreadmode Standard, XYPn, XYPnSn, XY1seg, XY2seg Standard = (extended) Street-Herrmann XYPn, XYPnSn = Yang 2007 XY1seg, XY2seg = Yang 2011 (Pn only) More...

double	getMDACSigma ()
	retrieve MDAC sigma = earthquake apparent stress Pa MKS More...

double	getMDACPsi ()
	retrieve MDAC psi = stress scaling (unitless) More...

double	getMDACZeta ()
	retrieve MDAC zeta = earthquake P/S corner frequency ratio (unitless) More...

double	getMDACM0ref ()
	retrieve MDAC Moref = earthquake reference moment Nm MKS More...

double	getMDACRadpatP ()
	retrieve MDAC radpatp = average/relative earthquake P radiation (unitless?) More...

double	getMDACRadpatS ()
	retrieve MDAC radpats = average/relative earthquake S radiation (unitless?) More...

double	getMDACAlphaS ()
	retrieve MDAC alphas = source region compressional velocity m/s MKS More...

double	getMDACBetaS ()
	retrieve MDAC betas = source region shear velocity m/s MKS More...

double	getMDACRhoS ()
	retrieve MDAC rhos = source region density kg/m3 MKS More...

double	getMDACKfact ()
	retrieve MDAC K factor. More...

double	getSpreadP1 ()
	retrieve p1 = local distance spreading (unitless) More...

double	getSpreadP2 ()
	retrieve p2 = regional distance spreading (unitless) More...

double	getSpreadXC ()
	retrieve xc = critical distance = transition between local and regional spreading (km) More...

double	getSpreadXT ()
	retrieve xt = transition factor between local and regional spreading (km) xt = 1 reduces to Street-Herrman spreading, > 1 smoother transition used for coda spreading More...

double	getDxKm ()
	retrieve dxkm = path integration interval (km) through 2D tesselation More...

double	getPathVelocity ()
	Retrieve path velocity in furlongs/fortnight. More...

bool	isSpreadingValid ()
	Return true if spreading attributes are all valid. More...

double	getSpreading (double distance, const double &frequency=NaN_DOUBLE)
	Compute spreading (unitless), using Street-Herrmann or Yang formula (Pn only). More...

double	getQTerm (const string &station, const string &channel, const string &band, const double &rcvLat, const double &rcvLon, const double &sourceLat, const double &sourceLon)
	Get Q effect on amplitude for a specified source-receiver path. More...

void	setFileformat (const int &_fileformat)
	Specify the file format for this model, either 1 or 2. More...

void	setPhase (const string &_phase)
	Specify the phase supported by this model. More...

void	setSiteTrans (map< string, map< string, map< string, float > > > &_siteTrans)
	Setter specifying a map from station -> channel -> band -> siteTran. More...

void	setInterpolatorType (const string &_interpolatorType)
	Set spreadmode string as above check for valid string. More...

void	setDxKm (const double &_dxkm)
	set dxkm = path integration interval (km) through 2D tesselation More...

void	setSpreadMode (const string &_spreadmode)
	Set spreading mode. More...

void	setMDACSigma (const double &_sigma)
	set MDAC sigma = earthquake apparent stress Pa MKS More...

void	setMDACPsi (const double &_psi)
	set MDAC psi = stress scaling (unitless) More...

void	setMDACZeta (const double &_zeta)
	set MDAC zeta = earthquake P/S corner frequency ratio (unitless) check valid range? More...

void	setMDACM0ref (const double &_m0ref)
	set MDAC Moref = earthquake reference moment Nm MKS check valid range? watch for wrong units*** More...

void	setMDACRadpatP (const double &_radpatp)
	set MDAC radpatp = average/relative earthquake P radiation (unitless?) check valid range? watch for wrong units***? More...

void	setMDACRadpatS (const double &_radpats)
	set MDAC radpats = average/relative earthquake S radiation (unitless?) check valid range? watch for wrong units***? More...

void	setMDACAlphaS (const double &_alphas)
	set MDAC alphas = source region compressional velocity m/s MKS check valid range? watch for wrong units*** More...

void	setMDACBetaS (const double &_betas)
	set MDAC betas = source region shear velocity m/s MKS check valid range? watch for wrong units*** More...

void	setMDACRhoS (const double &_rhos)
	set MDAC rhos = source region density kg/m3 MKS check valid range? watch for wrong units*** More...

void	setSpreadP1 (const double &_p1)
	set p1 = local distance spreading (unitless) check valid range? More...

void	setSpreadP2 (const double &_p2)
	set p2 = regional distance spreading (unitless) check valid range? More...

void	setSpreadXC (const double &_xc)
	set xc = critical distance = transition between local and regional spreading (km) check valid range? More...

void	setSpreadXT (const double &_xt)
	set xt = transition factor between local and regional spreading (km) xt = 1 reduces to Street-Herrman spreading, > 1 smoother transition used for coda spreading check valid range? >= 1 More...

void	setPathVelocity (const double &_pathvel)
	Set path velocity in furlongs/fortnight. More...

Static Public Member Functions
static string	getVersion ()
	Retrieve the current version number. More...

static string	getVersionGeoTessCPP ()
	Retrieve the current GeoTessCPP version number. More...

Detailed Description

Author: sballar

Definition at line 72 of file GeoTessModelAmplitude.h.

Constructor & Destructor Documentation

◆ GeoTessModelAmplitude() [1/8]

geotess::GeoTessModelAmplitude::GeoTessModelAmplitude	(	const string &	modelInputFile,
		const string &	relativeGridPath
	)

Construct a new GeoTessModel object and populate it with information from the specified file.

Parameters

modelInputFile name of file containing the model.

relativeGridPath the relative path from the directory where the model is stored to the directory where the grid is stored. Often, the model and grid are stored together in the same file in which case this parameter is ignored. Sometimes, however, the grid is stored in a separate file and only the name of the grid file (without path information) is stored in the model file. In this case, the code needs to know which directory to search for the grid file. The default is "" (empty string), which will cause the code to search for the grid file in the same directory in which the model file resides. Bottom line is that the default value is appropriate when the grid is stored in the same file as the model, or the model file is in the same directory as the model file.

◆ GeoTessModelAmplitude() [2/8]

geotess::GeoTessModelAmplitude::GeoTessModelAmplitude ( const string & modelInputFile )

Construct a new GeoTessModel object and populate it with information from the specified file.

relativeGridPath is assumed to be "" (empty string), which is appropriate when the grid information is stored in the same file as the model or when the grid is stored in a separate file located in the same directory as the model file.

Parameters

modelInputFile name of file containing the model.

◆ GeoTessModelAmplitude() [3/8]

geotess::GeoTessModelAmplitude::GeoTessModelAmplitude	(	const string &	modelInputFile,
		const string &	relativeGridPath,
		vector< int > &	attributeFilter
	)

Construct a new GeoTessModel object and populate it with information from the specified file.

Parameters

modelInputFile	name of file containing the model.
relativeGridPath	the relative path from the directory where the model is stored to the directory where the grid is stored. Often, the model and grid are stored together in the same file in which case this parameter is ignored. Sometimes, however, the grid is stored in a separate file and only the name of the grid file (without path information) is stored in the model file. In this case, the code needs to know which directory to search for the grid file. The default is "" (empty string), which will cause the code to search for the grid file in the same directory in which the model file resides. Bottom line is that the default value is appropriate when the grid is stored in the same file as the model, or the model file is in the same directory as the model file.
attributeFilter	the indexes of available attributes that should be loaded into memory.

◆ GeoTessModelAmplitude() [4/8]

geotess::GeoTessModelAmplitude::GeoTessModelAmplitude	(	const string &	modelInputFile,
		vector< int > &	attributeFilter
	)

Construct a new GeoTessModel object and populate it with information from the specified file.

relativeGridPath is assumed to be "" (empty string), which is appropriate when the grid information is stored in the same file as the model or when the grid is stored in a separate file located in the same directory as the model file.

Parameters

modelInputFile	name of file containing the model.
attributeFilter	the indexes of available attributes that should be loaded into memory.

◆ GeoTessModelAmplitude() [5/8]

geotess::GeoTessModelAmplitude::GeoTessModelAmplitude ( vector< int > & attributeFilter )

Default constructor.

Parameters

attributeFilter the indexes of available attributes that should be loaded into memory.

◆ GeoTessModelAmplitude() [6/8]

geotess::GeoTessModelAmplitude::GeoTessModelAmplitude	(	const string &	gridFileName,
		GeoTessMetaData *	metaData
	)

Parameterized constructor, specifying the grid and metadata for the model.

The grid is constructed and the data structures are initialized based on information supplied in metadata. The data structures are not populated with any information however (all Profiles are NULL). The application should populate the new model's Profiles after this constructor completes.

Before calling this constructor, the supplied MetaData object must be populated with required information by calling the following MetaData methods:

setDescription()
setLayerNames()
setAttributes()
setDataType()
setLayerTessIds() (only required if grid has more than one multi-level tessellation)

Parameters

gridFileName	name of file from which to load the grid.
metaData	MetaData the new GeoTessModel instantiates a reference to the supplied metaData. No copy is made.

Exceptions

GeoTessException if metadata is incomplete.

◆ GeoTessModelAmplitude() [7/8]

geotess::GeoTessModelAmplitude::GeoTessModelAmplitude	(	GeoTessGrid *	grid,
		GeoTessMetaData *	metaData
	)

Parameterized constructor, specifying the grid and metadata for the model.

The grid is constructed and the data structures are initialized based on information supplied in metadata. The data structures are not populated with any information however (all Profiles are NULL). The application should populate the new model's Profiles after this constructor completes.

Before calling this constructor, the supplied MetaData object must be populated with required information by calling the following MetaData methods:

setDescription()
setLayerNames()
setAttributes()
setDataType()
setLayerTessIds() (only required if grid has more than one multi-level tessellation)
setSoftwareVersion()
setGenerationDate()

Parameters

grid	a pointer to the GeoTessGrid that will support this GeoTessModel. GeoTessModel assumes ownership of the supplied grid object and will delete it when it is done with it.
metaData	MetaData the new GeoTessModel instantiates a reference to the supplied metaData. No copy is made.

Exceptions

GeoTessException if metadata is incomplete.

◆ GeoTessModelAmplitude() [8/8]

geotess::GeoTessModelAmplitude::GeoTessModelAmplitude ( GeoTessModel * baseModel )

Construct a new GeoTessModelAmplitude by making a deep copy of an existing GeoTessModel and initializing the extra data with default values.

Parameters

baseModel pointer to an existing GeoTessModel.

Member Function Documentation

◆ class_name()

string geotess::GeoTessModelAmplitude::class_name ( )

inline

Returns the class name: GeoTessModelAmplitude.

Returns: the class name: GeoTessModelAmplitude

Definition at line 379 of file GeoTessModelAmplitude.h.

◆ getBands()

void geotess::GeoTessModelAmplitude::getBands	(	const string &	station,
		const string &	channel,
		set< string > &	bands
	)

inline

Retrieve the set of channels supported by the specified station.

Parameters

station
channel
bands	the set of bands supported by the specified station.

Definition at line 997 of file GeoTessModelAmplitude.h.

◆ getChannels()

void geotess::GeoTessModelAmplitude::getChannels	(	const string &	station,
		set< string > &	channels
	)

inline

Retrieve the set of channels supported by the specified station.

Parameters

station
channels	the set of channels supported by the specified station.

Definition at line 983 of file GeoTessModelAmplitude.h.

◆ getDxKm()

double geotess::GeoTessModelAmplitude::getDxKm ( )

inline

retrieve dxkm = path integration interval (km) through 2D tesselation

Returns: dxkm string

Definition at line 1239 of file GeoTessModelAmplitude.h.

◆ getFileformat()

int geotess::GeoTessModelAmplitude::getFileformat ( )

inline

Definition at line 888 of file GeoTessModelAmplitude.h.

◆ getFrequencyMap()

map< string, vector< float > > & geotess::GeoTessModelAmplitude::getFrequencyMap ( )

inline

Retrieve a reference to the map from a string representation of a frequency band, to the same information stored as a 2 element array of doubles.

For example, key = '1.0_2.0', value = [1.0, 2.0]

Returns: a reference to the map from a string representation of a frequency band, to the same information stored as a 2 element array of doubles.

Definition at line 1059 of file GeoTessModelAmplitude.h.

◆ getMDACAlphaS()

double geotess::GeoTessModelAmplitude::getMDACAlphaS ( )

inline

retrieve MDAC alphas = source region compressional velocity m/s MKS

Returns: value of alphas trailing S = Source region

Definition at line 1133 of file GeoTessModelAmplitude.h.

◆ getMDACBetaS()

double geotess::GeoTessModelAmplitude::getMDACBetaS ( )

inline

retrieve MDAC betas = source region shear velocity m/s MKS

Returns: value of betas trailing S = Source region

Definition at line 1140 of file GeoTessModelAmplitude.h.

◆ getMDACKfact()

double geotess::GeoTessModelAmplitude::getMDACKfact ( )

inline

retrieve MDAC K factor.

Returns: K factor

Definition at line 1153 of file GeoTessModelAmplitude.h.

◆ getMDACM0ref()

double geotess::GeoTessModelAmplitude::getMDACM0ref ( )

inline

retrieve MDAC Moref = earthquake reference moment Nm MKS

Returns: value of Moref

Definition at line 1112 of file GeoTessModelAmplitude.h.

◆ getMDACPsi()

double geotess::GeoTessModelAmplitude::getMDACPsi ( )

inline

retrieve MDAC psi = stress scaling (unitless)

Returns: value of psi

Definition at line 1100 of file GeoTessModelAmplitude.h.

◆ getMDACRadpatP()

double geotess::GeoTessModelAmplitude::getMDACRadpatP ( )

inline

retrieve MDAC radpatp = average/relative earthquake P radiation (unitless?)

Returns: value of radpatp trailing P = P wave

Definition at line 1119 of file GeoTessModelAmplitude.h.

◆ getMDACRadpatS()

double geotess::GeoTessModelAmplitude::getMDACRadpatS ( )

inline

retrieve MDAC radpats = average/relative earthquake S radiation (unitless?)

Returns: value of radpats trailing P = S wave

Definition at line 1126 of file GeoTessModelAmplitude.h.

◆ getMDACRhoS()

double geotess::GeoTessModelAmplitude::getMDACRhoS ( )

inline

retrieve MDAC rhos = source region density kg/m3 MKS

Returns: value of rhos trailing S = Source region

Definition at line 1147 of file GeoTessModelAmplitude.h.

◆ getMDACSigma()

double geotess::GeoTessModelAmplitude::getMDACSigma ( )

inline

retrieve MDAC sigma = earthquake apparent stress Pa MKS

Returns: value of sigma

Definition at line 1094 of file GeoTessModelAmplitude.h.

◆ getMDACZeta()

double geotess::GeoTessModelAmplitude::getMDACZeta ( )

inline

retrieve MDAC zeta = earthquake P/S corner frequency ratio (unitless)

Returns: value of zeta

Definition at line 1106 of file GeoTessModelAmplitude.h.

◆ getMemory()

virtual LONG_INT geotess::GeoTessModelAmplitude::getMemory ( )

inlinevirtual

Retrieve the amount of core memory required to load the model, in bytes.

This includes memory for the base class variables as well as the memory required to store the siteTrans information in the derived class. It does not include memory for the GeoTessGrid, which can be requested separately.

Returns: memory footprint in bytes.

Definition at line 582 of file GeoTessModelAmplitude.h.

◆ getNBands()

int geotess::GeoTessModelAmplitude::getNBands	(	const string &	station,
		const string &	channel
	)

inline

Definition at line 966 of file GeoTessModelAmplitude.h.

◆ getNChannels()

int geotess::GeoTessModelAmplitude::getNChannels ( const string & station )

inline

Definition at line 958 of file GeoTessModelAmplitude.h.

◆ getNSiteTrans()

int geotess::GeoTessModelAmplitude::getNSiteTrans ( )

inline

Retrieve the total number site terms supported for all station/channel/bands.

Returns: the total number site terms supported for all station/channel/bands

Definition at line 931 of file GeoTessModelAmplitude.h.

◆ getNStations()

int geotess::GeoTessModelAmplitude::getNStations ( )

inline

Retrieve the number of stations that have site terms represented.

Returns: the number of stations that have site terms represented.

Definition at line 944 of file GeoTessModelAmplitude.h.

◆ getPathQ() [1/4]

double geotess::GeoTessModelAmplitude::getPathQ	(	const double &	latA,
		const double &	lonA,
		const double &	latB,
		const double &	lonB,
		const bool &	inDegrees,
		const string &	band
	)

inline

Retrieve the value of effective Q for the specified frequency band, integrated along the great circle path from pointA to pointB.

Parameters

latA
lonA
latB
lonB
inDegrees	if true, lats and lons are assumed to be in degrees, otherwise radians.
band	the frequency band, e.g., "1.0_2.0"

Returns: the value of effective Q for the specified frequency band,

Exceptions

GeoTessException

Definition at line 654 of file GeoTessModelAmplitude.h.

◆ getPathQ() [2/4]

double geotess::GeoTessModelAmplitude::getPathQ	(	const double *	pointA,
		const double *	pointB,
		const string &	band
	)

inline

Retrieve the value of effective Q for the specified frequency band, integrated along the great circle path from pointA to pointB.

Parameters

pointA	unit vector representing start of great circle path
pointB	unit vector representing end of great circle path
band	the frequency band, e.g., "1.0_2.0"

Returns: the value of effective Q for the specified frequency band,

Exceptions

GeoTessException

Definition at line 682 of file GeoTessModelAmplitude.h.

◆ getPathQ() [3/4]

double geotess::GeoTessModelAmplitude::getPathQ	(	const string &	band,
		map< int, double >	weights
	)

inline

Retrieve the value of effective Q for the specified frequency band, using weights computed using GeoTessModel::getWeights, avoid repeat getWeights calls Q stored as floats.

Parameters

band	the frequency band, e.g., "1.0_2.0"
weights	a map from integer point index to double path weight at that point.

Returns: the value of effective Q for the specified frequency band,

Exceptions

GeoTessException

Definition at line 802 of file GeoTessModelAmplitude.h.

◆ getPathQ() [4/4]

double geotess::GeoTessModelAmplitude::getPathQ	(	GeoTessGreatCircle &	path,
		const string &	band
	)

inline

Retrieve the value of effective Q for the specified frequency band, integrated along the great circle path from pointA to pointB.

Parameters

path	great circle path along which to compute Q
band	the frequency band, e.g., "1.0_2.0"

Returns: the value of effective Q for the specified frequency band,

Exceptions

GeoTessException

Definition at line 696 of file GeoTessModelAmplitude.h.

◆ getPathVelocity()

double geotess::GeoTessModelAmplitude::getPathVelocity ( )

inline

Retrieve path velocity in furlongs/fortnight.

Returns: path velocity in furlongs/fortnight

Definition at line 1245 of file GeoTessModelAmplitude.h.

◆ getPhase()

string geotess::GeoTessModelAmplitude::getPhase ( )

inline

Retrieve the phase supported by this model.

Returns: the phase supported by this model

Definition at line 894 of file GeoTessModelAmplitude.h.

◆ getQmode()

string geotess::GeoTessModelAmplitude::getQmode ( )

inline

qmode "Q(f)" or "Qo-eta" parameterization of Q frequency dependence expect Q for each band or Qo and eta in this model, latter preferred

Returns: qmode string

Definition at line 1070 of file GeoTessModelAmplitude.h.

◆ getQTerm()

double geotess::GeoTessModelAmplitude::getQTerm	(	const string &	station,
		const string &	channel,
		const string &	band,
		const double &	rcvLat,
		const double &	rcvLon,
		const double &	sourceLat,
		const double &	sourceLon
	)

inline

Get Q effect on amplitude for a specified source-receiver path.

Includes the path integral of Q through the model plus site term plus spreading term.

Parameters

station
channel
band
siteLat	in degrees
siteLon	in degrees
sourceLat	in degrees
sourceLon	in degrees

Definition at line 1347 of file GeoTessModelAmplitude.h.

◆ getSiteTrans() [1/2]

map< string, map< string, map< string, float > > > & geotess::GeoTessModelAmplitude::getSiteTrans ( )

inline

Get reference to the map from station -> channel -> band -> siteTran.

Returns: a reference to the map from station -> channel -> band -> siteTran

Definition at line 900 of file GeoTessModelAmplitude.h.

◆ getSiteTrans() [2/2]

float geotess::GeoTessModelAmplitude::getSiteTrans	(	const string &	station,
		const string &	channel,
		const string &	band
	)

inline

Retrieve the site term for the specified station/channel/band or NaN if not supported.

Parameters

station
channel
band

Returns

Definition at line 911 of file GeoTessModelAmplitude.h.

◆ getSpreading()

double geotess::GeoTessModelAmplitude::getSpreading	(	double	distance,
		const double &	frequency = `NaN_DOUBLE`
	)

inline

Compute spreading (unitless), using Street-Herrmann or Yang formula (Pn only).

XYPn(Sn) Yang 2007, XY2seg Yang 2011, XY1seg? expand if needed assume spreadingValid has been called

Parameters

frequency	in Hz.
distance	source-receiver separation in km.

Definition at line 1293 of file GeoTessModelAmplitude.h.

◆ getSpreadMode()

string geotess::GeoTessModelAmplitude::getSpreadMode ( )

inline

spreadmode Standard, XYPn, XYPnSn, XY1seg, XY2seg Standard = (extended) Street-Herrmann XYPn, XYPnSn = Yang 2007 XY1seg, XY2seg = Yang 2011 (Pn only)

Returns: spreadmode string

Definition at line 1088 of file GeoTessModelAmplitude.h.

◆ getSpreadP1()

double geotess::GeoTessModelAmplitude::getSpreadP1 ( )

inline

retrieve p1 = local distance spreading (unitless)

Returns: value of p1

Definition at line 1213 of file GeoTessModelAmplitude.h.

◆ getSpreadP2()

double geotess::GeoTessModelAmplitude::getSpreadP2 ( )

inline

retrieve p2 = regional distance spreading (unitless)

Returns: value of p2

Definition at line 1219 of file GeoTessModelAmplitude.h.

◆ getSpreadXC()

double geotess::GeoTessModelAmplitude::getSpreadXC ( )

inline

retrieve xc = critical distance = transition between local and regional spreading (km)

Returns: value of xc

Definition at line 1225 of file GeoTessModelAmplitude.h.

◆ getSpreadXT()

double geotess::GeoTessModelAmplitude::getSpreadXT ( )

inline

retrieve xt = transition factor between local and regional spreading (km) xt = 1 reduces to Street-Herrman spreading, > 1 smoother transition used for coda spreading

Returns: value of xt

Definition at line 1233 of file GeoTessModelAmplitude.h.

◆ getStations()

void geotess::GeoTessModelAmplitude::getStations ( set< string > & stations )

inline

Retrieve the set of channels supported by the specified station.

Parameters

station
channels	the set of channels supported by the specified station.

Definition at line 952 of file GeoTessModelAmplitude.h.

◆ getVersion()

static string geotess::GeoTessModelAmplitude::getVersion ( )

inlinestatic

Retrieve the current version number.

Returns: the current version number

Definition at line 385 of file GeoTessModelAmplitude.h.

◆ getVersionGeoTessCPP()

static string geotess::GeoTessModelAmplitude::getVersionGeoTessCPP ( )

inlinestatic

Retrieve the current GeoTessCPP version number.

Returns: the current GeoTessCPP version number

Definition at line 391 of file GeoTessModelAmplitude.h.

◆ isSpreadingValid()

bool geotess::GeoTessModelAmplitude::isSpreadingValid ( )

inline

Return true if spreading attributes are all valid.

Returns: true if spreading attributes are all valid.

Definition at line 1251 of file GeoTessModelAmplitude.h.

◆ isSupportedBand()

bool geotess::GeoTessModelAmplitude::isSupportedBand	(	const string &	station,
		string	channel,
		string	band
	)

inline

Return true if there is a site term values available for the specified station-channel-band.

Parameters

station
channel
band

Returns: true if there is a site term values available for the specified station-channel-band

Definition at line 1040 of file GeoTessModelAmplitude.h.

◆ isSupportedChannel()

bool geotess::GeoTessModelAmplitude::isSupportedChannel	(	const string &	station,
		string	channel
	)

inline

Return true if there are any site term values available for the specified station-channel.

Parameters

station
channel

Returns: true if there are any site term values available for the specified station-channel

Definition at line 1025 of file GeoTessModelAmplitude.h.

◆ isSupportedStation()

bool geotess::GeoTessModelAmplitude::isSupportedStation ( const string & station )

inline

Return true if there are any site term values available for the specified station.

Parameters

station

Returns: true if there are any site term values available for the specified station

Definition at line 1014 of file GeoTessModelAmplitude.h.

◆ operator==()

virtual bool geotess::GeoTessModelAmplitude::operator== ( const GeoTessModelAmplitude & other ) const

virtual

Determine if this and other GeoTessModelAmplitudes are equal.

To be equal, all their base model data must be equal plus all

◆ setDxKm()

void geotess::GeoTessModelAmplitude::setDxKm ( const double & _dxkm )

inline

set dxkm = path integration interval (km) through 2D tesselation

Parameters

_dxkm path integration interval in km

Definition at line 1444 of file GeoTessModelAmplitude.h.

◆ setFileformat()

void geotess::GeoTessModelAmplitude::setFileformat ( const int & _fileformat )

inline

Specify the file format for this model, either 1 or 2.

If 1, only sitetrans info is appended. If 2, sitetrans and spreading info is appended.

Parameters

_fileformat

Exceptions

GeoTessException if _fileformat is not 1 or 2

Definition at line 1389 of file GeoTessModelAmplitude.h.

◆ setInterpolatorType()

void geotess::GeoTessModelAmplitude::setInterpolatorType ( const string & _interpolatorType )

inline

Set spreadmode string as above check for valid string.

Definition at line 1429 of file GeoTessModelAmplitude.h.

◆ setMDACAlphaS()

void geotess::GeoTessModelAmplitude::setMDACAlphaS ( const double & _alphas )

inline

set MDAC alphas = source region compressional velocity m/s MKS check valid range? watch for wrong units***

Definition at line 1502 of file GeoTessModelAmplitude.h.

◆ setMDACBetaS()

void geotess::GeoTessModelAmplitude::setMDACBetaS ( const double & _betas )

inline

set MDAC betas = source region shear velocity m/s MKS check valid range? watch for wrong units***

Definition at line 1508 of file GeoTessModelAmplitude.h.

◆ setMDACM0ref()

void geotess::GeoTessModelAmplitude::setMDACM0ref ( const double & _m0ref )

inline

set MDAC Moref = earthquake reference moment Nm MKS check valid range? watch for wrong units***

Definition at line 1484 of file GeoTessModelAmplitude.h.

◆ setMDACPsi()

void geotess::GeoTessModelAmplitude::setMDACPsi ( const double & _psi )

inline

set MDAC psi = stress scaling (unitless)

Parameters

MDAC psi

Definition at line 1472 of file GeoTessModelAmplitude.h.

◆ setMDACRadpatP()

void geotess::GeoTessModelAmplitude::setMDACRadpatP ( const double & _radpatp )

inline

set MDAC radpatp = average/relative earthquake P radiation (unitless?) check valid range? watch for wrong units***?

Definition at line 1490 of file GeoTessModelAmplitude.h.

◆ setMDACRadpatS()

void geotess::GeoTessModelAmplitude::setMDACRadpatS ( const double & _radpats )

inline

set MDAC radpats = average/relative earthquake S radiation (unitless?) check valid range? watch for wrong units***?

Definition at line 1496 of file GeoTessModelAmplitude.h.

◆ setMDACRhoS()

void geotess::GeoTessModelAmplitude::setMDACRhoS ( const double & _rhos )

inline

set MDAC rhos = source region density kg/m3 MKS check valid range? watch for wrong units***

Definition at line 1514 of file GeoTessModelAmplitude.h.

◆ setMDACSigma()

void geotess::GeoTessModelAmplitude::setMDACSigma ( const double & _sigma )

inline

set MDAC sigma = earthquake apparent stress Pa MKS

Parameters

MDAC sigma

Definition at line 1466 of file GeoTessModelAmplitude.h.

◆ setMDACZeta()

void geotess::GeoTessModelAmplitude::setMDACZeta ( const double & _zeta )

inline

set MDAC zeta = earthquake P/S corner frequency ratio (unitless) check valid range?

Definition at line 1478 of file GeoTessModelAmplitude.h.

◆ setPathVelocity()

void geotess::GeoTessModelAmplitude::setPathVelocity ( const double & _pathvel )

inline

Set path velocity in furlongs/fortnight.

Parameters

_pathvel path velocity in furlongs/fortnight

Definition at line 1546 of file GeoTessModelAmplitude.h.

◆ setPhase()

void geotess::GeoTessModelAmplitude::setPhase ( const string & _phase )

inline

Specify the phase supported by this model.

This method sets the values of the phase-dependent coefficients used by method getSpreadingXY().

Parameters

_phase the phase supported by this model

Exceptions

GeoTessException if phase is not one of [ Pn, Sn, Pg, Lg ]

Definition at line 1407 of file GeoTessModelAmplitude.h.

◆ setSiteTrans()

void geotess::GeoTessModelAmplitude::setSiteTrans ( map< string, map< string, map< string, float > > > & _siteTrans )

inline

Setter specifying a map from station -> channel -> band -> siteTran.

Parameters

_siteTrans

Definition at line 1422 of file GeoTessModelAmplitude.h.

◆ setSpreadMode()

void geotess::GeoTessModelAmplitude::setSpreadMode ( const string & _spreadmode )

inline

Set spreading mode.

Must be one of Standard, XYPn, XYPnSn, XY1seg, XY2seg

Parameters

_spreadmode

Definition at line 1450 of file GeoTessModelAmplitude.h.

◆ setSpreadP1()

void geotess::GeoTessModelAmplitude::setSpreadP1 ( const double & _p1 )

inline

set p1 = local distance spreading (unitless) check valid range?

Definition at line 1520 of file GeoTessModelAmplitude.h.

◆ setSpreadP2()

void geotess::GeoTessModelAmplitude::setSpreadP2 ( const double & _p2 )

inline

set p2 = regional distance spreading (unitless) check valid range?

Definition at line 1526 of file GeoTessModelAmplitude.h.

◆ setSpreadXC()

void geotess::GeoTessModelAmplitude::setSpreadXC ( const double & _xc )

inline

set xc = critical distance = transition between local and regional spreading (km) check valid range?

Definition at line 1532 of file GeoTessModelAmplitude.h.

◆ setSpreadXT()

void geotess::GeoTessModelAmplitude::setSpreadXT ( const double & _xt )

inline

set xt = transition factor between local and regional spreading (km) xt = 1 reduces to Street-Herrman spreading, > 1 smoother transition used for coda spreading check valid range? >= 1

Definition at line 1540 of file GeoTessModelAmplitude.h.

The documentation for this class was generated from the following file:

include/GeoTessModelAmplitude.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ GeoTessModelAmplitude() [1/8]

◆ GeoTessModelAmplitude() [2/8]

◆ GeoTessModelAmplitude() [3/8]

◆ GeoTessModelAmplitude() [4/8]

◆ GeoTessModelAmplitude() [5/8]

◆ GeoTessModelAmplitude() [6/8]

◆ GeoTessModelAmplitude() [7/8]

◆ GeoTessModelAmplitude() [8/8]

Member Function Documentation

◆ class_name()

◆ getBands()

◆ getChannels()

◆ getDxKm()

◆ getFileformat()

◆ getFrequencyMap()

◆ getMDACAlphaS()

◆ getMDACBetaS()

◆ getMDACKfact()

◆ getMDACM0ref()

◆ getMDACPsi()

◆ getMDACRadpatP()

◆ getMDACRadpatS()

◆ getMDACRhoS()

◆ getMDACSigma()

◆ getMDACZeta()

◆ getMemory()

◆ getNBands()

◆ getNChannels()

◆ getNSiteTrans()

◆ getNStations()

◆ getPathQ() [1/4]

◆ getPathQ() [2/4]

◆ getPathQ() [3/4]

◆ getPathQ() [4/4]

◆ getPathVelocity()

◆ getPhase()

◆ getQmode()

◆ getQTerm()

◆ getSiteTrans() [1/2]

◆ getSiteTrans() [2/2]

◆ getSpreading()

◆ getSpreadMode()

◆ getSpreadP1()

◆ getSpreadP2()

◆ getSpreadXC()

◆ getSpreadXT()

◆ getStations()

◆ getVersion()

◆ getVersionGeoTessCPP()

◆ isSpreadingValid()

◆ isSupportedBand()

◆ isSupportedChannel()

◆ isSupportedStation()

◆ operator==()

◆ setDxKm()

◆ setFileformat()

◆ setInterpolatorType()

◆ setMDACAlphaS()

◆ setMDACBetaS()

◆ setMDACM0ref()

◆ setMDACPsi()

◆ setMDACRadpatP()

◆ setMDACRadpatS()

◆ setMDACRhoS()

◆ setMDACSigma()

◆ setMDACZeta()

◆ setPathVelocity()

◆ setPhase()

◆ setSiteTrans()

◆ setSpreadMode()

◆ setSpreadP1()

◆ setSpreadP2()

◆ setSpreadXC()

◆ setSpreadXT()