QGIS/python/core/qgsrasterbandstats.sip
wonder 46a2d125a2 Merged refactoring branch back to trunk.
git-svn-id: http://svn.osgeo.org/qgis/trunk@6415 c8812cc2-4d05-0410-92ff-de0c093fc19c
2007-01-09 02:39:15 +00:00

51 lines
1.9 KiB
Plaintext

/** \brief The RasterBandStats struct is a container for statistics about a single
* raster band.
*/
class QgsRasterBandStats
{
%TypeHeaderCode
#include <qgsrasterbandstats.h>
%End
public:
/** \brief The name of the band that these stats belong to. */
QString bandName;
/** \brief The gdal band number (starts at 1)*/
int bandNoInt;
/** \brief A flag to indicate whether this RasterBandStats struct
* is completely populated */
bool statsGatheredFlag;
/** \brief The minimum cell value in the raster band. NO_DATA values
* are ignored. This does not use the gdal GetMinimum function. */
double minValDouble;
/** \brief The maximum cell value in the raster band. NO_DATA values
* are ignored. This does not use the gdal GetMaximmum function. */
double maxValDouble;
/** \brief The range is the distance between min & max. */
double rangeDouble;
/** \brief The mean cell value for the band. NO_DATA values are excluded. */
double meanDouble;
/** \brief The sum of the squares. Used to calculate standard deviation. */
double sumSqrDevDouble;
/** \brief The standard deviation of the cell values. */
double stdDevDouble;
/** \brief The sum of all cells in the band. NO_DATA values are excluded. */
double sumDouble;
/** \brief The number of cells in the band. Equivalent to height x width.
* TODO: check if NO_DATA are excluded!*/
int elementCountInt;
/** \brief Store the histogram for a given layer */
typedef QVector<int> HistogramVector;
// TODO: why SIP says its unsupported?
//HistogramVector * histogramVector;
/** \brief whteher histogram values are estimated or completely calculated */
bool histogramEstimatedFlag;
/** whehter histogram compuation should include out of range values */
bool histogramOutOfRangeFlag;
/** Color table */
// TODO: not working
//QgsColorTable colorTable;
};