cogwheel.gw_prior.combined.RegisteredPriorMixin

class cogwheel.gw_prior.combined.RegisteredPriorMixin

Bases: ReferenceWaveformFinderMixin

Register existence of a Prior subclass in prior_registry.

Intended usage is to only register the final priors (i.e., for the full set of GW parameters). RegisteredPriorMixin should be inherited before Prior (otherwise PriorError is raised) in order to test for conditioned-on parameters.

Methods

from_reference_waveform_finder

Instantiate prior.Prior subclass with help from a likelihood.ReferenceWaveformFinder instance.
classmethod from_reference_waveform_finder(reference_waveform_finder, **kwargs)

Instantiate prior.Prior subclass with help from a likelihood.ReferenceWaveformFinder instance.

This will generate kwargs for:

  • tgps

  • par_dic_0

  • f_avg

  • f_ref

  • ref_det_name

  • detector_pair

  • t0_refdet

  • mchirp_range

Additional **kwargs can be passed to complete missing entries or override these.