-
Notifications
You must be signed in to change notification settings - Fork 26
/
distance_statistics.py
1006 lines (855 loc) · 33.4 KB
/
distance_statistics.py
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
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
Distance statistics for planar point patterns
"""
__author__ = "Serge Rey sjsrey@gmail.com"
__all__ = ['DStatistic', 'G', 'F', 'J', 'K', 'L', 'Envelopes', 'Genv', 'Fenv', 'Jenv', 'Kenv', 'Lenv']
from .process import PoissonPointProcess as csr
import numpy as np
from matplotlib import pyplot as plt
class DStatistic(object):
"""
Abstract Base Class for distance statistics.
Parameters
----------
name : string
Name of the function. ("G", "F", "J", "K" or "L")
Attributes
----------
d : array
The distance domain sequence.
"""
def __init__(self, name):
self.name = name
def plot(self, qq=False):
"""
Plot the distance function
Parameters
----------
qq: Boolean
If False the statistic is plotted against distance. If Frue, the
quantile-quantile plot is generated, observed vs. CSR.
"""
# assuming mpl
x = self.d
if qq:
plt.plot(self.ev, self._stat)
plt.plot(self.ev, self.ev)
else:
plt.plot(x, self._stat, label='{}'.format(self.name))
plt.ylabel("{}(d)".format(self.name))
plt.xlabel('d')
plt.plot(x, self.ev, label='CSR')
plt.title("{} distance function".format(self.name))
class G(DStatistic):
"""
Estimates the nearest neighbor distance distribution function G for a
point pattern.
Parameters
----------
pp : :class:`.PointPattern`
Point Pattern instance.
intervals : int
The length of distance domain sequence.
dmin : float
The minimum of the distance domain.
dmax : float
The maximum of the distance domain.
d : sequence
The distance domain sequence.
If d is specified, intervals, dmin and dmax are ignored.
Attributes
----------
name : string
Name of the function. ("G", "F", "J", "K" or "L")
d : array
The distance domain sequence.
G : array
The cumulative nearest neighbor distance distribution over d.
Notes
-----
In the analysis of planar point processes, the estimate of :math:`G` is
typically compared to the value expected from a completely spatial
random (CSR) process given as:
.. math::
G(d) = 1 - e^{-\lambda \pi d^2}
where :math:`\lambda` is the intensity (points per unit area) of the point
process and :math:`d` is distance.
For a clustered pattern, the empirical function will be above the
expectation, while for a uniform pattern the empirical function falls below
the expectation.
"""
def __init__(self, pp, intervals=10, dmin=0.0, dmax=None, d=None):
res = _g(pp, intervals, dmin, dmax, d)
self.d = res[:, 0]
self.G = self._stat = res[:, 1]
self.ev = 1 - np.exp(-pp.lambda_window * np.pi * self.d * self.d)
self.pp = pp
super(G, self).__init__(name="G")
class F(DStatistic):
"""
Estimates the empty space distribution function for a point pattern: F(d).
Parameters
----------
pp : :class:`.PointPattern`
Point Pattern instance.
n : int
Number of empty space points (random points).
intervals : int
The length of distance domain sequence.
dmin : float
The minimum of the distance domain.
dmax : float
The maximum of the distance domain.
d : sequence
The distance domain sequence.
If d is specified, intervals, dmin and dmax are ignored.
Attributes
----------
d : array
The distance domain sequence.
G : array
The cumulative empty space nearest event distance distribution
over d.
Notes
-----
In the analysis of planar point processes, the estimate of :math:`F` is
typically compared to the value expected from a process that displays
complete spatial randomness (CSR):
.. math::
F(d) = 1 - e^{-\lambda \pi d^2}
where :math:`\lambda` is the intensity (points per unit area) of the point
process and :math:`d` is distance.
The expectation is identical to the expectation for the :class:`G` function
for a CSR process. However, for a clustered pattern, the empirical G
function will be below the expectation, while for a uniform pattern the
empirical function falls above the expectation.
"""
def __init__(self, pp, n=100, intervals=10, dmin=0.0, dmax=None, d=None):
res = _f(pp, n, intervals, dmin, dmax, d)
self.d = res[:, 0]
self.F = self._stat = res[:, 1]
self.ev = 1 - np.exp(-pp.lambda_window * np.pi * self.d * self.d)
super(F, self).__init__(name="F")
class J(DStatistic):
"""
Estimates the J function for a point pattern :cite:`VanLieshout1996`
Parameters
----------
pp : :class:`.PointPattern`
Point Pattern instance.
n : int
Number of empty space points (random points).
intervals : int
The length of distance domain sequence.
dmin : float
The minimum of the distance domain.
dmax : float
The maximum of the distance domain.
d : sequence
The distance domain sequence.
If d is specified, intervals, dmin and dmax are ignored.
Attributes
----------
d : array
The distance domain sequence.
j : array
F function over d.
Notes
-----
The :math:`J` function is a ratio of the hazard functions defined for
:math:`G` and :math:`F`:
.. math::
J(d) = \\frac{1-G(d) }{1-F(d)}
where :math:`G(d)` is the nearest neighbor distance distribution function
(see :class:`G`)
and :math:`F(d)` is the empty space function (see :class:`F`).
For a CSR process the J function equals 1. Empirical values larger than 1
are indicative of uniformity, while values below 1 suggest clustering.
"""
def __init__(self, pp, n=100, intervals=10, dmin=0.0, dmax=None, d=None):
res = _j(pp, n, intervals, dmin, dmax, d)
self.d = res[:, 0]
self.j = self._stat = res[:, 1]
self.ev = self.j / self.j
super(J, self).__init__(name="J")
class K(DStatistic):
"""
Estimates the K function for a point pattern.
Parameters
----------
pp : :class:`.PointPattern`
Point Pattern instance.
intervals : int
The length of distance domain sequence.
dmin : float
The minimum of the distance domain.
dmax : float
The maximum of the distance domain.
d : sequence
The distance domain sequence.
If d is specified, intervals, dmin and dmax are ignored.
Attributes
----------
d : array
The distance domain sequence.
k : array
K function over d.
Notes
-----
The :math:`K` function is estimated using
.. math::
\\hat{K}(h) = \\frac{a}{n (n-1)} \\sum_{i} \\sum_{j \\ne i} I(d_{i,j} \\le h)
where :math:`a` is the area of the window, :math:`n` the number of event points, and :math:`I(d_{i,j} \le h)` is an indicator function returning 1 when points i and j are separated by a distance of :math:`h` or less, 0 otherwise.
"""
def __init__(self, pp, intervals=10, dmin=0.0, dmax=None, d=None):
res = _k(pp, intervals, dmin, dmax, d)
self.d = res[:, 0]
self.k = self._stat = res[:, 1]
self.ev = np.pi * self.d * self.d
super(K, self).__init__(name="K")
class L(DStatistic):
"""
Estimates the l function for a point pattern.
Parameters
----------
pp : :class:`.PointPattern`
Point Pattern instance.
intervals : int
The length of distance domain sequence.
dmin : float
The minimum of the distance domain.
dmax : float
The maximum of the distance domain.
d : sequence
The distance domain sequence.
If d is specified, intervals, dmin and dmax are ignored.
Attributes
----------
d : array
The distance domain sequence.
l : array
L function over d.
"""
def __init__(self, pp, intervals=10, dmin=0.0, dmax=None, d=None):
res = _l(pp, intervals, dmin, dmax, d)
self.d = res[:, 0]
self.l = self._stat = res[:, 1]
super(L, self).__init__(name="L")
def plot(self):
# assuming mpl
x = self.d
plt.plot(x, self._stat, label='{}'.format(self.name))
plt.ylabel("{}(d)".format(self.name))
plt.xlabel('d')
plt.title("{} distance function".format(self.name))
def _g(pp, intervals=10, dmin=0.0, dmax=None, d=None):
"""
Estimate the nearest neighbor distances function G.
Parameters
----------
pp : :class:`.PointPattern`
Point Pattern instance.
intevals : int
Number of intervals to evaluate F over.
dmin : float
Lower limit of distance range.
dmax : float
Upper limit of distance range. If dmax is None, dmax will be set
to maximum nearest neighor distance.
d : sequence
The distance domain sequence. If d is specified, intervals, dmin
and dmax are ignored.
Returns
-------
: array
A 2-dimensional numpy array of 2 columns. The first column is
the distance domain sequence for the point pattern. The second
column is the cumulative nearest neighbor distance distribution.
Notes
-----
See :class:`G`.
"""
if d is None:
w = pp.max_nnd/intervals
if dmax:
w = dmax/intervals
d = [w*i for i in range(intervals + 2)]
cdf = [0] * len(d)
for i, d_i in enumerate(d):
smaller = [nndi for nndi in pp.nnd if nndi <= d_i]
cdf[i] = len(smaller)*1./pp.n
return np.vstack((d, cdf)).T
def _f(pp, n=100, intervals=10, dmin=0.0, dmax=None, d=None):
"""
F empty space function.
Parameters
----------
pp : :class:`.PointPattern`
Point Pattern instance.
n : int
Number of empty space points (random points).
intevals : int
Number of intervals to evaluate F over.
dmin : float
Lower limit of distance range.
dmax : float
Upper limit of distance range. If dmax is None, dmax will be set
to maximum nearest neighor distance.
d : sequence
The distance domain sequence. If d is specified, intervals, dmin
and dmax are ignored.
Returns
-------
: array
A 2-dimensional numpy array of 2 columns. The first column is
the distance domain sequence for the point pattern. The second
column is corresponding F function.
Notes
-----
See :class:`.F`
"""
# get a csr pattern in window of pp
c = csr(pp.window, n, 1, asPP=True).realizations[0]
# for each point in csr pattern find the closest point in pp and the
# associated distance
nnids, nnds = pp.knn_other(c, k=1)
if d is None:
w = pp.max_nnd/intervals
if dmax:
w = dmax/intervals
d = [w*i for i in range(intervals + 2)]
cdf = [0] * len(d)
for i, d_i in enumerate(d):
smaller = [nndi for nndi in nnds if nndi <= d_i]
cdf[i] = len(smaller)*1./n
return np.vstack((d, cdf)).T
def _j(pp, n=100, intervals=10, dmin=0.0, dmax=None, d=None):
"""
J function: Ratio of hazard functions for F and G.
Parameters
----------
pp : :class:`.PointPattern`
Point Pattern instance.
n : int
Number of empty space points (random points).
intevals : int
Number of intervals to evaluate F over.
dmin : float
Lower limit of distance range.
dmax : float
Upper limit of distance range. If dmax is None, dmax will be set
to maximum nearest neighor distance.
d : sequence
The distance domain sequence. If d is specified, intervals, dmin
and dmax are ignored.
Returns
-------
: array
A 2-dimensional numpy array of 2 columns. The first column is
the distance domain sequence for the point pattern. The second
column is corresponding J function.
Notes
-----
See :class:`.J`
"""
F = _f(pp, n, intervals=intervals, dmin=dmin, dmax=dmax, d=d)
G = _g(pp, intervals=intervals, dmin=dmin, dmax=dmax, d=d)
FC = 1 - F[:, 1]
GC = 1 - G[:, 1]
last_id = len(GC) + 1
if np.any(FC == 0):
last_id = np.where(FC == 0)[0][0]
return np.vstack((F[:last_id, 0], GC[:last_id]/FC[:last_id])).T
def _k(pp, intervals=10, dmin=0.0, dmax=None, d=None):
"""
Interevent K function.
Parameters
----------
pp : :class:`.PointPattern`
Point Pattern instance.
n : int
Number of empty space points (random points).
intevals : int
Number of intervals to evaluate F over.
dmin : float
Lower limit of distance range.
dmax : float
Upper limit of distance range. If dmax is None, dmax will be set to one-quarter of the minimum side of the minimum bounding rectangle.
d : sequence
The distance domain sequence. If d is specified, intervals, dmin
and dmax are ignored.
Returns
-------
kcdf : array
A 2-dimensional numpy array of 2 columns. The first column is
the distance domain sequence for the point pattern. The second
column is corresponding K function.
Notes
-----
See :class:`.K`
"""
if d is None:
w = pp.rot/intervals
if dmax:
w = dmax/intervals
d = [w*i for i in range(intervals + 2)]
den = pp.lambda_window * (pp.n - 1)
kcdf = np.asarray([(di, len(pp.tree.query_pairs(di)) * 2 / den ) for di in d])
return kcdf
def _l(pp, intervals=10, dmin=0.0, dmax=None, d=None):
"""
Interevent L function.
Parameters
----------
pp : :class:`.PointPattern`
Point Pattern instance.
n : int
Number of empty space points (random points).
intevals : int
Number of intervals to evaluate F over.
dmin : float
Lower limit of distance range.
dmax : float
Upper limit of distance range. If dmax is None, dmax will be set
to length of bounding box diagonal.
d : sequence
The distance domain sequence. If d is specified, intervals, dmin
and dmax are ignored.
Returns
-------
kf : array
A 2-dimensional numpy array of 2 columns. The first column is
the distance domain sequence for the point pattern. The second
column is corresponding L function.
Notes
-----
See :class:`.L`
"""
kf = _k(pp, intervals, dmin, dmax, d)
kf[:, 1] = np.sqrt(kf[:, 1] / np.pi) - kf[:, 0]
return kf
class Envelopes(object):
"""
Abstract base class for simulation envelopes.
Parameters
----------
pp : :class:`.PointPattern`
Point Pattern instance.
intervals : int
The length of distance domain sequence. Default is 10.
dmin : float
The minimum of the distance domain.
dmax : float
The maximum of the distance domain.
d : sequence
The distance domain sequence.
If d is specified, intervals, dmin and dmax are ignored.
pct : float
1-alpha, alpha is the significance level. Default is 0.05,
1-alpha is the confidence level for the envelope.
realizations: :class:`.PointProcess`
Point process instance with more than 1 realizations.
Attributes
----------
name : string
Name of the function. ("G", "F", "J", "K" or "L")
observed : array
A 2-dimensional numpy array of 2 columns. The first column is
the distance domain sequence for the observed point pattern.
The second column is the specific function ("G", "F", "J",
"K" or "L") over the distance domain sequence for the
observed point pattern.
low : array
A 1-dimensional numpy array. Lower bound of the simulation
envelope.
high : array
A 1-dimensional numpy array. Higher bound of the simulation
envelope.
mean : array
A 1-dimensional numpy array. Mean values of the simulation
envelope.
"""
def __init__(self, *args, **kwargs):
# setup arguments
self.name = kwargs['name']
# calculate observed function
self.pp = args[0]
self.observed = self.calc(*args, **kwargs)
self.d = self.observed[:, 0] # domain to be used in all realizations
# do realizations
self.mapper(kwargs['realizations'])
def mapper(self, realizations):
reals = realizations.realizations
res = np.asarray([self.calc(reals[p]) for p in reals])
# When calculating the J function for all the simulations, the length
# of the returned interval domains might be different.
if self.name == "J":
res = []
for p in reals:
j = self.calc(reals[p])
if j.shape[0] < self.d.shape[0]:
diff = self.d.shape[0]-j.shape[0]
for i in range(diff):
j = np.append(j, [[self.d[i+diff], np.inf]], axis=0)
res.append(j)
res = np.array(res)
res = res[:, :, -1]
res.sort(axis=0)
nres = len(res)
self.low = res[np.int(nres * self.pct/2.)]
self.high = res[np.int(nres * (1-self.pct/2.))]
self.mean = res.mean(axis=0)
def calc(self, *args, **kwargs):
print('implement in subclass')
def plot(self):
# assuming mpl
x = self.d
plt.plot(x, self.observed[:, 1], label='{}'.format(self.name))
plt.plot(x, self.mean, 'g-.', label='CSR')
plt.plot(x, self.low, 'r-.', label='LB')
plt.plot(x, self.high, 'r-.', label="UB")
plt.ylabel("{}(d)".format(self.name))
plt.xlabel('d')
plt.title("{} Simulation Envelopes".format(self.name))
plt.legend(loc=0)
class Genv(Envelopes):
"""
Simulation envelope for G function.
Parameters
----------
pp : :class:`.PointPattern`
Point Pattern instance.
intervals : int
The length of distance domain sequence. Default is 10.
dmin : float
The minimum of the distance domain.
dmax : float
Upper limit of distance range. If dmax is None, dmax will be
set to maximum nearest neighbor distance.
d : sequence
The distance domain sequence.
If d is specified, intervals, dmin and dmax are ignored.
pct : float
1-alpha, alpha is the significance level. Default is 0.05,
which means 95% confidence level for the envelopes.
realizations: :class:`.PointProcess`
Point process instance with more than 1 realizations.
Attributes
----------
name : string
Name of the function. ("G", "F", "J", "K" or "L")
observed : array
A 2-dimensional numpy array of 2 columns. The first column is
the distance domain sequence for the observed point pattern.
The second column is cumulative nearest neighbor distance
distribution (G function) for the observed point pattern.
low : array
A 1-dimensional numpy array. Lower bound of the simulation
envelope.
high : array
A 1-dimensional numpy array. Higher bound of the simulation
envelope.
mean : array
A 1-dimensional numpy array. Mean values of the simulation
envelope.
Examples
--------
.. plot::
>>> import libpysal as ps
>>> from pointpats import Genv, PoissonPointProcess, Window
>>> from libpysal.cg import shapely_ext
>>> va = ps.io.open(ps.examples.get_path("vautm17n.shp"))
>>> polys = [shp for shp in va]
>>> state = shapely_ext.cascaded_union(polys)
>>> pp = PoissonPointProcess(Window(state.parts), 100, 1, asPP=True).realizations[0]
>>> csrs = PoissonPointProcess(pp.window, 100, 100, asPP=True)
>>> genv_bb = Genv(pp, realizations=csrs)
>>> genv_bb.plot()
"""
def __init__(self, pp, intervals=10, dmin=0.0, dmax=None, d=None, pct=0.05,
realizations=None):
self.pp = pp
self.intervals = intervals
self.dmin = dmin
self.dmax = dmax
self.d = d
self.pct = pct
super(Genv, self).__init__(pp, realizations=realizations, name="G")
def calc(self, *args, **kwargs):
pp = args[0]
return _g(pp, intervals=self.intervals, dmin=self.dmin, dmax=self.dmax,
d=self.d)
class Fenv(Envelopes):
"""
Simulation envelope for F function.
Parameters
----------
pp : :class:`.PointPattern`
Point Pattern instance.
n : int
Number of empty space points (random points).
intervals : int
The length of distance domain sequence. Default is 10.
dmin : float
The minimum of the distance domain.
dmax : float
Upper limit of distance range. If dmax is None, dmax will be
set to maximum nearest neighbor distance.
d : sequence
The distance domain sequence.
If d is specified, intervals, dmin and dmax are ignored.
pct : float
1-alpha, alpha is the significance level. Default is 0.05,
which means 95% confidence level for the envelopes.
realizations: :class:`.PointProcess`
Point process instance with more than 1 realizations.
Attributes
----------
name : string
Name of the function. ("G", "F", "J", "K" or "L")
observed : array
A 2-dimensional numpy array of 2 columns. The first column is
the distance domain sequence for the observed point pattern.
The second column is F function for the observed point
pattern.
low : array
A 1-dimensional numpy array. Lower bound of the simulation
envelope.
high : array
A 1-dimensional numpy array. Higher bound of the simulation
envelope.
mean : array
A 1-dimensional numpy array. Mean values of the simulation
envelope.
Examples
--------
.. plot::
>>> import libpysal as ps
>>> from libpysal.cg import shapely_ext
>>> from pointpats import PoissonPointProcess,Window,Fenv
>>> va = ps.io.open(ps.examples.get_path("vautm17n.shp"))
>>> polys = [shp for shp in va]
>>> state = shapely_ext.cascaded_union(polys)
>>> pp = PoissonPointProcess(Window(state.parts), 100, 1, asPP=True).realizations[0]
>>> csrs = PoissonPointProcess(pp.window, 100, 100, asPP=True)
>>> fenv = Fenv(pp, realizations=csrs)
>>> fenv.plot()
"""
def __init__(self, pp, n=100, intervals=10, dmin=0.0, dmax=None, d=None,
pct=0.05, realizations=None):
self.pp = pp
self.n = n
self.intervals = intervals
self.dmin = dmin
self.dmax = dmax
self.d = d
self.pct = pct
super(Fenv, self).__init__(pp, realizations=realizations, name="F")
def calc(self, *args, **kwargs):
pp = args[0]
return _f(pp, self.n, intervals=self.intervals, dmin=self.dmin,
dmax=self.dmax, d=self.d)
class Jenv(Envelopes):
"""
Simulation envelope for J function.
Parameters
----------
pp : :class:`.PointPattern`
Point Pattern instance.
n : int
Number of empty space points (random points).
intervals : int
The length of distance domain sequence. Default is 10.
dmin : float
The minimum of the distance domain.
dmax : float
Upper limit of distance range. If dmax is None, dmax will be
set to maximum nearest neighbor distance.
d : sequence
The distance domain sequence.
If d is specified, intervals, dmin and dmax are ignored.
pct : float
1-alpha, alpha is the significance level. Default is 0.05,
which means 95% confidence level for the envelopes.
realizations: :class:`.PointProcess`
Point process instance with more than 1 realizations.
Attributes
----------
name : string
Name of the function. ("G", "F", "J", "K" or "L")
observed : array
A 2-dimensional numpy array of 2 columns. The first column is
the distance domain sequence for the observed point pattern.
The second column is J function for the observed point
pattern.
low : array
A 1-dimensional numpy array. Lower bound of the simulation
envelope.
high : array
A 1-dimensional numpy array. Higher bound of the simulation
envelope.
mean : array
A 1-dimensional numpy array. Mean values of the simulation
envelope.
Examples
--------
.. plot::
>>> import libpysal as ps
>>> from pointpats import Jenv, PoissonPointProcess, Window
>>> from libpysal.cg import shapely_ext
>>> va = ps.io.open(ps.examples.get_path("vautm17n.shp"))
>>> polys = [shp for shp in va]
>>> state = shapely_ext.cascaded_union(polys)
>>> pp = PoissonPointProcess(Window(state.parts), 100, 1, asPP=True).realizations[0]
>>> csrs = PoissonPointProcess(pp.window, 100, 100, asPP=True)
>>> jenv = Jenv(pp, realizations=csrs)
>>> jenv.plot()
"""
def __init__(self, pp, n=100, intervals=10, dmin=0.0, dmax=None, d=None,
pct=0.05, realizations=None):
self.pp = pp
self.n = n
self.intervals = intervals
self.dmin = dmin
self.dmax = dmax
self.d = d
self.pct = pct
super(Jenv, self).__init__(pp, realizations=realizations, name="J")
def calc(self, *args, **kwargs):
pp = args[0]
return _j(pp, self.n, intervals=self.intervals, dmin=self.dmin,
dmax=self.dmax, d=self.d)
class Kenv(Envelopes):
"""
Simulation envelope for K function.
Parameters
----------
pp : :class:`.PointPattern`
Point Pattern instance.
intervals : int
The length of distance domain sequence. Default is 10.
dmin : float
The minimum of the distance domain.
dmax : float
Upper limit of distance range. If dmax is None, dmax will be
set to maximum nearest neighbor distance.
d : sequence
The distance domain sequence.
If d is specified, intervals, dmin and dmax are ignored.
pct : float
1-alpha, alpha is the significance level. Default is 0.05,
which means 95% confidence level for the envelope.
realizations: :class:`.PointProcess`
Point process instance with more than 1 realizations.
Attributes
----------
name : string
Name of the function. ("G", "F", "J", "K" or "L")
observed : array
A 2-dimensional numpy array of 2 columns. The first column is
the distance domain sequence for the observed point pattern.
The second column is K function for the observed point
pattern.
low : array
A 1-dimensional numpy array. Lower bound of the simulation
envelope.
high : array
A 1-dimensional numpy array. Higher bound of the simulation
envelope.
mean : array
A 1-dimensional numpy array. Mean values of the simulation
envelope.
Examples
--------
.. plot::
>>> import libpysal as ps
>>> from pointpats import Kenv, PoissonPointProcess, Window
>>> from libpysal.cg import shapely_ext
>>> va = ps.io.open(ps.examples.get_path("vautm17n.shp"))
>>> polys = [shp for shp in va]
>>> state = shapely_ext.cascaded_union(polys)
>>> pp = PoissonPointProcess(Window(state.parts), 100, 1, asPP=True).realizations[0]
>>> csrs = PoissonPointProcess(pp.window, 100, 100, asPP=True)
>>> kenv = Kenv(pp, realizations=csrs)
>>> kenv.plot()
"""
def __init__(self, pp, intervals=10, dmin=0.0, dmax=None, d=None,
pct=0.05, realizations=None):
self.pp = pp
self.intervals = intervals
self.dmin = dmin
self.dmax = dmax
self.d = d
self.pct = pct
super(Kenv, self).__init__(pp, realizations=realizations, name="K")
def calc(self, *args, **kwargs):
pp = args[0]
return _k(pp, intervals=self.intervals, dmin=self.dmin, dmax=self.dmax,
d=self.d)
class Lenv(Envelopes):
"""
Simulation envelope for L function.
Parameters
----------
pp : :class:`.PointPattern`
Point Pattern instance.
intervals : int
The length of distance domain sequence. Default is 10.
dmin : float
The minimum of the distance domain.
dmax : float
Upper limit of distance range. If dmax is None, dmax will be
set to maximum nearest neighbor distance.
d : sequence
The distance domain sequence.
If d is specified, intervals, dmin and dmax are ignored.
pct : float
1-alpha, alpha is the significance level. Default is 0.05,
which means 95% confidence level for the envelopes.
realizations: :class:`.PointProcess`
Point process instance with more than 1 realizations.
Attributes
----------
name : string
Name of the function. ("G", "F", "J", "K" or "L")
observed : array
A 2-dimensional numpy array of 2 columns. The first column is
the distance domain sequence for the observed point pattern.
The second column is L function for the observed point
pattern.
low : array
A 1-dimensional numpy array. Lower bound of the simulation
envelope.
high : array
A 1-dimensional numpy array. Higher bound of the simulation
envelope.
mean : array
A 1-dimensional numpy array. Mean values of the simulation
envelope.
Examples
--------
.. plot::
>>> import libpysal as ps
>>> from pointpats import Lenv, PoissonPointProcess, Window
>>> from libpysal.cg import shapely_ext
>>> va = ps.io.open(ps.examples.get_path("vautm17n.shp"))
>>> polys = [shp for shp in va]
>>> state = shapely_ext.cascaded_union(polys)
>>> pp = PoissonPointProcess(Window(state.parts), 100, 1, asPP=True).realizations[0]
>>> csrs = PoissonPointProcess(pp.window, 100, 100, asPP=True)
>>> lenv = Lenv(pp, realizations=csrs)
>>> lenv.plot()
"""
def __init__(self, pp, intervals=10, dmin=0.0, dmax=None, d=None,
pct=0.05, realizations=None):
self.pp = pp
self.intervals = intervals
self.dmin = dmin
self.dmax = dmax
self.d = d
self.pct = pct