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 "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QDomDocument>
#include <QDomElement>
 
class QgsSettingsEntryDouble;

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;
 
    QgsRasterMinMaxOrigin();
 
    bool operator==( const QgsRasterMinMaxOrigin &other ) const;


    Qgis::RasterRangeLimit limits() const { return mLimits; }

    Qgis::RasterRangeExtent extent() const { return mExtent; }

    Qgis::RasterRangeAccuracy statAccuracy() const { return mAccuracy; }

    double cumulativeCutLower() const { return mCumulativeCutLower; }

    double cumulativeCutUpper() const { return mCumulativeCutUpper; }

    double stdDevFactor() const { return mStdDevFactor; }


    void setLimits( Qgis::RasterRangeLimit limits ) { mLimits = limits; }

    void setExtent( Qgis::RasterRangeExtent extent ) { mExtent = extent; }

    void setStatAccuracy( Qgis::RasterRangeAccuracy 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( Qgis::RasterRangeLimit limits );

    static Qgis::RasterRangeLimit limitsFromString( const QString &limits );

    static QString extentString( Qgis::RasterRangeExtent extent );

    static Qgis::RasterRangeExtent extentFromString( const QString &extent );

    static QString statAccuracyString( Qgis::RasterRangeAccuracy accuracy );

    static Qgis::RasterRangeAccuracy statAccuracyFromString( const QString &accuracy );
 
#ifndef SIP_RUN
    static const QgsSettingsEntryDouble *settingsCumulativeCutLower SIP_SKIP;
 
    static const QgsSettingsEntryDouble *settingsCumulativeCutUpper SIP_SKIP;
#endif
 
  private:
    Qgis::RasterRangeLimit mLimits = Qgis::RasterRangeLimit::NotSet;
    Qgis::RasterRangeExtent mExtent = Qgis::RasterRangeExtent::WholeRaster;
    Qgis::RasterRangeAccuracy mAccuracy = Qgis::RasterRangeAccuracy::Estimated;
    double mCumulativeCutLower;
    double mCumulativeCutUpper;
    double mStdDevFactor;
};
 
#endif // QGSRASTERMINMAXORIGIN_H