forked from Automating-GIS-processes/2016
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathLesson6-toolbox.html
379 lines (269 loc) · 18.5 KB
/
Lesson6-toolbox.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-88382509-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>ArcGIS Toolbox — GeoPython - AutoGIS 1 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="GeoPython - AutoGIS 1 documentation" href="index.html"/>
<link rel="next" title="Writing arcpy scripts" href="Lesson6-arcpy-script.html"/>
<link rel="prev" title="Python in ArcGIS" href="Lesson6-arcpy.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> GeoPython - AutoGIS
<img src="_static/logo_hy_geo_135.png" class="logo" />
</a>
<div class="version">
2016 Autumn
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Course information</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="course-info.html">General info</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installing_Anacondas_GIS.html">Installing Python + GIS</a></li>
<li class="toctree-l1"><a class="reference internal" href="License-terms.html">License and terms of usage</a></li>
</ul>
<p class="caption"><span class="caption-text">Lesson 1</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Lesson1-Intro-Python-GIS.html">Introduction to Python GIS</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson1-Geometric-Objects.html">Geometric Objects - Spatial Data Model</a></li>
<li class="toctree-l1"><a class="reference internal" href="Exercise-1.html">Exercise 1</a></li>
</ul>
<p class="caption"><span class="caption-text">Lesson 2</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Lesson2-overview.html">Lesson 2 Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson2-download-data.html">Download datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson2-overview-pandas-geopandas.html">Pandas and Geopandas -modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson2-pandas-intro.html">Introduction to Pandas</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson2-geopandas-basics.html">Introduction to Geopandas</a></li>
<li class="toctree-l1"><a class="reference internal" href="Exercise-2.html">Exercise 2</a></li>
</ul>
<p class="caption"><span class="caption-text">Lesson 3</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Lesson3-overview.html">Lesson 3 Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson3-geocoding.html">Geocoding</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson3-table-join.html">Table join</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson3-projections.html">Re-projecting data</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson3-point-in-polygon.html">Point in Polygon & Intersect</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson3-spatial-join.html">Spatial join</a></li>
<li class="toctree-l1"><a class="reference internal" href="Exercise-3.html">Exercise 3</a></li>
</ul>
<p class="caption"><span class="caption-text">Lesson 4</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Lesson4-overview.html">Lesson 4 Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson4-download-data.html">Download datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson4-geometric-operations.html">Geometric operations</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson4-reclassify.html">Data reclassification</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson4-nearest-neighbour.html">Nearest Neighbour Analysis</a></li>
<li class="toctree-l1"><a class="reference internal" href="Exercise-4.html">Exercise 4</a></li>
</ul>
<p class="caption"><span class="caption-text">Lesson 5</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Lesson5-overview.html">Lesson 5 Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson5-download-data.html">Download datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson5-static-maps.html">Static maps</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson5-interactive-map-bokeh.html">Interactive maps with Bokeh</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson5-share-on-github.html">Sharing interactive plots on GitHub</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson5-interactive-map-folium.html">Interactive maps on Leaflet</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson5-World-3D.html">Inspiration: World 3D</a></li>
<li class="toctree-l1"><a class="reference internal" href="Exercise-5.html">Exercise 5</a></li>
</ul>
<p class="caption"><span class="caption-text">Lesson 6</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Lesson6-overview.html">Lesson 6 Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson6-arcpy.html">Python in ArcGIS</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">ArcGIS Toolbox</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#creating-an-arcgis-toolbox-for-python-scripts">Creating an ArcGIS Toolbox for Python scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="#opening-the-toolbox-in-arcgis">Opening the toolbox in ArcGIS</a></li>
<li class="toctree-l2"><a class="reference internal" href="#defining-the-toolbox-functionalities">Defining the toolbox functionalities</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Lesson6-arcpy-script.html">Writing arcpy scripts</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson6-run-the-tool.html">Running the Python script from ArcGIS</a></li>
</ul>
<p class="caption"><span class="caption-text">Lesson 7</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Lesson7-overview.html">Lesson 7 Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson7-download.html">Download data</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson7-read-raster.html">Reading raster files with GDAL</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson7-read-raster-array.html">Reading raster as a numerical array</a></li>
<li class="toctree-l1"><a class="reference internal" href="Lesson7-gdal-utilities.html">GDAL command line tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="Exercise-7.html">Exercise 7</a></li>
</ul>
<p class="caption"><span class="caption-text">Lesson 8</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Lesson8-network-analysis.html">Network analysis in Python</a></li>
</ul>
<p class="caption"><span class="caption-text">Final Assignment</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Final-assignment.html">Final assignment</a></li>
</ul>
<p class="caption"><span class="caption-text">Map Challenge 2016</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="map-challenge.html">Map Challenge 2016</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">GeoPython - AutoGIS</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>ArcGIS Toolbox</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Automating-GIS-processes/2016/blob/master/source/Lesson6-toolbox.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="arcgis-toolbox">
<h1>ArcGIS Toolbox<a class="headerlink" href="#arcgis-toolbox" title="Permalink to this headline">¶</a></h1>
<div class="section" id="creating-an-arcgis-toolbox-for-python-scripts">
<h2>Creating an ArcGIS Toolbox for Python scripts<a class="headerlink" href="#creating-an-arcgis-toolbox-for-python-scripts" title="Permalink to this headline">¶</a></h2>
<p>Now as we know how to use/access Python in ArcGIS, let’s start our arcpy demo by creating a <strong>Toolbox</strong> for our scripts.</p>
<p>A Toolbox is a Graphical User Interface for using specific tools in ArcGIS:</p>
<blockquote>
<div><ul class="simple">
<li>Setting input/output files</li>
<li>Setting parameters</li>
</ul>
</div></blockquote>
<p>It is also possible and recommendable to create your own toolbox for the Python scripts that you have created, although it is possible to run your Python script also
without one.</p>
<p>Creating a ArcGIS Toolbox is easy. Just open the file catalog panel in ArcGIS (i.e. file explorer of ArcGIS), press right mouse on a location where you want to save your toolbox, and choose <strong>New</strong> –> <strong>Toolbox</strong>. Let’s create
a toolbox called <code class="docutils literal"><span class="pre">ProcessChains.tbx</span></code> and save it into the computer (put it into a folder where you can easily find it).</p>
<div class="figure">
<a class="reference internal image-reference" href="_images/arcgis-create-toolbox.png"><img alt="_images/arcgis-create-toolbox.png" src="_images/arcgis-create-toolbox.png" style="width: 251.0px; height: 261.0px;" /></a>
</div>
</div>
<div class="section" id="opening-the-toolbox-in-arcgis">
<h2>Opening the toolbox in ArcGIS<a class="headerlink" href="#opening-the-toolbox-in-arcgis" title="Permalink to this headline">¶</a></h2>
<p>Now you have should have an empty toolbox saved on a disk. We can import the toolbox easily. Add ProcessChains.tbx to ArcGIS with three simple steps:</p>
<blockquote>
<div><ol class="arabic simple">
<li>activate ArcToolbox panel</li>
<li>right click in white space</li>
<li>Add Toolbox (browse to the directory where you save your toolbox)</li>
</ol>
</div></blockquote>
</div>
<div class="section" id="defining-the-toolbox-functionalities">
<h2>Defining the toolbox functionalities<a class="headerlink" href="#defining-the-toolbox-functionalities" title="Permalink to this headline">¶</a></h2>
<p>Now we have our custom Toolbox in ArcGIS but it cannot yet do anything. Let’s first create a graphical user interface for our tool.</p>
<p>Defining input/output files plus additional parameters for your own Python script can be done by creating a <strong>Script</strong> -tool (i.e. user interface) into your ArcGIS toolbox:</p>
<div class="figure">
<a class="reference internal image-reference" href="_images/arcgis-script-tool.png"><img alt="_images/arcgis-script-tool.png" src="_images/arcgis-script-tool.png" style="width: 225.5px; height: 192.0px;" /></a>
</div>
<p>It opens a dialog where you should write some generic description of your tool such as the name of the tool and description for it (do like below):</p>
<div class="figure">
<a class="reference internal image-reference" href="_images/arcgis-script-description.png"><img alt="_images/arcgis-script-description.png" src="_images/arcgis-script-description.png" style="width: 323.25px; height: 423.75px;" /></a>
</div>
<p>Now we can add parameters to our tool which are then asked from the user when the tool is used. Parameters can be defined from the properties of your Script tool:</p>
<div class="figure">
<a class="reference internal image-reference" href="_images/arcgis-properties.png"><img alt="_images/arcgis-properties.png" src="_images/arcgis-properties.png" style="width: 250.5px; height: 237.75px;" /></a>
</div>
<p>From the <code class="docutils literal"><span class="pre">Parameters</span></code> -tab we can add different kind of parameters to our tool.</p>
<div class="figure">
<a class="reference internal image-reference" href="_images/arcgis-parameter-tab-whole.png"><img alt="_images/arcgis-parameter-tab-whole.png" src="_images/arcgis-parameter-tab-whole.png" style="width: 324.0px; height: 424.5px;" /></a>
</div>
<p>We can name the paramater as we like in <code class="docutils literal"><span class="pre">Display</span> <span class="pre">name</span></code> column. The <code class="docutils literal"><span class="pre">Data</span> <span class="pre">type</span></code> column determines what kind of input the user can
pass to that specific parameter. It can be for example <strong>Shapefile</strong>, <strong>Folder</strong>, <strong>Field</strong>, <strong>Integer</strong>, or a <strong>Raster</strong> (see the full list by clicking a row at Data Type column). Create following parameters:</p>
<div class="figure">
<a class="reference internal image-reference" href="_images/arcgis-parameter-tab-upper.png"><img alt="_images/arcgis-parameter-tab-upper.png" src="_images/arcgis-parameter-tab-upper.png" style="width: 345.6px; height: 140.4px;" /></a>
</div>
<p>From the lower part of the dialog we can adjust the properties of individual parameter (selected in Parameters list, above) that we have added to our tool. We can for example determine the
<code class="docutils literal"><span class="pre">Direction</span></code> of the parameter (Input or output), determine with <code class="docutils literal"><span class="pre">`Filter</span></code> what kind of values are valid for the parameter (e.g. list of values or range), or specify a <code class="docutils literal"><span class="pre">Default</span></code> value for a parameter:</p>
<div class="figure">
<a class="reference internal image-reference" href="_images/arcgis-parameter-tab-lower.png"><img alt="_images/arcgis-parameter-tab-lower.png" src="_images/arcgis-parameter-tab-lower.png" style="width: 306.0px; height: 157.5px;" /></a>
</div>
<div class="admonition-task admonition">
<p class="first admonition-title">Task</p>
<p class="last">Determine the <code class="docutils literal"><span class="pre">Filter</span></code> parameter for <code class="docutils literal"><span class="pre">Presence</span> <span class="pre">value</span></code> as a range of values from 1-5.</p>
</div>
<p>Finally, you should end up having a nice interface for your tool that looks something similar as this:</p>
<div class="figure">
<a class="reference internal image-reference" href="_images/arcgis-my-script.png"><img alt="_images/arcgis-my-script.png" src="_images/arcgis-my-script.png" style="width: 686.25px; height: 336.0px;" /></a>
</div>
<p>Next, we need to write the Python script that we run with this tool interface!</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="Lesson6-arcpy-script.html" class="btn btn-neutral float-right" title="Writing arcpy scripts" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="Lesson6-arcpy.html" class="btn btn-neutral" title="Python in ArcGIS" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2016, Henrikki Tenkanen.
Last updated on Feb 20, 2017.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
<li><a href="http://project.invalid/">Project Homepage</a> »</li>
<div class="footer">
<img src="../img/GPLv3_Logo.svg">
</div>
</body>
</html>