waveformtools.diagnostics

Diagnostic tools

Functions

`IsModesEqual`(modes1, modes2, modes_list)	Check if the mode amplitudes are equal
`RMSerrs`(func1, func2, info)	Compute and return the RMS error between two arrays

Classes

MethodInfo([int_method, diff_method, ...])

The methods for integration ,differential to be passed on for operations.

waveformtools.diagnostics.IsModesEqual(modes1, modes2, modes_list)[source]

Check if the mode amplitudes are equal

Parameters:

modes1, modes2: dict: A dictionary of modes. For each mode, the data could be an array.
modes_list: list: A list of list of mode numbers
Returns
——-
modes_err: float: The error of each mode as a dict

class waveformtools.diagnostics.MethodInfo(int_method='MP', diff_method='SH', ell_max=8, eval_ell_max=8, degree=8, reg=True, swsh_routine='waveformtools', atol=0.0001, rtol=0.01, ode_solver='solve_ivp', ivp_method='RK45', vectorized=True, error_info=False, spin_weight=None)[source]: The methods for integration ,differential to be passed on for operations.

waveformtools.diagnostics.RMSerrs(func1, func2, info)[source]

Compute and return the RMS error between two arrays

Parameters:

Returns: