Quantum GIS API Documentation  1.7.4
Public Types | Public Member Functions | Public Attributes
QgsRasterBandStats Class Reference

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

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 55 of file qgsrasterbandstats.h.

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

Color table.

Definition at line 61 of file qgsrasterbandstats.h.

Referenced by QgsRasterLayer::setDataProvider().

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().

Store the histogram for a given layer.

Definition at line 74 of file qgsrasterbandstats.h.

Referenced by QgsRasterLayer::setDataProvider().

whteher histogram values are estimated or completely calculated

Definition at line 68 of file qgsrasterbandstats.h.

whehter histogram compuation should include out of range values

Definition at line 71 of file qgsrasterbandstats.h.

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().

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().

The range is the distance between min & max.

Definition at line 88 of file qgsrasterbandstats.h.

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

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().

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().

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:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines