From bccc0bd781c3ef201b9fa4aae89e1ce125f9d001 Mon Sep 17 00:00:00 2001
From: Soichiro Morisaki <soichiro.morisaki@ligo.org>
Date: Wed, 28 Oct 2020 11:07:47 -0500
Subject: [PATCH] bilby/gw/prior.py: add docstrings to
UniformInComponentsChirpMass and UniformInComponentsMassRatio
---
bilby/gw/prior.py | 34 ++++++++++++++++++++++++++++++++++
1 file changed, 34 insertions(+)
diff --git a/bilby/gw/prior.py b/bilby/gw/prior.py
index 920052803..3de39b442 100644
--- a/bilby/gw/prior.py
+++ b/bilby/gw/prior.py
@@ -291,6 +291,23 @@ class UniformInComponentsChirpMass(PowerLaw):
def __init__(self, minimum, maximum, name='chirp_mass',
latex_label='$\mathcal{M}$', unit=None, boundary=None):
+ """
+ Prior distribution for chirp mass which is uniform in component masses.
+
+ This is useful when chirp mass and mass ratio are sampled while the
+ prior is uniform in component masses.
+
+ Parameters
+ ----------
+ minimum : float
+ The minimum of chirp mass
+ maximum : float
+ The maximum of chirp mass
+ name: see superclass
+ latex_label: see superclass
+ unit: see superclass
+ boundary: see superclass
+ """
super(UniformInComponentsChirpMass, self).__init__(
alpha=1., minimum=minimum, maximum=maximum,
name=name, latex_label=latex_label, unit=unit, boundary=boundary)
@@ -300,6 +317,23 @@ class UniformInComponentsMassRatio(Prior):
def __init__(self, minimum, maximum, name='mass_ratio', latex_label='$q$',
unit=None, boundary=None):
+ """
+ Prior distribution for mass ratio which is uniform in component masses.
+
+ This is useful when chirp mass and mass ratio are sampled while the
+ prior is uniform in component masses.
+
+ Parameters
+ ----------
+ minimum : float
+ The minimum of mass ratio
+ maximum : float
+ The maximum of mass ratio
+ name: see superclass
+ latex_label: see superclass
+ unit: see superclass
+ boundary: see superclass
+ """
super(UniformInComponentsMassRatio, self).__init__(
minimum=minimum, maximum=maximum, name=name,
latex_label=latex_label, unit=unit, boundary=boundary)
--
GitLab