WSF
wsf::coverage::MeasureLatLonStats Class Reference

#include <WsfCoverageMeasureLatLonStats.hpp>

Public Types

enum class  Projection { cLATITUDE , cLONGITUDE }
 The projection direction. More...

Public Member Functions

 MeasureLatLonStats (const Coverage &aCoverage, const Measure &aMeasure, Projection aProjection, double aMinimumBinSize)
Projection GetProjection () const
 Return the projection direction.
std::string GetProjectionDescription () const
 Return the string description of the projection direction.
std::size_t GetSize () const
 Return the number of projected data points.
double GetVariable (std::size_t aIndex) const
 Return the latitude or longitude for the given index.
double GetMinValue (std::size_t aIndex) const
 Return the minimum value of the measured quantity for the given index.
double GetMaxValue (std::size_t aIndex) const
 Return the maximum value of the measured quantity for the given index.
double GetMeanValue (std::size_t aIndex) const
 Return the mean value of the measured quantity for the given index.
int GetCount (std::size_t aIndex) const
 Return the number of points that contributed to the mean for the given index.

Detailed Description

Class to project measured values onto latitude or longitude.

The computes the minimum, maximum and mean values of a quantity that was measured over some coverage grid. The statistics are computed for either the set of latitude or longitude values present in the grid. After the projection, independent values are considered to be the same if they are withing a given bin size. This is intended to avoid numerical issues with floating-point comparison, and should typically be set to a small value.

Member Enumeration Documentation

◆ Projection

The projection direction.

Enumerator
cLATITUDE 
cLONGITUDE 

Constructor & Destructor Documentation

◆ MeasureLatLonStats()

wsf::coverage::MeasureLatLonStats::MeasureLatLonStats ( const Coverage & aCoverage,
const Measure & aMeasure,
Projection aProjection,
double aMinimumBinSize )

Member Function Documentation

◆ GetCount()

int wsf::coverage::MeasureLatLonStats::GetCount ( std::size_t aIndex) const
inline

Return the number of points that contributed to the mean for the given index.

◆ GetMaxValue()

double wsf::coverage::MeasureLatLonStats::GetMaxValue ( std::size_t aIndex) const
inline

Return the maximum value of the measured quantity for the given index.

◆ GetMeanValue()

double wsf::coverage::MeasureLatLonStats::GetMeanValue ( std::size_t aIndex) const
inline

Return the mean value of the measured quantity for the given index.

◆ GetMinValue()

double wsf::coverage::MeasureLatLonStats::GetMinValue ( std::size_t aIndex) const
inline

Return the minimum value of the measured quantity for the given index.

◆ GetProjection()

Projection wsf::coverage::MeasureLatLonStats::GetProjection ( ) const
inline

Return the projection direction.

◆ GetProjectionDescription()

std::string wsf::coverage::MeasureLatLonStats::GetProjectionDescription ( ) const

Return the string description of the projection direction.

References cLATITUDE.

◆ GetSize()

std::size_t wsf::coverage::MeasureLatLonStats::GetSize ( ) const
inline

Return the number of projected data points.

◆ GetVariable()

double wsf::coverage::MeasureLatLonStats::GetVariable ( std::size_t aIndex) const
inline

Return the latitude or longitude for the given index.


The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved