Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                           qgsruggednessfilter.h  -  description
       3                 :            :                           ---------------------
       4                 :            :     begin                : August 7th, 2009
       5                 :            :     copyright            : (C) 2009 by Marco Hugentobler
       6                 :            :     email                : marco dot hugentobler at karto dot baug dot ethz dot ch
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSRUGGEDNESSFILTER_H
      19                 :            : #define QGSRUGGEDNESSFILTER_H
      20                 :            : 
      21                 :            : #include "qgsninecellfilter.h"
      22                 :            : #include "qgis_analysis.h"
      23                 :            : 
      24                 :            : /**
      25                 :            :  * \ingroup analysis
      26                 :            :  * \brief Calculates the ruggedness index based on a 3x3 moving window.
      27                 :            :  *
      28                 :            :  * Algorithm from Riley et al. 1999: A terrain ruggedness index that quantifies topographic heterogeneity
      29                 :            : */
      30                 :          0 : class ANALYSIS_EXPORT QgsRuggednessFilter: public QgsNineCellFilter
      31                 :            : {
      32                 :            :   public:
      33                 :            :     QgsRuggednessFilter( const QString &inputFile, const QString &outputFile, const QString &outputFormat );
      34                 :            : 
      35                 :            :   protected:
      36                 :            : 
      37                 :            :     float processNineCellWindow( float *x11, float *x21, float *x31,
      38                 :            :                                  float *x12, float *x22, float *x32,
      39                 :            :                                  float *x13, float *x23, float *x33 ) override;
      40                 :            : 
      41                 :            : #ifdef HAVE_OPENCL
      42                 :            :   private:
      43                 :            :     QgsRuggednessFilter();
      44                 :            : 
      45                 :            :     virtual const QString openClProgramBaseName() const override
      46                 :            :     {
      47                 :            :       return QStringLiteral( "ruggedness" );
      48                 :            :     }
      49                 :            : #endif
      50                 :            : 
      51                 :            : };
      52                 :            : 
      53                 :            : #endif // QGSRUGGEDNESSFILTER_H