qgszonalstatistics.h

Go to the documentation of this file.

/***************************************************************************
                          qgszonalstatistics.h  -  description
                          ----------------------------
    begin                : August 29th, 2009
    copyright            : (C) 2009 by Marco Hugentobler
    email                : marco at hugis dot net
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSZONALSTATISTICS_H
#define QGSZONALSTATISTICS_H
 
#include <QString>
#include <QMap>
 
#include <limits>
#include <cfloat>
 
#include "qgis_analysis.h"
#include "qgsfeedback.h"
#include "qgscoordinatereferencesystem.h"
#include "qgsfields.h"
 
class QgsGeometry;
class QgsVectorLayer;
class QgsRasterLayer;
class QgsRasterInterface;
class QgsRasterDataProvider;
class QgsRectangle;
class QgsField;
class QgsFeatureSink;
class QgsFeatureSource;
 
class ANALYSIS_EXPORT QgsZonalStatistics
{
  public:
 
    enum Statistic
    {
      Count       = 1,  
      Sum    = 2,  
      Mean = 4,  
      Median = 8, 
      StDev = 16, 
      Min = 32,  
      Max = 64,  
      Range = 128, 
      Minority = 256, 
      Majority = 512, 
      Variety = 1024, 
      Variance = 2048, 
      All = Count | Sum | Mean | Median | StDev | Max | Min | Range | Minority | Majority | Variety | Variance
    };
    Q_DECLARE_FLAGS( Statistics, Statistic )
 
    
    enum Result
    {
      Success = 0, 
      LayerTypeWrong = 1, 
      LayerInvalid, 
      RasterInvalid, 
      RasterBandInvalid, 
      FailedToCreateField = 8, 
      Canceled = 9 
    };
 
    QgsZonalStatistics( QgsVectorLayer *polygonLayer,
                        QgsRasterLayer *rasterLayer,
                        const QString &attributePrefix = QString(),
                        int rasterBand = 1,
                        QgsZonalStatistics::Statistics stats = QgsZonalStatistics::Statistics( QgsZonalStatistics::Count | QgsZonalStatistics::Sum | QgsZonalStatistics::Mean ) );
 
    QgsZonalStatistics( QgsVectorLayer *polygonLayer,
                        QgsRasterInterface *rasterInterface,
                        const QgsCoordinateReferenceSystem &rasterCrs,
                        double rasterUnitsPerPixelX,
                        double rasterUnitsPerPixelY,
                        const QString &attributePrefix = QString(),
                        int rasterBand = 1,
                        QgsZonalStatistics::Statistics stats = QgsZonalStatistics::Statistics( QgsZonalStatistics::Count | QgsZonalStatistics::Sum | QgsZonalStatistics::Mean ) );
 
 
    QgsZonalStatistics::Result calculateStatistics( QgsFeedback *feedback );
 
    static QString displayName( QgsZonalStatistics::Statistic statistic );
 
    static QString shortName( QgsZonalStatistics::Statistic statistic );
 
    static QMap<QgsZonalStatistics::Statistic, QVariant> calculateStatistics( QgsRasterInterface *rasterInterface, const QgsGeometry &geometry, double cellSizeX, double cellSizeY, int rasterBand, QgsZonalStatistics::Statistics statistics );
 
  private:
    QgsZonalStatistics() = default;
 
    class FeatureStats
    {
      public:
        FeatureStats( bool storeValues = false, bool storeValueCounts = false )
          : mStoreValues( storeValues )
          , mStoreValueCounts( storeValueCounts )
        {
        }
 
        void reset()
        {
          sum = 0;
          count = 0;
          max = std::numeric_limits<double>::lowest();
          min = std::numeric_limits<double>::max();
          valueCount.clear();
          values.clear();
        }
 
        void addValue( double value, double weight = 1.0 )
        {
          if ( weight < 1.0 )
          {
            sum += value * weight;
            count += weight;
          }
          else
          {
            sum += value;
            ++count;
          }
          min = std::min( min, value );
          max = std::max( max, value );
          if ( mStoreValueCounts )
            valueCount.insert( value, valueCount.value( value, 0 ) + 1 );
          if ( mStoreValues )
            values.append( value );
        }
        double sum = 0.0;
        double count = 0.0;
        double max = std::numeric_limits<double>::lowest();
        double min = std::numeric_limits<double>::max();
        QMap< double, int > valueCount;
        QList< double > values;
 
      private:
        bool mStoreValues = false;
        bool mStoreValueCounts = false;
    };
 
    QString getUniqueFieldName( const QString &fieldName, const QList<QgsField> &newFields );
 
    QgsRasterInterface *mRasterInterface = nullptr;
    QgsCoordinateReferenceSystem mRasterCrs;
 
    double mCellSizeX = 0;
    double mCellSizeY = 0;
 
    int mRasterBand = 0;
    QgsVectorLayer *mPolygonLayer = nullptr;
    QString mAttributePrefix;
    Statistics mStatistics = QgsZonalStatistics::All;
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsZonalStatistics::Statistics )
 
// clazy:excludeall=qstring-allocations
 
#endif // QGSZONALSTATISTICS_H