Package pylal :: Module kdes :: Class BoundedKDE
[hide private]
[frames] | no frames]

Class BoundedKDE

source code

scipy.stats.gaussian_kde --+
                           |
                          BoundedKDE

Density estimation using a KDE on bounded domains.

Bounds can be any combination of low or high (if no bound, set to
``float('inf')`` or ``float('-inf')``), and can be periodic or
non-periodic.  Cannot handle topologies that have
multi-dimensional periodicities; will only handle topologies that
are direct products of (arbitrary numbers of) R, [0,1], and S1.

:param pts:
    ``(Ndim, Npts)`` shaped array of points (as in :class:`gaussian_kde`).

:param low: 
    Lower bounds; if ``None``, assume no lower bounds.

:param high:
    Upper bounds; if ``None``, assume no upper bounds.

:param periodic:
    Boolean array giving periodicity in each dimension; if
    ``None`` assume no dimension is periodic.

:param bw_method: (optional)
    Bandwidth estimation method (see :class:`gaussian_kde`).

Instance Methods [hide private]
 
__init__(self, pts, low=None, high=None, periodic=None, bw_method=None) source code
 
evaluate(self, pts)
Evaluate the KDE at the given points.
source code
 
__call__(self, pts)
Evaluate the KDE at the given points.
source code
 
quantile(self, pt)
Quantile of ``pt``, evaluated by a greedy algorithm.
source code
Method Details [hide private]

quantile(self, pt)

source code 
Quantile of ``pt``, evaluated by a greedy algorithm.

:param pt:
    The point at which the quantile value is to be computed.

The quantile of ``pt`` is the fraction of points used to
construct the KDE that have a lower KDE density than ``pt``.