Statistics
| Revision:

gvsig-geoprocess / org.gvsig.geoprocess / trunk / org.gvsig.geoprocess / org.gvsig.geoprocess.app / org.gvsig.geoprocess.app.mainplugin / src / main / resources / help / en / general / toolbox.html @ 338

History | View | Annotate | Download (18.8 KB)

1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2

    
3
<!--Converted with LaTeX2HTML 2002-2-1 (1.71)
4
original version by:  Nikos Drakos, CBLU, University of Leeds
5
* revised and updated by:  Marcus Hennecke, Ross Moore, Herb Swan
6
* with significant contributions from:
7
  Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
8
<HTML>
9
<HEAD>
10
<TITLE>The SEXTANTE toolbox</TITLE>
11
<META NAME="description" CONTENT="The SEXTANTE toolbox">
12
<META NAME="keywords" CONTENT="IntroductionToSEXTANTE">
13
<META NAME="resource-type" CONTENT="document">
14
<META NAME="distribution" CONTENT="global">
15

    
16
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
17
<META NAME="Generator" CONTENT="LaTeX2HTML v2002-2-1">
18
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
19

    
20
<LINK REL="STYLESHEET" HREF="IntroductionToSEXTANTE.css">
21

    
22
</HEAD>
23

    
24
<BODY >
25
<!--Table of Child-Links-->
26
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
27

    
28
<UL CLASS="ChildLinks">
29
<LI><A NAME="tex2html140"
30
  HREF="node4.html#SECTION00410000000000000000">Introduction</A>
31
<LI><A NAME="tex2html141"
32
  HREF="node4.html#SECTION00420000000000000000">The algorithm dialog</A>
33
<UL>
34
<LI><A NAME="tex2html142"
35
  HREF="node4.html#SECTION00421000000000000000">The parameters tab</A>
36
<LI><A NAME="tex2html143"
37
  HREF="node4.html#SECTION00422000000000000000">The raster output tab</A>
38
</UL>
39
<BR>
40
<LI><A NAME="tex2html144"
41
  HREF="node4.html#SECTION00430000000000000000">Data objects generated by SEXTANTE algorithms</A>
42
<LI><A NAME="tex2html145"
43
  HREF="node4.html#SECTION00440000000000000000">Context help</A>
44
<LI><A NAME="tex2html146"
45
  HREF="node4.html#SECTION00450000000000000000">Configuring SEXTANTE</A>
46
<UL>
47
<LI><A NAME="tex2html147"
48
  HREF="node4.html#SECTION00451000000000000000">General</A>
49
<LI><A NAME="tex2html148"
50
  HREF="node4.html#SECTION00452000000000000000">Folders</A>
51
<LI><A NAME="tex2html149"
52
  HREF="node4.html#SECTION00453000000000000000">WPS and GRASS</A>
53
</UL></UL>
54
<!--End of Table of Child-Links-->
55
<HR>
56

    
57
<H1><A NAME="SECTION00400000000000000000">
58
The SEXTANTE toolbox</A>
59
</H1>
60

    
61
<P>
62

    
63
<H1><A NAME="SECTION00410000000000000000">
64
Introduction</A>
65
</H1>
66

    
67
<P>
68
The <SPAN  CLASS="textit">Toolbox</SPAN> is the main element of the SEXTANTE GUI, and the one that you are more likely to use in your daily work. It shows the list of all available algorithms grouped in different blocks, and is the access point to run them whether as a single process or as a batch process involving several executions of a same algorithm on different sets of inputs.
69

    
70
<P>
71
<DIV ALIGN="CENTER">
72
<IMG
73
  WIDTH="401" HEIGHT="502" ALIGN="BOTTOM" BORDER="0"
74
 SRC="./toolbox.png"
75
 ALT="Image toolbox">
76

    
77
</DIV>
78

    
79
<P>
80
Depending on the data available in the GIS, you will be able to execute an algorithm or not. When there is enough data for the algorithm to be executed (i.e. the algorithm requires raster layers and you have raster layer already loaded into the GIS), its name is shown in black, otherwise, it is shown in grey.
81

    
82
<P>
83
In the lower part of the toolbox you can find a text box and a search button. To reduce the number of algorithms shown in the toolbox and make it easier to find the one you need, you can enter any word or phrase on the text box and click on the search button. SEXTANTE will search the help files associated to each algorithm and show only those algorithms that include the word or phrase in their corresponding help files. To show all the algorithms again, make a search with an empty string.
84

    
85
<P>
86
The configuration button can be found on the search panel as well. It gives access to a new dialog that you can use to configure SEXTANTE. 
87

    
88
<P>
89
<DIV ALIGN="CENTER">
90
<IMG
91
  WIDTH="600" HEIGHT="504" ALIGN="BOTTOM" BORDER="0"
