gvsig-geoprocess / org.gvsig.geoprocess / trunk / org.gvsig.geoprocess / org.gvsig.geoprocess.app / org.gvsig.geoprocess.app.mainplugin / src / main / resources / help / en / general / commandline.html @ 338
History | View | Annotate | Download (9.14 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 batch processing interface</TITLE> |
| 11 |
<META NAME="description" CONTENT="The SEXTANTE batch processing interface"> |
| 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="tex2html183" |
| 30 |
HREF="node6.html#SECTION00610000000000000000">Introducci?n</A> |
| 31 |
<LI><A NAME="tex2html184" |
| 32 |
HREF="node6.html#SECTION00620000000000000000">The parameters table</A> |
| 33 |
<LI><A NAME="tex2html185" |
| 34 |
HREF="node6.html#SECTION00630000000000000000">Filling the parameters table</A> |
| 35 |
<LI><A NAME="tex2html186" |
| 36 |
HREF="node6.html#SECTION00640000000000000000">Setting raster output characteristics</A> |
| 37 |
<LI><A NAME="tex2html187" |
| 38 |
HREF="node6.html#SECTION00650000000000000000">Executing the batch process</A> |
| 39 |
</UL>
|
| 40 |
<!--End of Table of Child-Links-->
|
| 41 |
<HR>
|
| 42 |
|
| 43 |
<H1><A NAME="SECTION00600000000000000000"> |
| 44 |
The SEXTANTE batch processing interface</A>
|
| 45 |
</H1>
|
| 46 |
|
| 47 |
<P>
|
| 48 |
|
| 49 |
<H1><A NAME="SECTION00610000000000000000"> |
| 50 |
Introducción</A> |
| 51 |
</H1>
|
| 52 |
|
| 53 |
<P>
|
| 54 |
SEXTANTE algorithms (including models) can be executed as a batch process. That is, they can be executed using not a single set of inputs, but several of them, executing the algorithm as many times as needed. This is useful when processing large amounts of data, since it is not necessary to launch the algorithm many times from the toolbox. |
| 55 |
|
| 56 |
<P>
|
| 57 |
<DIV ALIGN="CENTER"> |
| 58 |
<IMG
|
| 59 |
WIDTH="355" HEIGHT="449" ALIGN="BOTTOM" BORDER="0" |
| 60 |
SRC="./batch_processing.png" |
| 61 |
ALT="Image batch_processing"> |
| 62 |
|
| 63 |
</DIV>
|
| 64 |
|
| 65 |
<P>
|
| 66 |
|
| 67 |
<H1><A NAME="SECTION00620000000000000000"> |
| 68 |
The parameters table</A>
|
| 69 |
</H1>
|
| 70 |
|
| 71 |
<P>
|
| 72 |
Executing a batch process is similar to performing a single execution of an algorithm. Parameter values have to be defined, but in this case we need not just a single value for each parameter, but a set of them instead, one for each time the algorithm has to be executed. Values are introduced using a table like the one shown next. |
| 73 |
|
| 74 |
<P>
|
| 75 |
<DIV ALIGN="CENTER"> |
| 76 |
<IMG
|
| 77 |
WIDTH="873" HEIGHT="375" ALIGN="BOTTOM" BORDER="0" |
| 78 |
SRC="./batch_processing2.png" |
| 79 |
ALT="Image batch_processing2"> |
| 80 |
|
| 81 |
</DIV>
|
| 82 |
|
| 83 |
<P>
|
| 84 |
Each line of this table represents a single execution of the algorithm, and each cell contains the value of one of the parameters. It is similar to the parameters tab that you see when executing an algorithm from the toolbox, but with a different arrangement. |
| 85 |
|
| 86 |
<P>
|
| 87 |
By default, the table contains just two rows. You can add or remove rows using the buttons on the right hand side of the window. |
| 88 |
|
| 89 |
<P>
|
| 90 |
Once the size of the table has been set, it has to be filled with the desired values |
| 91 |
|
| 92 |
<P>
|
| 93 |
|
| 94 |
<H1><A NAME="SECTION00630000000000000000"> |
| 95 |
Filling the parameters table</A>
|
| 96 |
</H1>
|
| 97 |
|
| 98 |
<P>
|
| 99 |
Whatever the type of parameter it represents, every cell has a text string as its associated value. Double-clicking on a cell, this string can be edited, directly typing the desired value. For most of the parameters, however, it is more convenient to use the button on the right hand side of the cell. Clicking on it, a dialog is shown to select the value of the parameter. The content of this dialog depends on the kind of parameter, and it features elements that make it easier to introduce the desired value. For example, for a selection parameter the list of all possible values is shown and the value can be chosen from them. |
| 100 |
|
| 101 |
<P>
|
| 102 |
<DIV ALIGN="CENTER"> |
| 103 |
<IMG
|
| 104 |
WIDTH="311" HEIGHT="120" ALIGN="BOTTOM" BORDER="0" |
| 105 |
SRC="./batch_processing3.png" |
| 106 |
ALT="Image batch_processing3"> |
| 107 |
|
| 108 |
</DIV>
|
| 109 |
|
| 110 |
<P>
|
| 111 |
For all parameter cells, if the introduced value is correct, it will be shown in black. If the value is wrong (for instance, a numerical value out of the valid range or an option that does not exists for a selecion parameter), the text will be shown in red. |
| 112 |
|
| 113 |
<P>
|
| 114 |
<DIV ALIGN="CENTER"> |
| 115 |
<IMG
|
| 116 |
WIDTH="561" HEIGHT="81" ALIGN="BOTTOM" BORDER="0" |
| 117 |
SRC="./batch_processing4.png" |
| 118 |
ALT="Image batch_processing4"> |
| 119 |
|
| 120 |
</DIV>
|
| 121 |
|
| 122 |
<P>
|
| 123 |
The most importante different between executing an algorithm from the toolbox and executing it as part of a batch process is that input data objects are taken directly from files, and not from the set of layers already opened in the GIS. For this reason, any algorithm can be executed as a batch process even if no data objects at all are opened and the algorithm cannot be called from the toolbox. |
| 124 |
|
| 125 |
<P>
|
| 126 |
Filenames for input data objects are introduced directly typing or, more conveniently, clicking on the button on the right hand of the cell, which shows a typical file chooser dialog. Multiple files can be selected at once. If the input parameter represents a single data object and several files are selected, each one of them will be put in a separate row, adding new ones if needed. If it represents a multiple input, all the selected files will be added to a single cell, separated by commas. |
| 127 |
|
| 128 |
<P>
|
| 129 |
If multiple bands are required, a more complex dialog is shown, which incorporates a table for selecting both layer files and bands. Click on the cells on the left side to select the file which contains the raster layer. Then click on the left side to select the bands you want to use from that layer. To know the number of bands in a layer it would be necessary to open it. However, SEXTANTE does not open the layer, and shows instead a list of bands from 1 to 250 to select from. If you select a band that does not exist in the selected layer, an error message will be shown at execution time. |
| 130 |
|
| 131 |
<P>
|
| 132 |
<DIV ALIGN="CENTER"> |
| 133 |
<IMG
|
| 134 |
WIDTH="579" HEIGHT="455" ALIGN="BOTTOM" BORDER="0" |
| 135 |
SRC="./batch_processing_bands.png" |
| 136 |
ALT="Image batch_processing_bands"> |
| 137 |
|
| 138 |
</DIV>
|
| 139 |
|
| 140 |
<P>
|
| 141 |
Output data objects are always saved to a file and, unlike when executing an algorithm from the toolbox, saving to a temporary one is not permitted. You can type the name directly or use the file chooser dialog that appears when clicking on the accompanying button. This dialog differs slightly from the standard one, incorporating some additional fields for autocompletion. |
| 142 |
|
| 143 |
<P>
|
| 144 |
<DIV ALIGN="CENTER"> |
| 145 |
<IMG
|
| 146 |
WIDTH="963" HEIGHT="427" ALIGN="BOTTOM" BORDER="0" |
| 147 |
SRC="./batch_processing_save.png" |
| 148 |
ALT="Image batch_processing_save"> |
| 149 |
|
| 150 |
</DIV>
|
| 151 |
|
| 152 |
<P>
|
| 153 |
If the default value (<SPAN CLASS="textsf">Do not autocomplete</SPAN>) is selected, SEXTANTE will just put the selected filename in the selected cell from the parameters table. If any of the other options is selected, all the cells below the selected one will be automatically filled based on a defined criteria. This way, it is much easier to fill the table, and the batch process can be defined with less effort. |
| 154 |
|
| 155 |
<P>
|
| 156 |
Automatic filling can be done simply adding correlative numbers to the selected filepath, or appending the value of another field at the same row. This is particularly useful for naming output data object according to input ones. |
| 157 |
|
| 158 |
<P>
|
| 159 |
<DIV ALIGN="CENTER"> |
| 160 |
<IMG
|
| 161 |
WIDTH="368" HEIGHT="84" ALIGN="BOTTOM" BORDER="0" |
| 162 |
SRC="./batch_processing_filepath.png" |
| 163 |
ALT="Image batch_processing_filepath"> |
| 164 |
|
| 165 |
</DIV>
|
| 166 |
|
| 167 |
<P>
|
| 168 |
Cells can be selected just clicking and dragging. Selected cells can be copied and pasted in a different place of the parameters table, making it easy to fill it with repeated values. |
| 169 |
|
| 170 |
<P>
|
| 171 |
|
| 172 |
<H1><A NAME="SECTION00640000000000000000"> |
| 173 |
Setting raster output characteristics</A>
|
| 174 |
</H1>
|
| 175 |
|
| 176 |
<P>
|
| 177 |
Just like when executing a single algorithm, when running a batch process that generates raster layers you must define the extent and cellsize of the raster layers to be created. The corresponding <SPAN CLASS="textit">Raster Output</SPAN> tab is similar to the one found when running a single algorithm, but only contains two options: fit to input layers and used-defined. |
| 178 |
|
| 179 |
<P>
|
| 180 |
The selection will be applied to all the single executions contained in the current batch process. If you want to use different raster output configurations, then you must define different batch processes. |
| 181 |
|
| 182 |
<P>
|
| 183 |
<DIV ALIGN="CENTER"> |
| 184 |
<IMG
|
| 185 |
WIDTH="596" HEIGHT="486" ALIGN="BOTTOM" BORDER="0" |
| 186 |
SRC="./batch_processing_output.png" |
| 187 |
ALT="Image batch_processing_output"> |
| 188 |
|
| 189 |
</DIV>
|
| 190 |
|
| 191 |
<P>
|
| 192 |
|
| 193 |
<H1><A NAME="SECTION00650000000000000000"> |
| 194 |
Executing the batch process</A>
|
| 195 |
</H1>
|
| 196 |
|
| 197 |
<P>
|
| 198 |
To execute the batch process once you have introduced all the necessary values, just click on <SPAN CLASS="textit">OK</SPAN>. SEXTANTE will show the progress of each executed algorithm, and at the end will show a dialog with information about the values used and the problems encountered during the execution of the whole process. |
| 199 |
|
| 200 |
<P>
|
| 201 |
<DIV ALIGN="CENTER"> |
| 202 |
<IMG
|
| 203 |
WIDTH="508" HEIGHT="335" ALIGN="BOTTOM" BORDER="0" |
| 204 |
SRC="./batch_processing_executing.png" |
| 205 |
ALT="Image batch_processing_executing"> |
| 206 |
|
| 207 |
</DIV>
|
| 208 |
|
| 209 |
<P>
|
| 210 |
<BR><HR> |
| 211 |
<ADDRESS>
|
| 212 |
Victor Olaya |
| 213 |
2010-02-18 |
| 214 |
</ADDRESS>
|
| 215 |
</BODY>
|
| 216 |
</HTML>
|