Quantum GIS API Documentation  1.7.5-Wroclaw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Public Attributes | List of all members
QgsRasterBandStats Class Reference

The RasterBandStats struct is a container for statistics about a single raster band. More...

#include <qgsrasterbandstats.h>

Public Types

typedef QVector< int > HistogramVector
 

Public Member Functions

 QgsRasterBandStats ()
 

Public Attributes

QString bandName
 The name of the band that these stats belong to. More...
 
int bandNumber
 The gdal band number (starts at 1) More...
 
QList
< QgsColorRampShader::ColorRampItem
colorTable
 Color table. More...
 
int elementCount
 The number of cells in the band. More...
 
bool isHistogramEstimated
 whteher histogram values are estimated or completely calculated More...
 
bool isHistogramOutOfRange
 whehter histogram compuation should include out of range values More...
 
HistogramVectorhistogramVector
 Store the histogram for a given layer. More...
 
double maximumValue
 The maximum cell value in the raster band. More...
 
double minimumValue
 The minimum cell value in the raster band. More...
 
double mean
 The mean cell value for the band. More...
 
double range
 The range is the distance between min & max. More...
 
double stdDev
 The standard deviation of the cell values. More...
 
bool statsGathered
 A flag to indicate whether this RasterBandStats struct is completely populated. More...
 
double sum
 The sum of all cells in the band. More...
 
double sumOfSquares
 The sum of the squares. More...
 

Detailed Description

The RasterBandStats struct is a container for statistics about a single raster band.

Definition at line 32 of file qgsrasterbandstats.h.

Member Typedef Documentation

Definition at line 35 of file qgsrasterbandstats.h.

Constructor & Destructor Documentation

QgsRasterBandStats::QgsRasterBandStats ( )
inline

Definition at line 37 of file qgsrasterbandstats.h.

References MathUtils::max(), and MathUtils::min().

Member Data Documentation

QString QgsRasterBandStats::bandName

The name of the band that these stats belong to.

Definition at line 55 of file qgsrasterbandstats.h.

Referenced by QgsRasterLayer::bandNumber(), QgsRasterDataProvider::bandStatistics(), QgsRasterLayer::bandStatistics(), and QgsRasterLayer::setDataProvider().

int QgsRasterBandStats::bandNumber
QList<QgsColorRampShader::ColorRampItem> QgsRasterBandStats::colorTable

Color table.

Definition at line 61 of file qgsrasterbandstats.h.

Referenced by QgsRasterLayer::setDataProvider().

int QgsRasterBandStats::elementCount

The number of cells in the band.

Equivalent to height x width. TODO: check if NO_DATA are excluded!

Definition at line 65 of file qgsrasterbandstats.h.

Referenced by QgsRasterDataProvider::bandStatistics(), and QgsRasterLayer::metadata().

HistogramVector* QgsRasterBandStats::histogramVector

Store the histogram for a given layer.

Definition at line 74 of file qgsrasterbandstats.h.

Referenced by QgsRasterLayer::setDataProvider().

bool QgsRasterBandStats::isHistogramEstimated

whteher histogram values are estimated or completely calculated

Definition at line 68 of file qgsrasterbandstats.h.

bool QgsRasterBandStats::isHistogramOutOfRange

whehter histogram compuation should include out of range values

Definition at line 71 of file qgsrasterbandstats.h.

double QgsRasterBandStats::maximumValue

The maximum cell value in the raster band.

NO_DATA values are ignored. This does not use the gdal GetMaximmum function.

Definition at line 78 of file qgsrasterbandstats.h.

Referenced by QgsRasterDataProvider::bandStatistics(), QgsRasterLayer::drawPalettedSingleBandPseudoColor(), QgsRasterLayer::drawSingleBandPseudoColor(), QgsRasterLayer::metadata(), and QgsRasterLayer::setMinimumMaximumUsingDataset().

double QgsRasterBandStats::mean
double QgsRasterBandStats::minimumValue

The minimum cell value in the raster band.

NO_DATA values are ignored. This does not use the gdal GetMinimum function.

Definition at line 82 of file qgsrasterbandstats.h.

Referenced by QgsRasterDataProvider::bandStatistics(), QgsRasterLayer::drawPalettedSingleBandPseudoColor(), QgsRasterLayer::drawSingleBandPseudoColor(), QgsRasterLayer::metadata(), and QgsRasterLayer::setMinimumMaximumUsingDataset().

double QgsRasterBandStats::range

The range is the distance between min & max.

Definition at line 88 of file qgsrasterbandstats.h.

Referenced by QgsRasterDataProvider::bandStatistics(), and QgsRasterLayer::metadata().

bool QgsRasterBandStats::statsGathered

A flag to indicate whether this RasterBandStats struct is completely populated.

Definition at line 95 of file qgsrasterbandstats.h.

Referenced by QgsRasterDataProvider::bandStatistics(), QgsRasterLayer::bandStatistics(), and QgsRasterLayer::setDataProvider().

double QgsRasterBandStats::stdDev
double QgsRasterBandStats::sum

The sum of all cells in the band.

NO_DATA values are excluded.

Definition at line 98 of file qgsrasterbandstats.h.

Referenced by QgsRasterDataProvider::bandStatistics(), and QgsRasterLayer::metadata().

double QgsRasterBandStats::sumOfSquares

The sum of the squares.

Used to calculate standard deviation.

Definition at line 101 of file qgsrasterbandstats.h.

Referenced by QgsRasterDataProvider::bandStatistics(), and QgsRasterLayer::metadata().


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