-
Notifications
You must be signed in to change notification settings - Fork 1
/
gibble.html
287 lines (216 loc) · 12.7 KB
/
gibble.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
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Path-based geometry decomposition — gibble • gibble</title>
<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>
<!-- Font Awesome icons -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/all.min.css" integrity="sha256-nAmazAk6vS34Xqo0BSrTb+abbtFlgsFK7NKSi6o7Y78=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/v4-shims.min.css" integrity="sha256-6qHlizsOWFskGlwVOKuns+D1nB6ssZrHQrNj1wGplHc=" crossorigin="anonymous" />
<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script>
<!-- headroom.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/headroom.min.js" integrity="sha256-DJFC1kqIhelURkuza0AvYal5RxMtpzLjFhsnVIeuk+U=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>
<meta property="og:title" content="Path-based geometry decomposition — gibble" />
<meta property="og:description" content="A gibble is a geometry map, a summary of the structure of each path within a
simple planar shape. The generic function gibble() will summarize all paths
within a complex type with a data frame row for each. Each row of the gibble
summary represents a component element of the object's geometry and records
the number of rows (i.e. how many coordinates) and the number of columns (i.e.
the number of axes in the geometric space). Another column type records the
class of the object, and object records an identifier for the entire object.
A special case column subobject identifies the component POLYGON part within
a MULTIPOLYGON. I.e. subobject is 1 unless that part is a hole. All
identifiers are sequential within the higher level groupings." />
<meta name="twitter:card" content="summary" />
<!-- mathjax -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="container template-reference-topic">
<header>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">gibble</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.3.0</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="../index.html">
<span class="fas fa fas fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="../reference/index.html">Reference</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
Articles
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="../articles/what-is-gibble.html">What is the gibble</a>
</li>
</ul>
</li>
<li>
<a href="../news/index.html">Changelog</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/mdsumner/gibble">
<span class="fab fa fab fa-github fa-lg"></span>
</a>
</li>
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header>
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Path-based geometry decomposition</h1>
<small class="dont-index">Source: <a href='https://github.com/mdsumner/gibble/blob/master/R/gibble-sf.R'><code>R/gibble-sf.R</code></a>, <a href='https://github.com/mdsumner/gibble/blob/master/R/gibble-silicate.R'><code>R/gibble-silicate.R</code></a>, <a href='https://github.com/mdsumner/gibble/blob/master/R/gibble-sp.R'><code>R/gibble-sp.R</code></a>, and 2 more</small>
<div class="hidden name"><code>gibble.Rd</code></div>
</div>
<div class="ref-description">
<p>A gibble is a geometry map, a summary of the structure of each path within a
simple planar shape. The generic function <code>gibble()</code> will summarize all paths
within a complex type with a data frame row for each. Each row of the gibble
summary represents a component element of the object's geometry and records
the number of rows (i.e. how many coordinates) and the number of columns (i.e.
the number of axes in the geometric space). Another column <code>type</code> records the
class of the object, and <code>object</code> records an identifier for the entire object.
A special case column <code>subobject</code> identifies the component POLYGON part within
a MULTIPOLYGON. I.e. <code>subobject</code> is 1 unless that part is a hole. All
identifiers are sequential within the higher level groupings.</p>
</div>
<pre class="usage"><span class='co'># S3 method for POINT</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for MULTIPOINT</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for LINESTRING</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for MULTILINESTRING</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for POLYGON</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for MULTIPOLYGON</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for list</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for sfc</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for sf</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for PATH0</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for PATH</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for trip</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for Polygon</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for Polygons</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for SpatialPolygons</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for Line</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for Lines</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for SpatialLines</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for SpatialMultiPoints</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for SpatialPoints</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for Spatial</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)
<span class='co'># S3 method for default</span>
<span class='fu'>gibble</span>(<span class='no'>x</span>, <span class='no'>...</span>)</pre>
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
<table class="ref-arguments">
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>x</th>
<td><p>geometry model</p></td>
</tr>
<tr>
<th>...</th>
<td><p>arguments reserved for methods, none currently</p></td>
</tr>
</table>
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
<p>data frame summarizing the geometry map, see <code>Details</code></p>
<h2 class="hasAnchor" id="details"><a class="anchor" href="#details"></a>Details</h2>
<p>Methods are provided for the <code>sf</code> classes. There is an internal version that
is designed to work fast on sets of structures, by delaying conversion to list
or data frame for as late as possible.</p>
<p>A geometry map is not so helpful on its own, and so does not have a formal
class. It is designed for use within other workflows such as updating the
coordinates of model object or translating between superficially different
formats.</p>
<p>Gibble is a distillation of the <code>sc_path</code> encoding of package
<a href='https://github.com/hypertidy/silicate'>silicate</a>, which came from the
<code>map_table</code> decompositions of spbabel, as an improvement on the single-table
<code>fortify</code> model used in <code>ggplot2</code>.</p>
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><div class='input'><span class='fu'>gibble</span>(<span class='no'>minimal_mesh</span>)</div><div class='output co'>#> <span style='color: #555555;'># A tibble: 3 x 5</span><span>
#> nrow ncol type subobject object
#> </span><span style='color: #555555;font-style: italic;'><int></span><span> </span><span style='color: #555555;font-style: italic;'><int></span><span> </span><span style='color: #555555;font-style: italic;'><chr></span><span> </span><span style='color: #555555;font-style: italic;'><int></span><span> </span><span style='color: #555555;font-style: italic;'><int></span><span>
#> </span><span style='color: #555555;'>1</span><span> 8 2 MULTIPOLYGON 1 1
#> </span><span style='color: #555555;'>2</span><span> 6 2 MULTIPOLYGON 1 1
#> </span><span style='color: #555555;'>3</span><span> 5 2 MULTIPOLYGON 1 2</div></span></pre>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<h2>Contents</h2>
<ul class="nav nav-pills nav-stacked">
<li><a href="#arguments">Arguments</a></li>
<li><a href="#value">Value</a></li>
<li><a href="#details">Details</a></li>
<li><a href="#examples">Examples</a></li>
</ul>
</div>
</div>
<footer>
<div class="copyright">
<p>Developed by Michael Sumner.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.4.1.</p>
</div>
</footer>
</div>
</body>
</html>