conversion_test.py

from __future__ import division, absolute_import
import unittest
import mock

import numpy as np

import bilby
from bilby.gw import conversion


class TestBasicConversions(unittest.TestCase):

    def setUp(self):
        self.mass_1 = 1.4
        self.mass_2 = 1.3
        self.mass_ratio = 13/14
        self.total_mass = 2.7
        self.chirp_mass = (1.4 * 1.3)**0.6 / 2.7**0.2
        self.symmetric_mass_ratio = (1.4 * 1.3) / 2.7**2
        self.cos_angle = -1
        self.angle = np.pi
        self.lambda_1 = 300
        self.lambda_2 = 300 * (14 / 13)**5
        self.lambda_tilde = 8 / 13 * (
            (1 + 7 * self.symmetric_mass_ratio
             - 31 * self.symmetric_mass_ratio**2)
            * (self.lambda_1 + self.lambda_2)
            + (1 - 4 * self.symmetric_mass_ratio)**0.5
            * (1 + 9 * self.symmetric_mass_ratio
               - 11 * self.symmetric_mass_ratio**2)
            * (self.lambda_1 - self.lambda_2)
        )
        self.delta_lambda = 1 / 2 * (
                (1 - 4 * self.symmetric_mass_ratio)**0.5
                * (1 - 13272 / 1319 * self.symmetric_mass_ratio
                   + 8944 / 1319 * self.symmetric_mass_ratio**2)
                * (self.lambda_1 + self.lambda_2)
                + (1 - 15910 / 1319 * self.symmetric_mass_ratio
                   + 32850 / 1319 * self.symmetric_mass_ratio**2
                   + 3380 / 1319 * self.symmetric_mass_ratio**3)
                * (self.lambda_1 - self.lambda_2)
        )

    def tearDown(self):
        del self.mass_1
        del self.mass_2
        del self.mass_ratio
        del self.total_mass
        del self.chirp_mass
        del self.symmetric_mass_ratio

    def test_total_mass_and_mass_ratio_to_component_masses(self):
        mass_1, mass_2 = conversion.total_mass_and_mass_ratio_to_component_masses(self.mass_ratio, self.total_mass)
        self.assertTrue(all([abs(mass_1 - self.mass_1) < 1e-5,
                             abs(mass_2 - self.mass_2) < 1e-5]))

    def test_symmetric_mass_ratio_to_mass_ratio(self):
        mass_ratio = conversion.symmetric_mass_ratio_to_mass_ratio(self.symmetric_mass_ratio)
        self.assertAlmostEqual(self.mass_ratio, mass_ratio)

    def test_chirp_mass_and_total_mass_to_symmetric_mass_ratio(self):
        symmetric_mass_ratio = conversion.chirp_mass_and_total_mass_to_symmetric_mass_ratio(self.chirp_mass, self.total_mass)
        self.assertAlmostEqual(self.symmetric_mass_ratio, symmetric_mass_ratio)

    def test_chirp_mass_and_mass_ratio_to_total_mass(self):
        total_mass = conversion.chirp_mass_and_mass_ratio_to_total_mass(self.chirp_mass, self.mass_ratio)
        self.assertAlmostEqual(self.total_mass, total_mass)

    def test_component_masses_to_chirp_mass(self):
        chirp_mass = conversion.component_masses_to_chirp_mass(self.mass_1, self.mass_2)
        self.assertAlmostEqual(self.chirp_mass, chirp_mass)

    def test_component_masses_to_total_mass(self):
        total_mass = conversion.component_masses_to_total_mass(self.mass_1, self.mass_2)
        self.assertAlmostEqual(self.total_mass, total_mass)

    def test_component_masses_to_symmetric_mass_ratio(self):
        symmetric_mass_ratio = conversion.component_masses_to_symmetric_mass_ratio(self.mass_1, self.mass_2)
        self.assertAlmostEqual(self.symmetric_mass_ratio, symmetric_mass_ratio)

    def test_component_masses_to_mass_ratio(self):
        mass_ratio = conversion.component_masses_to_mass_ratio(self.mass_1, self.mass_2)
        self.assertAlmostEqual(self.mass_ratio, mass_ratio)

    def test_mass_1_and_chirp_mass_to_mass_ratio(self):
        mass_ratio = conversion.mass_1_and_chirp_mass_to_mass_ratio(self.mass_1, self.chirp_mass)
        self.assertAlmostEqual(self.mass_ratio, mass_ratio)

    def test_lambda_tilde_to_lambda_1_lambda_2(self):
        lambda_1, lambda_2 =\
            conversion.lambda_tilde_to_lambda_1_lambda_2(
                self.lambda_tilde, self.mass_1, self.mass_2)
        self.assertTrue(all([abs(self.lambda_1 - lambda_1) < 1e-5,
                             abs(self.lambda_2 - lambda_2) < 1e-5]))

    def test_lambda_tilde_delta_lambda_to_lambda_1_lambda_2(self):
        lambda_1, lambda_2 =\
            conversion.lambda_tilde_delta_lambda_to_lambda_1_lambda_2(
                self.lambda_tilde, self.delta_lambda, self.mass_1, self.mass_2)
        self.assertTrue(all([abs(self.lambda_1 - lambda_1) < 1e-5,
                             abs(self.lambda_2 - lambda_2) < 1e-5]))

    def test_lambda_1_lambda_2_to_lambda_tilde(self):
        lambda_tilde = \
            conversion.lambda_1_lambda_2_to_lambda_tilde(
                self.lambda_1, self.lambda_2, self.mass_1, self.mass_2)
        self.assertTrue((self.lambda_tilde - lambda_tilde) < 1e-5)

    def test_lambda_1_lambda_2_to_delta_lambda(self):
        delta_lambda = \
            conversion.lambda_1_lambda_2_to_delta_lambda(
                self.lambda_1, self.lambda_2, self.mass_1, self.mass_2)
        self.assertTrue((self.delta_lambda - delta_lambda) < 1e-5)


