edited GRASS/SEXTANTE algorithm descriptions

qgis · Jan 26, 2013 · 20e4ec5 · 20e4ec5
1 parent f91e9d3
commit 20e4ec5
Show file tree

Hide file tree

Showing 25 changed files with 73 additions and 125 deletions.
diff --git a/python/plugins/sextante/grass/description/r.los.txt b/python/plugins/sextante/grass/description/r.los.txt
@@ -7,4 +7,4 @@ ParameterRaster|patt_map|Binary (1/0) raster layer to use as a mask|True
 ParameterString|obs_elev|Viewing position height above the ground|1.75
 ParameterString|max_dist|Maximum distance from the viewing point (meters)|10000
 ParameterBoolean|-c|Consider earth curvature (current ellipsoid)|False
-OutputRaster|output|Output raster layer
+OutputRaster|output|Output raster layer
diff --git a/python/plugins/sextante/grass/description/r.mapcalculator.txt b/python/plugins/sextante/grass/description/r.mapcalculator.txt
@@ -8,4 +8,4 @@ ParameterRaster|dmap|Raster layer D|True
 ParameterRaster|emap|Raster layer E|True
 ParameterRaster|fmap|Raster layer F|True
 ParameterString|formula|Formula| A*C+B
-OutputRaster|outfile|Output raster layer
+OutputRaster|outfile|Output raster layer
diff --git a/python/plugins/sextante/grass/description/r.plane.txt b/python/plugins/sextante/grass/description/r.plane.txt
@@ -1,5 +1,5 @@
 r.plane
-r.plane - Creates raster plane map given dip (inclination), aspect (azimuth) and one point.
+r.plane - Creates raster plane layer given dip (inclination), aspect (azimuth) and one point.
 Raster (r.*)
 ParameterNumber|dip|Dip of plane. Value must be between -90 and 90 degrees|None|None|0.0
 ParameterNumber|azimuth|Azimuth of the plane. Value must be between 0 and 360 degrees|None|None|0.0

diff --git a/python/plugins/sextante/grass/description/r.reclass.area.greater.txt b/python/plugins/sextante/grass/description/r.reclass.area.greater.txt
@@ -0,0 +1,6 @@
+r.reclass.area
+r.reclass.area.greater - Reclassifies a raster layer, selecting areas larger than a user specified size
+Raster (r.*)
+ParameterRaster|input|Input raster layer|False
+ParameterNumber|greater|Area threshold [hectares]|0|None|1
+OutputRaster|output|Output raster layer
diff --git a/python/plugins/sextante/grass/description/r.reclass.area.lesser.txt b/python/plugins/sextante/grass/description/r.reclass.area.lesser.txt
@@ -0,0 +1,6 @@
+r.reclass.area
+r.reclass.area.lesser - Reclassifies a raster layer, selecting areas lower than a user specified size
+Raster (r.*)
+ParameterRaster|input|Input raster layer|False
+ParameterNumber|lesser|Area threshold [hectares]|0|None|1
+OutputRaster|output|Output raster layer
diff --git a/python/plugins/sextante/grass/description/r.reclass.area.txt b/python/plugins/sextante/grass/description/r.reclass.area.txt
diff --git a/python/plugins/sextante/grass/description/r.reclass.txt b/python/plugins/sextante/grass/description/r.reclass.txt
@@ -1,6 +1,6 @@
 r.reclass
 r.reclass - Creates a new map layer whose category values are based upon a reclassification of the categories in an existing raster map layer.
 Raster (r.*)
-ParameterRaster|input|Name of input raster map|False
+ParameterRaster|input|Input raster layer|False
 ParameterFile|rules|File containing reclass rules|False
-OutputRaster|output|Name for output raster map
+OutputRaster|output|Output raster layer
diff --git a/python/plugins/sextante/grass/description/r.recode.txt b/python/plugins/sextante/grass/description/r.recode.txt
@@ -1,9 +1,7 @@
 r.recode
 r.recode - Recodes categorical raster maps.
 Raster (r.*)
-ParameterRaster|input|Name of input raster map|False
+ParameterRaster|input|Input layer|False
 ParameterFile|rules|File containing recode rules|False
-ParameterString|title|Title for output raster map|
-ParameterBoolean|-a|Align the current region to the input raster map|False
-ParameterBoolean|-d|Force output to 'double' raster map type (DCELL)|False
-OutputRaster|output|Name for output raster map
+*ParameterBoolean|-d|Force output to 'double' raster map type (DCELL)|False
+OutputRaster|output|Output raster layer
diff --git a/python/plugins/sextante/grass/description/r.regression.line.txt b/python/plugins/sextante/grass/description/r.regression.line.txt
@@ -1,7 +1,7 @@
 r.regression.line
 r.regression.line - Calculates linear regression from two raster layers : y = a + b*x.
 Raster (r.*)
