qgscontrastenhancement.h

Go to the documentation of this file.

/* **************************************************************************
                qgscontrastenhancement.h -  description
                       -------------------
begin                : Mon Oct 22 2007
copyright            : (C) 2007 by Peter J. Ersts
email                : ersts@amnh.org
 
This class contains code that was originally part of the larger QgsRasterLayer
class originally created circa 2004 by T.Sutton, Gary E.Sherman, Steve Halasz
****************************************************************************/
 
/* **************************************************************************
 *                                                                         *
 *   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 QGSCONTRASTENHANCEMENT_H
#define QGSCONTRASTENHANCEMENT_H
 
#include "qgis_core.h"
#include <limits>
 
#include "qgis_sip.h"
#include "qgsraster.h"
#include <memory>
 
class QgsContrastEnhancementFunction;
class QDomDocument;
class QDomElement;
class QString;
 
class CORE_EXPORT QgsContrastEnhancement
{
 
  public:
 
    enum ContrastEnhancementAlgorithm
    {
      NoEnhancement, 
      StretchToMinimumMaximum, 
      StretchAndClipToMinimumMaximum,
      ClipToMinimumMaximum,
      UserDefinedEnhancement
    };
 
    QgsContrastEnhancement( Qgis::DataType datatype = Qgis::DataType::Byte );
    QgsContrastEnhancement( const QgsContrastEnhancement &ce );
    ~QgsContrastEnhancement();
 
    const QgsContrastEnhancement &operator=( const QgsContrastEnhancement & ) = delete;
 
    static double maximumValuePossible( Qgis::DataType dataType )
    {
      switch ( dataType )
      {
        case Qgis::DataType::Byte:
          return std::numeric_limits<unsigned char>::max();
        case Qgis::DataType::Int8:
          return std::numeric_limits<int8_t>::max();
        case Qgis::DataType::UInt16:
          return std::numeric_limits<unsigned short>::max();
        case Qgis::DataType::Int16:
          return std::numeric_limits<short>::max();
        case Qgis::DataType::UInt32:
          return std::numeric_limits<unsigned int>::max();
        case Qgis::DataType::Int32:
          return std::numeric_limits<int>::max();
        case Qgis::DataType::Float32:
          return std::numeric_limits<float>::max();
        case Qgis::DataType::Float64:
          return std::numeric_limits<double>::max();
        case Qgis::DataType::CInt16:
          return std::numeric_limits<short>::max();
        case Qgis::DataType::CInt32:
          return std::numeric_limits<int>::max();
        case Qgis::DataType::CFloat32:
          return std::numeric_limits<float>::max();
        case Qgis::DataType::CFloat64:
          return std::numeric_limits<double>::max();
        case Qgis::DataType::ARGB32:
        case Qgis::DataType::ARGB32_Premultiplied:
        case Qgis::DataType::UnknownDataType:
          // XXX - mloskot: not handled?
          break;
      }
 
      return std::numeric_limits<double>::max();
    }
 
    static double minimumValuePossible( Qgis::DataType dataType )
    {
      switch ( dataType )
      {
        case Qgis::DataType::Byte:
          return std::numeric_limits<unsigned char>::min();
        case Qgis::DataType::Int8:
          return std::numeric_limits<int8_t>::min();
        case Qgis::DataType::UInt16:
          return std::numeric_limits<unsigned short>::min();
        case Qgis::DataType::Int16:
          return std::numeric_limits<short>::min();
        case Qgis::DataType::UInt32:
          return std::numeric_limits<unsigned int>::min();
        case Qgis::DataType::Int32:
          return std::numeric_limits<int>::min();
        case Qgis::DataType::Float32:
          return std::numeric_limits<float>::max() * -1.0;
        case Qgis::DataType::Float64:
          return std::numeric_limits<double>::max() * -1.0;
        case Qgis::DataType::CInt16:
          return std::numeric_limits<short>::min();
        case Qgis::DataType::CInt32:
          return std::numeric_limits<int>::min();
        case Qgis::DataType::CFloat32:
          return std::numeric_limits<float>::max() * -1.0;
        case Qgis::DataType::CFloat64:
          return std::numeric_limits<double>::max() * -1.0;
        case Qgis::DataType::ARGB32:
        case Qgis::DataType::ARGB32_Premultiplied:
        case Qgis::DataType::UnknownDataType:
          // XXX - mloskot: not handled?
          break;
      }
 
      return std::numeric_limits<double>::max() * -1.0;
    }
 
    static QString contrastEnhancementAlgorithmString( ContrastEnhancementAlgorithm algorithm );
 
    static ContrastEnhancementAlgorithm contrastEnhancementAlgorithmFromString( const QString &contrastEnhancementString );
 
    double maximumValue() const { return mMaximumValue; }
 
    double minimumValue() const { return mMinimumValue; }
 
    ContrastEnhancementAlgorithm contrastEnhancementAlgorithm() const { return mContrastEnhancementAlgorithm; }
 
    int enhanceContrast( double value );
 
    bool isValueInDisplayableRange( double value );
 
    void setContrastEnhancementAlgorithm( ContrastEnhancementAlgorithm algorithm, bool generateTable = true );
 
    void setContrastEnhancementFunction( QgsContrastEnhancementFunction *function SIP_TRANSFER );
 
    void setMaximumValue( double value, bool generateTable = true );
 
    void setMinimumValue( double value, bool generateTable = true );
 
    void writeXml( QDomDocument &doc, QDomElement &parentElem ) const;
 
    void readXml( const QDomElement &elem );
 
    void toSld( QDomDocument &doc, QDomElement &element ) const;
 
  private:
#ifdef SIP_RUN
    const QgsContrastEnhancement &operator=( const QgsContrastEnhancement & );
#endif
 
    ContrastEnhancementAlgorithm mContrastEnhancementAlgorithm = NoEnhancement;
 
    std::unique_ptr< QgsContrastEnhancementFunction > mContrastEnhancementFunction;
 
    bool mEnhancementDirty = false;
 
    int *mLookupTable = nullptr;
 
    double mMinimumValue;
 
    double mMaximumValue;
 
    Qgis::DataType mRasterDataType;
 
    double mRasterDataTypeRange;
 
    double mLookupTableOffset;
 
    bool generateLookupTable();
 
    int calculateContrastEnhancementValue( double );
 
};
 
#endif