1g.gui.rlisetup(1)           GRASS GIS User's Manual          g.gui.rlisetup(1)
2
3
4

NAME

6       g.gui.rlisetup  - Configuration tool for r.li modules.
7

KEYWORDS

9       general, GUI, raster, landscape structure analysis
10

SYNOPSIS

12       g.gui.rlisetup
13       g.gui.rlisetup --help
14       g.gui.rlisetup  [--help]  [--verbose]  [--quiet]  [--ui]
15
16   Flags:
17       --help
18           Print usage summary
19
20       --verbose
21           Verbose module output
22
23       --quiet
24           Quiet module output
25
26       --ui
27           Force launching GUI dialog
28

DESCRIPTION

30       The g.gui.rlisetup is a wxGUI component which allows the user to create
31       a configuration file for the analytical r.li modules. For a general in‐
32       troduction, see the r.li overview.
33       The  configurations  are  raster map independent, it means that you can
34       use a file created on a raster map for analyze any other you have.
35       The program is completely interactive and uses a GUI  to  help  you  in
36       your choices.
37
38   Analysis methods
39       Definition of creation of sampling area:
40
41           •   Whole map layer: use entire area selected above,
42
43           •   Regions: select one to many subareas via mouse,
44
45           •   Sample units: automated selection of sampling area (for details
46               see below)
47
48               •   Random nonoverlapping,
49
50               •   Systematic contiguous,
51
52               •   Systematic noncontiguous,
53
54               •   Stratified random,
55
56               •   Centered over sites (vector points).
57
58           •   Moving window: rectangular or circular with size
59
60       Definition of region for analysis:
61
62           •   Whole map layer: entire map (current region),
63
64           •   Keyboard setting: based on keyboard selection for region  defi‐
65               nition,
66
67           •   Draw  the sampling frame: based on interactive region selection
68               via mouse.
69
70   Usage details
71       The startup window shows your configuration files, you can:
72
73       TODO: description below needs further updates
74
75       1      View/Edit (Load a file) from the shown list:  the  configuration
76              is shown in a small text editor window.  Configuration files are
77              saved in the folder C:\Users\userxy\AppData\Roaming\GRASS8\r.li\
78              (MS-Windows)  or  $HOME/.r.li/ (GNU/Linux) (the file name can be
79              defined by the user). The output or an analysis can either be  a
80              new  raster map (in case of using a "moving window" analysis) or
81              be an ASCII text file (when not  performing  a  "moving  window"
82              analysis)  containing  the result.  Such text file will be saved
83              in the  folder  C:\Users\userxy\AppData\Roaming\GRASS8\r.li\out‐
84              put\ (MS-Windows) or $HOME/.grass8/r.li/output/ (GNU/Linux).
85              All dimensions are percentages of raster rows or columns.
86
87       2      Create a new configuration file: used for creating a new config‐
88              uration file in an interactive way, in three steps:
89
90       2.1    Choose file name and maps to use for setting:
91
92Name for new configuration file(required): the name of new con‐
93               figuration file
94
95Raster  map name to use to select areas (required): the name of
96               raster map used for selecting sampling areas
97
98Vector map to overlay (optional): name of a vector map used for
99               selecting sampling areas
100
101       2.2    Set  the  sampling frame. The sample frame is a rectangular area
102              which contains all the areas to analyze. It can  be  defined  in
103              three ways:
104
105Whole map layer: the sample frame is the whole map
106
107Keyboard  setting:  the user enters the coordinates in cells of
108               upper left corner of sampling frame and its length in rows  and
109               columns.
110
111Draw  the  sample frame: the user draws the sample frame on map
112               using mouse.
113
114       2.3    Set the sample areas. The sample areas are simply the  areas  to
115              analyze.  They  can be defined in five ways (see the picture be‐
116              low):
117
118Whole map layer: the sample area is the whole sample frame
119
120Regions: the user enters the number of  areas  and  then  draws
121               them using mouse.
122
123Sample  units: they are areas of rectangular or circular shape.
124               The user can define them using keyboard or mouse.
125
126               •   keyboard: the user define the shape of  sample  unists  and
127                   their disposition:
128
129Random  non  overlapping: the user specifies the number
130                       of sample units and they are placed in a random way  at
131                       runtime.  It is guaranteed that the areas do not inter‐
132                       sect themselves.
133
134Systematic contiguous: the  defined  sample  is  placed
135                       covering the sample frame, side by side across rows.
136
137Systematic  non contiguous: the same as above, but here
138                       ever rectangle is spaced from another  by  a  specified
139                       number of cells.
140
141Stratified  random:  the  sample  frame is divided in n
142                       strats of rows and m strats of columns  (n  and  m  are
143                       given by user), then the specified number of sample ar‐
144                       eas are placed in a random way, one for every m*n areas
145                       defined by strats.
146
147Centered  over  sites: the sample areas are placed into
148                       sample frame centering them on points in site file.
149
150               •   mouse: the user chooses the shape and then draws the speci‐
151                   fied number of sample areas on map.
152
153Moving Window: the user defines a rectangular or circular area,
154               it is moved over all the raster increasing only of a  cell  for
155               every  move(in  columns  if possible, if not in rows).  It pro‐
156               duces a new raster containing the result of all analysis.
157
158Select areas from the overlaid vector map: the sample areas are
159               defined  by  the  vector  map selected above.  For every cat in
160               vector map, the procedure prompts the user if they want to  in‐
161               clude  it as sample area.  The resulting configuration file can
162               be used only with the specified raster map, and  the  procedure
163               can  be  used  only  if whole map layer is selected as sampling
164               frame.
165
166       3      Remove a file the selected file is deleted  from  the  available
167              configuration files.
168
169       4      Help: open this help text.
170
171       5      Close module window.
172