92
 SRC="./config_dialog.png"
93
 ALT="Image config_dialog">
94

    
95
</DIV>
96

    
97
<P>
98
The meaning of each one of its parameters will be explained in the following pages.
99

    
100
<P>
101
To execute an algorithm, just double-click on its name in the toolbox.
102

    
103
<P>
104

    
105
<H1><A NAME="SECTION00420000000000000000">
106
The algorithm dialog</A>
107
</H1>
108

    
109
<P>
110
Once you double-click on the name of the algorithm that you want to execute, a dialog similar to the next one is shown (in this case, the dialog corresponds to the <SPAN  CLASS="textit">Anisotropic cost</SPAN> algorithm).
111

    
112
<P>
113
<DIV ALIGN="CENTER">
114
<IMG
115
  WIDTH="698" HEIGHT="446" ALIGN="BOTTOM" BORDER="0"
116
 SRC="./accumulated_cost_anisotropic.png"
117
 ALT="Image accumulated_cost_anisotropic">
118

    
119
</DIV>
120

    
121
<P>
122
This dialog is used to set the input values that the algorithm needs to be executed.
123

    
124
<P>
125
There is a main tab named <SPAN  CLASS="textit">Parameters</SPAN> where input values and configuration parameters are set. This tab has a different content depending on the requirements of the algorithm to be executed, and is created automatically based on those requirements. On the left side, the name of the parameter is shown. On the right side the value of the parameter can be set.
126

    
127
<P>
128
Those algorithms that generate raster layers as output have an additional tab named <SPAN  CLASS="textit">Raster ouptput</SPAN>. This tab is used to set the characteristics of those ouput raster layers, specifying its extent and its cell size.
129

    
130
<P>
131
On the lower part of the window there is a help button. Click on it to see the context help related to the current algorithm, where you will find detailed description of each parameter and each output generated by the algorithm.
132

    
133
<P>
134

    
135
<H2><A NAME="SECTION00421000000000000000">
136
The parameters tab</A>
137
</H2>
138

    
139
<P>
140
Although the number and type of parameters depends on the characteristics of the algorithm, the structure is similar for all of them. The parameters found on the parameters tab can be of one of the following types.
141

    
142
<P>
143

    
144
<UL>
145
<LI>A raster layer, to select from a list of all the ones available in the GIS application
146
</LI>
147
<LI>A vector layer, to select from a list of all the ones available in the GIS application
148
</LI>
149
<LI>A table, to select from a list of all the ones available in the GIS application
150
</LI>
151
<LI>A method, to choose from a selection list of possible options
152
                <DIV ALIGN="CENTER">
153
<IMG
154
  WIDTH="699" HEIGHT="444" ALIGN="BOTTOM" BORDER="0"
155
 SRC="./slope.png"
156
 ALT="Image slope">
157
                
158
</DIV>        
159
</LI>
160
<LI>A numerical value, to be introduced in a text box. 
161
</LI>
162
<LI>A text string, to be introduced in a text box
163
</LI>
164
<LI>A field, to choose from the attributes table of a vector layer or a single table selected in another parameter.
165
</LI>
166
<LI>A band, to select from the ones of a raster layer selected in another parameter. In both this and the previous type of parameter, the list of possible choices depends on the value selected in the parent parameter.
167
</LI>
168
<LI>A list of elements (whether raster layers, vector ones or tables), to select from the list of the ones available in the GIS application. To make the selection, click on the small button on the left side of the corresponding row to see a dialog like the following one.
169
                <DIV ALIGN="CENTER">
170
<IMG
171
  WIDTH="361" HEIGHT="362" ALIGN="BOTTOM" BORDER="0"
172
 SRC="./multiple_selection.png"
173
 ALT="Image multiple_selection">
174
                
175
</DIV>
176
</LI>
177
<LI>A file or folder
178
</LI>
179
<LI>A point, to be introduced as a pair of coordinates in two text boxes (X and Y coordinates). Alternatively, you can click on the button on the right side and select one of the points captured using the <SPAN  CLASS="textit">Coordinate Capture</SPAN> tool (you will find it along with the other SEXTANTE tools. Just select it and click on a view or map in your GIS, and it will get the coordinates of the point where you have clicked). 
180

    
181
<P>
182
</LI>
183
<LI>A small table to be edited by the user. These are used to define parameters like lookup tables or convolution kernels, among others.
184

    
185
<P>
186
Click on the button on the right side to see the table and edit its values. 
187
<DIV ALIGN="CENTER">
188
<IMG
189
  WIDTH="568" HEIGHT="349" ALIGN="BOTTOM" BORDER="0"
