Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
edited grass and saga algorithm descriptions
  • Loading branch information
volaya committed Jan 1, 2013
1 parent 287c9f3 commit 5c00014
Show file tree
Hide file tree
Showing 20 changed files with 114 additions and 58 deletions.
16 changes: 5 additions & 11 deletions python/plugins/sextante/grass/description/r.horizon.txt
@@ -1,16 +1,10 @@
r.horizon
r.horizon - Horizon angle computation from a digital elevation model.
Raster (r.*)
ParameterRaster|elevin|Name of the input elevation raster map [meters]|False
ParameterNumber|direction|Direction in which you want to know the horizon height|None|None|0.0
ParameterNumber|horizonstep|Angle step size for multidirectional horizon [degrees]|None|None|0.0
ParameterNumber|bufferzone|For horizon rasters, read from the DEM an extra buffer around the present region|None|None|0.0
ParameterNumber|e_buff|For horizon rasters, read from the DEM an extra buffer eastward the present region|None|None|0.0
ParameterNumber|w_buff|For horizon rasters, read from the DEM an extra buffer westward the present region|None|None|0.0
ParameterNumber|n_buff|For horizon rasters, read from the DEM an extra buffer northward the present region|None|None|0.0
ParameterNumber|s_buff|For horizon rasters, read from the DEM an extra buffer southward the present region|None|None|0.0
ParameterNumber|maxdistance|The maximum distance to consider when finding the horizon height|None|None|0.0
ParameterRaster|horizon|Prefix of the horizon raster output maps|False
ParameterString|coord|Coordinate for which you want to calculate the horizon|0,0
ParameterRaster|elevin|Elevation layer [meters]|False
ParameterNumber|direction|Direction in which you want to know the horizon height|0|360|0.0
ParameterNumber|horizonstep|Angle step size for multidirectional horizon [degrees]|0|360|0.0
ParameterNumber|maxdistance|The maximum distance to consider when finding the horizon height|0|None|10000
ParameterCoodinate|coord|Coordinate for which you want to calculate the horizon|0,0
ParameterString|dist|Sampling distance step coefficient (0.5-1.5)|1.0
ParameterBoolean|-d|Write output in degrees (default is radians)|False
5 changes: 3 additions & 2 deletions python/plugins/sextante/grass/description/r.info.txt
@@ -1,7 +1,7 @@
r.info
r.info - Output basic information about a raster map layer.
r.info - Output basic information about a raster layer.
Raster (r.*)
ParameterRaster|map|Name of input raster map|False
ParameterRaster|map|Raster layer|False
ParameterBoolean|-r|Print range only|False
ParameterBoolean|-s|Print raster map resolution (NS-res, EW-res) only|False
ParameterBoolean|-t|Print raster map type only|False
Expand All @@ -11,3 +11,4 @@ ParameterBoolean|-u|Print raster map data units only|False
ParameterBoolean|-d|Print raster map vertical datum only|False
ParameterBoolean|-m|Print map title only|False
ParameterBoolean|-p|Print raster map timestamp (day.month.year hour:minute:seconds) only|False
OutputHTML|html|Layer info
2 changes: 1 addition & 1 deletion python/plugins/sextante/grass/description/r.kappa.txt
Expand Up @@ -5,4 +5,4 @@ ParameterRaster|classification|Raster layer containing classification result|Fal
ParameterRaster|reference|Raster layer containing reference classes|False
ParameterString|title|Title for error matrix and kappa|ACCURACY ASSESSMENT
ParameterBoolean|-h|No header in the report|False
OutputFile|output|output file containing error matrix and kappa
OutputFile|output|Output file containing error matrix and kappa
Expand Up @@ -5,4 +5,4 @@ ParameterRaster|dem|Elevation|False
ParameterNumber|wl|Water level|None|None|1000.0
ParameterString|xy|Seed point coordinates|0,0
ParameterBoolean|-n|Use negative depth values for lake raster layer|False
OutputRaster|lake|Raster map with lake
OutputRaster|lake|Raster layer with lake
4 changes: 2 additions & 2 deletions python/plugins/sextante/grass/description/r.lake.layer.txt
Expand Up @@ -3,6 +3,6 @@ r.lake.layer - Fills lake at given point to given level.
Raster (r.*)
ParameterRaster|dem|Elevation|False
ParameterNumber|wl|Water level|None|None|1000.0
ParameterRaster|seed|Name of raster map with given starting point(s) (at least 1 cell > 0)|False
ParameterRaster|seed|Raster layer with starting point(s) (at least 1 cell > 0)|False
ParameterBoolean|-n|Use negative depth values for lake raster layer|False
OutputRaster|lake|Outtput raster map with lake
OutputRaster|lake|Output raster map with lake
7 changes: 3 additions & 4 deletions python/plugins/sextante/grass/description/r.mfilter.fp.txt
@@ -1,9 +1,8 @@
r.mfilter.fp
r.mfilter.fp - Raster map matrix filter.
Raster (r.*)
ParameterRaster|input|Name of input raster map|False
ParameterRaster|input|input layer|False
ParameterFile|filter|Filter file|False
ParameterNumber|repeat|Number of times to repeat the filter|None|None|1
ParameterString|title|Output raster map title|
ParameterNumber|repeat|Number of times to repeat the filter|1|None|1
ParameterBoolean|-z|Apply filter only to zero data values|False
OutputRaster|output|Name for output raster map
OutputRaster|output|Output layer
7 changes: 3 additions & 4 deletions python/plugins/sextante/grass/description/r.mfilter.txt
@@ -1,9 +1,8 @@
r.mfilter
r.mfilter - Performs raster map matrix filter.
Raster (r.*)
ParameterRaster|input|Name of input raster map|False
ParameterRaster|input|Input layer|False
ParameterFile|filter|Filter file|False
ParameterNumber|repeat|Number of times to repeat the filter|None|None|1
ParameterString|title|Output raster map title|
ParameterNumber|repeat|Number of times to repeat the filter|1|None|1
ParameterBoolean|-z|Apply filter only to zero data values|False
OutputRaster|output|Name for output raster map
OutputRaster|output|Output layer
6 changes: 3 additions & 3 deletions python/plugins/sextante/grass/description/r.mode.txt
@@ -1,6 +1,6 @@
r.mode
r.mode - Finds the mode of values in a cover map within areas assigned the same category value in a user-specified base map.
Raster (r.*)
ParameterRaster|base|Base map to be reclassified|False
ParameterRaster|cover|Name of cover raster map|False
OutputRaster|output|Name for output raster map
ParameterRaster|base|Base layer to be reclassified|False
ParameterRaster|cover|Categories layer|False
OutputRaster|output|Output layer
4 changes: 2 additions & 2 deletions python/plugins/sextante/grass/description/r.patch.txt
@@ -1,6 +1,6 @@
r.patch
r.patch - Creates a composite raster map layer by using one (or more) map layer(s) to fill in areas of "no data" in another map layer.
Raster (r.*)
ParameterMultipleInput|input|Name of raster maps to be patched together|3|False
ParameterMultipleInput|input|Raster maps to be patched together|3|False
ParameterBoolean|-z|Use zero (0) for transparency instead of NULL|False
OutputRaster|output|Name for resultant raster map
OutputRaster|output|Result
7 changes: 4 additions & 3 deletions python/plugins/sextante/grass/description/r.plane.txt
@@ -1,10 +1,11 @@
r.plane
r.plane - Creates raster plane map 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
ParameterNumber|easting|Easting coordinate of a point on the plane|None|None|0.0
ParameterNumber|northing|Northing coordinate of a point on the plane|None|None|0.0
ParameterNumber|elevation|Name of elevation raster map|None|None|0.0
ParameterSelection|type|Type of the raster map to be created|int;float;double
OutputRaster|name|Name of raster plane to be created
ParameterNumber|elevation|Elevation coordinate of a point on the plane|None|None|0.0
ParameterSelection|type|Data type of resulting layer|int;float;double
OutputRaster|name|Output raster layer
11 changes: 5 additions & 6 deletions python/plugins/sextante/grass/description/r.profile.txt
@@ -1,11 +1,10 @@
r.profile
r.profile - Outputs the raster map layer values lying on user-defined line(s).
r.profile - Outputs the raster layer values lying on user-defined line(s).
Raster (r.*)
ParameterRaster|input|Name of input raster map|False
ParameterString|profile|Profile coordinate pairs|
ParameterString|res|Resolution along profile (default = current region resolution)|
ParameterRaster|input|Input raster layer|False
ParameterString|profile|Profile coordinate pairs|0,0,1,1
ParameterNumber|res|Resolution along profile|0|None|1.0
ParameterString|null|Character to represent no data cell|*
ParameterBoolean|-i|Interactively select End-Points|False
ParameterBoolean|-g|Output easting and northing in first two columns of four column output|False
ParameterBoolean|-c|Output RRR:GGG:BBB color values for each profile point|False
OutputFile|output|Name of file for output (use output=- for stdout)
OutputFile|output|Output filename
@@ -1,8 +1,7 @@
r.regression.line
r.regression.line - Calculates linear regression from two raster maps: y = a + b*x.
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
ParameterBoolean|-g|Print in shell script style|False
ParameterBoolean|-s|Slower but accurate (applies to FP maps only)|False
OutputFile|output|ASCII file for storing regression coefficients (output to screen if file not specified)
ParameterBoolean|-s|Slower but accurate|False
OutputHTML|html|Regression data
36 changes: 36 additions & 0 deletions python/plugins/sextante/grass/ext/r_info.py
@@ -0,0 +1,36 @@
# -*- coding: utf-8 -*-

