QgsRasterBandStats Class Reference

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

#include <qgsrasterbandstats.h>

Public Types
enum	Stats {   None = 0, Min = 1, Max = 1 << 1, Range = 1 << 2,   Sum = 1 << 3, Mean = 1 << 4, StdDev = 1 << 5, SumOfSquares = 1 << 6,   All = Min | Max | Range | Sum | Mean | StdDev | SumOfSquares }

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

Public Attributes
int	bandNumber
	The gdal band number (starts at 1) More...
qgssize	elementCount
	The number of not no data cells in the band. More...
QgsRectangle	extent
	Extent used to calc statistics. More...
int	height
	Number of rows used to calc statistics. More...
double	maximumValue
	The maximum cell value in the raster band. More...
double	mean
	The mean cell value for the band. NO_DATA values are excluded. More...
double	minimumValue
	The minimum cell value in the raster band. More...
double	range
	The range is the distance between min & max. More...
int	statsGathered
	Collected statistics. More...
double	stdDev
	The standard deviation of the cell values. More...
double	sum
	The sum of all cells in the band. NO_DATA values are excluded. More...
double	sumOfSquares
	The sum of the squares. Used to calculate standard deviation. More...
int	width
	Number of columns used to calc statistics. More...

Detailed Description

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

Definition at line 34 of file qgsrasterbandstats.h.

Member Enumeration Documentation

enum QgsRasterBandStats::Stats

Enumerator
None
Min
Max
Range
Sum
Mean
StdDev
SumOfSquares
All

Definition at line 37 of file qgsrasterbandstats.h.

Constructor & Destructor Documentation

QgsRasterBandStats::QgsRasterBandStats ( )

inline

Definition at line 50 of file qgsrasterbandstats.h.

Member Function Documentation

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

inline

Compares region, size etc. not collected statistics.

Definition at line 67 of file qgsrasterbandstats.h.

Member Data Documentation

int QgsRasterBandStats::bandNumber

The gdal band number (starts at 1)

Definition at line 77 of file qgsrasterbandstats.h.

qgssize QgsRasterBandStats::elementCount

The number of not no data cells in the band.

Definition at line 81 of file qgsrasterbandstats.h.

QgsRectangle QgsRasterBandStats::extent

Extent used to calc statistics.

Definition at line 118 of file qgsrasterbandstats.h.

int QgsRasterBandStats::height

Number of rows used to calc statistics.

Definition at line 115 of file qgsrasterbandstats.h.

double QgsRasterBandStats::maximumValue

The maximum cell value in the raster band.

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

Definition at line 86 of file qgsrasterbandstats.h.

double QgsRasterBandStats::mean

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

Definition at line 94 of file qgsrasterbandstats.h.

double QgsRasterBandStats::minimumValue

The minimum cell value in the raster band.

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

Definition at line 91 of file qgsrasterbandstats.h.

double QgsRasterBandStats::range

The range is the distance between min & max.

Definition at line 97 of file qgsrasterbandstats.h.

int QgsRasterBandStats::statsGathered

Collected statistics.

Definition at line 103 of file qgsrasterbandstats.h.

double QgsRasterBandStats::stdDev

The standard deviation of the cell values.

Definition at line 100 of file qgsrasterbandstats.h.

double QgsRasterBandStats::sum

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

Definition at line 106 of file qgsrasterbandstats.h.

double QgsRasterBandStats::sumOfSquares

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

Definition at line 109 of file qgsrasterbandstats.h.

int QgsRasterBandStats::width

Number of columns used to calc statistics.

Definition at line 112 of file qgsrasterbandstats.h.

---

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

• /build/qgis-3.4.15+24xenial/src/core/raster/qgsrasterbandstats.h