Gaussian-modulated amplitude wrapper potential

class galpy.potential.GaussianAmplitudeWrapperPotential(*args, **kwargs)[source]

Potential wrapper class that allows the amplitude of a Potential object to be modulated as a Gaussian. The amplitude A applied to a potential wrapped by an instance of this class is changed as

\[A(t) = amp\,\exp\left(-\frac{[t-t_0]^2}{2\,\sigma^2}\right)\]
__init__(amp=1.0, pot=None, to=0.0, sigma=1.0, ro=None, vo=None)[source]

Initialize a GaussianAmplitudeWrapper Potential.

Parameters:
  • amp (float, optional) – Amplitude to be applied to the potential. Default is 1.0.

  • pot (Potential instance or list thereof, optional) – This potential is made to rotate around the z axis by the wrapper.

  • to (float or Quantity, optional) – Time at which the Gaussian peaks. Default is 0.0.

  • sigma (float or Quantity, optional) – Standard deviation of the Gaussian. Default is 1.0.

  • ro (float or Quantity, optional) – Distance scale for translation into internal units (default from configuration file).

  • vo (float or Quantity, optional) – Velocity scale for translation into internal units (default from configuration file).

Notes

  • 2018-02-21 - Started - Bovy (UofT)