"""
***************************************************************************
r_info.py
---------------------
Date : December 2012
Copyright : (C) 2012 by Victor Olaya
Email : volayaf at gmail dot com
***************************************************************************
* *
* 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. *
* *
***************************************************************************
"""
__author__ = 'Victor Olaya'
__date__ = 'December 2012'
__copyright__ = '(C) 2012, Victor Olaya'
# This will get replaced with a git SHA1 when you do a git archive
__revision__ = '$Format:%H$'

def postProcessResults(alg):
htmlFile = alg.getOutputFromName('html').value
found = False
f = open(htmlFile, "w")
f.write("<h2>r.info</h2>\n")
for line in alg.consoleOutput:
if found and not line.strip().endswith('exit'):
f.write(line + "<br>\n")
if 'r.info' in line:
found = True
f.close()

36 changes: 36 additions & 0 deletions python/plugins/sextante/grass/ext/r_regression_line.py
@@ -0,0 +1,36 @@
# -*- coding: utf-8 -*-

"""
***************************************************************************
r_regression_line.py
---------------------
Date : December 2012
Copyright : (C) 2012 by Victor Olaya
Email : volayaf at gmail dot com
***************************************************************************
* *
* 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. *
* *
***************************************************************************
"""
__author__ = 'Victor Olaya'
__date__ = 'December 2012'
__copyright__ = '(C) 2012, Victor Olaya'
# This will get replaced with a git SHA1 when you do a git archive
__revision__ = '$Format:%H$'