NOTES

174       Configuration  files are raster map independent because areas are saved
175       using relative coordinates.
176
177       Screenshots of the wizard window frames:
178
179         g.gui.rlisetup: First frame of wizard for  selecting  ex‐   g.gui.rlisetup: Frame for selecting maps
180       isting configuration files or creating a new one
181
182         g.gui.rlisetup: Frame for inserting sampling areas           g.gui.rlisetup:  Frame  for  defining rectangular moving
183                                                                    window
184
185         g.gui.rlisetup: Frame for defining circular moving window   g.gui.rlisetup: Frame for  choosing  the  sampling  frame
186                                                                    with keyboard
187
188         g.gui.rlisetup: Frame for drawing the sampling frame        g.gui.rlisetup: Summary frame before saving
189
190

EXAMPLES

192   Moving window analysis on full region
193       TODO: update examples to new g.gui.rlisetup dialog:
194
195       Example  for a 7x7 moving window analysis on full region, the output is
196       a raster map:
197
198       Click on "New", then:
199
200           •   Configuration file name: "movwindow7"
201
202           •   Raster map name to use to select areas: "forests"
203       1. Setup sampling frame:
204
205           •   Define a sampling  frame  (region  for  analysis):  "Whole  map
206               layer", then "OK"
207       2. Setup sampling frame
208
209           •   Define sampling areas: "Moving window", then "OK"
210
211           •   Then click on "Use keyboard to define moving window dimension"
212       Select type of shape:
213
214           •   [x] Rectangular
215
216           •   Width size (in cells)?: "7"
217
218           •   Height size (in cells)?: "7"
219
220           •   Then "Save settings"
221       3. Save settings: click on button
222       (4.) Close
223
224       Now  an  anaysis  can be performed using one of the analytical modules,
225       e.g.
226       g.region raster=forests -p
227       r.li.patchdensity input=forests conf=movwindow7 output=forests_p_dens7
228       r.univar forests_p_dens7
229       The result is the new raster map "forests_p_dens7" which shows (in this
230       example) the patch density of the forest areas.
231       See the respective modules for further examples.
232
233   Whole region analysis
234       Example  for  a whole region analysis, the output is a text file: Click
235       on "New", then:
236
237           •   Configuration file name: "whole_region"
238
239           •   Raster map name to use to select areas: "lsat7_2000_40"
240       1. Setup sampling frame:
241
242           •   Define a sampling  frame  (region  for  analysis):  "Whole  map
243               layer", then "OK"
244       2. Setup sampling frame
245
246           •   Define sampling areas: "Whole map layer", then "OK"
247       3. Save settings: click on button
248       (4.) Close
249
250       Now  an  anaysis  can be performed using one of the analytical modules,
251       e.g.
252       g.region raster=lsat7_2002_40 -p
253       r.li.shannon input=lsat7_2000_40 conf=whole_region output=lsat7_2000_40_shannon
254       The result is the new text file  "forests_p_dens7"  (stored  in  folder
255       $HOME/.r.li/output/.
256       See the respective modules for further examples.
257

REFERENCES

259       McGarigal, K., and B. J. Marks. 1995. FRAGSTATS: spatial pattern analy‐
260       sis program for quantifying landscape structure. USDA For. Serv.   Gen.
261       Tech. Rep. PNW-351. (PDF)
262

SEE ALSO

264        r.li - package overview
265       r.li.daemon
266
267        Old r.le suite manual (1992)
268
269        wxGUI, wxGUI components
270

AUTHORS

272       Luca Delucchi
273       Rewritten from r.li.setup by Claudio Porta and Lucio Davide Spano
274

SOURCE CODE

276       Available at: wxGUI RLi Setup source code (history)
277
278       Accessed: Saturday Jan 21 21:17:59 2023
279
280       Main  index | GUI index | Topics index | Keywords index | Graphical in‐
281       dex | Full index
282
283       © 2003-2023 GRASS Development Team, GRASS GIS 8.2.1 Reference Manual
284
285
286
287GRASS 8.2.1                                                  g.gui.rlisetup(1)
Impressum