yaw.config#

This module implements the configuration for yaw, which are the free parameters for the correlation function measurements. These parameters control

  1. the scales on which correlations are measured (ScalesConfig),

  2. the redshift binning for the redshift reconstruction (BinningConfig),

  3. backend related parameters (BackendConfig), and

  4. the resampling method for error estimation (ResamplingConfig).

Each of these four configuration classes are implemented as immuateble dataclasses, i.e. their values cannot be modified after creation.

For convenience, the first three configuration classes are grouped together in the Configuration class, since these parameters are often needed together. This configuration class additionally specifies the cosmological model. For more details, refer to the yaw.core.cosmology module.

The recommended way to create a new configuration is thorough its constructor methods Configuration.create() or Configuration.modify() to create a new, modified configuration from an existing one. The default values for the parameters are listed in yaw.config.default (also available as yaw.config.DEFAULT), parameters that support a fixed set of options can be accessed through yaw.config.OPTIONS, an instance of the Options generating class.

Submodules

Classes

Configuration(scales, binning, backend, ...)

The central configration for correlation measurements.

ScalesConfig(rmin, rmax[, rweight, rbin_num])

Configuration of scales used for correlation measurements.

BinningConfig(zbins[, method])

TODO

BackendConfig([thread_num, crosspatch, ...])

Configuration of backends used for correlation measurements.

ResamplingConfig([method, crosspatch, ...])

Configuration for error estimation from spatial resampling.