The RasterBandStats struct is a container for statistics about a single raster band. More...

#include <qgsrasterbandstats.h>

Public Member Functions
	QgsRasterBandStats ()=default

bool	contains (const QgsRasterBandStats &s) const
	Compares region, size etc. not collected statistics.

Public Attributes
int	bandNumber = 1
	The gdal band number (starts at 1)

qgssize	elementCount = 0
	The number of not no data cells in the band.

QgsRectangle	extent
	Extent used to calc statistics.

int	height = 0
	Number of rows used to calc statistics.

double	maximumValue = -std::numeric_limits<double>::max()
	The maximum cell value in the raster band.

double	mean = 0
	The mean cell value for the band. NO_DATA values are excluded.

double	minimumValue = std::numeric_limits<double>::max()
	The minimum cell value in the raster band.

double	range = 0
	The range is the distance between min & max.

Qgis::RasterBandStatistics	statsGathered
	Collected statistics.

double	stdDev = 0
	The standard deviation of the cell values.

double	sum = 0
	The sum of all cells in the band. NO_DATA values are excluded.

double	sumOfSquares = 0
	The sum of the squares. Used to calculate standard deviation.

int	width = 0
	Number of columns used to calc statistics.

Detailed Description

The RasterBandStats struct is a container for statistics about a single raster band.

Definition at line 36 of file qgsrasterbandstats.h.

Constructor & Destructor Documentation

◆ QgsRasterBandStats()

QgsRasterBandStats::QgsRasterBandStats ( )

default

Member Function Documentation

◆ contains()

bool QgsRasterBandStats::contains ( const QgsRasterBandStats & s ) const

inline

Compares region, size etc. not collected statistics.

Definition at line 43 of file qgsrasterbandstats.h.

Member Data Documentation

◆ bandNumber

int QgsRasterBandStats::bandNumber = 1

The gdal band number (starts at 1)

Definition at line 53 of file qgsrasterbandstats.h.

◆ elementCount

qgssize QgsRasterBandStats::elementCount = 0

The number of not no data cells in the band.

Definition at line 58 of file qgsrasterbandstats.h.

◆ extent

QgsRectangle QgsRasterBandStats::extent

Extent used to calc statistics.

Definition at line 97 of file qgsrasterbandstats.h.

◆ height

int QgsRasterBandStats::height = 0

Number of rows used to calc statistics.

Definition at line 94 of file qgsrasterbandstats.h.

◆ maximumValue

double QgsRasterBandStats::maximumValue = -std::numeric_limits<double>::max()

The maximum cell value in the raster band.

NO_DATA values are ignored. This does not use the gdal GetMaximmum function.

Definition at line 64 of file qgsrasterbandstats.h.

◆ mean

double QgsRasterBandStats::mean = 0

The mean cell value for the band. NO_DATA values are excluded.

Definition at line 73 of file qgsrasterbandstats.h.

◆ minimumValue

double QgsRasterBandStats::minimumValue = std::numeric_limits<double>::max()

The minimum cell value in the raster band.

NO_DATA values are ignored. This does not use the gdal GetMinimum function.

Definition at line 70 of file qgsrasterbandstats.h.

◆ range

double QgsRasterBandStats::range = 0

The range is the distance between min & max.

Definition at line 76 of file qgsrasterbandstats.h.

◆ statsGathered

Qgis::RasterBandStatistics QgsRasterBandStats::statsGathered

Collected statistics.

Definition at line 82 of file qgsrasterbandstats.h.

◆ stdDev

double QgsRasterBandStats::stdDev = 0

The standard deviation of the cell values.

Definition at line 79 of file qgsrasterbandstats.h.

◆ sum

double QgsRasterBandStats::sum = 0

The sum of all cells in the band. NO_DATA values are excluded.

Definition at line 85 of file qgsrasterbandstats.h.

◆ sumOfSquares

double QgsRasterBandStats::sumOfSquares = 0

The sum of the squares. Used to calculate standard deviation.

Definition at line 88 of file qgsrasterbandstats.h.

◆ width

int QgsRasterBandStats::width = 0

Number of columns used to calc statistics.

Definition at line 91 of file qgsrasterbandstats.h.

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

/build/qgis-3.41.0+git20241126+3291e9ff48b+99sid/src/core/raster/qgsrasterbandstats.h

Public Member Functions

Public Attributes