QgsRasterHistogram Class Reference

A container for a histogram of a single raster band. More...

#include <qgsrasterhistogram.h>

Public Types
typedef QVector< int >	HistogramVector

Public Member Functions
	QgsRasterHistogram ()=default
	Constructor for an invalid QgsRasterHistogram.
bool	operator== (const QgsRasterHistogram &h) const
	Compares region, size etc. not histogram itself.

Public Attributes
int	bandNumber = 0
	The gdal band number (starts at 1).
int	binCount = 0
	Number of bins (intervals,buckets) in histogram.
QgsRectangle	extent
	Extent used to calc histogram.
int	height = 0
	Number of rows used to calc histogram.
QgsRasterHistogram::HistogramVector	histogramVector
	Stores the histogram for a given layer.
bool	includeOutOfRange = false
	Whether histogram includes out of range values (in first and last bin).
double	maximum = 0
	The maximum histogram value.
double	minimum = 0
	The minimum histogram value.
int	nonNullCount = 0
	The number of non NULL cells used to calculate histogram.
bool	valid = false
	Histogram is valid.
int	width = 0
	Number of columns used to calc histogram.

Detailed Description

A container for a histogram of a single raster band.

It is used to cache computed histograms in raster providers.

Definition at line 35 of file qgsrasterhistogram.h.

Member Typedef Documentation

HistogramVector

typedef QVector<int> QgsRasterHistogram::HistogramVector

Definition at line 38 of file qgsrasterhistogram.h.

Constructor & Destructor Documentation

QgsRasterHistogram()

QgsRasterHistogram::QgsRasterHistogram ( )

default

Constructor for an invalid QgsRasterHistogram.

Member Function Documentation

operator==()

bool QgsRasterHistogram::operator== ( const QgsRasterHistogram & h ) const

inline

Compares region, size etc. not histogram itself.

Definition at line 46 of file qgsrasterhistogram.h.

Member Data Documentation

bandNumber

int QgsRasterHistogram::bandNumber = 0

The gdal band number (starts at 1).

Definition at line 59 of file qgsrasterhistogram.h.

binCount

int QgsRasterHistogram::binCount = 0

Number of bins (intervals,buckets) in histogram.

Definition at line 62 of file qgsrasterhistogram.h.

extent

QgsRectangle QgsRasterHistogram::extent

Extent used to calc histogram.

Definition at line 88 of file qgsrasterhistogram.h.

height

int QgsRasterHistogram::height = 0

Number of rows used to calc histogram.

Definition at line 85 of file qgsrasterhistogram.h.

histogramVector

QgsRasterHistogram::HistogramVector QgsRasterHistogram::histogramVector

Stores the histogram for a given layer.

Definition at line 73 of file qgsrasterhistogram.h.

includeOutOfRange

bool QgsRasterHistogram::includeOutOfRange = false

Whether histogram includes out of range values (in first and last bin).

Definition at line 68 of file qgsrasterhistogram.h.

maximum

double QgsRasterHistogram::maximum = 0

The maximum histogram value.

Definition at line 76 of file qgsrasterhistogram.h.

minimum

double QgsRasterHistogram::minimum = 0

The minimum histogram value.

Definition at line 79 of file qgsrasterhistogram.h.

nonNullCount

int QgsRasterHistogram::nonNullCount = 0

The number of non NULL cells used to calculate histogram.

Definition at line 65 of file qgsrasterhistogram.h.

valid

bool QgsRasterHistogram::valid = false

Histogram is valid.

Definition at line 91 of file qgsrasterhistogram.h.

width

int QgsRasterHistogram::width = 0

Number of columns used to calc histogram.

Definition at line 82 of file qgsrasterhistogram.h.

---

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

• /build/qgis-3.99.0+git20251205+26c88405ac0+99sid/src/core/raster/qgsrasterhistogram.h