-ParameterRaster|map1|Map for x coefficient|False
-ParameterRaster|map2|Map for y coefficient|False
+ParameterRaster|map1|Layer for x coefficient|False
+ParameterRaster|map2|Layer for y coefficient|False
 ParameterBoolean|-s|Slower but accurate|False
 OutputHTML|html|Regression data
diff --git a/python/plugins/sextante/grass/description/r.report.txt b/python/plugins/sextante/grass/description/r.report.txt
@@ -1,15 +1,13 @@
 r.report
-r.report - Reports statistics for raster map layers.
+r.report - Reports statistics for raster layers.
 Raster (r.*)
-ParameterMultipleInput|map|Raster map(s) to report on|3.0|False
+ParameterMultipleInput|map|Raster layer(s) to report on|3.0|False
 ParameterSelection|units|Units|mi;me;k;a;h;c;p
 ParameterString|null|Character representing no data cell value|*
-ParameterNumber|nsteps|Number of fp subranges to collect stats from|None|None|255
+ParameterNumber|nsteps|Number of fp subranges to collect stats from|1|None|255
 ParameterBoolean|-h|Suppress page headers|True
 ParameterBoolean|-f|Use formfeeds between pages|True
 ParameterBoolean|-e|Scientific format|True
 ParameterBoolean|-n|Filter out all no data cells|True
