qgsrasterbandstats.h

Go to the documentation of this file.

/***************************************************************************
                        qgsrasterbandstats.h  -  description
                              -------------------
 begin                : Fri Jun 28 2002
 copyright            : (C) 2005 by T.Sutton
 email                : tim@linfiniti.com
***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSRASTERBANDSTATS
#define QGSRASTERBANDSTATS
 
#include <limits>
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsrectangle.h"
 
#include <QString>
#include <QVector>

class CORE_EXPORT QgsRasterBandStats
{
  public:
    QgsRasterBandStats() = default;

    bool contains( const QgsRasterBandStats &s ) const
    {
      return ( s.bandNumber == bandNumber && s.extent == extent && s.width == width && s.height == height && s.statsGathered == ( statsGathered & s.statsGathered ) );
    }

    int bandNumber = 1;
 
    // TODO: check if no data are excluded in stats calculation

    qgssize elementCount = 0;

    double maximumValue = -std::numeric_limits<double>::max();

    double minimumValue = std::numeric_limits<double>::max();

    double mean = 0;

    double range = 0;

    double stdDev = 0;

    Qgis::RasterBandStatistics statsGathered;

    double sum = 0;

    double sumOfSquares = 0;

    int width = 0;

    int height = 0;

    QgsRectangle extent;
};
 
#endif