diff --git a/CHANGELOG.md b/CHANGELOG.md
index fdd2375db0378eca1b030168a754050621140be6..2a675b616107ca9323d39048f5f724c9dec610d4 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,6 +2,11 @@
## Unreleased
+### Changes
+- Renamed "prior" to "prior" in bilby.gw.likelihood.GravtitationalWaveTransient
+ for consistency with bilby.core. **WARNING**: This will break scripts which
+ use marginalization.
+
## [0.3.3] 2018-11-08
Changes currently on master, but not under a tag.
diff --git a/bilby/gw/likelihood.py b/bilby/gw/likelihood.py
index eaa6d9dadfe4a74c45f172b60f7647444d9a3d87..d5a63c4d3bc907e40373d7df9319f4d175532f58 100644
--- a/bilby/gw/likelihood.py
+++ b/bilby/gw/likelihood.py
@@ -44,7 +44,7 @@ class GravitationalWaveTransient(likelihood.Likelihood):
phase_marginalization: bool, optional
If true, marginalize over phase in the likelihood.
This is done analytically using a Bessel function.
- prior: dict, optional
+ priors: dict, optional
If given, used in the distance and phase marginalization.
Returns
@@ -56,7 +56,7 @@ class GravitationalWaveTransient(likelihood.Likelihood):
"""
def __init__(self, interferometers, waveform_generator, time_marginalization=False, distance_marginalization=False,
- phase_marginalization=False, prior=None):
+ phase_marginalization=False, priors=None):
self.waveform_generator = waveform_generator
likelihood.Likelihood.__init__(self, dict())
@@ -64,32 +64,32 @@ class GravitationalWaveTransient(likelihood.Likelihood):
self.time_marginalization = time_marginalization
self.distance_marginalization = distance_marginalization
self.phase_marginalization = phase_marginalization
- self.prior = prior
+ self.priors = priors
self._check_set_duration_and_sampling_frequency_of_waveform_generator()
if self.time_marginalization:
self._check_prior_is_set(key='geocent_time')
self._setup_time_marginalization()
- prior['geocent_time'] = float(self.interferometers.start_time)
+ priors['geocent_time'] = float(self.interferometers.start_time)
if self.phase_marginalization:
self._check_prior_is_set(key='phase')
self._bessel_function_interped = None
self._setup_phase_marginalization()
- prior['phase'] = float(0)
+ priors['phase'] = float(0)
if self.distance_marginalization:
self._check_prior_is_set(key='luminosity_distance')
- self._distance_array = np.linspace(self.prior['luminosity_distance'].minimum,
- self.prior['luminosity_distance'].maximum, int(1e4))
+ self._distance_array = np.linspace(self.priors['luminosity_distance'].minimum,
+ self.priors['luminosity_distance'].maximum, int(1e4))
self._setup_distance_marginalization()
- prior['luminosity_distance'] = float(self._ref_dist)
+ priors['luminosity_distance'] = float(self._ref_dist)
def __repr__(self):
return self.__class__.__name__ + '(interferometers={},\n\twaveform_generator={},\n\ttime_marginalization={}, ' \
- 'distance_marginalization={}, phase_marginalization={}, prior={})'\
+ 'distance_marginalization={}, phase_marginalization={}, priors={})'\
.format(self.interferometers, self.waveform_generator, self.time_marginalization,
- self.distance_marginalization, self.phase_marginalization, self.prior)
+ self.distance_marginalization, self.phase_marginalization, self.priors)
def _check_set_duration_and_sampling_frequency_of_waveform_generator(self):
""" Check the waveform_generator has the same duration and
@@ -113,28 +113,28 @@ class GravitationalWaveTransient(likelihood.Likelihood):
setattr(self.waveform_generator, attr, ifo_attr)
def _check_prior_is_set(self, key):
- if key not in self.prior or not isinstance(
- self.prior[key], Prior):
+ if key not in self.priors or not isinstance(
+ self.priors[key], Prior):
logger.warning(
'Prior not provided for {}, using the BBH default.'.format(key))
if key == 'geocent_time':
- self.prior[key] = Uniform(
+ self.priors[key] = Uniform(
self.interferometers.start_time,
self.interferometers.start_time + self.interferometers.duration)
else:
- self.prior[key] = BBHPriorDict()[key]
+ self.priors[key] = BBHPriorDict()[key]
@property
- def prior(self):
+ def priors(self):
return self.__prior
- @prior.setter
- def prior(self, prior):
- if prior is not None:
- self.__prior = prior.copy()
+ @priors.setter
+ def priors(self, priors):
+ if priors is not None:
+ self.__prior = priors.copy()
elif any([self.time_marginalization, self.phase_marginalization,
self.distance_marginalization]):
- raise ValueError("You can't use a marginalized likelihood without specifying a prior")
+ raise ValueError("You can't use a marginalized likelihood without specifying a priors")
else:
self.__prior = None
@@ -229,7 +229,7 @@ class GravitationalWaveTransient(likelihood.Likelihood):
@property
def _ref_dist(self):
- """ Smallest distance contained in prior """
+ """ Smallest distance contained in priors """
return self._distance_array[0]
@property
@@ -253,7 +253,7 @@ class GravitationalWaveTransient(likelihood.Likelihood):
def _create_lookup_table(self):
""" Make the lookup table """
- self.distance_prior_array = np.array([self.prior['luminosity_distance'].prob(distance)
+ self.distance_prior_array = np.array([self.priors['luminosity_distance'].prob(distance)
for distance in self._distance_array])
logger.info('Building lookup table for distance marginalisation.')
@@ -286,7 +286,7 @@ class GravitationalWaveTransient(likelihood.Likelihood):
int(self.interferometers.duration / 2 *
self.waveform_generator.sampling_frequency) + 1)[1:]
self.time_prior_array =\
- self.prior['geocent_time'].prob(times) * delta_tc
+ self.priors['geocent_time'].prob(times) * delta_tc
class BasicGravitationalWaveTransient(likelihood.Likelihood):
diff --git a/examples/injection_examples/marginalized_likelihood.py b/examples/injection_examples/marginalized_likelihood.py
index 685657725301d2ffd214aaad6f71b99eb4b257b8..06ef88b6731622146e984d5a750861ac4967bd56 100644
--- a/examples/injection_examples/marginalized_likelihood.py
+++ b/examples/injection_examples/marginalized_likelihood.py
@@ -49,7 +49,7 @@ for key in ['a_1', 'a_2', 'tilt_1', 'tilt_2', 'phi_12', 'phi_jl', 'iota', 'ra',
# being marginalised. A lookup table is used fro distance marginalisation which
# takes a few minutes to build.
likelihood = bilby.gw.GravitationalWaveTransient(
- interferometers=ifos, waveform_generator=waveform_generator, prior=priors,
+ interferometers=ifos, waveform_generator=waveform_generator, priors=priors,
distance_marginalization=True, phase_marginalization=True,
time_marginalization=True)
diff --git a/test/gw_likelihood_test.py b/test/gw_likelihood_test.py
index 989aaa656c142fb5df3489f1a82ade7bf054d553..6380d27aaabf99494a763ecf2cc765659d242838 100644
--- a/test/gw_likelihood_test.py
+++ b/test/gw_likelihood_test.py
@@ -92,7 +92,7 @@ class TestGWTransient(unittest.TestCase):
self.likelihood = bilby.gw.likelihood.GravitationalWaveTransient(
interferometers=self.interferometers,
- waveform_generator=self.waveform_generator, prior=self.prior.copy()
+ waveform_generator=self.waveform_generator, priors=self.prior.copy()
)
self.likelihood.parameters = self.parameters.copy()
@@ -133,7 +133,7 @@ class TestGWTransient(unittest.TestCase):
def test_repr(self):
expected = 'GravitationalWaveTransient(interferometers={},\n\twaveform_generator={},\n\t' \
'time_marginalization={}, distance_marginalization={}, phase_marginalization={}, ' \
- 'prior={})'.format(self.interferometers, self.waveform_generator, False, False, False, self.prior)
+ 'priors={})'.format(self.interferometers, self.waveform_generator, False, False, False, self.prior)
self.assertEqual(expected, repr(self.likelihood))
@@ -163,7 +163,7 @@ class TestTimeMarginalization(unittest.TestCase):
self.likelihood = bilby.gw.likelihood.GravitationalWaveTransient(
interferometers=self.interferometers,
- waveform_generator=self.waveform_generator, prior=self.prior.copy()
+ waveform_generator=self.waveform_generator, priors=self.prior.copy()
)
self.likelihood.parameters = self.parameters.copy()
@@ -190,7 +190,7 @@ class TestTimeMarginalization(unittest.TestCase):
self.time = bilby.gw.likelihood.GravitationalWaveTransient(
interferometers=self.interferometers,
waveform_generator=self.waveform_generator,
- time_marginalization=True, prior=self.prior.copy()
+ time_marginalization=True, priors=self.prior.copy()
)
times = self.waveform_generator.start_time + np.linspace(
0, self.duration, 4097)[:-1]
@@ -219,7 +219,7 @@ class TestTimeMarginalization(unittest.TestCase):
self.time = bilby.gw.likelihood.GravitationalWaveTransient(
interferometers=self.interferometers,
waveform_generator=self.waveform_generator,
- time_marginalization=True, prior=self.prior.copy()
+ time_marginalization=True, priors=self.prior.copy()
)
times = self.waveform_generator.start_time + np.linspace(
0, self.duration, 4097)[:-1]
@@ -276,11 +276,11 @@ class TestMarginalizedLikelihood(unittest.TestCase):
new_prior = self.prior.copy()
like = bilby.gw.likelihood.GravitationalWaveTransient(
interferometers=self.interferometers,
- waveform_generator=self.waveform_generator, prior=new_prior,
+ waveform_generator=self.waveform_generator, priors=new_prior,
time_marginalization=True
)
- same = all([temp.minimum == like.prior['geocent_time'].minimum,
- temp.maximum == like.prior['geocent_time'].maximum,
+ same = all([temp.minimum == like.priors['geocent_time'].minimum,
+ temp.maximum == like.priors['geocent_time'].maximum,
new_prior['geocent_time'] == temp.minimum])
self.assertTrue(same)
self.prior['geocent_time'] = temp
@@ -290,11 +290,11 @@ class TestMarginalizedLikelihood(unittest.TestCase):
new_prior = self.prior.copy()
like = bilby.gw.likelihood.GravitationalWaveTransient(
interferometers=self.interferometers,
- waveform_generator=self.waveform_generator, prior=new_prior,
+ waveform_generator=self.waveform_generator, priors=new_prior,
phase_marginalization=True
)
- same = all([temp.minimum == like.prior['phase'].minimum,
- temp.maximum == like.prior['phase'].maximum,
+ same = all([temp.minimum == like.priors['phase'].minimum,
+ temp.maximum == like.priors['phase'].maximum,
new_prior['phase'] == float(0)])
self.assertTrue(same)
self.prior['phase'] = temp
@@ -328,13 +328,13 @@ class TestPhaseMarginalization(unittest.TestCase):
self.likelihood = bilby.gw.likelihood.GravitationalWaveTransient(
interferometers=self.interferometers,
- waveform_generator=self.waveform_generator, prior=self.prior.copy()
+ waveform_generator=self.waveform_generator, priors=self.prior.copy()
)
self.phase = bilby.gw.likelihood.GravitationalWaveTransient(
interferometers=self.interferometers,
waveform_generator=self.waveform_generator,
- phase_marginalization=True, prior=self.prior.copy()
+ phase_marginalization=True, priors=self.prior.copy()
)
for like in [self.likelihood, self.phase]:
like.parameters = self.parameters.copy()
@@ -392,26 +392,26 @@ class TestTimePhaseMarginalization(unittest.TestCase):
self.likelihood = bilby.gw.likelihood.GravitationalWaveTransient(
interferometers=self.interferometers,
- waveform_generator=self.waveform_generator, prior=self.prior.copy()
+ waveform_generator=self.waveform_generator, priors=self.prior.copy()
)
self.time = bilby.gw.likelihood.GravitationalWaveTransient(
interferometers=self.interferometers,
waveform_generator=self.waveform_generator,
- time_marginalization=True, prior=self.prior.copy()
+ time_marginalization=True, priors=self.prior.copy()
)
self.phase = bilby.gw.likelihood.GravitationalWaveTransient(
interferometers=self.interferometers,
waveform_generator=self.waveform_generator,
- phase_marginalization=True, prior=self.prior.copy()
+ phase_marginalization=True, priors=self.prior.copy()
)
self.time_phase = bilby.gw.likelihood.GravitationalWaveTransient(
interferometers=self.interferometers,
waveform_generator=self.waveform_generator,
time_marginalization=True, phase_marginalization=True,
- prior=self.prior.copy()
+ priors=self.prior.copy()
)
for like in [self.likelihood, self.time, self.phase, self.time_phase]:
like.parameters = self.parameters.copy()