yaw.correlation.estimators.PeeblesHauser#

class yaw.correlation.estimators.PeeblesHauser[source]#

Bases: CorrelationEstimator

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

Methods

__init__()

eval(*, dd, rr, **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, rr: NDArray, **kwargs) → NDArray[source]#

Evaluate the estimator with the given pair counts.

Parameters:

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

  • rr (NDArray) – Random-random pair counts (normalised).

Returns:

NDArray

name: str = 'PeeblesHauser'#

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>, <CtsRR>]#

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

short: str = 'PH'#

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.