class TestConvertToLALParams(unittest.TestCase):

    def setUp(self):
        self.search_keys = []
        self.parameters = dict()
        self.component_mass_pars = dict(mass_1=1.4, mass_2=1.4)
        self.mass_parameters = self.component_mass_pars.copy()
        self.mass_parameters['mass_ratio'] =\
            conversion.component_masses_to_mass_ratio(**self.component_mass_pars)
        self.mass_parameters['symmetric_mass_ratio'] = \
            conversion.component_masses_to_symmetric_mass_ratio(**self.component_mass_pars)
        self.mass_parameters['chirp_mass'] = \
            conversion.component_masses_to_chirp_mass(**self.component_mass_pars)
        self.mass_parameters['total_mass'] = \
            conversion.component_masses_to_total_mass(**self.component_mass_pars)
        self.component_tidal_parameters = dict(lambda_1=300, lambda_2=300)
        self.all_component_pars = self.component_tidal_parameters.copy()
        self.all_component_pars.update(self.component_mass_pars)
        self.tidal_parameters = self.component_tidal_parameters.copy()
        self.tidal_parameters['lambda_tilde'] = \
            conversion.lambda_1_lambda_2_to_lambda_tilde(**self.all_component_pars)
        self.tidal_parameters['delta_lambda'] = \
            conversion.lambda_1_lambda_2_to_delta_lambda(**self.all_component_pars)

    def tearDown(self):
        del self.search_keys
        del self.parameters

    def bbh_convert(self):
        self.parameters, self.added_keys =\
            conversion.convert_to_lal_binary_black_hole_parameters(
                self.parameters)

    def bns_convert(self):
        self.parameters, self.added_keys = \
            conversion.convert_to_lal_binary_neutron_star_parameters(
                self.parameters)

    def test_redshift_to_luminosity_distance(self):
        self.parameters['redshift'] = 1
        dl = conversion.redshift_to_luminosity_distance(
            self.parameters['redshift'])
        self.bbh_convert()
        self.assertEqual(self.parameters['luminosity_distance'], dl)

    def test_comoving_to_luminosity_distance(self):
        self.parameters['comoving_distance'] = 1
        dl = conversion.comoving_distance_to_luminosity_distance(
            self.parameters['comoving_distance'])
        self.bbh_convert()
        self.assertEqual(self.parameters['luminosity_distance'], dl)

    def test_source_to_lab_frame(self):
        self.parameters['test_source'] = 1
        self.parameters['redshift'] = 1
        lab = self.parameters['test_source'] * (1 + self.parameters['redshift'])
        self.bbh_convert()
        self.assertEqual(self.parameters['test'], lab)

    def _conversion_to_component_mass(self, keys):
        for key in keys:
            self.parameters[key] = self.mass_parameters[key]
        self.bbh_convert()
        self.assertAlmostEqual(
            max([abs(self.parameters[key] - self.component_mass_pars[key])
                 for key in ['mass_1', 'mass_2']]), 0)

    def test_chirp_mass_total_mass(self):
        self._conversion_to_component_mass(['chirp_mass', 'total_mass'])

    def test_chirp_mass_sym_mass_ratio(self):
        self._conversion_to_component_mass(['chirp_mass', 'symmetric_mass_ratio'])

    def test_chirp_mass_mass_ratio(self):
        self._conversion_to_component_mass(['chirp_mass', 'mass_ratio'])

    def test_total_mass_sym_mass_ratio(self):
        self._conversion_to_component_mass(['total_mass', 'symmetric_mass_ratio'])

    def test_total_mass_mass_ratio(self):
        self._conversion_to_component_mass(['total_mass', 'mass_ratio'])

    def test_total_mass_mass_1(self):
        self._conversion_to_component_mass(['total_mass', 'mass_1'])

    def test_total_mass_mass_2(self):
        self._conversion_to_component_mass(['total_mass', 'mass_2'])

    def test_sym_mass_ratio_mass_1(self):
        self._conversion_to_component_mass(['symmetric_mass_ratio', 'mass_1'])

    def test_sym_mass_ratio_mass_2(self):
        self._conversion_to_component_mass(['symmetric_mass_ratio', 'mass_2'])

    def test_mass_ratio_mass_1(self):
        self._conversion_to_component_mass(['mass_ratio', 'mass_1'])

    def test_mass_ratio_mass_2(self):
        self._conversion_to_component_mass(['mass_ratio', 'mass_2'])

    def test_bbh_aligned_spin_to_spherical(self):
        self.parameters['chi_1'] = -0.5
        a_1 = abs(self.parameters['chi_1'])
        tilt_1 = np.arccos(np.sign(self.parameters['chi_1']))
        phi_jl = 0.0
        phi_12 = 0.0
        self.bbh_convert()
        self.assertDictEqual(
            {key: self.parameters[key]
             for key in ['a_1', 'tilt_1', 'phi_12', 'phi_jl']},
            dict(a_1=a_1, tilt_1=tilt_1, phi_jl=phi_jl, phi_12=phi_12))

    def test_bbh_cos_angle_to_angle_conversion(self):
        self.parameters['cos_tilt_1'] = 1
        t1 = np.arccos(self.parameters['cos_tilt_1'])
        self.bbh_convert()
        self.assertEqual(self.parameters['tilt_1'], t1)

    def _conversion_to_component_tidal(self, keys):
        for key in keys:
            self.parameters[key] = self.tidal_parameters[key]
        for key in ['mass_1', 'mass_2']:
            self.parameters[key] = self.mass_parameters[key]
        self.bns_convert()
        component_dict = {
            key: self.parameters[key] for key in ['lambda_1', 'lambda_2']}
        self.assertDictEqual(component_dict, self.component_tidal_parameters)

    def test_lambda_tilde_delta_lambda(self):
        self._conversion_to_component_tidal(['lambda_tilde', 'delta_lambda'])

    def test_lambda_tilde(self):
        self._conversion_to_component_tidal(['lambda_tilde'])

    def test_lambda_1(self):
        self._conversion_to_component_tidal(['lambda_1'])

    def test_bns_spherical_spin_to_aligned(self):
        self.parameters['a_1'] = -1
        self.parameters['tilt_1'] = np.arccos(0.5)
        chi_1 = self.parameters['a_1'] * np.cos(self.parameters['tilt_1'])
        self.bns_convert()
        self.assertEqual(self.parameters['chi_1'], chi_1)


class TestDistanceTransformations(unittest.TestCase):

    def setUp(self):
        self.distances = np.linspace(1, 1000, 100)

    def test_luminosity_redshift_with_cosmology(self):
        z = conversion.luminosity_distance_to_redshift(self.distances, cosmology='WMAP9')
        dl = conversion.redshift_to_luminosity_distance(z, cosmology='WMAP9')
        self.assertAlmostEqual(max(abs(dl - self.distances)), 0, 4)

    def test_comoving_redshift_with_cosmology(self):
        z = conversion.comoving_distance_to_redshift(self.distances, cosmology='WMAP9')
        dc = conversion.redshift_to_comoving_distance(z, cosmology='WMAP9')
        self.assertAlmostEqual(max(abs(dc - self.distances)), 0, 4)

    def test_comoving_luminosity_with_cosmology(self):
        dc = conversion.comoving_distance_to_luminosity_distance(self.distances, cosmology='WMAP9')
        dl = conversion.luminosity_distance_to_comoving_distance(dc, cosmology='WMAP9')
        self.assertAlmostEqual(max(abs(dl - self.distances)), 0, 4)


if __name__ == '__main__':
    unittest.main()