openModeller  Version 1.5.0
AreaStats Class Reference

#include <AreaStats.hh>

Collaboration diagram for AreaStats:
Collaboration graph

Public Member Functions

 AreaStats (Scalar predictionThreshold=0.5)
 
 AreaStats (const AreaStats *areaStats)
 
 ~AreaStats ()
 
void reset (Scalar predictionThreshold=0.5)
 
void addPrediction (Scalar predictionValue)
 
void addNonPrediction ()
 
int getTotalArea () const
 
int getAreaPredictedPresent () const
 
int getAreaPredictedAbsent () const
 
int getAreaNotPredicted () const
 
Scalar getPredictionThreshold () const
 
ConfigurationPtr getConfiguration () const
 

Private Attributes

int _areaTotal
 
int _areaPredPresent
 
int _areaPredAbsent
 
int _areaNotPredicted
 
Scalar _predictionThreshold
 

Detailed Description

Definition at line 38 of file AreaStats.hh.

Constructor & Destructor Documentation

AreaStats::AreaStats ( Scalar  predictionThreshold = 0.5)

Default constructor.

Parameters
predictionThresholdThreshold for prediction values, above which a prediction value means a predicted presence.

Definition at line 33 of file AreaStats.cpp.

References reset().

Here is the call graph for this function:

AreaStats::AreaStats ( const AreaStats areaStats)

Copy constructor.

Parameters
areaStatsPointer to an AreaStats object to be copied.

Definition at line 38 of file AreaStats.cpp.

AreaStats::~AreaStats ( )

Destructor.

Definition at line 46 of file AreaStats.cpp.

Member Function Documentation

void AreaStats::addNonPrediction ( )

Count a cell where the prediction doesn't apply.

Definition at line 67 of file AreaStats.cpp.

References _areaNotPredicted, and _areaTotal.

void AreaStats::addPrediction ( Scalar  predictionValue)

Count another cell based on its prediction value.

Parameters
predictionValueValue of the prediction in the current cell.

Definition at line 57 of file AreaStats.cpp.

References _areaPredAbsent, _areaPredPresent, _areaTotal, and _predictionThreshold.

Referenced by Projector::createMap(), and OpenModeller::getEstimatedAreaStats().

int AreaStats::getAreaNotPredicted ( ) const
inline

Returns total number of cells where prediction doesn't apply.

Definition at line 97 of file AreaStats.hh.

int AreaStats::getAreaPredictedAbsent ( ) const
inline

Returns total number of cell predicted absent.

Definition at line 92 of file AreaStats.hh.

int AreaStats::getAreaPredictedPresent ( ) const
inline

Returns total number of cell predicted present.

Definition at line 87 of file AreaStats.hh.

Referenced by main().

ConfigurationPtr AreaStats::getConfiguration ( ) const

Serialize the area stats

Definition at line 75 of file AreaStats.cpp.

References _areaPredPresent, _areaTotal, and _predictionThreshold.

Referenced by main().

Scalar AreaStats::getPredictionThreshold ( ) const
inline

Returns the prediction threshold.

Definition at line 102 of file AreaStats.hh.

Referenced by Projector::createMap().

int AreaStats::getTotalArea ( ) const
inline

Returns total number of cells counted.

Definition at line 82 of file AreaStats.hh.

Referenced by main().

void AreaStats::reset ( Scalar  predictionThreshold = 0.5)

Resets area counters.

Parameters
predictionThresholdNew threshold for prediction values, above which a prediction value means a predicted presence.

Definition at line 50 of file AreaStats.cpp.

References _areaNotPredicted, _areaPredAbsent, _areaPredPresent, _areaTotal, and _predictionThreshold.

Referenced by AreaStats(), Projector::createMap(), OpenModeller::getEstimatedAreaStats(), and OpenModeller::setProjectionConfiguration().

Member Data Documentation

int AreaStats::_areaNotPredicted
private

Definition at line 113 of file AreaStats.hh.

Referenced by addNonPrediction(), and reset().

int AreaStats::_areaPredAbsent
private

Definition at line 112 of file AreaStats.hh.

Referenced by addPrediction(), and reset().

int AreaStats::_areaPredPresent
private

Definition at line 111 of file AreaStats.hh.

Referenced by addPrediction(), getConfiguration(), and reset().

int AreaStats::_areaTotal
private

Definition at line 110 of file AreaStats.hh.

Referenced by addNonPrediction(), addPrediction(), getConfiguration(), and reset().

Scalar AreaStats::_predictionThreshold
private

Definition at line 115 of file AreaStats.hh.

Referenced by addPrediction(), getConfiguration(), and reset().


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