QgsRasterHistogram Class Reference

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

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

Detailed Description

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

It is used to cache computed histograms in raster providers.

Member Typedef Documentation

typedef QVector<int> QgsRasterHistogram::HistogramVector

Constructor & Destructor Documentation

QgsRasterHistogram::QgsRasterHistogram ( )

inline

Member Function Documentation

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

inline

Compares region, size etc. not histogram itself

Member Data Documentation

int QgsRasterHistogram::bandNumber

The gdal band number (starts at 1)

int QgsRasterHistogram::binCount

Number of bins (intervals,buckets) in histogram.

QgsRectangle QgsRasterHistogram::extent

Extent used to calc histogram.

int QgsRasterHistogram::height

Number of rows used to calc histogram.

HistogramVector QgsRasterHistogram::histogramVector

Store the histogram for a given layer.

Note

not available via python binding

bool QgsRasterHistogram::includeOutOfRange

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

double QgsRasterHistogram::maximum

The maximum histogram value.

double QgsRasterHistogram::minimum

The minimum histogram value.

int QgsRasterHistogram::nonNullCount

The number of non NULL cells used to calculate histogram.

bool QgsRasterHistogram::valid

Histogram is valid.

int QgsRasterHistogram::width

Number of columns used to calc histogram.

---

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

• /tmp/buildd/qgis-2.6.0+wheezy1/src/core/raster/qgsrasterhistogram.h