yaw.crosscorrelate_scalar#

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

Measure the angular cross-correlation amplitude between two object catalogs, with one of the catalogue being the scalar field.

The cross-correlation amplitude is measured between the unknown sample and redshift slices of the reference samples as defined in the configuration. This requires that the reference sample (and its randoms, if provided) have redshifts attached. If any of the input catalogs have weights, they will be used to weight the pair counts accordingly.

Note

The unknown sample randoms are optional. If supplied, the correlation will be NK - RK; otherwise, NK will be returned, with the mean k subtracted over the footprint.

Parameters:

  • config – Configuration defining the redshift binning and correlation scales.

  • reference – Catalog holding the reference sample data.

  • unknown – Catalog holding the unknown sample data.

Keyword Arguments:

  • unk_rand – Catalog holding the unknown random data (optional).

  • 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).