qgsrasterminmaxorigin.h

Go to the documentation of this file.

/***************************************************************************
    qgsrasterminmaxorigin.h - Origin of min/max values
     --------------------------------------
    Date                 : Dec 2016
    Copyright            : (C) 2016 by Even Rouault
    email                : even.rouault at spatialys.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 QGSRASTERMINMAXORIGIN_H
#define QGSRASTERMINMAXORIGIN_H
 
#include <QDomDocument>
#include "qgis_sip.h"
#include <QDomElement>
 
#include "qgis_core.h"
 
class CORE_EXPORT QgsRasterMinMaxOrigin
{
 
  public:
 
    static constexpr double CUMULATIVE_CUT_LOWER = 0.02;
 
    static constexpr double CUMULATIVE_CUT_UPPER = 0.98;
 
    static constexpr double DEFAULT_STDDEV_FACTOR = 2.0;
 
#ifdef SIP_RUN
    enum Limits
    {
      None SIP_PYNAME( None_ ), 
      MinMax, 
      StdDev, 
      CumulativeCut 
    };
#else
    enum Limits
    {
      None, 
      MinMax, 
      StdDev, 
      CumulativeCut 
    };
#endif
 
    enum Extent
    {
      WholeRaster,
      CurrentCanvas,
      UpdatedCanvas
    };
 
    enum StatAccuracy
    {
      Exact,
      Estimated
    };
 
    QgsRasterMinMaxOrigin();
 
    bool operator ==( const QgsRasterMinMaxOrigin &other ) const;
 
 
    QgsRasterMinMaxOrigin::Limits limits() const { return mLimits; }
 
    QgsRasterMinMaxOrigin::Extent extent() const { return mExtent; }
 
    QgsRasterMinMaxOrigin::StatAccuracy statAccuracy() const { return mAccuracy; }
 
    double cumulativeCutLower() const { return mCumulativeCutLower; }
 
    double cumulativeCutUpper() const { return mCumulativeCutUpper; }
 
    double stdDevFactor() const { return mStdDevFactor; }
 
 
    void setLimits( QgsRasterMinMaxOrigin::Limits limits ) { mLimits = limits; }
 
    void setExtent( QgsRasterMinMaxOrigin::Extent extent ) { mExtent = extent; }
 
    void setStatAccuracy( QgsRasterMinMaxOrigin::StatAccuracy accuracy ) { mAccuracy = accuracy; }
 
    void setCumulativeCutLower( double val ) { mCumulativeCutLower = val; }
 
    void setCumulativeCutUpper( double val ) { mCumulativeCutUpper = val; }
 
    void setStdDevFactor( double val ) { mStdDevFactor = val; }
 
 
    void writeXml( QDomDocument &doc, QDomElement &parentElem ) const;
 
    void readXml( const QDomElement &elem );
 
 
    static QString limitsString( Limits limits );
 
    static Limits limitsFromString( const QString &limits );
 
    static QString extentString( QgsRasterMinMaxOrigin::Extent extent );
 
    static QgsRasterMinMaxOrigin::Extent extentFromString( const QString &extent );
 
    static QString statAccuracyString( QgsRasterMinMaxOrigin::StatAccuracy accuracy );
 
    static QgsRasterMinMaxOrigin::StatAccuracy statAccuracyFromString( const QString &accuracy );
 
  private:
 
    Limits mLimits = None;
    Extent mExtent = WholeRaster;
    StatAccuracy mAccuracy = Estimated;
    double mCumulativeCutLower;
    double mCumulativeCutUpper;
    double mStdDevFactor;
};
 
#endif // QGSRASTERMINMAXORIGIN_H