Correlation measurements

The measurements of the cross- and autocorrelation amplitudes are implemented in two functions, which both take a configuration object, and multiple data catalogs as input:

crosscorrelate(config, reference, unknown, *)	Measure the angular cross-correlation amplitude between two object catalogs.
autocorrelate(config, data, random, *[, ...])	Measure the angular autocorrelation amplitude of an object catalog.

Similar versions exist for scalar-field correlation functions.

crosscorrelate_scalar(config, reference, ...)	Measure the angular cross-correlation amplitude between two object catalogs, with one of the catalogue being the scalar field.
autocorrelate_scalar(config, data, *[, ...])	Measure the angular autocorrelation amplitude of a scalar field.

Correlation functions

The functions above return a special container that collects and stores all pairs counted per redshift bin and combination of spatial patches (used to estimate covariances):

CorrFunc(dd[, dr, rd, rr])	Container for correlation function amplitude pair counts.
ScalarCorrFunc(dd[, dr])	Container for scalar field correlation function amplitude pair counts.

The container itself is a wrapper around another set of containers that store the normalised pair counts per patch and redshift, which in turn store the raw pair counts and metadata required to normalise the pair counts correctly:

correlation.NormalisedCounts(counts, sum_weights)	Stores normalised pair counts from a correlation measurement.
correlation.PatchedCounts(binning, counts, ...)	Stores the pair counts in spatial patches from catalogs in a correlation measurement.
correlation.PatchedSumWeights(binning, ...)	Stores the sum of weights in spatial patches from catalogs in a correlation measurement.