pyseobnr.generate_waveform.generate_prec_hpc_opt

pyseobnr.generate_waveform.generate_prec_hpc_opt(q: float, chi1: np.ndarray, chi2: np.ndarray, omega_start: float, omega_ref: float | None = None, settings: Dict[Any, Any] | None = None, debug: bool = False) → tuple[np.array, np.array] | tuple[np.array, np.array, Model][source]

Generate the GW wave polarizations for precessing model in an optimised way. In particular, do not compute the inertial frame modes, instead write the polarizations directly summing over the co-precessing frame modes.

Parameters:

  • q (float) – Mass ratio >=1

  • chi1 (np.ndarray) – Dimensionless spin of the primary

  • chi2 (np.ndarray) – Dimensionless spin of the secondary

  • omega_start (float) – Starting orbital frequency, in geometric units

  • omega_ref (float, optional) – Reference orbital frequency, in geometric units. Defaults to None, in which case equals omega_start

  • settings (Dict[Any,Any], optional) – Any additional settings to pass to model. Defaults to None

  • debug (bool, optional) – Run in debug mode and return the model object. Defaults to False

Returns:

Either (time, polarization) or (time, polarizations, model)

if debug=True

Return type:

Tuple