yaw.correlation.estimators.Hamilton#

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

Bases: CorrelationEstimator

Implementation of the Hamilton correlation estimator \(\frac{DD \times RR}{DR \times RD} - 1\).

Methods

__init__()

eval(*, dd, dr, rr[, rd])

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: NDArray, rr: NDArray, rd: NDArray | None = None) → NDArray[source]#

Evaluate the estimator with the given pair counts.

Parameters:

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

  • dr (NDArray) – Data-random pair counts (normalised).

  • rd (NDArray, optional) – Random-data pair counts (normalised). If not provided, use dr instead.

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

Returns:

NDArray

name: str = 'Hamilton'#

Full name of the estimator.

optional: list[Cts] = [<CtsRD>]#

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

requires: list[Cts] = [<CtsDD>, <CtsDR>, <CtsRR>]#

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

short: str = 'HM'#

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.