yaw.correlation.estimators.DavisPeebles

class yaw.correlation.estimators.DavisPeebles

Bases: CorrelationEstimator

Implementation of the Davis-Peebles correlation estimator \(\frac{DD}{DR} - 1\).

Note

Accepts both \(DR\) and \(RD\) for the denominator.

Methods

__init__()
eval(*, dd, dr_rd, **kwargs)	Evaluate the estimator with the given pair counts.

Attributes

name	Full name of the estimator.
optional	Get a symbolic list of optional pair counts that may be used to evaluate the estimator.
requires	Get a symbolic list of pair counts required to evaluate the estimator.
short	Get a short form representation of the estimator name.
variants	List of all implemented correlation estimators classes.

classmethod eval(*, dd: NDArray, dr_rd: NDArray, **kwargs) → NDArray

Evaluate the estimator with the given pair counts.

Parameters:

• dd (NDArray) – Data-data pair counts (normalised).

• dr_rd (NDArray) – Either data-random or random-data pair counts (normalised).

Returns:

NDArray

name: str = 'DavisPeebles'

Full name of the estimator.

optional: list[Cts] = []

Get a symbolic list of optional pair counts that may be used to evaluate the estimator.

requires: list[Cts] = [<CtsDD>, <CtsMix>]

Get a symbolic list of pair counts required to evaluate the estimator.

short: str = 'DP'

Get a short form representation of the estimator name.

variants: list[CorrelationEstimator] = [<class 'yaw.correlation.estimators.PeeblesHauser'>, <class 'yaw.correlation.estimators.DavisPeebles'>, <class 'yaw.correlation.estimators.Hamilton'>, <class 'yaw.correlation.estimators.LandySzalay'>]

List of all implemented correlation estimators classes.