QgsRasterBandStats Class Reference
[QGIS core library]

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

#include <qgsrasterbandstats.h>

List of all members.

Public Types

typedef QVector< int > HistogramVector

Public Member Functions

 QgsRasterBandStats ()

Public Attributes

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


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

The name of the band that these stats belong to.

Definition at line 54 of file qgsrasterbandstats.h.

Referenced by QgsRasterLayer::bandNumber(), QgsRasterLayer::bandStatistics(), and QgsRasterLayer::readFile().

The gdal band number (starts at 1).

Definition at line 57 of file qgsrasterbandstats.h.

Referenced by QgsRasterLayer::bandNumber(), QgsRasterLayer::bandStatistics(), and QgsRasterLayer::readFile().

Color table.

Definition at line 60 of file qgsrasterbandstats.h.

Referenced by QgsRasterLayer::readFile().

The number of cells in the band.

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

Definition at line 64 of file qgsrasterbandstats.h.

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

whteher histogram values are estimated or completely calculated

Definition at line 67 of file qgsrasterbandstats.h.

Referenced by QgsRasterLayer::populateHistogram().

whehter histogram compuation should include out of range values

Definition at line 70 of file qgsrasterbandstats.h.

Referenced by QgsRasterLayer::populateHistogram().

Store the histogram for a given layer.

Definition at line 73 of file qgsrasterbandstats.h.

Referenced by QgsRasterLayer::populateHistogram(), and QgsRasterLayer::readFile().

The maximum cell value in the raster band.

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

Definition at line 77 of file qgsrasterbandstats.h.

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

The minimum cell value in the raster band.

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

Definition at line 81 of file qgsrasterbandstats.h.

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

The range is the distance between min & max.

Definition at line 87 of file qgsrasterbandstats.h.

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

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

Definition at line 94 of file qgsrasterbandstats.h.

Referenced by QgsRasterLayer::bandStatistics(), and QgsRasterLayer::readFile().

The sum of all cells in the band.

NO_DATA values are excluded.

Definition at line 97 of file qgsrasterbandstats.h.

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

The sum of the squares.

Used to calculate standard deviation.

Definition at line 100 of file qgsrasterbandstats.h.

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


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

Generated on Sat Feb 4 19:17:46 2012 for Quantum GIS API Documentation by  doxygen 1.5.6