Branch data     Line data    Source code

       1                 :            : /* **************************************************************************
       2                 :            :               qgscliptominmaxenhancement.h -  description
       3                 :            :                        -------------------
       4                 :            : begin                : Fri Nov 16 2007
       5                 :            : copyright            : (C) 2007 by Peter J. Ersts
       6                 :            : email                : ersts@amnh.org
       7                 :            : 
       8                 :            : ****************************************************************************/
       9                 :            : 
      10                 :            : /* **************************************************************************
      11                 :            :  *                                                                         *
      12                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      13                 :            :  *   it under the terms of the GNU General Public License as published by  *
      14                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      15                 :            :  *   (at your option) any later version.                                   *
      16                 :            :  *                                                                         *
      17                 :            :  ***************************************************************************/
      18                 :            : 
      19                 :            : #ifndef QGSCLIPTOMINMAXENHANCEMENT_H
      20                 :            : #define QGSCLIPTOMINMAXENHANCEMENT_H
      21                 :            : 
      22                 :            : #include "qgis_core.h"
      23                 :            : #include "qgscontrastenhancementfunction.h"
      24                 :            : 
      25                 :            : /**
      26                 :            :  * \ingroup core
      27                 :            :  * \brief A raster contrast enhancement that will clip a value to the specified min/max range.
      28                 :            :  * For example if a min max range of [10,240] is specified in the constructor, and
      29                 :            :  * a value of 250 is called using enhance(), the value will be truncated ('clipped')
      30                 :            :  * to 240.
      31                 :            :  */
      32                 :          0 : class CORE_EXPORT QgsClipToMinMaxEnhancement : public QgsContrastEnhancementFunction
      33                 :            : {
      34                 :            : 
      35                 :            :   public:
      36                 :            :     QgsClipToMinMaxEnhancement( Qgis::DataType, double, double );
      37                 :            : 
      38                 :            :     int enhance( double ) override;
      39                 :            : 
      40                 :            :     bool isValueInDisplayableRange( double ) override;
      41                 :            : };
      42                 :            : 
      43                 :            : #endif