glassutil zonestats class More...

#include <ZoneStats.h>

Collaboration diagram for traveltime::CZoneStats:

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

	~CZoneStats ()
	CZoneStats destructor. More...

virtual bool	setup (const std::string *pConfigFileName)
	CZoneStats configuration function. More...

virtual void	clear ()
	CZoneStats clear function. More...

const ZoneStatsInfoStruct *	getZonestatsInfoForLatLon (double dLat, double dLon)
	CZoneStats retrieval function. More...

float	getMaxDepthForLatLon (double dLat, double dLon)
	Max Depth retrieval function. More...

float	getRelativeObservabilityOfSeismicEventsAtLocation (double dLat, double dLon)
	relative observability retrieval function More...

Static Public Attributes
static const char *	szLatGridBinSize = "LatGridBinSize"
	A const char array representing the Lat grid bin string size. More...

static const char *	szLonGridBinSize = "LonGridBinSize"
	A const char array representing the Lon grid bin string size. More...

static const char *	szLatLonHeader = "LAT LON "
	A const char array representing the Lat/Lon header string size. More...

static const int	nNumExpectedFields = 9
	An integer constant containing the number of fields for parsing. More...

static const int	iParseStateGetSZRecords = 3
	An integer constant defining the state for getting sz records. More...

static const int	iParseStateGetLatGBS = 0
	An integer constant defining the state for getting lat gbs. More...

static const int	iParseStateGetLonGBS = 1
	An integer constant defining the state for getting lon gbs. More...

static const int	iParseStateGetRecordHeader = 2
	An integer constant defining the state for getting the record header. More...

static const float	depthInvalid = -999.0
	A float constant containing the invalid depth value. More...

Protected Attributes
std::vector< ZoneStatsInfoStruct >	m_vZSData
	a std::vector of ZoneStatsInfoStruct's containing the zone stats information More...

int	m_nTotalNumEvents
	An integer containing the total number of events in the zone stats information. More...

double	m_dAvgObservabilityPerBin
	A double containing the average observability per bin. More...

float	fLatBinSizeDeg
	A float containing the laititude bin size in degrees. More...

float	fLonBinSizeDeg
	A float containing the longitude bin size in degrees. More...

ZoneStatsInfoStruct	m_ZSDefault
	a ZoneStatsInfoStruct containing the default zone stats information More...

Detailed Description

glassutil zonestats class

The CZonestats class encapsulates the logic and functionality needed to load and serve zone statistics for historical seismic events

Constructor & Destructor Documentation

traveltime::CZoneStats::CZoneStats ( )

CZoneStats constructor.

The constructor for the CZoneStats class.

traveltime::CZoneStats::~CZoneStats ( )

CZoneStats destructor.

The destructor for the CZoneStats class.

Member Function Documentation

void traveltime::CZoneStats::clear ( )

virtual

CZoneStats clear function.

The clear function for the CZoneStats class. Clears all zonestats info.

float traveltime::CZoneStats::getMaxDepthForLatLon	(	double	dLat,
		double	dLon
	)

Max Depth retrieval function.

This function gets the maximum depth for a given latitude and longitude

Parameters

dLat	- A double containing the latitude to use
dLon	- A double containing the longitude to use

Returns: Returns a double value containing the maximum depth

float traveltime::CZoneStats::getRelativeObservabilityOfSeismicEventsAtLocation	(	double	dLat,
		double	dLon
	)

relative observability retrieval function

This function gets the relative observability for a given latitude and longitude

Parameters

dLat	- A double containing the latitude to use
dLon	- A double containing the longitude to use

Returns: Returns a double value containing the relative observability

const ZoneStatsInfoStruct * traveltime::CZoneStats::getZonestatsInfoForLatLon	(	double	dLat,
		double	dLon
	)

CZoneStats retrieval function.

This function gets the zone stats information for a given latitude and longitude

Parameters

dLat	- A double containing the latitude to use
dLon	- A double containing the longitude to use

Returns: Returns pointer to a ZoneStatsInfoStruct containing the zone stats information

bool traveltime::CZoneStats::setup ( const std::string * pConfigFileName )

virtual

CZoneStats configuration function.

This function configures the CZoneStats class

Parameters

pConfigFileName - A pointer to the config filename, from which to read zonestats info.

Returns: returns true if successful.

Member Data Documentation

const float traveltime::CZoneStats::depthInvalid = -999.0

static

A float constant containing the invalid depth value.

float traveltime::CZoneStats::fLatBinSizeDeg

protected

A float containing the laititude bin size in degrees.

float traveltime::CZoneStats::fLonBinSizeDeg

protected

A float containing the longitude bin size in degrees.

const int traveltime::CZoneStats::iParseStateGetLatGBS = 0

static

An integer constant defining the state for getting lat gbs.

const int traveltime::CZoneStats::iParseStateGetLonGBS = 1

static

An integer constant defining the state for getting lon gbs.

const int traveltime::CZoneStats::iParseStateGetRecordHeader = 2

static

An integer constant defining the state for getting the record header.

const int traveltime::CZoneStats::iParseStateGetSZRecords = 3

static

An integer constant defining the state for getting sz records.

double traveltime::CZoneStats::m_dAvgObservabilityPerBin

protected

A double containing the average observability per bin.

int traveltime::CZoneStats::m_nTotalNumEvents

protected

An integer containing the total number of events in the zone stats information.

std::vector<ZoneStatsInfoStruct> traveltime::CZoneStats::m_vZSData

protected

a std::vector of ZoneStatsInfoStruct's containing the zone stats information

ZoneStatsInfoStruct traveltime::CZoneStats::m_ZSDefault

protected

a ZoneStatsInfoStruct containing the default zone stats information

const int traveltime::CZoneStats::nNumExpectedFields = 9

static

An integer constant containing the number of fields for parsing.

const char * traveltime::CZoneStats::szLatGridBinSize = "LatGridBinSize"

static

A const char array representing the Lat grid bin string size.

const char * traveltime::CZoneStats::szLatLonHeader = "LAT LON "

static

A const char array representing the Lat/Lon header string size.

const char * traveltime::CZoneStats::szLonGridBinSize = "LonGridBinSize"

static

A const char array representing the Lon grid bin string size.

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

glasscore/traveltime/include/ZoneStats.h
glasscore/traveltime/src/ZoneStats.cpp

Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation