yaw.autocorrelate#

yaw.autocorrelate(config: Configuration, data: Catalog, random: Catalog, *, count_rr: bool = True, progress: bool = False, max_workers: int | None = None) → list[CorrFunc][source]#

Measure the angular autocorrelation amplitude of an object catalog.

The autocorrelation amplitude is measured in slices of redshift, which requires that the data sample and its randoms have redshifts attached. If any of the input catalogs have weights, they will be used to weight the pair counts accordingly.

Parameters:

  • config – Configuration defining the redshift binning and correlation scales.

  • data – Catalog holding the data sample.

  • random – Catalog holding the random sample.

Keyword Arguments:

  • count_rr – Whether to count the random-random pair counts, which enables using the Landy-Szalay correlation estimator (recommended when measuring on scales of a few Mpc and above).

  • progress – Show a progress on the terminal (disabled by default).

  • max_workers – Limit the number of parallel workers for this operation (all by default, only multiprocessing).

Returns:

List of CorrFunc containers with pair counts (one for each configured scale).

Raises:

  • ValueError – If no randoms are provided.

  • InconsistentPatchesError – If the patches of the data or random catalog do not overlap.

On this page