gw.waveform_generator.waveform_generator.SEOBNRv4PHM_maximum_starting_frequency
gw.waveform_generator.waveform_generator.SEOBNRv4PHM_maximum_starting_frequency(
total_mass,
fudge=0.99,
)Given a total mass return the largest possible starting frequency allowed for SEOBNRv4PHM and similar effective-one-body models.
The intended use for this function is at the stage of designing a data set: after choosing a mass prior one can use it to figure out which prior samples would run into an issue when generating an EOB waveform, and tweak the parameters to reduce the number of failing configurations.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| total_mass | float | Total mass in units of solar masses | required |
| fudge | float | A fudge factor | 0.99 |
Returns
| Name | Type | Description |
|---|---|---|
| f_max_Hz | float | The largest possible starting frequency in Hz |