galpy.df.evolveddiskdf.sigmaR2

evolveddiskdf.sigmaR2(R, t=0.0, nsigma=None, deg=False, phi=0.0, epsrel=0.01, epsabs=1e-05, grid=None, gridpoints=101, returnGrid=False, surfacemass=None, meanvR=None, hierarchgrid=False, nlevels=2, integrate_method='dopr54_c')[source]

Calculate the radial variance of the velocity distribution at (R,phi)

Parameters:

  • R (float) – Radius at which to calculate the moment (can be Quantity)

  • t (float, optional) – Time at which to evaluate the DF (can be a list or ndarray; if this is the case, list needs to be in descending order and equally spaced) (can be Quantity)

  • nsigma (float, optional) – Number of sigma to integrate the velocities over (based on an estimate, so be generous)

  • deg (bool, optional) – Azimuth is in degree (default=False); do not set this when giving phi as a Quantity

  • phi (float, optional) – Azimuth (rad unless deg=True; can be Quantity)

  • epsrel (float, optional) – Scipy.integrate keyword (the integration calculates the ratio of this vmoment to that of the initial DF)

  • epsabs (float, optional) – Scipy.integrate keyword (the integration calculates the ratio of this vmoment to that of the initial DF)

  • grid (bool or evolveddiskdfGrid or evolveddiskdfHierarchicalGrid, optional) – If set to True, build a grid and use that to evaluate integrals; if set to a grid-objects (such as returned by this procedure), use this grid

  • gridpoints (int, optional) – Number of points to use for the grid in 1D (default=101)

  • returnGrid (bool, optional) – If True, return the grid object (default=False)

  • surfacemass (float, optional) – If set use this pre-calculated surfacemass

  • meanvR (float, optional) – If set use this pre-calculated mean vR

  • hierarchgrid (bool, optional) – If True, use a hierarchical grid (default=False)

  • nlevels (int, optional) – Number of hierarchical levels for the hierarchical grid

  • integrate_method (str, optional) – orbit.integrate method argument

Returns:

Variance of vR. If returnGrid is True, return a tuple with the variance of vR and the grid object.

Return type:

float or tuple

Notes

  • 2011-03-31 - Written - Bovy (NYU)