qgscontrastenhancementfunction.h

Go to the documentation of this file.

/* **************************************************************************
              qgscontrastenhancementfunction.h -  description
                       -------------------
begin                : Fri Nov 16 2007
copyright            : (C) 2007 by Peter J. Ersts
email                : [email protected]

****************************************************************************/

/* **************************************************************************
 *                                                                         *
 *   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 QGSCONTRASTENHANCEMENTFUNCTION_H
#define QGSCONTRASTENHANCEMENTFUNCTION_H

#include "qgis_core.h"
#include "qgis.h"

class CORE_EXPORT QgsContrastEnhancementFunction
{

  public:
    QgsContrastEnhancementFunction( Qgis::DataType, double, double );
    QgsContrastEnhancementFunction( const QgsContrastEnhancementFunction &f );
    virtual ~QgsContrastEnhancementFunction() = default;

    virtual int enhance( double value );

    virtual bool isValueInDisplayableRange( double value );

    void setMaximumValue( double value );

    void setMinimumValue( double value );

    double maximumValue() const { return mMaximumValue; }

    double minimumValue() const { return mMinimumValue; }

  protected:
    double mMaximumValue;

    double mMinimumValue;

    double mMinimumMaximumRange;

    Qgis::DataType mQgsRasterDataType;

    double mMaximumValuePossible = std::numeric_limits< double >::max() SIP_SKIP;
    double mMinimumValuePossible = std::numeric_limits< double >::lowest() SIP_SKIP;

};

#endif