190
 SRC="./fixed_table.png"
191
 ALT="Image fixed_table">
192

    
193
</DIV>
194

    
195
<P>
196
Depending on the algorithm, the number of rows can be modified or not, using the buttons on the right side of the window.
197

    
198
<P>
199
</LI>
200
</UL>
201

    
202
<P>
203
If you have previously executed an algorithm (whether in this work session or in another one), you will find an additional component in the lower left part of the parameters tab.
204

    
205
<P>
206
<DIV ALIGN="CENTER">
207
<IMG
208
  WIDTH="362" HEIGHT="33" ALIGN="BOTTOM" BORDER="0"
209
 SRC="./previous_parameters.png"
210
 ALT="Image previous_parameters">
211

    
212
</DIV>
213

    
214
<P>
215
By default, in this the parameters are set to the values they had in the last execution. Using the arrow buttons you can change to the values used in previous executions, browsing the SEXTANTE history.
216

    
217
<P>
218

    
219
<H2><A NAME="SECTION00422000000000000000">
220
The raster output tab</A>
221
</H2>
222

    
223
<P>
224
The <SPAN  CLASS="textit">Raster output</SPAN> tab is found in those algorithms that generate raster layers. Unlike in most GIS, when combining several raster layers as input for an algorithm, they do not have to have the same extent an cellsize in order to process them together. That is, layers don't have necessarily to ``match'' between them. Instead, the characteristics of the output raster layer are defined and SEXTANTE performs the corresponding resampling and cropping needed to generate layer with those characteristics. 
225

    
226
<P>
227
It is responsibility of the user to enter adequate values and be aware of the limitations of this mechanism, so as to generate cartographically sound results. (i.e. you can select a small cell size for the resulting raster layers, but if the input layers you are using have a bad resolution the results will not be geographically sound).
228

    
229
<P>
230
The following options are available in the The <SPAN  CLASS="textit">Raster output</SPAN> tab:
231

    
232
<P>
233

    
234
<UL>
235
<LI>Fit to input layers. By default, the characteristics of the output raster layers are set based on the input ones. The minimum extent needed to cover all the input layers is used.
236

    
237
<P>
238
<DIV ALIGN="CENTER">
239
<IMG
240
  WIDTH="705" HEIGHT="475" ALIGN="BOTTOM" BORDER="0"
241
 SRC="./fit_to_input_layers.png"
242
 ALT="Image fit_to_input_layers">
243

    
244
</DIV>
245

    
246
<P>
247
</LI>
248
<LI>User defined. The coordinates of the boundaries of the extent and the cellsize are both defined manually, entering the desired values in the corresponding text boxes.
249

    
250
<P>
251
<DIV ALIGN="CENTER">
252
<IMG
253
  WIDTH="704" HEIGHT="476" ALIGN="BOTTOM" BORDER="0"
254
 SRC="./user_defined.png"
255
 ALT="Image user_defined">
256

    
257
</DIV>
258

    
259
<P>
260
</LI>
261
<LI>Use predefined extent. Depending on the GIS you are using, this option will let you use predefined extents like, for instance, the extent of one of the views currently opened.
262

    
263
<P>
264
<DIV ALIGN="CENTER">
265
<IMG
266
  WIDTH="698" HEIGHT="444" ALIGN="BOTTOM" BORDER="0"
267
 SRC="./extent_from_view.png"
268
 ALT="Image extent_from_view">
269

    
270
</DIV>
271

    
272
<P>
273
</LI>
274
<LI>Use extent from layer. The extent of a layer can be used as well to define the output characteristics, even if the layer is not used as input to the algorithm. If the selected layer is a vector one, the cellsize will have to be entered manually, since vector layers do not have an associated cellsize.
275

    
276
<P>
277
<DIV ALIGN="CENTER">
278
<IMG
279
  WIDTH="696" HEIGHT="445" ALIGN="BOTTOM" BORDER="0"
280
 SRC="./extent_from_layer.png"
281
 ALT="Image extent_from_layer">
