yaw.config.options.Options#

class yaw.config.options.Options[source]#

Bases: object

Methods

__init__()

Attributes

`backend`	Lists the names of the currently available backends for correlation measurements.
`binning`	Lists the currently implemented methods to generate redshift bins with the `BinningConfig` class.
`cosmology`	Lists the availble named cosmologies in `astropy`.
`kind`	Lists the currently implemented methods for covariance calculation.
`merge`	Lists the available modes to merge correlation measurements.
`method`	Lists the currently implemented methods for spatial resampling.

property backend: tuple[str]#: Lists the names of the currently available backends for correlation measurements.

property binning: tuple[str]#

Lists the currently implemented methods to generate redshift bins with the BinningConfig class.

Values

comoving: Generate a binning with equal width in radial comoving distance.

linear: Generate a binning with equal width in redshift.

logspace: Generate a binning with equal width in logarithmic redshift \(\log(1+z)\).

Note

Class also accepts manual if custom bin edges are provided.

property cosmology: tuple[str]#

Lists the availble named cosmologies in astropy.

On top of these comological models, custom cosmologies can be defined by subclassing yaw.core.cosmology.CustomCosmology.

property kind: tuple[str]#

Lists the currently implemented methods for covariance calculation.

Values

full: Compute all matrix elements of the covariance.

diag: Compute only the main diagonal and the primary off-diagonals of the covariance matrix. This option applies, if the covariance is computed from a concatenated set of data samples, which have a crosscorrelation of interest. For example if concatenating the samples obtained from multiple redshift bins, the primary off-diagonals contain the covariance at the same redshift between different bins.

var: Compute the variance, i.e. only the diagonal elements.

property merge: tuple[str]#

Lists the available modes to merge correlation measurements.

Values

patches: Merge measurements by concatenating spatial patches, i.e. extending the area over which measurements are taken. This may miss out some correlation signal between the two measurements.

redshift: Merge measurements by concatenating redshift bins, i.e. extending the redshift range.

property method: tuple[str]#

Lists the currently implemented methods for spatial resampling.

Resampling uses the spatial patches to get uncertainty estimates for the correlation function measurements.

Values

jackknife: Use jackknife resampling (generate samples and leave out one patch at a time).

bootstrap: Use bootstrap resampling (generate samples by randomly drawing patches with replacement).