Added reference to algorithm description for ruggedness index

mhugent · mhugent · commit 2bb0aa86789b · 2010-10-31T17:41:57.000Z
git-svn-id: http://svn.osgeo.org/qgis/trunk/qgis@14464 c8812cc2-4d05-0410-92ff-de0c093fc19c
diff --git a/src/analysis/raster/qgsruggednessfilter.h b/src/analysis/raster/qgsruggednessfilter.h
@@ -20,7 +20,8 @@
 
 #include "qgsninecellfilter.h"
 
-/**Calculates the ruggedness index based on a 3x3 moving window*/
+/**Calculates the ruggedness index based on a 3x3 moving window.
+  Algorithm from Riley et al. 1999: A terrain ruggedness index that quantifies topographic heterogeneity*/
 class ANALYSIS_EXPORT QgsRuggednessFilter: public QgsNineCellFilter
 {
   public:

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,8 @@`
`20`	`20`
`21`	`21`	`#include "qgsninecellfilter.h"`
`22`	`22`
`23`		`-/*Calculates the ruggedness index based on a 3x3 moving window/`
	`23`	`+/**Calculates the ruggedness index based on a 3x3 moving window.`
	`24`	`+ Algorithm from Riley et al. 1999: A terrain ruggedness index that quantifies topographic heterogeneity*/`
`24`	`25`	`class ANALYSIS_EXPORT QgsRuggednessFilter: public QgsNineCellFilter`
`25`	`26`	`{`
`26`	`27`	`public:`