yaw.correlation.paircounts

This module implements containers for storing pair counts (PatchedCount) and the total number of objects (PatchedTotal) for pair count normalisation. The data is stored per spatial patch and in bins of redshift. The containers implement methods to compute total value (summing over all patches) and samples needed for error estimations after evaluating the correlation estimator (e.g. jackknife or bootstrap resampling).

Finally, NormalisedCounts implements normalised pair counts and holds both a PatchedCount and PatchedTotal container. Its NormalisedCounts.sample() method computes the ratio of counts-to-total-objects and samples thereof.

Classes

PatchedTotal(binning, totals1, totals2, *, auto)	Container class for the product of the total number of objects of two samples.
PatchedCount(binning, counts, *, auto)	Container class for pair counts between two samples.
NormalisedCounts(count, total)	Container to store counts and the total number of objects obtained from measuring pair counts for a correlation function.