bilby.core.prior.joint.BaseJointPriorDist

class bilby.core.prior.joint.BaseJointPriorDist(names, bounds=None)

Bases: object

__init__(names, bounds=None)

A class defining JointPriorDist that will be overwritten with child classes defining the joint prior distributions between given parameters,

Parameters:

names: list (required)

A list of the parameter names in the JointPriorDist. The listed parameters must have the same order that they appear in the lists of statistical parameters that may be passed in child class

bounds: list (optional)

A list of bounds on each parameter. The defaults are for bounds at +/- infinity.

__call__(*args, **kwargs)

Call self as a function.

Methods

__init__(names[, bounds])	A class defining JointPriorDist that will be overwritten with child classes defining the joint prior distributions between given parameters,
filled_request()	Check if all requested parameters have been filled.
filled_rescale()	Check if all the rescaled parameters have been filled.
from_repr(string)	Generate the distribution from its __repr__
get_instantiation_dict()
ln_prob(*args[, xp])
prob(*args[, xp])
rescale(*args[, xp])
reset_request()	Reset the requested parameters to None.
reset_rescale()	Reset the rescaled parameters to None.
reset_sampled()
sample([size, random_state])	Draw, and set, a sample from the Dist, accompanying method _sample needs to overwritten

filled_request()

Check if all requested parameters have been filled.

filled_rescale()

Check if all the rescaled parameters have been filled.

classmethod from_repr(string)

Generate the distribution from its __repr__

reset_request()

Reset the requested parameters to None.

reset_rescale()

Reset the rescaled parameters to None.

sample(size=1, *, random_state=None, **kwargs)

Draw, and set, a sample from the Dist, accompanying method _sample needs to overwritten

Parameters:

size: int

number of samples to generate, defaults to 1