pint.utils.get_wavex_amps

pint.utils.get_wavex_amps(model, index=None, quantity=False)[source]

Return the WaveX amplitudes for a timing model.

If index is specified, returns the sine/cosine amplitudes corresponding to the user-provided indices. If index isn’t specified, returns all WaveX sine/cosine amplitudes in timing model

Parameters:
  • model (pint.models.timing_model.TimingModel) – Timing model from which to return WaveX frequencies

  • index (float, int, list, np.ndarray, None) – Number or list/array of numbers corresponding to WaveX amplitudes to return

  • quantity (bool) – If set to True, returns a list of tuples of astropy.quanitity.Quantity rather than a list of prefixParameters tuples

Return type:

List of WXSIN_ and WXCOS_ parameters