cogwheel.gw_prior.combined

Define some commonly used priors for the full set of parameters, for convenience.

Prior classes defined here can be used for parameter estimation and are registered in a dictionary prior_registry.

Note on registered prior class names:

  • LVC*, IAS* and Volumetric* priors differ on the distribution of component spins: LVC is isotropic and uniform in magnitude, IAS is uniform in the effective spin, and Volumetric is isotropic and uniform in the magnitude cubed.

  • Intrinsic* priors are for the intrinsic parameters only, these priors may be paired with a likelihood that marginalizes over extrinsic parameters.

  • Cartesian* priors try to avoid polar coordinates for the inplane spin components, these are better suited for samplers that don’t implement periodic parameters.

Classes

AlignedSpinIASPrior

Aligned spin, flat in chieff, uniform luminosity volume.

AlignedSpinIASPriorComovingVT

Aligned spin, flat in chieff, uniform comoving VT.

AlignedSpinLVCPrior

Aligned spin components from isotropic distribution, uniform luminosity volume.

AlignedSpinLVCPriorComovingVT

Aligned spins from isotropic distribution, uniform comoving VT.

CartesianIASPrior

Precessing, flat in chieff, uniform luminosity volume.

CartesianIntrinsicIASPrior

Prior for usage with MarginalizedExtrinsicLikelihood.

ExtrinsicParametersPrior

Uniform luminosity volume, fixed intrinsic parameters.

IASPrior

Precessing, flat in chieff, uniform luminosity volume.

IASPriorComovingVT

Precessing, flat in chieff, uniform comoving VT.

IntrinsicAlignedSpinIASPrior

Prior for usage with MarginalizedExtrinsicLikelihoodQAS.

IntrinsicAlignedSpinLVCPrior

Prior for usage with MarginalizedExtrinsicLikelihoodQAS.

IntrinsicIASPrior

Prior for usage with MarginalizedExtrinsicLikelihood.

IntrinsicLVCPrior

Prior for usage with MarginalizedExtrinsicLikelihood.

IntrinsicVolumetricSpinPrior

Prior for usage with MarginalizedExtrinsicLikelihood.

LVCPrior

Precessing, isotropic spins, uniform luminosity volume.

LVCPriorComovingVT

Precessing, isotropic spins, uniform comoving VT.

MarginalizedDistanceAndPhaseIASPrior

Prior for usage with MarginalizedDistanceLikelihood.

MarginalizedDistanceIASPrior

Prior for usage with MarginalizedDistanceLikelihood.

MarginalizedDistanceLVCPrior

Prior for usage with MarginalizedDistanceLikelihood.

PNIntrinsicVolumetricSpinPrior

Prior for usage with MarginalizedExtrinsicLikelihood.

ReferenceWaveformFinderMixin

Provide a constructor based on a likelihood.ReferenceWaveformFinder instance to provide initialization arguments.

RegisteredPriorMixin

Register existence of a Prior subclass in prior_registry.

TidalIASPrior

Aligned spin, flat in tidal parameters, flat in chieff, uniform luminosity volume.

Exceptions

ConditionedPriorError

Indicates that a Prior is conditioned on some parameters.