yaw.autocorrelate_scalar#

yaw.autocorrelate_scalar(config: Configuration, data: Catalog, *, progress: bool = False, max_workers: int | None = None) → list[ScalarCorrFunc][source]#

Measure the angular autocorrelation amplitude of a scalar field.

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.

Keyword Arguments:

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

  • max_workers – Limit the number of parallel workers for this operation (all by default). Takes precedence over the value in the configuration.

Returns:

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

On this page