QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Public Member Functions | Public Attributes | List of all members
QgsRasterHistogram Class Reference

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

#include <qgsrasterhistogram.h>

Collaboration diagram for QgsRasterHistogram:
Collaboration graph
[legend]

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

Member Typedef Documentation

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
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
double QgsRasterHistogram::minimum
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: