dingo.gw.conversion package

Submodules

dingo.gw.conversion.spin_conversion module

dingo.gw.conversion.spin_conversion.cartesian_spins(p, f_ref)

Transform PE spins to cartesian spins.

Parameters:
  • p (dict) – contains parameters, including PE spins

  • f_ref (float) – reference frequency for definition of spins

Returns:

result – parameters, including cartesian spins

Return type:

dict

dingo.gw.conversion.spin_conversion.change_spin_conversion_phase(samples, f_ref, sc_phase_old, sc_phase_new, num_processes=1)

Change the phase used to convert cartesian spins to PE spins. The cartesian spins are independent of the spin conversion phase. When converting from cartesian spins to PE spins, the phase value has an impact on theta_jn and phi_jl.

The usual convention for the PE spins is to use the phase parameter for the conversion (cart. spins <–> PE spins), but for dingo-IS with the synthetic phase extension we need to use another convention, where the PE spins are defined with spin conversion phase 0. This function transforms between the different conventions.

Parameters:
  • samples (pd.Dataframe) – Parameters.

  • f_ref (float) – Reference frequency for definition of spins.

  • sc_phase_old (float or None) – Spin conversion phase used for input parameters. If None, use the phase parameter.

  • sc_phase_new (float or None) – Spin conversion phase used for output parameters. If None, use the phase parameter.

  • num_processes (int) – Number of parallel processes.

Returns:

parameters with changed spin conversion phase

Return type:

p_new

dingo.gw.conversion.spin_conversion.component_masses(p)
dingo.gw.conversion.spin_conversion.pe_spins(p, f_ref)

Transform cartesian spins to PE spins.

Parameters:
  • p (dict) – contains parameters, including cartesian spins

  • f_ref (float) – reference frequency for definition of spins

Returns:

result – parameters, including PE spins

Return type:

dict

Module contents