glasscore detection trigger class More...

#include <Trigger.h>

Collaboration diagram for glasscore::CTrigger:

Public Member Functions
	CTrigger ()
	CTrigger constructor. More...

	CTrigger (double lat, double lon, double z, double ot, double resolution, double maxZ, double sum, int count, bool aSeismic, std::vector< std::shared_ptr< CPick >> picks, CWeb *web)
	CTrigger advanced constructor. More...

	~CTrigger ()
	CTrigger destructor. More...

bool	initialize (double lat, double lon, double z, double ot, double resolution, double maxZ, double sum, int count, bool aSeismic, std::vector< std::shared_ptr< CPick >> picks, CWeb *web)
	CTrigger initialization function. More...

void	clear ()
	CTrigger clear function. More...

double	getLatitude () const
	Get the latitude for this trigger. More...

double	getLongitude () const
	Get the longitude for this trigger. More...

double	getDepth () const
	Get the depth for this trigger. More...

glass3::util::Geo	getGeo () const
	Get the combined trigger location (latitude, longitude, depth) as a CGeo object. More...

double	getTOrigin () const
	Get the origin time for this trigger. More...

double	getWebResolution () const
	Gets the node resolution of the web that nucleated this trigger. More...

double	getNodeMaxDepth () const
	Get the node max depth for this trigger. More...

bool	getNodeAseismic () const
	Gets a flag indicating that the node is in an aseismic area. More...

double	getBayesValue () const
	Gets the current bayes stack value for this trigger. More...

int	getPickCount () const
	Gets the number of picks supporting this trigger. More...

const CWeb *	getWeb () const
	Gets a pointer to the web that generated this trigger, used to get travel times. More...

const std::vector< std::shared_ptr< CPick > >	getVPick () const
	Get the list of picks supporting this trigger. More...

Detailed Description

glasscore detection trigger class

The CTrigger class represents a single detection trigger from the detection graph database. A CTrigger consists of the location (latitude, longitude, and depth) of the triggering node, the spatial resolution of the triggering node, and a list of picks that made the trigger

CTrigger uses smart pointers (std::shared_ptr).

Constructor & Destructor Documentation

glasscore::CTrigger::CTrigger ( )

CTrigger constructor.

glasscore::CTrigger::CTrigger	(	double	lat,
		double	lon,
		double	z,
		double	ot,
		double	resolution,
		double	maxZ,
		double	sum,
		int	count,
		bool	aSeismic,
		std::vector< std::shared_ptr< CPick >>	picks,
		CWeb *	web
	)

CTrigger advanced constructor.

Construct a trigger using the provided data

Parameters

lat	- A double value containing the latitude to use for this trigger in degrees
lon	- A double value containing the longitude to use for this trigger in degrees
z	- A double value containing the depth to use for this trigger in kilometers
ot	- A double value containing the time to use for this trigger in seconds
resolution	- A double value containing the inter-node resolution in kilometer
maxZ	- A double value containing the node maximum depth
sum	- A double value containing the bayesian sum for this trigger
count	- An integer value containing the site count for this trigger
aSeismic	- A boolean flag indicating whether the node is aseismic
picks	- A std::vector<std::shared_ptr<CPick> containing the picks for this trigger
web	- A pointer to the creating node's CWeb

glasscore::CTrigger::~CTrigger ( )

CTrigger destructor.

Member Function Documentation

void glasscore::CTrigger::clear ( )

CTrigger clear function.

double glasscore::CTrigger::getBayesValue ( ) const

Gets the current bayes stack value for this trigger.

Returns: Returns a double containing the current bayes stack value

double glasscore::CTrigger::getDepth ( ) const

Get the depth for this trigger.

Returns: Return a double containing the depth in kilometers

glass3::util::Geo glasscore::CTrigger::getGeo ( ) const

Get the combined trigger location (latitude, longitude, depth) as a CGeo object.

Returns: Returns a glass3::util::Geo object containing the combined location.

double glasscore::CTrigger::getLatitude ( ) const

Get the latitude for this trigger.

Returns: Return a double containing the latitude in degrees

double glasscore::CTrigger::getLongitude ( ) const

Get the longitude for this trigger.

Returns: Return a double containing the longitude in degrees

bool glasscore::CTrigger::getNodeAseismic ( ) const

Gets a flag indicating that the node is in an aseismic area.

Returns: Returns a boolean flag, true if the node is aseismic, false otherwise

double glasscore::CTrigger::getNodeMaxDepth ( ) const

Get the node max depth for this trigger.

Returns: Return a double containing the node max depth in kilometers

int glasscore::CTrigger::getPickCount ( ) const

Gets the number of picks supporting this trigger.

Returns: Returns and integer containing the number of picks supporting this trigger

double glasscore::CTrigger::getTOrigin ( ) const

Get the origin time for this trigger.

Returns: Returns a double containing the trigger origin time in Gregorian seconds

const std::vector< std::shared_ptr< CPick > > glasscore::CTrigger::getVPick ( ) const

Get the list of picks supporting this trigger.

Returns: Returns a vector of shared_ptr's to the CPick objects supporting this trigger

const CWeb * glasscore::CTrigger::getWeb ( ) const

Gets a pointer to the web that generated this trigger, used to get travel times.

Returns: Returns a pointer to the CWeb that generated this trigger

double glasscore::CTrigger::getWebResolution ( ) const

Gets the node resolution of the web that nucleated this trigger.

Returns: Returns a double value containing the node resolution of the web that nucleated this trigger in kilometers

bool glasscore::CTrigger::initialize	(	double	lat,
		double	lon,
		double	z,
		double	ot,
		double	resolution,
		double	maxZ,
		double	sum,
		int	count,
		bool	aSeismic,
		std::vector< std::shared_ptr< CPick >>	picks,
		CWeb *	web
	)

CTrigger initialization function.

Initialize a trigger using the provided data

Parameters

lat	- A double value containing the latitude to use for this trigger in degrees
lon	- A double value containing the longitude to use for this trigger in degrees
z	- A double value containing the depth to use for this trigger in kilometers
ot	- A double value containing the time to use for this trigger in seconds
resolution	- A double value containing the inter-node resolution in kilometer
maxZ	- A double value containing the node maximum depth
sum	- A double value containing the bayesian sum for this trigger
count	- An integer value containing the site count for this trigger
aSeismic	- A boolean flag indicating whether the node is aseismic
picks	- A std::vector<std::shared_ptr<CPick> containing the picks for this trigger
web	- A pointer to the creating node's web

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

glasscore/glasslib/include/Trigger.h
glasscore/glasslib/src/Trigger.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation