pint.utils.find_optimal_nharms

pint.utils.find_optimal_nharms(model: TimingModel, toas: TOAs, component: Literal['WaveX', 'DMWaveX'], nharms_max: int = 45) → Tuple[int, ndarray][source]

Find the optimal number of harmonics for WaveX/DMWaveX using the Akaike Information Criterion.

Parameters:

  • model (pint.models.timing_model.TimingModel) – The timing model. Should not already contain WaveX/DMWaveX or PLRedNoise/PLDMNoise.

  • toas (pint.toa.TOAs) – Input TOAs

  • component (str) – Component name; “WaveX” or “DMWaveX”

  • nharms_max (int) – Maximum number of harmonics

Returns:

  • nharms_opt (int) – Optimal number of harmonics

  • aics (ndarray) – Array of normalized AIC values.