yaw.correlation.autocorrelate#

yaw.correlation.autocorrelate(config: Configuration, data: BaseCatalog, random: BaseCatalog, *, linkage: PatchLinkage | None = None, compute_rr: bool = True, progress: bool = False) → CorrFunc | dict[str, CorrFunc][source]#

Compute an angular autocorrelation function in bins of redshift.

The correlation is measured on fixed physical scales that are converted to angles for each redshift bin. All parameters (binning, scales, etc.) are bundled in the input configuration, see yaw.config.

Note

Both the data and random catalogue require redshift point estimates.

Parameters:

config (Configuration) – Provides all major run parameters, such as scales, binning, and for the correlation measurement backend.
data (BaseCatalog) – The data sample catalogue.
random (BaseCatalog) – Random catalogue for the data sample.

Keyword Arguments:

linkage (PatchLinkage, optional) – Provide a linkage object that determines which spatial patches must be correlated given the measurement scales. Ensures consistency when measuring correlations repeatedly for a fixed set of input catalogues. Generated automatically by default.
compute_rr (bool) – Whether the random-random (RR) pair counts are computed.
progress (bool) – Display a progress bar.

Returns:

Container that holds the measured pair counts, or a dictionary of containers if multiple scales are configured. Dictionary keys have a kpcXXtXX pattern, where XX are the lower and upper scale limit as integers, in kpc (see yaw.core.cosmology.Scale).

Return type:

CorrFunc or dict[str, CorrFunc]