cogwheel.gw_prior.spinΒΆ

Default modular priors for spin parameters, for convenience.

They can be combined just by subclassing cogwheel.prior.CombinedPrior and defining an attribute prior_classes that is a list of priors (see cogwheel.gw_prior.combined).

Each may consume some arguments in the __init__(), but should forward as **kwargs any arguments that other priors may need.

Classes

CartesianUniformDiskInplaneSpinsIsotropicInclinationPrior

Similar to UniformDiskInplaneSpinsIsotropicInclinationPrior except it uses Cartesian rather than polar coordinates.

IsotropicSpinsAlignedComponentsPrior

Prior for aligned spin components of an isotropic distribution.

IsotropicSpinsInplaneComponentsIsotropicInclinationPrior

Prior for in-plane spins and inclination that is uniform in magnitude and solid angle (isotropic) for each of the constituent spins independently when combined with IsotropicSpinsAlignedComponentsPrior.

IsotropicSpinsInplaneComponentsIsotropicInclinationSkyLocationPrior

Prior for in-plane spins, inclination and sky location that is uniform in magnitude and solid angle (isotropic) for each of the constituent spins independently when combined with IsotropicSpinsAlignedComponentsPrior.

UniformDiskInplaneSpinsIsotropicInclinationPrior

Prior for in-plane spins and inclination that is uniform in the disk \(s_x^2 + s_y^2 < 1 - s_z^2\) for each of the component spins, and isotropic in the inclination.

UniformDiskInplaneSpinsIsotropicInclinationSkyLocationPrior

Prior for in-plane spins, inclination and sky location.

UniformEffectiveSpinPrior

Spin prior for aligned spins that is flat in effective spin chieff.

VolumetricSpinsAlignedComponentsPrior

Prior for aligned spin components corresponding to a density uniform in the ball |s1,2| < 1.

ZeroInplaneSpinsPrior

Set inplane spins to zero.