def postProcessResults(alg):
htmlFile = alg.getOutputFromName('html').value
found = False
f = open(htmlFile, "w")
f.write("<h2>r.regresion.line</h2>\n")
for line in alg.consoleOutput:
if found and not line.strip().endswith('exit'):
f.write(line + "<br>\n")
if 'r.regression.line' in line:
found = True
f.close()

2 changes: 1 addition & 1 deletion python/plugins/sextante/grass/ext/v_info.py
Expand Up @@ -33,4 +33,4 @@ def postProcessResults(alg):
if 'v.info' in line:
found = True
f.close()


Expand Up @@ -2,8 +2,8 @@ Fragmentation (Alternative)
grid_analysis
ParameterRaster|CLASSES|Classification|False
ParameterNumber|CLASS|Class Identifier|None|None|1
ParameterNumber|NEIGHBORHOOD_MIN|Neighborhood|1.0|None|1
ParameterNumber|NEIGHBORHOOD_MAX|Neighborhood|1.0|None|1
ParameterNumber|NEIGHBORHOOD_MIN|Neighborhood Min|1.0|None|1
ParameterNumber|NEIGHBORHOOD_MAX|Neighborhood Max|1.0|None|1
ParameterSelection|AGGREGATION|Level Aggregation|[0] average;[1] multiplicative
ParameterBoolean|BORDER |Add Border|True
ParameterNumber|WEIGHT|Connectivity Weighting|None|None|1.1
Expand Down
Expand Up @@ -2,8 +2,8 @@ Fragmentation (Standard)
grid_analysis
ParameterRaster|CLASSES|Classification|False
ParameterNumber|CLASS|Class Identifier|None|None|1
ParameterNumber|NEIGHBORHOOD_MIN|Neighborhood|1.0|None|3
ParameterNumber|NEIGHBORHOOD_MAX|Neighborhood|1.0|None|3
ParameterNumber|NEIGHBORHOOD_MIN|Neighborhood Min|1.0|None|1
ParameterNumber|NEIGHBORHOOD_MAX|Neighborhood Max|1.0|None|3
ParameterSelection|AGGREGATION|Level Aggregation|[0] average;[1] multiplicative
ParameterBoolean|BORDER|Add Border|True
ParameterNumber|WEIGHT|Connectivity Weighting|None|None|1.1
Expand Down

This file was deleted.

@@ -1,8 +1,8 @@
Join Attributes from a Table
table_tools
ParameterTable|TABLE_A|Table|False
ParameterVector|TABLE_A|Shapes|-1|False
ParameterTable|TABLE_B|Join Table|False
ParameterTableField|ID_A|Attribute (Table)|TABLE_A
ParameterTableField|ID_B|Attribute (Join Table)|TABLE_B
ParameterBoolean|KEEPALL |Keep All|True
OutputTable|RESULT|Result
OutputVector|RESULT|Result

0 comments on commit 5c00014

Please sign in to comment.