pyseobnr.generate_waveform.generate_modes_opt

pyseobnr.generate_waveform.generate_modes_opt(q: float, chi1: float | np.ndarray, chi2: float | np.ndarray, omega_start: float, omega_ref: float | None = None, eccentricity: float | None = None, rel_anomaly: float | None = None, approximant: SupportedApproximants = 'SEOBNRv5HM', settings: Dict[Any, Any] = None, debug: bool = False) → tuple[np.array, np.array] | tuple[np.array, np.array, Model][source]

Compute the GW waveform modes for the given configuration and approximant.

Parameters:

  • q (float) – Mass ratio >=1

  • chi1 (Union[float,np.ndarray]) – Dimensionless spin of primary. If float, interpreted as z component

  • chi2 (Union[float,np.ndarray]) – Dimensionless spin of secondary. If float, interpreted as z component

  • 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.

  • eccentricity (float, optional) – Eccentricity of the orbit, corresponding to the Keplerian (relativistic) parametrization. Defaults to 0 (no eccentricity)

  • rel_anomaly (float, optional) – Relativistic anomaly. Radial phase which parametrizes the orbit within the Keplerian (relativistic) parametrization. Defaults to 0 (periastron)

  • approximant (SupportedApproximants, optional) – The approximant to use. Defaults to “SEOBNRv5HM”

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

  • debug (bool, optional) – Run in debug mode. Defaults to False

Raises:

  • ValueError – If input parameters are not physical

  • NotImplementedError – If the approximant requested does not exist

Returns:

Either (time, dictionary of modes) or (time, dictionary of modes, model) if debug=True

Return type:

Tuple