yaw.correlation#

This module implements the computation of correlation functions with crosscorrelate() and autocorrelate() from input data catalogues, see yaw.catalogs.

These measurement methods return the main class, the correlation function CorrFunc container. It holds the normalised pair counts (in NormalisedCounts containers) computed within each spatial patch and bins of redshift. The actual correlation function values and its uncertainty (from resampling the spatial patches) can be computed using the CorrFunc.sample(), which returns a CorrData container.

For the conversion of the correlation functions to a redshift estimate refer to the yaw.redshifts module.

Submodules

Functions

autocorrelate(config, data, random, *[, ...])

Compute an angular autocorrelation function in bins of redshift.

crosscorrelate(config, reference, unknown, *)

Compute an angular crosscorrelation function in bins of redshift.

add_corrfuncs(corrfuncs[, weights])

Add correlation functions that are measured at different scales.

Classes

CorrFunc(dd[, dr, rd, rr])

Container object for measured correlation pair counts.

CorrData(binning, data, samples, method[, info])

Container class for sampled correlation function data.