Skip to content

Commit

Permalink
Uniform and informative output names for Processing (GRASS-r.* module…
Browse files Browse the repository at this point in the history
…s, take #2, up to r.report)
  • Loading branch information
pcav committed May 18, 2015
1 parent 15419b8 commit e633caf
Show file tree
Hide file tree
Showing 61 changed files with 65 additions and 64 deletions.
Expand Up @@ -22,4 +22,4 @@ ParameterNumber|error|Error break criteria for iterative solvers (jacobi, sor, c
ParameterSelection|solver|The type of solver which should solve the symmetric linear equation system|gauss;lu;cholesky;jacobi;sor;cg;bicgstab;pcg
ParameterString|relax|The relaxation parameter used by the jacobi and sor solver for speedup or stabilizing|1
ParameterBoolean|-s|Use a sparse matrix, only available with iterative solvers|False
OutputRaster|output|The map storing the numerical result [m]
OutputRaster|output|Groundwater flow
Expand Up @@ -7,3 +7,4 @@ ParameterNumber|horizonstep|Angle step size for multidirectional horizon [degree
ParameterNumber|maxdistance|The maximum distance to consider when finding the horizon height|0|None|10000
ParameterString|dist|Sampling distance step coefficient (0.5-1.5)|1.0
ParameterBoolean|-d|Write output in degrees (default is radians)|False
OutputRaster|horizon|Horizon
Expand Up @@ -6,4 +6,4 @@ ParameterNumber|direction|Direction in which you want to know the horizon height
ParameterNumber|maxdistance|The maximum distance to consider when finding the horizon height|0|None|10000
ParameterString|dist|Sampling distance step coefficient (0.5-1.5)|1.0
ParameterBoolean|-d|Write output in degrees (default is radians)|False
OutputRaster|horizon|Horizon angle computation
OutputRaster|horizon|Horizon
Expand Up @@ -11,4 +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
OutputHTML|html|Basic information
Expand Up @@ -6,4 +6,4 @@ 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
ParameterBoolean|-w|Wide report (132 columns)|False
OutputFile|output|Output file containing error matrix and kappa
OutputFile|output|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 layer with lake
OutputRaster|lake|Lake
Expand Up @@ -5,4 +5,4 @@ ParameterRaster|dem|Elevation|False
ParameterNumber|wl|Water level|None|None|1000.0
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|Output raster map with lake
OutputRaster|lake|Lake
2 changes: 1 addition & 1 deletion python/plugins/processing/algs/grass/description/r.los.txt
Expand Up @@ -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|Intervisibility
Expand Up @@ -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|Calculated
Expand Up @@ -3,4 +3,4 @@ r.median - Finds the median of values in a cover layer within areas assigned the
Raster (r.*)
ParameterRaster|base|Base raster layer|False
ParameterRaster|cover|Cover layer|False
OutputRaster|output|Output raster layer
OutputRaster|output|Median
Expand Up @@ -5,4 +5,4 @@ ParameterRaster|input|input layer|False
ParameterFile|filter|Filter file|False
ParameterNumber|repeat|Number of times to repeat the filter|1|None|1
ParameterBoolean|-z|Apply filter only to zero data values|False
OutputRaster|output|Output layer
OutputRaster|output|Filtered
Expand Up @@ -5,4 +5,4 @@ ParameterRaster|input|Input layer|False
ParameterFile|filter|Filter file|False
ParameterNumber|repeat|Number of times to repeat the filter|1|None|1
ParameterBoolean|-z|Apply filter only to zero data values|False
OutputRaster|output|Output layer
OutputRaster|output|Filtered
Expand Up @@ -3,4 +3,4 @@ r.mode - Finds the mode of values in a cover layer within areas assigned the sam
Raster (r.*)
ParameterRaster|base|Base layer to be reclassified|False
ParameterRaster|cover|Categories layer|False
OutputRaster|output|Output layer
OutputRaster|output|Mode
Expand Up @@ -7,4 +7,4 @@ ParameterNumber|size|Neighborhood size|1|None|3
ParameterBoolean|-c|Use circular neighborhood|False
*ParameterBoolean|-a|Do not align output with the input|False
*ParameterFile|weight|File containing weights|False
OutputRaster|output|Output layer
OutputRaster|output|Neighbors
Expand Up @@ -2,4 +2,4 @@ r.out.gridatb
r.out.gridatb - Exports GRASS raster map to GRIDATB.FOR map file (TOPMODEL)
Raster (r.*)
ParameterRaster|input|Name of input raster map|False
OutputFile|output|GRIDATB i/o map file
OutputFile|output|GRIDATB
Expand Up @@ -3,4 +3,4 @@ r.out.ppm - Converts a raster layer to a PPM image file at the pixel resolution
Raster (r.*)
ParameterRaster|input|Input raster layer|False
ParameterBoolean|-G|Output greyscale instead of color|True
OutputFile|output|Output PPM file
OutputFile|output|PPM
Expand Up @@ -4,4 +4,4 @@ Raster (r.*)
ParameterRaster|elev|Elevation layer|False
ParameterRaster|color|Color layer|False
ParameterNumber|exag|Vertical exaggeration|None|None|1.0
OutputFile|output|Output VRML file
OutputFile|output|VRML
Expand Up @@ -3,4 +3,4 @@ r.out.xyz - Export a raster map to a text file as x,y,z values based on cell cen
Raster (r.*)
ParameterRaster|input|Name of input raster map|False
ParameterString|fs|Field separator|
OutputFile|output|Name for output file
OutputFile|output|xyz
Expand Up @@ -9,4 +9,4 @@ ParameterSelection|param|Morphometric parameter in 'size' window to calculate|el
ParameterNumber|exp|Exponent for distance weighting (0.0-4.0)|None|None|0.0
ParameterNumber|zscale|Vertical scaling factor|None|None|1.0
ParameterBoolean|-c|Constrain model through central window cell|False
OutputRaster|output|Output raster layer containing morphometric parameter
OutputRaster|output|Morphometric parameter
Expand Up @@ -3,4 +3,4 @@ r.patch - Creates a composite raster layer by using one (or more) layer(s) to fi
Raster (r.*)
ParameterMultipleInput|input|Raster layers to be patched together|3|False
ParameterBoolean|-z|Use zero (0) for transparency instead of NULL|False
OutputRaster|output|Result
OutputRaster|output|Patched
Expand Up @@ -7,4 +7,4 @@ 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|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
OutputRaster|name|Plane
Expand Up @@ -7,4 +7,4 @@ ParameterNumber|res|Resolution along profile|0|None|1.0
ParameterString|null|Character to represent no data cell|*
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|Output filename
OutputFile|output|Profile
Expand Up @@ -4,5 +4,5 @@ Raster (r.*)
ParameterRaster|input|Input raster layer|False
ParameterNumber|quantiles|Number of quantiles|2|None|4
*ParameterBoolean|-r|Generate recode rules based on quantile-defined intervals|False
OutputHTML|html|Output report
OutputFile|outputtext|Output text file
OutputHTML|html|Quantiles
OutputFile|outputtext|Quantiles (text)
Expand Up @@ -3,4 +3,4 @@ r.random.cells - Generates random cell values with spatial dependence.
Raster (r.*)
ParameterNumber|distance|Maximum distance of spatial correlation (value(s) >= 0.0)|0.0|None|0.0
*ParameterNumber|seed|Random seed (SEED_MIN >= value >= SEED_MAX) (default [random])|None|None|0.0
OutputRaster|output|Output raster layer
OutputRaster|output|Random
Expand Up @@ -3,4 +3,4 @@ r.random.raster - Create random raster
Raster (r.*)
ParameterRaster|raster|Name of input raster map|False
ParameterNumber|value|The number of points to allocate |None|None|1
OutputRaster|output|Output layer
OutputRaster|output|Random
4 changes: 2 additions & 2 deletions python/plugins/processing/algs/grass/description/r.random.txt
Expand Up @@ -4,5 +4,5 @@ Raster (r.*)
ParameterRaster|input|Input raster layer|False
ParameterRaster|cover|Input cover raster layer|False
ParameterNumber|n|The number of points to allocate|0|None|10
OutputRaster|raster_output|Output raster layer
OutputVector|vector_output|Output vector layer
OutputRaster|raster_output|Random raster
OutputVector|vector_output|random vector
Expand Up @@ -3,4 +3,4 @@ r.reclass.area.greater - Reclassifies a raster layer, selecting areas larger tha
Raster (r.*)
ParameterRaster|input|Input raster layer|False
ParameterNumber|greater|Area threshold [hectares]|0|None|1.0
OutputRaster|output|Output raster layer
OutputRaster|output|Reclassified
Expand Up @@ -3,4 +3,4 @@ r.reclass.area.lesser - Reclassifies a raster layer, selecting areas lower than
Raster (r.*)
ParameterRaster|input|Input raster layer|False
ParameterNumber|lesser|Area threshold [hectares]|0|None|1.0
OutputRaster|output|Output raster layer
OutputRaster|output|Reclassified
Expand Up @@ -3,4 +3,4 @@ r.reclass - Creates a new map layer whose category values are based upon a recla
Raster (r.*)
ParameterRaster|input|Input raster layer|False
ParameterFile|rules|File containing reclass rules|False
OutputRaster|output|Output raster layer
OutputRaster|output|Reclassified
Expand Up @@ -4,4 +4,4 @@ Raster (r.*)
ParameterRaster|input|Input layer|False
ParameterFile|rules|File containing recode rules|False
*ParameterBoolean|-d|Force output to 'double' raster map type (DCELL)|False
OutputRaster|output|Output raster layer
OutputRaster|output|Recoded
Expand Up @@ -4,4 +4,4 @@ Raster (r.*)
ParameterRaster|map1|Layer for x coefficient|False
ParameterRaster|map2|Layer for y coefficient|False
ParameterBoolean|-s|Slower but accurate|False
OutputHTML|html|Regression data
OutputHTML|html|Regression coefficients
Expand Up @@ -10,4 +10,4 @@ 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 layers have no data|True
OutputHTML|html|Output report file
OutputHTML|html|Report
Expand Up @@ -22,4 +22,4 @@ ParameterNumber|error|Error break criteria for iterative solvers (jacobi, sor, c
ParameterSelection|solver|The type of solver which should solve the symmetric linear equation system|gauss;lu;cholesky;jacobi;sor;cg;bicgstab;pcg
ParameterString|relax|The relaxation parameter used by the jacobi and sor solver for speedup or stabilizing|1
ParameterBoolean|-s|Use a sparse matrix, only available with iterative solvers|False
OutputRaster|output|The map storing the numerical result [m]
OutputRaster|output|Groundwater flow
Expand Up @@ -6,4 +6,4 @@ ParameterNumber|direction|Direction in which you want to calculate the horizon h
ParameterNumber|maxdistance|The maximum distance to consider when finding the horizon height|0|None|10000
ParameterString|dist|Sampling distance step coefficient (0.5-1.5)|1.0
ParameterBoolean|-d|Write output in degrees (default is radians)|False
OutputRaster|horizon|Prefix of the horizon raster output maps
OutputRaster|horizon|Horizon
Expand Up @@ -11,4 +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
OutputHTML|html|Basic information
Expand Up @@ -6,4 +6,4 @@ 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
ParameterBoolean|-w|Wide report (132 columns)|False
OutputFile|output|Output file containing error matrix and kappa
OutputFile|output|Error matrix and kappa
Expand Up @@ -5,4 +5,4 @@ ParameterRaster|elevation|Elevation|False
ParameterNumber|water_level|Water level|None|None|1000.0
ParameterString|coordinates|Seed point coordinates|0,0
ParameterBoolean|-n|Use negative depth values for lake raster layer|False
OutputRaster|lake|Output raster map with lake
OutputRaster|lake|Lake
Expand Up @@ -5,4 +5,4 @@ ParameterRaster|elevation|Elevation|False
ParameterNumber|water_level|Water level|None|None|1000.0
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|Output raster map with lake
OutputRaster|lake|Lake
Expand Up @@ -3,4 +3,4 @@ r.median - Finds the median of values in a cover layer within areas assigned the
Raster (r.*)
ParameterRaster|base|Base raster layer|False
ParameterRaster|cover|Cover layer|False
OutputRaster|output|Output raster layer
OutputRaster|output|Median
Expand Up @@ -5,4 +5,4 @@ ParameterRaster|input|input layer|False
ParameterFile|filter|Filter file|False
ParameterNumber|repeat|Number of times to repeat the filter|1|None|1
ParameterBoolean|-z|Apply filter only to zero data values|False
OutputRaster|output|Output layer
OutputRaster|output|Filtered
Expand Up @@ -5,4 +5,4 @@ ParameterRaster|input|Input layer|False
ParameterFile|filter|Filter file|False
ParameterNumber|repeat|Number of times to repeat the filter|1|None|1
ParameterBoolean|-z|Apply filter only to zero data values|False
OutputRaster|output|Output layer
OutputRaster|output|Filtered
Expand Up @@ -3,4 +3,4 @@ r.mode - Finds the mode of values in a cover layer within areas assigned the sam
Raster (r.*)
ParameterRaster|base|Base layer to be reclassified|False
ParameterRaster|cover|Categories layer|False
OutputRaster|output|Output layer
OutputRaster|output|Mode
Expand Up @@ -7,4 +7,4 @@ ParameterNumber|size|Neighborhood size|1|None|3
ParameterBoolean|-c|Use circular neighborhood|False
*ParameterBoolean|-a|Do not align output with the input|False
*ParameterFile|weight|File containing weights|False
OutputRaster|output|Output layer
OutputRaster|output|Neighbors
Expand Up @@ -2,4 +2,4 @@ r.out.gridatb
r.out.gridatb - Exports GRASS raster map to GRIDATB.FOR map file (TOPMODEL)
Raster (r.*)
ParameterRaster|input|Name of input raster map|False
OutputFile|output|GRIDATB i/o map file
OutputFile|output|GRIDATB
Expand Up @@ -3,4 +3,4 @@ r.out.ppm - Converts a raster layer to a PPM image file at the pixel resolution
Raster (r.*)
ParameterRaster|input|Input raster layer|False
ParameterBoolean|-g|Output greyscale instead of color|True
OutputFile|output|Output PPM file
OutputFile|output|PPM
Expand Up @@ -4,4 +4,4 @@ Raster (r.*)
ParameterRaster|elevation|Elevation layer|False
ParameterRaster|color|Color layer|False
ParameterNumber|exaggeration|Vertical exaggeration|None|None|1.0
OutputFile|output|Output VRML file
OutputFile|output|VRML
Expand Up @@ -9,4 +9,4 @@ ParameterSelection|param|Morphometric parameter in 'size' window to calculate|el
ParameterNumber|exp|Exponent for distance weighting (0.0-4.0)|None|None|0.0
ParameterNumber|zscale|Vertical scaling factor|None|None|1.0
ParameterBoolean|-c|Constrain model through central window cell|False
OutputRaster|output|Output raster layer containing morphometric parameter
OutputRaster|output|Morphometric parameter
Expand Up @@ -3,4 +3,4 @@ r.patch - Creates a composite raster layer by using one (or more) layer(s) to fi
Raster (r.*)
ParameterMultipleInput|input|Raster layers to be patched together|3|False
ParameterBoolean|-z|Use zero (0) for transparency instead of NULL|False
OutputRaster|output|Result
OutputRaster|output|Patched
Expand Up @@ -7,4 +7,4 @@ 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|Elevation coordinate of a point on the plane|None|None|0.0
ParameterSelection|type|Data type of resulting layer|int;float;double
OutputRaster|output|Output raster layer
OutputRaster|output|Plane
Expand Up @@ -7,4 +7,4 @@ ParameterNumber|res|Resolution along profile|0|None|1.0
ParameterString|null_value|Character to represent no data cell|*
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|Output filename
OutputFile|output|Profile
Expand Up @@ -4,5 +4,5 @@ Raster (r.*)
ParameterRaster|input|Input raster layer|False
ParameterNumber|quantiles|Number of quantiles|2|None|4
*ParameterBoolean|-r|Generate recode rules based on quantile-defined intervals|False
OutputHTML|html|Output report
OutputFile|outputtext|Output text file
OutputHTML|html|Quantiles
OutputFile|outputtext|Quantiles (text)
Expand Up @@ -3,4 +3,4 @@ r.random.cells - Generates random cell values with spatial dependence.
Raster (r.*)
ParameterNumber|distance|Maximum distance of spatial correlation (value(s) >= 0.0)|0.0|None|0.0
*ParameterNumber|seed|Random seed (SEED_MIN >= value >= SEED_MAX) (default [random])|None|None|0.0
OutputRaster|output|Output raster layer
OutputRaster|output|Random
Expand Up @@ -3,4 +3,4 @@ r.random.raster - Create random raster
Raster (r.*)
ParameterRaster|raster|Name of input raster map|False
ParameterNumber|value|The number of points to allocate |None|None|1
OutputRaster|output|Output layer
OutputRaster|output|Random
Expand Up @@ -4,5 +4,5 @@ Raster (r.*)
ParameterRaster|input|Input raster layer|False
ParameterRaster|cover|Input cover raster layer|False
ParameterNumber|npoints|The number of points to allocate|0|None|10
OutputRaster|raster|Output raster layer
OutputVector|vector|Output vector layer
OutputRaster|raster|Random raster
OutputVector|vector|Random vector
Expand Up @@ -3,4 +3,4 @@ r.reclass.area.greater - Reclassifies a raster layer, selecting areas larger tha
Raster (r.*)
ParameterRaster|input|Input raster layer|False
ParameterNumber|greater|Area threshold [hectares]|0|None|1.0
OutputRaster|output|Output raster layer
OutputRaster|output|Reclassified
Expand Up @@ -3,4 +3,4 @@ r.reclass.area.lesser - Reclassifies a raster layer, selecting areas lower than
Raster (r.*)
ParameterRaster|input|Input raster layer|False
ParameterNumber|lesser|Area threshold [hectares]|0|None|1.0
OutputRaster|output|Output raster layer
OutputRaster|output|Reclassified
Expand Up @@ -3,4 +3,4 @@ r.reclass - Creates a new map layer whose category values are based upon a recla
Raster (r.*)
ParameterRaster|input|Input raster layer|False
ParameterFile|rules|File containing reclass rules|-
OutputRaster|output|Output raster layer
OutputRaster|output|Reclassified
Expand Up @@ -4,4 +4,4 @@ Raster (r.*)
ParameterRaster|input|Input layer|False
ParameterFile|rules|File containing recode rules|False
*ParameterBoolean|-d|Force output to 'double' raster map type (DCELL)|False
OutputRaster|output|Output raster layer
OutputRaster|output|Recoded
Expand Up @@ -9,4 +9,4 @@ ParameterBoolean|-h|Suppress page headers|True
ParameterBoolean|-f|Use formfeeds between pages|True
ParameterBoolean|-e|Scientific format|True
ParameterBoolean|-n|Do not report no data cells|True
OutputHTML|html|Output report file
OutputHTML|html|Report
Expand Up @@ -6,4 +6,4 @@ ParameterString|coordinates|Coordinate identifying the viewing position|0,0
ParameterString|observer_elevation|Viewing position height above the ground|1.75
ParameterString|max_distance|Maximum distance from the viewing point (meters)|10000
ParameterBoolean|-c|Consider earth curvature (current ellipsoid)|False
OutputRaster|output|Output raster layer
OutputRaster|output|Intervisibility
Expand Up @@ -6,4 +6,4 @@ ParameterMultipleInput|XGRIDS|Additional layers|3|True
ParameterString|FORMULA|Formula|
ParameterBoolean|USE_NODATA|Use NoData|False
ParameterSelection|TYPE|Output Data Type|[0] bit;[1] unsigned 1 byte integer;[2] signed 1 byte integer;[3] unsigned 2 byte integer;[4] signed 2 byte integer;[5] unsigned 4 byte integer;[6] signed 4 byte integer;[7] 4 byte floating point number;[8] 8 byte floating point number|7
OutputRaster|RESULT|Result layer
OutputRaster|RESULT|Calculated

0 comments on commit e633caf

Please sign in to comment.