QGIS API Documentation 3.29.0-Master (006c3c0232)
Public Member Functions | Static Public Member Functions | List of all members
QgsPointCloudStatistics Class Reference

Class used to store statistics of a point cloud dataset. More...

#include <qgspointcloudstatistics.h>

Public Member Functions

 QgsPointCloudStatistics ()
 Constructor. More...
 
 QgsPointCloudStatistics (int sampledPointsCount, const QMap< QString, QgsPointCloudAttributeStatistics > &stats)
 Constructor from statistics map. More...
 
QMap< int, int > availableClasses (const QString &attribute) const
 Returns a map containing the count of each class of the attribute attribute If no matching statistic is available then an empty map will be returned. More...
 
QList< int > classesOf (const QString &attribute) const
 Returns a list of existing classes which are present for the specified attribute. More...
 
void clear ()
 Clears the statistics of all attributes. More...
 
void clear (const QVector< QgsPointCloudAttribute > &attributes)
 Clears the statistics of given attributes attributes. More...
 
void combineWith (const QgsPointCloudStatistics &stats)
 Merges the current statistics with the statistics from stats. More...
 
double maximum (const QString &attribute) const
 Returns the maximum value for the attribute attribute If no matching statistic is available then NaN will be returned. More...
 
double mean (const QString &attribute) const
 Returns the mean value for the attribute attribute If no matching statistic is available then NaN will be returned. More...
 
double minimum (const QString &attribute) const
 Returns the minimum value for the attribute attribute If no matching statistic is available then NaN will be returned. More...
 
int sampledPointsCount () const
 Returns the number of points used to calculate the statistics. More...
 
QMap< QString, QgsPointCloudAttributeStatisticsstatisticsMap () const
 Returns a map object containing all the statistics. More...
 
QgsPointCloudAttributeStatistics statisticsOf (const QString &attribute) const
 Returns the calculated statistics of attribute attribute. More...
 
double stDev (const QString &attribute) const
 Returns the standard deviation value for the attribute attribute If no matching statistic is available then NaN will be returned. More...
 
QByteArray toStatisticsJson () const
 Converts the current statistics object into JSON object. More...
 

Static Public Member Functions

static QgsPointCloudStatistics fromStatisticsJson (QByteArray stats)
 Creates a statistics object from the JSON object stats. More...
 

Detailed Description

Class used to store statistics of a point cloud dataset.

Since
QGIS 3.26

Definition at line 61 of file qgspointcloudstatistics.h.

Constructor & Destructor Documentation

◆ QgsPointCloudStatistics() [1/2]

QgsPointCloudStatistics::QgsPointCloudStatistics ( )

Constructor.

Definition at line 55 of file qgspointcloudstatistics.cpp.

◆ QgsPointCloudStatistics() [2/2]

QgsPointCloudStatistics::QgsPointCloudStatistics ( int  sampledPointsCount,
const QMap< QString, QgsPointCloudAttributeStatistics > &  stats 
)

Constructor from statistics map.

Definition at line 60 of file qgspointcloudstatistics.cpp.

Member Function Documentation

◆ availableClasses()

QMap< int, int > QgsPointCloudStatistics::availableClasses ( const QString &  attribute) const

Returns a map containing the count of each class of the attribute attribute If no matching statistic is available then an empty map will be returned.

Definition at line 96 of file qgspointcloudstatistics.cpp.

◆ classesOf()

QList< int > QgsPointCloudStatistics::classesOf ( const QString &  attribute) const

Returns a list of existing classes which are present for the specified attribute.

Definition at line 88 of file qgspointcloudstatistics.cpp.

◆ clear() [1/2]

void QgsPointCloudStatistics::clear ( )

Clears the statistics of all attributes.

Definition at line 66 of file qgspointcloudstatistics.cpp.

◆ clear() [2/2]

void QgsPointCloudStatistics::clear ( const QVector< QgsPointCloudAttribute > &  attributes)

Clears the statistics of given attributes attributes.

Definition at line 71 of file qgspointcloudstatistics.cpp.

◆ combineWith()

void QgsPointCloudStatistics::combineWith ( const QgsPointCloudStatistics stats)

Merges the current statistics with the statistics from stats.

Definition at line 132 of file qgspointcloudstatistics.cpp.

◆ fromStatisticsJson()

QgsPointCloudStatistics QgsPointCloudStatistics::fromStatisticsJson ( QByteArray  stats)
static

Creates a statistics object from the JSON object stats.

Definition at line 163 of file qgspointcloudstatistics.cpp.

◆ maximum()

double QgsPointCloudStatistics::maximum ( const QString &  attribute) const

Returns the maximum value for the attribute attribute If no matching statistic is available then NaN will be returned.

Definition at line 110 of file qgspointcloudstatistics.cpp.

◆ mean()

double QgsPointCloudStatistics::mean ( const QString &  attribute) const

Returns the mean value for the attribute attribute If no matching statistic is available then NaN will be returned.

Definition at line 117 of file qgspointcloudstatistics.cpp.

◆ minimum()

double QgsPointCloudStatistics::minimum ( const QString &  attribute) const

Returns the minimum value for the attribute attribute If no matching statistic is available then NaN will be returned.

Definition at line 103 of file qgspointcloudstatistics.cpp.

◆ sampledPointsCount()

int QgsPointCloudStatistics::sampledPointsCount ( ) const
inline

Returns the number of points used to calculate the statistics.

Definition at line 73 of file qgspointcloudstatistics.h.

◆ statisticsMap()

QMap< QString, QgsPointCloudAttributeStatistics > QgsPointCloudStatistics::statisticsMap ( ) const
inline

Returns a map object containing all the statistics.

Definition at line 131 of file qgspointcloudstatistics.h.

◆ statisticsOf()

QgsPointCloudAttributeStatistics QgsPointCloudStatistics::statisticsOf ( const QString &  attribute) const

Returns the calculated statistics of attribute attribute.

Definition at line 79 of file qgspointcloudstatistics.cpp.

◆ stDev()

double QgsPointCloudStatistics::stDev ( const QString &  attribute) const

Returns the standard deviation value for the attribute attribute If no matching statistic is available then NaN will be returned.

Definition at line 124 of file qgspointcloudstatistics.cpp.

◆ toStatisticsJson()

QByteArray QgsPointCloudStatistics::toStatisticsJson ( ) const

Converts the current statistics object into JSON object.

Definition at line 147 of file qgspointcloudstatistics.cpp.


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