The QgsRasterHistogram is a container for histogram of a single raster band. More...

#include <qgsrasterhistogram.h>

Public Types
typedef QVector< int >	HistogramVector

Public Member Functions
	QgsRasterHistogram ()

bool	operator== (const QgsRasterHistogram &h) const
	Compares region, size etc. not histogram itself. More...

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

int	binCount
	Number of bins (intervals,buckets) in histogram. More...

QgsRectangle	extent
	Extent used to calc histogram. More...

int	height
	Number of rows used to calc histogram. More...

QgsRasterHistogram::HistogramVector	histogramVector
	Store the histogram for a given layer. More...

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

double	maximum
	The maximum histogram value. More...

double	minimum
	The minimum histogram value. More...

int	nonNullCount
	The number of non NULL cells used to calculate histogram. More...

bool	valid
	Histogram is valid. More...

int	width
	Number of columns used to calc histogram. More...

Detailed Description

The QgsRasterHistogram is a container for histogram of a single raster band.

It is used to cache computed histograms in raster providers.

Definition at line 32 of file qgsrasterhistogram.h.

Member Typedef Documentation

◆ HistogramVector

typedef QVector<int> QgsRasterHistogram::HistogramVector

Definition at line 35 of file qgsrasterhistogram.h.

Constructor & Destructor Documentation

◆ QgsRasterHistogram()

QgsRasterHistogram::QgsRasterHistogram ( )

inline

Definition at line 37 of file qgsrasterhistogram.h.

Member Function Documentation

◆ operator==()

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

inline

Compares region, size etc. not histogram itself.

Definition at line 51 of file qgsrasterhistogram.h.

Member Data Documentation

◆ bandNumber

int QgsRasterHistogram::bandNumber

The gdal band number (starts at 1)

Definition at line 64 of file qgsrasterhistogram.h.

◆ binCount

int QgsRasterHistogram::binCount

Number of bins (intervals,buckets) in histogram.

Definition at line 67 of file qgsrasterhistogram.h.

◆ extent

QgsRectangle QgsRasterHistogram::extent

Extent used to calc histogram.

Definition at line 94 of file qgsrasterhistogram.h.

◆ height

int QgsRasterHistogram::height

Number of rows used to calc histogram.

Definition at line 91 of file qgsrasterhistogram.h.

◆ histogramVector

QgsRasterHistogram::HistogramVector QgsRasterHistogram::histogramVector

Store the histogram for a given layer.

Note: not available via Python binding

Definition at line 79 of file qgsrasterhistogram.h.

◆ includeOutOfRange

bool QgsRasterHistogram::includeOutOfRange

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

Definition at line 73 of file qgsrasterhistogram.h.

◆ maximum

double QgsRasterHistogram::maximum

The maximum histogram value.

Definition at line 82 of file qgsrasterhistogram.h.

◆ minimum

double QgsRasterHistogram::minimum

The minimum histogram value.

Definition at line 85 of file qgsrasterhistogram.h.

◆ nonNullCount

int QgsRasterHistogram::nonNullCount

The number of non NULL cells used to calculate histogram.

Definition at line 70 of file qgsrasterhistogram.h.

◆ valid

bool QgsRasterHistogram::valid

Histogram is valid.

Definition at line 97 of file qgsrasterhistogram.h.

◆ width

int QgsRasterHistogram::width

Number of columns used to calc histogram.

Definition at line 88 of file qgsrasterhistogram.h.

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

/tmp/buildd/qgis-3.2.0+99unstable/src/core/raster/qgsrasterhistogram.h

Public Types

Public Member Functions

Public Attributes