pointpats.K

class pointpats.K(pp, intervals=10, dmin=0.0, dmax=None, d=None)[source]

Estimates the K function for a point pattern.

Parameters
ppPointPattern

Point Pattern instance.

intervalsint

The length of distance domain sequence.

dminfloat

The minimum of the distance domain.

dmaxfloat

The maximum of the distance domain.

dsequence

The distance domain sequence. If d is specified, intervals, dmin and dmax are ignored.

Notes

The \(K\) function is estimated using

\[\hat{K}(h) = \frac{a}{n (n-1)} \sum_{i} \sum_{j \ne i} I(d_{i,j} \le h)\]

where \(a\) is the area of the window, \(n\) the number of event points, and \(I(d_{i,j} \le h)\) is an indicator function returning 1 when points i and j are separated by a distance of \(h\) or less, 0 otherwise.

Attributes
darray

The distance domain sequence.

karray

K function over d.

__init__(self, pp, intervals=10, dmin=0.0, dmax=None, d=None)[source]

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(self, pp[, intervals, dmin, dmax, d])

Initialize self.

plot(self[, qq])

Plot the distance function

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.