282

    
283
</DIV>
284

    
285
<P>
286
</LI>
287
</UL>
288

    
289
<P>
290
If an option other than the automatic fitting is selected, SEXTANTE will check that the values are correct and the resulting layers will not be too large (due to, for instance, a wrong cell size). If the output layers seems to large, SEXTANTE will show the next message dialog to ensure that the user really want those layer to be created.
291

    
292
<P>
293
<DIV ALIGN="CENTER">
294
<IMG
295
  WIDTH="347" HEIGHT="113" ALIGN="BOTTOM" BORDER="0"
296
 SRC="./warning.png"
297
 ALT="Image warning">
298

    
299
</DIV>
300

    
301
<P>
302
Not all algorithms have the first option available, since not all algorithms that generate raster layers take some other raster layer as input. The interpolation algorithms, for instance, take a vector layer and create a raster one. The extent and cellsize of the latter has to be manually defined, since it cannot be set based solely on the input vector layer.
303

    
304
<P>
305

    
306
<H1><A NAME="SECTION00430000000000000000">
307
Data objects generated by SEXTANTE algorithms</A>
308
</H1>
309

    
310
<P>
311
Data objects generated by SEXTANTE can be of any of the following types:
312

    
313
<P>
314

    
315
<UL>
316
<LI>A raster layer
317
</LI>
318
<LI>A vector layer
319
</LI>
320
<LI>A table
321
</LI>
322
<LI>A graphical result (chart, graph, etc.)
323
</LI>
324
<LI>A text-only HTML-formatted result
325
</LI>
326
</UL>
327

    
328
<P>
329
Layers and tables can be saved to a file, and the parameters window will contain a text box corresponding to each one of these outputs, where you can type the desired filepath. If you do not enter any filepath, a temporal filename and folder will be used.
330

    
331
<P>
332
The supported formats depend on the ones supported by the GIS onto which SEXTANTE is running. Here is a list of the ones supported by the implementations known to date:
333

    
334
<P>
335

    
336
<UL>
337
<LI>gvSIG: shp, dxf, tif, asc 
338
</LI>
339
<LI>OpenJUMP: shp, tif
340
</LI>
341
<LI>uDig: shp, tif
342
</LI>
343
</UL>
344

    
345
<P>
346
To select a format, just select the corresponding file extension. If the extension of the filepath you entered does not match any of the supported ones, the default extension (the first one in the list of supported ones) will be appended to the filepath and the file format corresponding to that extension will be used to save the layer or table.
347

    
348
<P>
349
You can set a default folder for output data objects. Go to the configuration dialog (you can open it from the toolbox), and in the ``Folders'' tab you will find a text box named ``Output folder''. This output folder is used as the default path in case you type just a filename with no path (i.e. <TT>myfile.shp</TT>) when executing an algorithm. 
350

    
351
<P>
352
Sometimes, layers might have names that include spacial characters. For example, if you rasterize a layer named ``mylayer'', the result will be a new layer named ``mylayer[rasterized]''. Those brackets can cause you some problems if you later want to use that layer as input for the raster calculator, or from the command-line interface, so it can be a good idea to remove them (the same happens with other characters such as ``&#225;'' or ``&#241;'' that might appear if you use SEXTANTE in spanish). You can tell SEXTANTE to automatically replace those character with valid standard ones. To do so, open the configuration dialog and select the ``General'' group. Select the check box with the label ``Modify output names''.
353

    
354
<P>
355
Apart from raster layers and tables, SEXTANTE also generates graphics and texts. These results are kept in memory and shown at the end of the algorithm execution in a new dialog. This dialog will keep the results produced by SEXTANTE during the current session, and can be shown at any time using the <SPAN  CLASS="textit">Results</SPAN> button.
356
You can save graphical results as images in png format, and texts as HTML files. Right-click on the name of the result in the tree on the left hand of the window and select <SPAN  CLASS="textit">Save as...</SPAN>.
357

    
358
<P>
359
<DIV ALIGN="CENTER">
360
<IMG
361
  WIDTH="699" HEIGHT="378" ALIGN="BOTTOM" BORDER="0"
362
 SRC="./information_square.png"
363
 ALT="Image information_square">
364

    
365
</DIV>
366

    
367
<P>
368
<DIV ALIGN="CENTER">
369
<IMG
370
  WIDTH="699" HEIGHT="377" ALIGN="BOTTOM" BORDER="0"
371
 SRC="./graphic.png"
372
 ALT="Image graphic">
373

    
374
</DIV>
375

    
376
<P>
377

    
378
<H1><A NAME="SECTION00440000000000000000">
379
Context help</A>
380
</H1>
381

    
382
<P>
383
Each SEXTANTE algorithm has its own context help file, which provides detailed information about the meaning of each input parameter and each output object, and gives hints about its usage. To access the context help system, click on the button that you will find in the algorithm dialog, or right-click on its name on the toolbox and then select <SPAN  CLASS="textit">See help</SPAN>.
384

    
385
<P>
386
<DIV ALIGN="CENTER">
387
<IMG
388
  WIDTH="699" HEIGHT="444" ALIGN="BOTTOM" BORDER="0"
389
 SRC="./help.png"
390
 ALT="Image help">
391

    
392
</DIV>
393

    
394
<P>
395
The context help system contains not only information about each algorithm, but also description of each one of the elements of the SEXTANTE GUI like the text you are reading now. You will find it at the top of the tree on the left hand side of the help window. Just select an item to see its associated help file on the right canvas.
396

    
397
<P>
398
<DIV ALIGN="CENTER">
399
<IMG
400
  WIDTH="1147" HEIGHT="741" ALIGN="BOTTOM" BORDER="0"
401
 SRC="./help_slope.png"
402
 ALT="Image help_slope">
403

    
404
</DIV>
405

    
406
<P>
407
Help files associated to each algorithm are stored as XML files, and can be edited using the help authoring tools included with SEXTANTE. Right click on the name of the algorithm in the context help window and select <SPAN  CLASS="textit">Edit help</SPAN> to get to the following window:
408

    
409
<P>
410
<DIV ALIGN="CENTER">
411
<IMG
412
  WIDTH="799" HEIGHT="526" ALIGN="BOTTOM" BORDER="0"
413
 SRC="./help_edition.png"
414
 ALT="Image help_edition">
415

    
416
</DIV>
417

    
418
<P>
419
On the left hand side you can select any of the elements to be documented (input parameter and outputs, along with other fixed field such as a general description of the algorithm). Then use the right hand side boxes to enter to text associated to that element or add images.
420

    
421
<P>
422

    
423
<H1><A NAME="SECTION00450000000000000000">
424
Configuring SEXTANTE</A>
425
</H1>
426

    
427
<P>
428
As we have seen, the configuration button in the lower part of the toolbox gives access to a new dialog where you can configure how SEXTANTE works. Configuration parameters are structured in separate blocks that you can select on the left-hand side of the dialog.
429

    
430
<P>
431

    
432
<H2><A NAME="SECTION00451000000000000000">
433
General</A>
434
</H2>
435

    
436
<P>
437
You will see two check boxes in this group:
438

    
439
<P>
440

    
441
<UL>
442
<LI><SPAN  CLASS="textbf">Modify output names</SPAN>: if you check this option, output names will be modified to avoid characters such as brackets, blank spaces or stress marks.
443
</LI>
444
<LI><SPAN  CLASS="textbf">Use internal names for outputs</SPAN>: when this option is selected, SEXTANTE uses internal names to name output layers. This is useful if you plan to use the command-line interface to write scripts, since the names of the outputs can be know in advance (having a look at the help files, under the <SPAN  CLASS="textit">Command-line usage</SPAN> will inform you of those names). If this options is not selected, SEXTANTE will produce layers with names that depend on the current language or sometimes on the names of the input layers, which can cause you trouble if you plan to use those layers for your script.
445
</LI>
446
</UL>
447

    
448
<P>
449

    
450
<H2><A NAME="SECTION00452000000000000000">
451
Folders</A>
452
</H2>
453

    
454
<P>
455
Two folders can be defined:
456

    
457
<P>
458

    
459
<UL>
460
<LI><SPAN  CLASS="textbf">Ouput folder</SPAN>: when entering the filename for an output layer, if it does not include a valid path, it will be saved to this default output folder.
461
</LI>
462
<LI><SPAN  CLASS="textbf">Models folder</SPAN>: the folder where models are stored. This will be explained in detail in the following chapter.
463
</LI>
464
</UL>
465

    
466
<P>
467

    
468
<H2><A NAME="SECTION00453000000000000000">
469
WPS and GRASS</A>
470
</H2>
471

    
472
<P>
473
The set of algorithms of SEXTANTE can be extended connecting to remote WPS processes or calling the well-known GRASS GIS (SEXTANTE will act as a GRASS frontend). This is explained in detail in a separate chapter at the end of this manual.
474
<BR><HR>
475
<ADDRESS>
476
Victor Olaya
477
2010-02-18
478
</ADDRESS>
479
</BODY>
480
</HTML>