QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties 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>

Collaboration diagram for QgsRasterBandStats:
Collaboration graph
[legend]

Public Types

enum  Stats {
  None = 0, Min = 1, Max = 1 << 1, Range = 1 << 2,
  Sum = 1 << 3, Mean = 1 << 4, StdDev = 1 << 5, SumOfSquares = 1 << 6,
  All = Min | Max | Range | Sum | Mean | StdDev | SumOfSquares
}
 

Public Member Functions

 QgsRasterBandStats ()
 
bool contains (const QgsRasterBandStats &s) const
 

Public Attributes

int bandNumber
 The gdal band number (starts at 1) More...
 
qgssize elementCount
 The number of not no data cells in the band. 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...
 
int statsGathered
 Collected statistics. More...
 
double sum
 The sum of all cells in the band. More...
 
double sumOfSquares
 The sum of the squares. More...
 
int width
 Number of columns used to calc statistics. More...
 
int height
 Number of rows used to calc statistics. More...
 
QgsRectangle extent
 Extent used to calc statistics. More...
 

Detailed Description

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

Definition at line 33 of file qgsrasterbandstats.h.

Member Enumeration Documentation

Enumerator
None 
Min 
Max 
Range 
Sum 
Mean 
StdDev 
SumOfSquares 
All 

Definition at line 36 of file qgsrasterbandstats.h.

Constructor & Destructor Documentation

QgsRasterBandStats::QgsRasterBandStats ( )
inline

Definition at line 49 of file qgsrasterbandstats.h.

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

Member Function Documentation

bool QgsRasterBandStats::contains ( const QgsRasterBandStats s) const
inline

Compares region, size etc. not collected statistics

Definition at line 65 of file qgsrasterbandstats.h.

References bandNumber, extent, height, statsGathered, and width.

Referenced by QgsRasterInterface::bandStatistics(), and QgsRasterInterface::hasStatistics().

Member Data Documentation

int QgsRasterBandStats::bandNumber

The gdal band number (starts at 1)

Definition at line 75 of file qgsrasterbandstats.h.

Referenced by contains(), and QgsRasterInterface::initStatistics().

qgssize QgsRasterBandStats::elementCount

The number of not no data cells in the band.

Definition at line 79 of file qgsrasterbandstats.h.

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

QgsRectangle QgsRasterBandStats::extent

Extent used to calc statistics.

Definition at line 114 of file qgsrasterbandstats.h.

Referenced by QgsRasterInterface::bandStatistics(), contains(), and QgsRasterInterface::initStatistics().

int QgsRasterBandStats::height

Number of rows used to calc statistics.

Definition at line 111 of file qgsrasterbandstats.h.

Referenced by QgsRasterInterface::bandStatistics(), contains(), and QgsRasterInterface::initStatistics().

double QgsRasterBandStats::maximumValue
double QgsRasterBandStats::mean
double QgsRasterBandStats::minimumValue
double QgsRasterBandStats::range

The range is the distance between min & max.

Definition at line 93 of file qgsrasterbandstats.h.

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

int QgsRasterBandStats::statsGathered

Collected statistics.

Definition at line 99 of file qgsrasterbandstats.h.

Referenced by QgsRasterInterface::bandStatistics(), contains(), and QgsRasterInterface::initStatistics().

double QgsRasterBandStats::stdDev
double QgsRasterBandStats::sum

The sum of all cells in the band.

NO_DATA values are excluded.

Definition at line 102 of file qgsrasterbandstats.h.

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

double QgsRasterBandStats::sumOfSquares

The sum of the squares.

Used to calculate standard deviation.

Definition at line 105 of file qgsrasterbandstats.h.

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

int QgsRasterBandStats::width

Number of columns used to calc statistics.

Definition at line 108 of file qgsrasterbandstats.h.

Referenced by QgsRasterInterface::bandStatistics(), contains(), and QgsRasterInterface::initStatistics().


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