-ParameterBoolean|-N|Filter out cells where all maps have no data|True
-ParameterBoolean|-C|Report for cats fp ranges (fp maps only)|True
-ParameterBoolean|-i|Read fp map as integer (use map's quant rules)|True
-OutputHTML|output|Name of an output file to hold the report
+ParameterBoolean|-N|Filter out cells where all layers have no data|True
+OutputHTML|output|Output report file
diff --git a/python/plugins/sextante/grass/description/r.resamp.interp.txt b/python/plugins/sextante/grass/description/r.resamp.interp.txt
@@ -1,6 +1,6 @@
 r.resamp.interp
-r.resamp.interp - Resamples raster map layers to a finer grid using interpolation.
+r.resamp.interp - Resamples a raster map layer to a finer grid using interpolation.
 Raster (r.*)
-ParameterRaster|input|Name of input raster map|False
+ParameterRaster|input|Input raster layer|False
 ParameterSelection|method|Interpolation method|nearest;bilinear;bicubic
-OutputRaster|output|Name for output raster map
+OutputRaster|output|Output raster layer
diff --git a/python/plugins/sextante/grass/description/r.resamp.rst.txt b/python/plugins/sextante/grass/description/r.resamp.rst.txt
@@ -1,9 +1,8 @@
 r.resamp.rst
-r.resamp.rst - Reinterpolates and optionally computes topographic analysis using regularized spline with tension and smoothing.
+r.resamp.rst - Reinterpolates using regularized spline with tension and smoothing.
 Raster (r.*)
-ParameterRaster|input|Name of input raster map|False
+ParameterRaster|input|Raster layer|False
 ParameterNumber|ew_res|Desired east-west resolution|0.0|None|1
 ParameterNumber|ns_res|Desired north-south resolution|0.0|None|1
 ParameterBoolean|-t|Use dnorm independent tension|False
-ParameterBoolean|-d|Output partial derivatives instead of topographic parameters|False
-OutputRaster|elev|Output z-file (elevation) map
+OutputRaster|elev|Output layer
diff --git a/python/plugins/sextante/grass/description/r.resamp.stats.txt b/python/plugins/sextante/grass/description/r.resamp.stats.txt
@@ -1,8 +1,8 @@
 r.resamp.stats
-r.resamp.stats - Resamples raster map layers to a coarser grid using aggregation.
+r.resamp.stats - Resamples raster layers to a coarser grid using aggregation.
 Raster (r.*)
-ParameterRaster|input|Name of input raster map|False
+ParameterRaster|input|Input raster layer|False
 ParameterSelection|method|Aggregation method|average;median;mode;minimum;maximum;quart1;quart3;perc90;sum;variance;stddev
 ParameterBoolean|-n|Propagate NULLs|False
 ParameterBoolean|-w|Weight according to area (slower)|False
-OutputRaster|output|Name for output raster map
+OutputRaster|output|Output raster layer
diff --git a/python/plugins/sextante/grass/description/r.resample.txt b/python/plugins/sextante/grass/description/r.resample.txt
@@ -1,5 +1,5 @@
 r.resample
 r.resample - GRASS raster map layer data resampling capability using nearest neighbors.
 Raster (r.*)
-ParameterRaster|input|Name of input raster map|False
-OutputRaster|output|Name for output raster map
+ParameterRaster|input|Input raster layer |False
+OutputRaster|output|Output raster layer
diff --git a/python/plugins/sextante/grass/description/r.rescale.eq.txt b/python/plugins/sextante/grass/description/r.rescale.eq.txt
@@ -1,7 +1,7 @@
 r.rescale.eq
-r.rescale.eq - Rescales histogram equalized the range of category values in a raster map layer.
+r.rescale.eq - Rescales histogram equalized the range of category values in a raster  layer.
 Raster (r.*)
-ParameterRaster|input|Name of input raster map|False
-ParameterRange|from|The input data range to be rescaled (default: full range of input map)
+ParameterRaster|input|Input raster layer|False
+ParameterRange|from|The input data range to be rescaled
 ParameterRange|to|The output data range
-OutputRaster|output|Name for output raster map
+OutputRaster|output|Output raster layer
diff --git a/python/plugins/sextante/grass/description/r.rescale.txt b/python/plugins/sextante/grass/description/r.rescale.txt
@@ -1,7 +1,7 @@
 r.rescale
-r.rescale - Rescales the range of category values in a raster map layer.
+r.rescale - Rescales the range of category values in a raster layer.
 Raster (r.*)
-ParameterRaster|input|Name of input raster map|False
-ParameterRange|from|The input data range to be rescaled (default: full range of input map)|
-ParameterRange|to|The output data range|a,d
-OutputRaster|output|Name for output raster map
+ParameterRaster|input|Input raster layer|False
+ParameterRange|from|The input data range to be rescaled|
+ParameterRange|to|The output data range|0,1
+OutputRaster|output|Output raster layer
diff --git a/python/plugins/sextante/grass/description/r.ros.txt b/python/plugins/sextante/grass/description/r.ros.txt
diff --git a/python/plugins/sextante/grass/description/r.series.txt b/python/plugins/sextante/grass/description/r.series.txt
@@ -1,10 +1,8 @@
 r.series
-r.series - Makes each output cell value a function of the values assigned to the corresponding cells in the input raster map layers.
+r.series - Makes each output cell value a function of the values assigned to the corresponding cells in the input raster layers.
 Raster (r.*)
-ParameterMultipleInput|input|Name of input raster map(s)|3.0|False
+ParameterMultipleInput|input|Input raster layer(s)|3.0|False
 ParameterBoolean|-n|Propagate NULLs|True
-ParameterSelection|method|Aggregate operation|average;count;median;mode;minimum;min_raster;maximum;max_raster;stddev;range;sum;threshold;variance;diversity;slope;offset;detcoeff;quart1;quart3;perc90;quantile;skewness;kurtosis
-*ParameterNumber|quantile|Quantile to calculate for method=quantile|0.0|1.0|0.0
-*ParameterNumber|threshold|Threshold to calculate for method=threshold|None|None|0.0
+ParameterSelection|method|Aggregate operation|average;count;median;mode;minimum;min_raster;maximum;max_raster;stddev;range;sum;variance;diversity;slope;offset;detcoeff;quart1;quart3;perc90;skewness;kurtosis
 *ParameterString|range|Ignore values outside this range (lo,hi)|-10000000000,10000000000
-OutputRaster|output|Name for output raster map
+OutputRaster|output|Ouptut raster layer
diff --git a/python/plugins/sextante/grass/description/r.shaded.relief.txt b/python/plugins/sextante/grass/description/r.shaded.relief.txt
@@ -1,10 +1,10 @@
 r.shaded.relief
-r.shaded.relief - Creates shaded relief map from an elevation map (DEM).
+r.shaded.relief - Creates shaded relief from an elevation layer (DEM).
 Raster (r.*)
-ParameterRaster|map|Input elevation map|False
+ParameterRaster|map|Input elevation layer|False
 ParameterNumber|altitude|Altitude of the sun in degrees above the horizon|None|None|30.0
 ParameterNumber|azimuth|Azimuth of the sun in degrees to the east of north|None|None|270.0
 ParameterNumber|zmult|Factor for exaggerating relief|None|None|1.0
 ParameterNumber|scale|Scale factor for converting horizontal units to elevation units|None|None|1.0
 ParameterSelection|units|et scaling factor (applies to lat./long. locations only, none: scale=1)|none;meters;feet
-OutputRaster|shadedmap|Output shaded relief map name
+OutputRaster|shadedmap|Output shaded relief layer
diff --git a/python/plugins/sextante/grass/description/r.slope.aspect.txt b/python/plugins/sextante/grass/description/r.slope.aspect.txt
@@ -1,18 +1,17 @@
 r.slope.aspect
-r.slope.aspect - Generates raster maps of slope, aspect, curvatures and partial derivatives from a elevation raster map.
+r.slope.aspect - Generates raster layers of slope, aspect, curvatures and partial derivatives from a elevation raster layer.
 Raster (r.*)
-ParameterRaster|elevation|Name of elevation raster map|False
+ParameterRaster|elevation|Elevation|False
 ParameterSelection|format|Format for reporting the slope|degrees;percent
-ParameterSelection|prec|Type of output aspect and slope maps|float;double;int
+ParameterSelection|prec|Type of output aspect and slope layer|float;double;int
 ParameterNumber|zfactor|Multiplicative factor to convert elevation units to meters|None|None|1.0
 ParameterNumber|min_slp_allowed|Minimum slope val. (in percent) for which aspect is computed|None|None|0.0
-ParameterBoolean|-a|Do not align the current region to the elevation layer|True
-OutputRaster|slope|Name for output slope raster map
-OutputRaster|aspect|Name for output aspect raster map
-OutputRaster|pcurv|Name for output profile curvature raster map
-OutputRaster|tcurv|Name for output tangential curvature raster map
-OutputRaster|dx|Name for output first order partial derivative dx (E-W slope) raster map
-OutputRaster|dy|Name for output first order partial derivative dy (N-S slope) raster map
-OutputRaster|dxx|Name for output second order partial derivative dxx raster map
-OutputRaster|dyy|Name for output second order partial derivative dyy raster map
-OutputRaster|dxy|Name for output second order partial derivative dxy raster map
+OutputRaster|slope|Output slope layer
+OutputRaster|aspect|Output aspect layer
+OutputRaster|pcurv|Output profile curvature layer
+OutputRaster|tcurv|Output tangential curvature layer
+OutputRaster|dx|Output first order partial derivative dx (E-W slope) layer
+OutputRaster|dy|Output first order partial derivative dy (N-S slope) layer
+OutputRaster|dxx|Output second order partial derivative dxx layer
+OutputRaster|dyy|Output second order partial derivative dyy layer
+OutputRaster|dxy|Output second order partial derivative dxy layer
diff --git a/python/plugins/sextante/grass/description/r.slope.txt b/python/plugins/sextante/grass/description/r.slope.txt
diff --git a/python/plugins/sextante/grass/description/r.spread.txt b/python/plugins/sextante/grass/description/r.spread.txt
diff --git a/python/plugins/sextante/grass/description/r.spreadpath.txt b/python/plugins/sextante/grass/description/r.spreadpath.txt
@@ -4,5 +4,4 @@ Raster (r.*)
 ParameterRaster|x_input|x_input|False
 ParameterRaster|y_input|y_input|False
 ParameterString|coordinate|coordinate|0,0
-ParameterBoolean|-v|-v|True
-OutputRaster|output|Name for output raster map
+OutputRaster|output|Output layer
diff --git a/python/plugins/sextante/grass/description/r.statistics.txt b/python/plugins/sextante/grass/description/r.statistics.txt
@@ -1,8 +1,8 @@
 r.statistics
 r.statistics - Calculates category or object oriented statistics.
 Raster (r.*)
-ParameterRaster|base|Name of base raster map|False
-ParameterRaster|cover|Name of cover raster map|False
-ParameterSelection|method|method|diversity;distribution;average;mode;median;avedev;stddev;variance;skewness;kurtosis;min;max;sum
+ParameterRaster|base|Base raster layer|False
+ParameterRaster|cover|Cover raster layer|False
+ParameterSelection|method|method|diversity;average;mode;median;avedev;stddev;variance;skewness;kurtosis;min;max;sum
 ParameterBoolean|-c|Cover values extracted from the category labels of the cover map|False
-OutputRaster|output|Resultant raster map (not used with 'distribution')
+OutputRaster|output|Output raster layer
diff --git a/python/plugins/sextante/saga/description/Merging.txt b/python/plugins/sextante/saga/description/Merging.txt
@@ -1,10 +1,9 @@
-Merging|Merge raster layers
+Merge raster layers|Merging
 grid_tools
 DontResample
 ParameterMultipleInput|GRIDS|Grids to Merge|3|False
 ParameterSelection|TYPE|Preferred data storage type|[0] 1 bit;[1] 1 byte unsigned integer;[2] 1 byte signed integer;[3] 2 byte unsigned integer;[4] 2 byte signed integer;[5] 4 byte unsigned integer;[6] 4 byte signed integer;[7] 4 byte floating point;[8] 8 byte floating point
 ParameterSelection|INTERPOL|Interpolation|[0] Nearest Neighbor;[1] Bilinear Interpolation;[2] Inverse Distance Interpolation;[3] Bicubic Spline Interpolation;[4] B-Spline Interpolation
 ParameterSelection|OVERLAP|Overlapping Cells|[0] mean value;[1] first value in order of grid list
 ParameterNumber|MERGE_INFO_MESH_SIZE|Cell Size|0.0|None|1.0
-OutputRaster|MERGED|Merged Grid
-d
+OutputRaster|MERGED|Merged Grid