QgsRasterHistogram Class Reference

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

#include <qgsrasterhistogram.h>

Collaboration diagram for QgsRasterHistogram:

List of all members.

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.
QgsRectangle	extent
	Extent used to calc histogram.
int	height
	Number of rows used to calc histogram.
HistogramVector	histogramVector
	Store the histogram for a given layer.
bool	includeOutOfRange
	Whether histogram includes out of range values (in first and last bin)
double	maximum
	The maximum histogram value.
double	minimum
	The minimum histogram value.
int	nonNullCount
	The number of non NULL cells used to calculate histogram.
bool	valid
	Histogram is valid.
int	width
	Number of columns used to calc histogram.

---

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 30 of file qgsrasterhistogram.h.

---

Member Typedef Documentation

typedef QVector<int> QgsRasterHistogram::HistogramVector

Definition at line 33 of file qgsrasterhistogram.h.

---

Constructor & Destructor Documentation

QgsRasterHistogram::QgsRasterHistogram

(

)

[inline]

Definition at line 35 of file qgsrasterhistogram.h.

---

Member Function Documentation

bool QgsRasterHistogram::operator==

(

const QgsRasterHistogram &

h

)

const [inline]

Compares region, size etc. not histogram itself

Definition at line 49 of file qgsrasterhistogram.h.

References bandNumber, binCount, extent, height, includeOutOfRange, maximum, minimum, and width.

---

Member Data Documentation

int QgsRasterHistogram::bandNumber

The gdal band number (starts at 1)

Definition at line 62 of file qgsrasterhistogram.h.

Referenced by QgsRasterInterface::initHistogram(), and operator==().

int QgsRasterHistogram::binCount

Number of bins (intervals,buckets) in histogram.

Definition at line 65 of file qgsrasterhistogram.h.

Referenced by QgsRasterInterface::cumulativeCut(), QgsRasterInterface::histogram(), QgsRasterInterface::initHistogram(), and operator==().

QgsRectangle QgsRasterHistogram::extent

Extent used to calc histogram.

Definition at line 91 of file qgsrasterhistogram.h.

Referenced by QgsRasterInterface::histogram(), QgsRasterInterface::initHistogram(), and operator==().

int QgsRasterHistogram::height

Number of rows used to calc histogram.

Definition at line 88 of file qgsrasterhistogram.h.

Referenced by QgsRasterInterface::histogram(), QgsRasterInterface::initHistogram(), and operator==().

HistogramVector QgsRasterHistogram::histogramVector

Store the histogram for a given layer.

Note:

not available via python binding

Definition at line 76 of file qgsrasterhistogram.h.

Referenced by QgsRasterInterface::cumulativeCut(), QgsRasterInterface::histogram(), and QgsRasterHistogramWidget::refreshHistogram().

bool QgsRasterHistogram::includeOutOfRange

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

Definition at line 71 of file qgsrasterhistogram.h.

Referenced by QgsRasterInterface::initHistogram(), and operator==().

double QgsRasterHistogram::maximum

The maximum histogram value.

Definition at line 79 of file qgsrasterhistogram.h.

Referenced by QgsRasterInterface::cumulativeCut(), QgsRasterInterface::histogram(), QgsRasterInterface::initHistogram(), operator==(), and QgsRasterHistogramWidget::refreshHistogram().

double QgsRasterHistogram::minimum

The minimum histogram value.

Definition at line 82 of file qgsrasterhistogram.h.

Referenced by QgsRasterInterface::cumulativeCut(), QgsRasterInterface::histogram(), QgsRasterInterface::initHistogram(), operator==(), and QgsRasterHistogramWidget::refreshHistogram().

int QgsRasterHistogram::nonNullCount

The number of non NULL cells used to calculate histogram.

Definition at line 68 of file qgsrasterhistogram.h.

Referenced by QgsRasterInterface::cumulativeCut(), and QgsRasterInterface::histogram().

bool QgsRasterHistogram::valid

Histogram is valid.

Definition at line 94 of file qgsrasterhistogram.h.

Referenced by QgsRasterInterface::histogram().

int QgsRasterHistogram::width

Number of columns used to calc histogram.

Definition at line 85 of file qgsrasterhistogram.h.

Referenced by QgsRasterInterface::histogram(), QgsRasterInterface::initHistogram(), and operator==().

---

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

• src/core/raster/qgsrasterhistogram.h