Skip to content

Update phx auxiliary functions

Cecilio Garcia-Quiros requested to merge cecilio.garcia-quiros/lalsuite:update-phx-auxiliar-functions into master

Description

This modifies auxiliary PhenomX functions that are standalone and not used anywhere, just for testing purposes.

A summary of the changes is the following:

  • Change the interface of the SimIMRPhenomXPMSA(PN)Angles functions to make them easier to use. The inclination argument is introduced so that they return the correct angle offsets.
  • Modify the SimIMRPhenomXHMAmplitude(Phase) so that they can return the amplitude and phase of the co-precessing modes. Also, now they can return the 22 mode.
  • Change the type of the input freq_array from REAL8Sequence to const in some FrequencySequence functions. This allows us to pass to the swig wrapper a numpy array instead of having to create a REAL8Sequence first.
  • Then function XLALSimIMRPhenomXPHMOneModeFrequencySequence has been renamed to XLALSimIMRPhenomXPHMFrequencySequenceOneMode to be more consistent with the naming convention in XHM.

Examples of how to use these functions and tests showing that they work properly are provided in this notebook: Precessing_XPHM_modes.ipynb

API Changes and Justification

Backwards Compatible Changes

  • This change does not modify any class/function/struct/type definitions in a public C header file or any Python class/function definitions
  • This change adds new classes/functions/structs/types to a public C header file or Python module

Backwards Incompatible Changes

  • This change modifies an existing class/function/struct/type definition in a public C header file or Python module
  • This change removes an existing class/function/struct/type from a public C header file or Python module

The functions mentioned above are declared in LALSimIMR.h, so they are public and since we changed the interface of the input and output parameters they are backwards incompatible. But these are auxiliary functions that are not commonly used for standard LVK analysis, they are used only by waveform developers for testing purposes, and with these changes their lives will be hopefully easier.

Review Status

This has been tested by the author with checks provided in the attached notebook.

Edited by Cecilio Garcia-Quiros

Merge request reports