QGIS API Documentation  2.99.0-Master (314842d)
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>

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

Member Typedef Documentation

◆ HistogramVector

Definition at line 34 of file qgsrasterhistogram.h.

Constructor & Destructor Documentation

◆ QgsRasterHistogram()

QgsRasterHistogram::QgsRasterHistogram ( )
inline

Definition at line 36 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 50 of file qgsrasterhistogram.h.

Member Data Documentation

◆ bandNumber

int QgsRasterHistogram::bandNumber

The gdal band number (starts at 1)

Definition at line 63 of file qgsrasterhistogram.h.

◆ binCount

int QgsRasterHistogram::binCount

Number of bins (intervals,buckets) in histogram.

Definition at line 66 of file qgsrasterhistogram.h.

◆ extent

QgsRectangle QgsRasterHistogram::extent

Extent used to calc histogram.

Definition at line 92 of file qgsrasterhistogram.h.

◆ height

int QgsRasterHistogram::height

Number of rows used to calc histogram.

Definition at line 89 of file qgsrasterhistogram.h.

◆ histogramVector

HistogramVector QgsRasterHistogram::histogramVector

Store the histogram for a given layer.

Note
not available via python binding

Definition at line 77 of file qgsrasterhistogram.h.

◆ includeOutOfRange

bool QgsRasterHistogram::includeOutOfRange

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

Definition at line 72 of file qgsrasterhistogram.h.

◆ maximum

double QgsRasterHistogram::maximum

The maximum histogram value.

Definition at line 80 of file qgsrasterhistogram.h.

◆ minimum

double QgsRasterHistogram::minimum

The minimum histogram value.

Definition at line 83 of file qgsrasterhistogram.h.

◆ nonNullCount

int QgsRasterHistogram::nonNullCount

The number of non NULL cells used to calculate histogram.

Definition at line 69 of file qgsrasterhistogram.h.

◆ valid

bool QgsRasterHistogram::valid

Histogram is valid.

Definition at line 95 of file qgsrasterhistogram.h.

◆ width

int QgsRasterHistogram::width

Number of columns used to calc histogram.

Definition at line 86 of file qgsrasterhistogram.h.


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