Waveform specification coverage
This page maps the public Torch and JAX dispatch names to a model or variant.
It also lists standalone waveform classes omitted from those dispatch registries.
Versioned slice means that a canonical specification and independent scalar
reference cover only the stated slice in the waveform library.
Provisional means the waveform is implemented but does not yet have that
complete, source-linked specification/reference contract. "Separate SEOBNR
track" identifies the retained external-data ROM wrapper without claiming
that this library work validates its external calibration asset.
The retired prototype record preserves
the former SEOBNR, TEOBResumS, and native-ROM routes outside this current-public
surface. The model names below link to the most relevant existing guide or evidence record;
those links are not substitutes for a six-section canonical specification.
The support catalog, model evidence manifest,
and validation overview remain the places to assess specific
options and numerical evidence. A dispatch alias is not a separate mathematical
model. Aliases without a backend label occur in both dispatchers; exceptions
are labeled in the table. The same alias can still select different backend
class routes, as the Pv2 ledger explains.
Direct class only means use the class API, not the FD/TD dispatcher.
| Model or variant | Form | Spec status | Public dispatch |
|---|---|---|---|
| TaylorF2 | native FD | versioned slice | taylorf2 |
| TaylorF2_HM | higher-mode extension | versioned slice | taylorf2hm |
| TaylorF2_Eccentric | eccentric extension | versioned slice | taylorf2eccentric, eccentrictaylorf2 |
| IMRPhenomD | native FD | versioned slice | imrphenomd |
| IMRPhenomHM | higher-mode extension | versioned slice | imrphenomhm |
| IMRPhenomXAS | native FD | versioned slice | imrphenomxas, phenomxas, xas |
| IMRPhenomXHM | higher-mode extension | provisional | imrphenomxhm |
| IMRPhenomP | precessing composition | provisional | imrphenomp |
| IMRPhenomPv2 | precessing variant | provisional | imrphenompv2 |
| IMRPhenomXP | precessing composition | provisional | imrphenomxp, phenomxp, xp |
| IMRPhenomXPHM | precessing higher-mode composition | provisional | imrphenomxphm, phenomxphm, xphm |
| IMRPhenomXPHM_SpinTaylor | XPHM precession variant | provisional | imrphenomxphmspintaylor, phenomxphmspintaylor, xphmspintaylor |
| IMRPhenomXPNR | XPHM PNR variant | provisional component evidence; full waveform unqualified | imrphenomxpnr, phenomxpnr, xpnr, pnr; Torch only: imrphenomxnpr, phenomxnpr, xnpr |
| IMRPhenomT | native TD | provisional | imrphenomt |
| IMRPhenomTHM | T higher-mode extension | provisional | imrphenomthm |
| IMRPhenomTP | T precessing extension | provisional | imrphenomtp |
| IMRPhenomTPHM | T precessing higher-mode extension | provisional | imrphenomtphm |
| IMRPhenomD_NRTidal | tidal composition | provisional | imrphenomdnrtidal, nrtidal |
| IMRPhenomD_NRTidalv2 | tidal composition | provisional | imrphenomdnrtidalv2, nrtidalv2 |
| IMRPhenomNSBH | matter composition | provisional | imrphenomnsbh, nsbh |
| KerrRingdown | ringdown generator | provisional | kerrringdown, ringdown |
| KerrRingdown220Direct | direct class 220 variant | versioned slice | direct class only |
| OfficialSEOBNRv4ROM | external-data wrapper | separate SEOBNR track | seobnrrom, seobnrv4rom, officialseobnrv4rom |
| ContinuousWave | direct waveform class | provisional | direct class only |
| ContinuousWaveH1Direct | direct class H1 variant | versioned slice | direct class only |
| MemoryWaveform | direct waveform class | provisional | direct class only |
| MemoryWaveform22Direct | direct class dominant-pair route | versioned slice | direct class only |
| EMRIKludge | direct waveform class | provisional | direct class only |
| ParameterizedPostEinstein | direct waveform class | provisional | direct class only |
| taylorf2-aligned-bh-spin-3.5pn/v1 | aligned-spin extension | versioned slice | direct class only |
| taylorf2-adiabatic-quadrupolar-tides-6.5pn/v1 | tidal extension | versioned slice | direct class only |
| taylorf2-spin-induced-quadrupole-3.5pn/v1 | spin-quadrupole extension | versioned slice | direct class only |
| ppe-supported-equations/v2 | ppE overlay equations | versioned slice | direct class only |
| emri.newtonian_eccentric_quadrupole.v1 | direct class Newtonian EMRI variant | versioned slice | direct class only |
The XPHM SpinTaylor and PNR rows are option-selecting dispatch variants of
IMRPhenomXPHM. IMRPhenomPv2 is a distinct JAX class; Torch selects a Pv2
path through its IMRPhenomP dispatch class. The T family is native time domain.
Other FD models may be converted to time series by get_td_waveform; that
conversion does not make them native TD approximants. The official v4 ROM uses
external data; direct SEOBNR_ROM class construction selects this same
evaluator. The former seobnrv5rom alias selected a different native
surrogate and has been retired; it must not silently select the official ROM.
Sine-Gaussian glitch wavelets and HybridMECO are supporting tools rather than
standalone dispatched waveforms. SpinPrecessionODE is retired.