-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
197 lines (177 loc) · 8.01 KB
/
index.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Welcome to SmartGrid’s documentation! — SmartGrid 0.1 documentation</title>
<link rel="stylesheet" href="classic.css" type="text/css" />
<link rel="stylesheet" href="pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="underscore.js"></script>
<script type="text/javascript" src="doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I"></a></li>
<li class="nav-item nav-item-0"><a href="#how-to-use">Smart Grid 0.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="welcome-to-smartgrid-s-documentation">
<h1>QGIS Smart Grid plugin<a class="headerlink" href="#welcome-to-smartgrid-s-documentation" title="Permalink to this headline">¶</a></h1>
<p>The Smart Grid plugin provides assistance to image analists on assessing and editing cloud masks on satellite imageries.</p>
<h2 id = "release-notes">Release notes</h2>
<p>Smart Grid 0.1 features:</p>
<ul>
Notify users when working with multiple projections.
</ul>
<ul>
Keep tracks of what has been done and still needs to.
</ul>
<ul>
Easy navigation through image parts.
</ul>
<ul>
Flexible zoom ranges for objective editing.
</ul>
<p>Bugs in this release:</p>
<ul>
Keypress functions won't work if the plugin is restarted with the Plugin Reloader plugin.
</ul>
<ul>
If keys are already occupied by the QGIS shortcut configuration, the keypress functions won't work either (same for shortcut keys).
</ul>
<ul>
Cloud filled grid cell won't display on the canvas when users add en empty cloud mask via the QGIS New Shapefile Layer option.
</ul>
<p id="smart-report">Smart Grid development report</p>
<a href="SmartGrid_development2.pdf" target="_blank"><img id="picpdf" src="pdf_icon.png"></a>
<p >Download plugin file</p>
<a href="SmartGrid.rar" download>SmartGrid.rar</a>
<p>Unpack in the following directory "~/.qgis2/python/plugins".
<h2 id = "how-to-use">How to use</h2>
<p>The steps to use this plugin are fairly simple:</p>
</div>
<div class="section" id="indices-and-tables">
<ol id = "step-list" class="simple">
<li><p>Open the Smart Grid plugin from within QGIS by clicking on the <img src="icon.png"> icon. </p></li>
<li><p>Save your project file in a directory.</p></li>
<li><p>Select a raster layer from the layers panel.</p></li>
<li><p>Click the create grid button. </p><img src="grid.png"></li>
<li><p>Click the create group button. </p><img src="group.png"></li>
<li><p>Click the create mask button. </p><img src="mask.png"></li>
<li><p>Navigate and edit on the grid layer using the designated keyboard shortcuts: </p>
<ul>W,A,S,D   : up,left,down,right </ul>
<ul>Q,E       : zoom full, zoom to grid cell</ul>
<ul>F,G        : mark, unmark grid cell (delete cloud filled grid cell) </ul>
<ul>1,3        : navigation mode, mask editing mode</ul>
<ul>2          : fill grid cell(s)</ul>
<ul>R         : deselect feature</ul>
</li>
<li><p>Repeat steps 3 to 6 for assessing a single raster image.</p></li>
</ol>
</div>
<div id="images">
<img id="pic" src="smartgrid.png">
<img id="pic1" src="smartgrid1.png">
<img id="pic2" src="smartgrid2.png">
</div>
<div id="concepts">
<h2>Concepts</h2>
<p>The Tool tab is the main interface of the Smart Grid plugin. </p>
<p>Tool features: </p>
<div class="features">
<ul>
Browses through your directory.
</ul>
<ul>
Creates a project folder named 'cloudmask' in the select directory.
</ul>
<ul>
Creates a grid based on a single raster layer (4 grid cell sizes: XS, S, M and L to choose from).
</ul>
<ul>
Create a grid based on the extent of the multiple layers within the map canvas.
</ul>
<ul>
Creates a group named 'Marking Group' and automatically insert the grid to it. A grid marker layer named 'Grid_marking' is created in the process inside the group.
</ul>
<ul>
Creates an empty cloud mask layer with a user defined layer name.
</ul>
<ul>
Removes temporary files, i.e. grid- and grid marker layers from the project directory.
</ul>
</div>
<p> Grid system <br>
The grid layers are created using the built-in QGIS algorithm. This algorithm requires: layer (raster) extent, grid cell size (x,y spacing), output type (polygon) and an output path. The grid is saved in the project file directory. An example of a vector grid is shown below. The grid layer has an ID attribute field, which the navigation, marking grid cells, cloud mask filler and other features are based on.
</p>
<img id= "grid2" src="grid2.png">
<p>Navigating through image parts is done on the grid layer through the use the grid cell IDs and numberes of column. To move right or left, the selected grid cell ID is added/ substracted with '1'. To move upward or downward, the selected grid cell ID is added/ substracted with the total numbers of column. The concept algorithm can be explained in formulas:
</p>
<div class="gridsystem">
<ul>
Right grid cell index   : selected grid cell ID index + 1
</ul>
<ul>
Left grid cell index    : selected grid cell ID index – 1
</ul>
<ul>
Above grid cell index  : selected grid cell ID index + numbers of column
</ul>
<ul>
Below grid cell index  : selected grid cell ID index – numbers of column
</ul>
</div>
</div>
</div>
</div>
</div>
<div id="sidebar" class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3>Table Of Contents</h3>
<ol>
<li><a class="reference internal" href="#release-notes">Release notes</a></li>
<li><a class="reference internal" href="#how-to-use">How to use</a></li>
<li><a class="reference internal" href="#images">UI</a></li>
<li><a class="reference internal" href="#concepts">Concepts</a></li>
</ol>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="nav-item nav-item-0"><a href="#">SmartGrid 0.1 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2018, Willy Tjiong.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
</div>
</body>
</html>