/
api.html
662 lines (636 loc) · 51.4 KB
/
api.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
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>libpysal API reference — libpysal v4.3.0 Manual</title>
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/pysal-styles.css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script>
<link rel="shortcut icon" href="_static/pysal_favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="libpysal.weights.W" href="generated/libpysal.weights.W.html" />
<link rel="prev" title="Datasets for use with libpysal" href="notebooks/examples.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<script type="text/javascript" src="_static/js/jquery-1.11.0.min.js "></script>
<script type="text/javascript" src="_static/js/jquery-fix.js "></script>
<script type="text/javascript" src="_static/bootstrap-3.3.7/js/bootstrap.min.js "></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js "></script>
</head><body>
<div id="navbar" class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">
libpysal</a>
<span class="navbar-text navbar-version pull-left"><b>4.3.0</b></span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li><a href="installation.html">Installation</a></li>
<li><a href="tutorial.html">Tutorial</a></li>
<li><a href="#">API</a></li>
<li><a href="references.html">References</a></li>
<li class="dropdown globaltoc-container">
<a role="button"
id="dLabelGlobalToc"
data-toggle="dropdown"
data-target="#"
href="index.html">Site <b class="caret"></b></a>
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc"><p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installing-released-version">Installing released version</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installing-development-version">Installing development version</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#spatial-weights">Spatial Weights</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#example-datasets">Example Datasets</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#spatial-weights">Spatial Weights</a></li>
<li class="toctree-l2"><a class="reference internal" href="#cg-computational-geometry">cg: Computational Geometry</a></li>
<li class="toctree-l2"><a class="reference internal" href="#io">io</a></li>
<li class="toctree-l2"><a class="reference internal" href="#examples">examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="references.html">References</a></li>
</ul>
</ul>
</li>
<li class="dropdown">
<a role="button"
id="dLabelLocalToc"
data-toggle="dropdown"
data-target="#"
href="#">Page <b class="caret"></b></a>
<ul class="dropdown-menu localtoc"
role="menu"
aria-labelledby="dLabelLocalToc"><ul>
<li><a class="reference internal" href="#">libpysal API reference</a><ul>
<li><a class="reference internal" href="#spatial-weights">Spatial Weights</a><ul>
<li><a class="reference internal" href="#distance-weights">Distance Weights</a></li>
<li><a class="reference internal" href="#contiguity-weights">Contiguity Weights</a></li>
<li><a class="reference internal" href="#spint-weights">spint Weights</a></li>
<li><a class="reference internal" href="#weights-util-classes-and-functions">Weights Util Classes and Functions</a></li>
<li><a class="reference internal" href="#weights-user-classes-and-functions">Weights user Classes and Functions</a></li>
<li><a class="reference internal" href="#set-theoretic-weights">Set Theoretic Weights</a></li>
<li><a class="reference internal" href="#spatial-lag">Spatial Lag</a></li>
</ul>
</li>
<li><a class="reference internal" href="#cg-computational-geometry">cg: Computational Geometry</a><ul>
<li><a class="reference internal" href="#alpha-shapes">alpha_shapes</a></li>
<li><a class="reference internal" href="#voronoi">voronoi</a></li>
<li><a class="reference internal" href="#sphere">sphere</a></li>
<li><a class="reference internal" href="#shapes">shapes</a></li>
<li><a class="reference internal" href="#standalone">standalone</a></li>
<li><a class="reference internal" href="#locators">locators</a></li>
<li><a class="reference internal" href="#kdtree">kdtree</a></li>
</ul>
</li>
<li><a class="reference internal" href="#io">io</a></li>
<li><a class="reference internal" href="#examples">examples</a></li>
</ul>
</li>
</ul>
</ul>
</li>
</ul>
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="body col-md-12 content" role="main">
<div class="section" id="libpysal-api-reference">
<span id="api-ref"></span><h1>libpysal API reference<a class="headerlink" href="#libpysal-api-reference" title="Permalink to this headline">¶</a></h1>
<div class="section" id="spatial-weights">
<h2>Spatial Weights<a class="headerlink" href="#spatial-weights" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.W.html#libpysal.weights.W" title="libpysal.weights.W"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.W</span></code></a>(neighbors[, weights, …])</p></td>
<td><p>Spatial weights class.</p></td>
</tr>
</tbody>
</table>
<div class="section" id="distance-weights">
<h3>Distance Weights<a class="headerlink" href="#distance-weights" title="Permalink to this headline">¶</a></h3>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.DistanceBand.html#libpysal.weights.DistanceBand" title="libpysal.weights.DistanceBand"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.DistanceBand</span></code></a>(data, threshold)</p></td>
<td><p>Spatial weights based on distance band.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.weights.Kernel.html#libpysal.weights.Kernel" title="libpysal.weights.Kernel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.Kernel</span></code></a>(data[, bandwidth, …])</p></td>
<td><p>Spatial weights based on kernel functions.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.KNN.html#libpysal.weights.KNN" title="libpysal.weights.KNN"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.KNN</span></code></a>(data[, k, p, ids, …])</p></td>
<td><p>Creates nearest neighbor weights matrix based on k nearest neighbors.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="contiguity-weights">
<h3>Contiguity Weights<a class="headerlink" href="#contiguity-weights" title="Permalink to this headline">¶</a></h3>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.Queen.html#libpysal.weights.Queen" title="libpysal.weights.Queen"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.Queen</span></code></a>(polygons, **kw)</p></td>
<td><p>Construct a weights object from a collection of pysal polygons that share at least one vertex.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.weights.Rook.html#libpysal.weights.Rook" title="libpysal.weights.Rook"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.Rook</span></code></a>(polygons, **kw)</p></td>
<td><p>Construct a weights object from a collection of pysal polygons that share at least one edge.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.Voronoi.html#libpysal.weights.Voronoi" title="libpysal.weights.Voronoi"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.Voronoi</span></code></a>(points[, …])</p></td>
<td><p>Voronoi weights for a 2-d point set</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.weights.W.html#libpysal.weights.W" title="libpysal.weights.W"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.W</span></code></a>(neighbors[, weights, …])</p></td>
<td><p>Spatial weights class.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="spint-weights">
<h3>spint Weights<a class="headerlink" href="#spint-weights" title="Permalink to this headline">¶</a></h3>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.WSP.html#libpysal.weights.WSP" title="libpysal.weights.WSP"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.WSP</span></code></a>(sparse[, id_order])</p></td>
<td><p>Thin <code class="docutils literal notranslate"><span class="pre">W</span></code> class for <code class="docutils literal notranslate"><span class="pre">spreg</span></code>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.weights.netW.html#libpysal.weights.netW" title="libpysal.weights.netW"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.netW</span></code></a>(link_list[, share, …])</p></td>
<td><p>Create a network-contiguity based weight object based on different nodal relationships encoded in a network.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.mat2L.html#libpysal.weights.mat2L" title="libpysal.weights.mat2L"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.mat2L</span></code></a>(edge_matrix)</p></td>
<td><p>Convert a matrix denoting network connectivity (edges or flows) to a list denoting edges</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.weights.ODW.html#libpysal.weights.ODW" title="libpysal.weights.ODW"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.ODW</span></code></a>(Wo, Wd[, transform, …])</p></td>
<td><p>Constructs an o*d by o*d origin-destination style spatial weight for o*d flows using standard spatial weights on o origins and d destinations.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.vecW.html#libpysal.weights.vecW" title="libpysal.weights.vecW"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.vecW</span></code></a>(origin_x, origin_y, …)</p></td>
<td><p>Distance-based spatial weight for vectors that is computed using a 4-dimensional distance between the origin x,y-coordinates and the destination x,y-coordinates</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="weights-util-classes-and-functions">
<h3>Weights Util Classes and Functions<a class="headerlink" href="#weights-util-classes-and-functions" title="Permalink to this headline">¶</a></h3>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.block_weights.html#libpysal.weights.block_weights" title="libpysal.weights.block_weights"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.block_weights</span></code></a>(regimes[, …])</p></td>
<td><p>Construct spatial weights for regime neighbors.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.weights.lat2W.html#libpysal.weights.lat2W" title="libpysal.weights.lat2W"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.lat2W</span></code></a>([nrows, ncols, rook, …])</p></td>
<td><p>Create a W object for a regular lattice.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.comb.html#libpysal.weights.comb" title="libpysal.weights.comb"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.comb</span></code></a>(items[, n])</p></td>
<td><p>Combinations of size n taken from items</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.weights.order.html#libpysal.weights.order" title="libpysal.weights.order"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.order</span></code></a>(w[, kmax])</p></td>
<td><p>Determine the non-redundant order of contiguity up to a specific order.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.higher_order.html#libpysal.weights.higher_order" title="libpysal.weights.higher_order"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.higher_order</span></code></a>(w[, k])</p></td>
<td><p>Contiguity weights object of order k.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.weights.shimbel.html#libpysal.weights.shimbel" title="libpysal.weights.shimbel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.shimbel</span></code></a>(w)</p></td>
<td><p>Find the Shimbel matrix for first order contiguity matrix.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.remap_ids.html#libpysal.weights.remap_ids" title="libpysal.weights.remap_ids"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.remap_ids</span></code></a>(w, old2new[, …])</p></td>
<td><p>Remaps the IDs in a spatial weights object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.weights.full2W.html#libpysal.weights.full2W" title="libpysal.weights.full2W"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.full2W</span></code></a>(m[, ids])</p></td>
<td><p>Create a PySAL W object from a full array.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.full.html#libpysal.weights.full" title="libpysal.weights.full"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.full</span></code></a>(w)</p></td>
<td><p>Generate a full numpy array.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.weights.WSP2W.html#libpysal.weights.WSP2W" title="libpysal.weights.WSP2W"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.WSP2W</span></code></a>(wsp, \*\*kwargs)</p></td>
<td><p>Convert a pysal WSP object (thin weights matrix) to a pysal W object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.get_ids.html#libpysal.weights.get_ids" title="libpysal.weights.get_ids"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.get_ids</span></code></a>(in_shps, idVariable)</p></td>
<td><p>Gets the IDs from the DBF file that moves with a given shape file or a geopandas.GeoDataFrame.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.weights.get_points_array_from_shapefile.html#libpysal.weights.get_points_array_from_shapefile" title="libpysal.weights.get_points_array_from_shapefile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.get_points_array_from_shapefile</span></code></a>(…)</p></td>
<td><p>Gets a data array of x and y coordinates from a given shapefile.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="weights-user-classes-and-functions">
<h3>Weights user Classes and Functions<a class="headerlink" href="#weights-user-classes-and-functions" title="Permalink to this headline">¶</a></h3>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.min_threshold_distance.html#libpysal.weights.min_threshold_distance" title="libpysal.weights.min_threshold_distance"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.min_threshold_distance</span></code></a>(data)</p></td>
<td><p>Get the maximum nearest neighbor distance.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.weights.lat2SW.html#libpysal.weights.lat2SW" title="libpysal.weights.lat2SW"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.lat2SW</span></code></a>([nrows, ncols, …])</p></td>
<td><p>Create a sparse W matrix for a regular lattice.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.w_local_cluster.html#libpysal.weights.w_local_cluster" title="libpysal.weights.w_local_cluster"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.w_local_cluster</span></code></a>(w)</p></td>
<td><p>Local clustering coefficients for each unit as a node in a graph.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.weights.higher_order_sp.html#libpysal.weights.higher_order_sp" title="libpysal.weights.higher_order_sp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.higher_order_sp</span></code></a>(w[, k, …])</p></td>
<td><p>Contiguity weights for either a sparse W or W for order k.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.hexLat2W.html#libpysal.weights.hexLat2W" title="libpysal.weights.hexLat2W"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.hexLat2W</span></code></a>([nrows, ncols])</p></td>
<td><p>Create a W object for a hexagonal lattice.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.weights.attach_islands.html#libpysal.weights.attach_islands" title="libpysal.weights.attach_islands"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.attach_islands</span></code></a>(w, w_knn1, …)</p></td>
<td><p>Attach nearest neighbor to islands in spatial weight w.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.nonplanar_neighbors.html#libpysal.weights.nonplanar_neighbors" title="libpysal.weights.nonplanar_neighbors"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.nonplanar_neighbors</span></code></a>(w, …)</p></td>
<td><p>Detect neighbors for non-planar polygon collections</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.weights.fuzzy_contiguity.html#libpysal.weights.fuzzy_contiguity" title="libpysal.weights.fuzzy_contiguity"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.fuzzy_contiguity</span></code></a>(gdf[, …])</p></td>
<td><p>Fuzzy contiguity spatial weights</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.min_threshold_dist_from_shapefile.html#libpysal.weights.min_threshold_dist_from_shapefile" title="libpysal.weights.min_threshold_dist_from_shapefile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.min_threshold_dist_from_shapefile</span></code></a>(…)</p></td>
<td><p>Get the maximum nearest neighbor distance between observations in the shapefile.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.weights.build_lattice_shapefile.html#libpysal.weights.build_lattice_shapefile" title="libpysal.weights.build_lattice_shapefile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.build_lattice_shapefile</span></code></a>(…)</p></td>
<td><p>Build a lattice shapefile with nrows rows and ncols cols.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.spw_from_gal.html#libpysal.weights.spw_from_gal" title="libpysal.weights.spw_from_gal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.spw_from_gal</span></code></a>(galfile)</p></td>
<td><p>Sparse scipy matrix for w from a gal file.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="set-theoretic-weights">
<h3>Set Theoretic Weights<a class="headerlink" href="#set-theoretic-weights" title="Permalink to this headline">¶</a></h3>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.w_union.html#libpysal.weights.w_union" title="libpysal.weights.w_union"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.w_union</span></code></a>(w1, w2, \*\*kwargs)</p></td>
<td><p>Returns a binary weights object, w, that includes all neighbor pairs that exist in either w1 or w2.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.weights.w_intersection.html#libpysal.weights.w_intersection" title="libpysal.weights.w_intersection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.w_intersection</span></code></a>(w1, w2[, …])</p></td>
<td><p>Returns a binary weights object, w, that includes only those neighbor pairs that exist in both w1 and w2.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.w_difference.html#libpysal.weights.w_difference" title="libpysal.weights.w_difference"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.w_difference</span></code></a>(w1, w2[, …])</p></td>
<td><p>Returns a binary weights object, w, that includes only neighbor pairs in w1 that are not in w2.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.weights.w_symmetric_difference.html#libpysal.weights.w_symmetric_difference" title="libpysal.weights.w_symmetric_difference"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.w_symmetric_difference</span></code></a>(w1, w2)</p></td>
<td><p>Returns a binary weights object, w, that includes only neighbor pairs that are not shared by w1 and w2.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.w_subset.html#libpysal.weights.w_subset" title="libpysal.weights.w_subset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.w_subset</span></code></a>(w1, ids, \*\*kwargs)</p></td>
<td><p>Returns a binary weights object, w, that includes only those observations in ids.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.weights.w_clip.html#libpysal.weights.w_clip" title="libpysal.weights.w_clip"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.w_clip</span></code></a>(w1, w2[, outSP])</p></td>
<td><p>Clip a continuous W object (w1) with a different W object (w2) so only cells where w2 has a non-zero value remain with non-zero values in w1.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="spatial-lag">
<h3>Spatial Lag<a class="headerlink" href="#spatial-lag" title="Permalink to this headline">¶</a></h3>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.weights.lag_spatial.html#libpysal.weights.lag_spatial" title="libpysal.weights.lag_spatial"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.lag_spatial</span></code></a>(w, y)</p></td>
<td><p>Spatial lag operator.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.weights.lag_categorical.html#libpysal.weights.lag_categorical" title="libpysal.weights.lag_categorical"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.weights.lag_categorical</span></code></a>(w, y[, ties])</p></td>
<td><p>Spatial lag operator for categorical variables.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cg-computational-geometry">
<h2>cg: Computational Geometry<a class="headerlink" href="#cg-computational-geometry" title="Permalink to this headline">¶</a></h2>
<div class="section" id="alpha-shapes">
<h3>alpha_shapes<a class="headerlink" href="#alpha-shapes" title="Permalink to this headline">¶</a></h3>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.alpha_shape.html#libpysal.cg.alpha_shape" title="libpysal.cg.alpha_shape"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.alpha_shape</span></code></a>(xys, alpha)</p></td>
<td><p>Alpha-shape delineation (Edelsbrunner, Kirkpatrick & Seidel, 1983) from a collection of points …</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.alpha_shape_auto.html#libpysal.cg.alpha_shape_auto" title="libpysal.cg.alpha_shape_auto"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.alpha_shape_auto</span></code></a>(xys[, step, …])</p></td>
<td><p>Computation of alpha-shape delineation with automated selection of alpha.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="voronoi">
<h3>voronoi<a class="headerlink" href="#voronoi" title="Permalink to this headline">¶</a></h3>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.voronoi_frames.html#libpysal.cg.voronoi_frames" title="libpysal.cg.voronoi_frames"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.voronoi_frames</span></code></a>(points[, radius, …])</p></td>
<td><p>Composite helper to return Voronoi regions and generator points as individual dataframes.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="sphere">
<h3>sphere<a class="headerlink" href="#sphere" title="Permalink to this headline">¶</a></h3>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.RADIUS_EARTH_KM.html#libpysal.cg.RADIUS_EARTH_KM" title="libpysal.cg.RADIUS_EARTH_KM"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.RADIUS_EARTH_KM</span></code></a></p></td>
<td><p>Convert a string or number to a floating point number, if possible.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.RADIUS_EARTH_MILES.html#libpysal.cg.RADIUS_EARTH_MILES" title="libpysal.cg.RADIUS_EARTH_MILES"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.RADIUS_EARTH_MILES</span></code></a></p></td>
<td><p>Convert a string or number to a floating point number, if possible.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.arcdist.html#libpysal.cg.arcdist" title="libpysal.cg.arcdist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.arcdist</span></code></a>(pt0, pt1[, radius])</p></td>
<td><p>Arc distance between two points on a sphere.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.arcdist2linear.html#libpysal.cg.arcdist2linear" title="libpysal.cg.arcdist2linear"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.arcdist2linear</span></code></a>(arc_dist[, radius])</p></td>
<td><p>Convert an arc distance (spherical earth) to a linear distance (R3) in the unit sphere.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.brute_knn.html#libpysal.cg.brute_knn" title="libpysal.cg.brute_knn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.brute_knn</span></code></a>(pts, k[, mode])</p></td>
<td><p>valid modes are [‘arc’,’xrz’]</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.fast_knn.html#libpysal.cg.fast_knn" title="libpysal.cg.fast_knn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.fast_knn</span></code></a>(pts, k[, return_dist])</p></td>
<td><p>Computes k nearest neighbors on a sphere.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.fast_threshold.html#libpysal.cg.fast_threshold" title="libpysal.cg.fast_threshold"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.fast_threshold</span></code></a>(pts, dist[, radius])</p></td>
<td><p>Find all neighbors on a sphere within a threshold distance</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.linear2arcdist.html#libpysal.cg.linear2arcdist" title="libpysal.cg.linear2arcdist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.linear2arcdist</span></code></a>(linear_dist[, radius])</p></td>
<td><p>Convert a linear distance in the unit sphere (R3) to an arc distance based on supplied radius</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.toLngLat.html#libpysal.cg.toLngLat" title="libpysal.cg.toLngLat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.toLngLat</span></code></a>(xyz)</p></td>
<td><p>Convert x,y,z to latitude and longitude</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.toXYZ.html#libpysal.cg.toXYZ" title="libpysal.cg.toXYZ"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.toXYZ</span></code></a>(pt)</p></td>
<td><p>Convert a point’s latitude and longitude to x,y,z</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.lonlat.html#libpysal.cg.lonlat" title="libpysal.cg.lonlat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.lonlat</span></code></a>(pointslist)</p></td>
<td><p>Converts point order from lat-lon tuples to lon-lat (x,y) tuples</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.harcdist.html#libpysal.cg.harcdist" title="libpysal.cg.harcdist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.harcdist</span></code></a>(p0, p1[, lonx, radius])</p></td>
<td><p>Alternative arc distance function, uses haversine formula</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.geointerpolate.html#libpysal.cg.geointerpolate" title="libpysal.cg.geointerpolate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.geointerpolate</span></code></a>(p0, p1, t[, lonx])</p></td>
<td><p>Finds a point on a sphere along the great circle distance between two points on a sphere also known as a way point in great circle navigation</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.geogrid.html#libpysal.cg.geogrid" title="libpysal.cg.geogrid"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.geogrid</span></code></a>(pup, pdown, k[, lonx])</p></td>
<td><p>Computes a k+1 by k+1 set of grid points for a bounding box in lat-lon uses geointerpolate</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="shapes">
<h3>shapes<a class="headerlink" href="#shapes" title="Permalink to this headline">¶</a></h3>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.Point.html#libpysal.cg.Point" title="libpysal.cg.Point"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.Point</span></code></a>(loc)</p></td>
<td><p>Geometric class for point objects.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.LineSegment.html#libpysal.cg.LineSegment" title="libpysal.cg.LineSegment"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.LineSegment</span></code></a>(start_pt, end_pt)</p></td>
<td><p>Geometric representation of line segment objects.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.Line.html#libpysal.cg.Line" title="libpysal.cg.Line"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.Line</span></code></a>(m, b)</p></td>
<td><p>Geometric representation of line objects.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.Ray.html#libpysal.cg.Ray" title="libpysal.cg.Ray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.Ray</span></code></a>(origin, second_p)</p></td>
<td><p>Geometric representation of ray objects.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.Chain.html#libpysal.cg.Chain" title="libpysal.cg.Chain"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.Chain</span></code></a>(vertices)</p></td>
<td><p>Geometric representation of a chain, also known as a polyline.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.Polygon.html#libpysal.cg.Polygon" title="libpysal.cg.Polygon"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.Polygon</span></code></a>(vertices[, holes])</p></td>
<td><p>Geometric representation of polygon objects.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.Rectangle.html#libpysal.cg.Rectangle" title="libpysal.cg.Rectangle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.Rectangle</span></code></a>(left, lower, right, upper)</p></td>
<td><p>Geometric representation of rectangle objects.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.asShape.html#libpysal.cg.asShape" title="libpysal.cg.asShape"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.asShape</span></code></a>(obj)</p></td>
<td><p>Returns a pysal shape object from obj.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="standalone">
<h3>standalone<a class="headerlink" href="#standalone" title="Permalink to this headline">¶</a></h3>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.bbcommon.html#libpysal.cg.bbcommon" title="libpysal.cg.bbcommon"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.bbcommon</span></code></a>(bb, bbother)</p></td>
<td><p>Old Stars method for bounding box overlap testing Also defined in pysal.weights._cont_binning</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.get_bounding_box.html#libpysal.cg.get_bounding_box" title="libpysal.cg.get_bounding_box"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.get_bounding_box</span></code></a>(items)</p></td>
<td><p>Find bounding box for a list of geometries</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.get_angle_between.html#libpysal.cg.get_angle_between" title="libpysal.cg.get_angle_between"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.get_angle_between</span></code></a>(ray1, ray2)</p></td>
<td><p>Returns the angle formed between a pair of rays which share an origin get_angle_between(Ray, Ray) -> number</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.is_collinear.html#libpysal.cg.is_collinear" title="libpysal.cg.is_collinear"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.is_collinear</span></code></a>(p1, p2, p3)</p></td>
<td><p>Returns whether a triplet of points is collinear.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.get_segments_intersect.html#libpysal.cg.get_segments_intersect" title="libpysal.cg.get_segments_intersect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.get_segments_intersect</span></code></a>(seg1, seg2)</p></td>
<td><p>Returns the intersection of two segments.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.get_segment_point_intersect.html#libpysal.cg.get_segment_point_intersect" title="libpysal.cg.get_segment_point_intersect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.get_segment_point_intersect</span></code></a>(seg, pt)</p></td>
<td><p>Returns the intersection of a segment and point.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.get_polygon_point_intersect.html#libpysal.cg.get_polygon_point_intersect" title="libpysal.cg.get_polygon_point_intersect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.get_polygon_point_intersect</span></code></a>(poly, pt)</p></td>
<td><p>Returns the intersection of a polygon and point.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.get_rectangle_point_intersect.html#libpysal.cg.get_rectangle_point_intersect" title="libpysal.cg.get_rectangle_point_intersect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.get_rectangle_point_intersect</span></code></a>(…)</p></td>
<td><p>Returns the intersection of a rectangle and point.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.get_ray_segment_intersect.html#libpysal.cg.get_ray_segment_intersect" title="libpysal.cg.get_ray_segment_intersect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.get_ray_segment_intersect</span></code></a>(ray, seg)</p></td>
<td><p>Returns the intersection of a ray and line segment.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.get_rectangle_rectangle_intersection.html#libpysal.cg.get_rectangle_rectangle_intersection" title="libpysal.cg.get_rectangle_rectangle_intersection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.get_rectangle_rectangle_intersection</span></code></a>(r0, r1)</p></td>
<td><p>Returns the intersection between two rectangles.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.get_polygon_point_dist.html#libpysal.cg.get_polygon_point_dist" title="libpysal.cg.get_polygon_point_dist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.get_polygon_point_dist</span></code></a>(poly, pt)</p></td>
<td><p>Returns the distance between a polygon and point.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.get_points_dist.html#libpysal.cg.get_points_dist" title="libpysal.cg.get_points_dist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.get_points_dist</span></code></a>(pt1, pt2)</p></td>
<td><p>Returns the distance between a pair of points.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.get_segment_point_dist.html#libpysal.cg.get_segment_point_dist" title="libpysal.cg.get_segment_point_dist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.get_segment_point_dist</span></code></a>(seg, pt)</p></td>
<td><p>Returns the distance between a line segment and point and distance along the segment of the closest point on the segment to the point as a ratio of the length of the segment.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.get_point_at_angle_and_dist.html#libpysal.cg.get_point_at_angle_and_dist" title="libpysal.cg.get_point_at_angle_and_dist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.get_point_at_angle_and_dist</span></code></a>(ray, …)</p></td>
<td><p>Returns the point at a distance and angle relative to the origin of a ray.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.convex_hull.html#libpysal.cg.convex_hull" title="libpysal.cg.convex_hull"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.convex_hull</span></code></a>(points)</p></td>
<td><p>Returns the convex hull of a set of points.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.is_clockwise.html#libpysal.cg.is_clockwise" title="libpysal.cg.is_clockwise"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.is_clockwise</span></code></a>(vertices)</p></td>
<td><p>Returns whether a list of points describing a polygon are clockwise or counterclockwise.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.point_touches_rectangle.html#libpysal.cg.point_touches_rectangle" title="libpysal.cg.point_touches_rectangle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.point_touches_rectangle</span></code></a>(point, rect)</p></td>
<td><p>Returns True if the point is in the rectangle or touches it’s boundary.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.get_shared_segments.html#libpysal.cg.get_shared_segments" title="libpysal.cg.get_shared_segments"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.get_shared_segments</span></code></a>(poly1, poly2)</p></td>
<td><p>Returns the line segments in common to both polygons.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.distance_matrix.html#libpysal.cg.distance_matrix" title="libpysal.cg.distance_matrix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.distance_matrix</span></code></a>(X[, p, threshold])</p></td>
<td><p>Calculate a distance matrix</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="locators">
<h3>locators<a class="headerlink" href="#locators" title="Permalink to this headline">¶</a></h3>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.Grid.html#libpysal.cg.Grid" title="libpysal.cg.Grid"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.Grid</span></code></a>(bounds, resolution)</p></td>
<td><p>Representation of a binning data structure.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.cg.PointLocator.html#libpysal.cg.PointLocator" title="libpysal.cg.PointLocator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.PointLocator</span></code></a>(points)</p></td>
<td><p>An abstract representation of a point indexing data structure.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.PolygonLocator.html#libpysal.cg.PolygonLocator" title="libpysal.cg.PolygonLocator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.PolygonLocator</span></code></a>(polygons)</p></td>
<td><p>An abstract representation of a polygon indexing data structure.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="kdtree">
<h3>kdtree<a class="headerlink" href="#kdtree" title="Permalink to this headline">¶</a></h3>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.cg.KDTree.html#libpysal.cg.KDTree" title="libpysal.cg.KDTree"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.cg.KDTree</span></code></a>(data[, leafsize, …])</p></td>
<td><p>kd-tree built on top of kd-tree functionality in scipy.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="io">
<h2>io<a class="headerlink" href="#io" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.io.open.html#libpysal.io.open" title="libpysal.io.open"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.io.open</span></code></a></p></td>
<td><p>alias of <a class="reference internal" href="generated/libpysal.io.fileio.FileIO.html#libpysal.io.fileio.FileIO" title="libpysal.io.fileio.FileIO"><code class="xref py py-class docutils literal notranslate"><span class="pre">libpysal.io.fileio.FileIO</span></code></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.io.fileio.FileIO.html#libpysal.io.fileio.FileIO" title="libpysal.io.fileio.FileIO"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.io.fileio.FileIO</span></code></a>([dataPath, mode, …])</p></td>
<td><p>Metaclass for supporting spatial data file read and write</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="examples">
<h2>examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.examples.available.html#libpysal.examples.available" title="libpysal.examples.available"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.examples.available</span></code></a>()</p></td>
<td><p>List available datasets.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/libpysal.examples.explain.html#libpysal.examples.explain" title="libpysal.examples.explain"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.examples.explain</span></code></a>(name)</p></td>
<td><p>Explain a dataset by name.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/libpysal.examples.get_path.html#libpysal.examples.get_path" title="libpysal.examples.get_path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">libpysal.examples.get_path</span></code></a>(file_name)</p></td>
<td><p>Get the path for a file by searching installed datasets.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<p class="pull-right">
<a href="#">Back to top</a>
<br/>
<div id="sourcelink">
<a href="_sources/api.rst.txt"
rel="nofollow">Source</a>
</div>
</p>
<p>
© Copyright 2018-, pysal developers.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.4.<br/>
</p>
</div>
</footer>
</body>
</html>