QGIS API Documentation  3.8.0-Zanzibar (11aff65)
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 ()=default
 Constructor for an invalid QgsRasterHistogram. More...
 
bool operator== (const QgsRasterHistogram &h) const
 Compares region, size etc. not histogram itself. More...
 

Public Attributes

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

Member Typedef Documentation

◆ HistogramVector

Definition at line 36 of file qgsrasterhistogram.h.

Constructor & Destructor Documentation

◆ QgsRasterHistogram()

QgsRasterHistogram::QgsRasterHistogram ( )
default

Constructor for an invalid QgsRasterHistogram.

Member Function Documentation

◆ operator==()

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

Compares region, size etc. not histogram itself.

Definition at line 44 of file qgsrasterhistogram.h.

Member Data Documentation

◆ bandNumber

int QgsRasterHistogram::bandNumber = 0

The gdal band number (starts at 1)

Definition at line 57 of file qgsrasterhistogram.h.

◆ binCount

int QgsRasterHistogram::binCount = 0

Number of bins (intervals,buckets) in histogram.

Definition at line 60 of file qgsrasterhistogram.h.

◆ extent

QgsRectangle QgsRasterHistogram::extent

Extent used to calc histogram.

Definition at line 86 of file qgsrasterhistogram.h.

◆ height

int QgsRasterHistogram::height = 0

Number of rows used to calc histogram.

Definition at line 83 of file qgsrasterhistogram.h.

◆ histogramVector

QgsRasterHistogram::HistogramVector QgsRasterHistogram::histogramVector

Stores the histogram for a given layer.

Definition at line 71 of file qgsrasterhistogram.h.

◆ includeOutOfRange

bool QgsRasterHistogram::includeOutOfRange = false

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

Definition at line 66 of file qgsrasterhistogram.h.

◆ maximum

double QgsRasterHistogram::maximum = 0

The maximum histogram value.

Definition at line 74 of file qgsrasterhistogram.h.

◆ minimum

double QgsRasterHistogram::minimum = 0

The minimum histogram value.

Definition at line 77 of file qgsrasterhistogram.h.

◆ nonNullCount

int QgsRasterHistogram::nonNullCount = 0

The number of non NULL cells used to calculate histogram.

Definition at line 63 of file qgsrasterhistogram.h.

◆ valid

bool QgsRasterHistogram::valid = false

Histogram is valid.

Definition at line 89 of file qgsrasterhistogram.h.

◆ width

int QgsRasterHistogram::width = 0

Number of columns used to calc histogram.

Definition at line 80 of file qgsrasterhistogram.h.


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