galpy.df.sphericaldf.sample

sphericaldf.sample(R=None, z=None, phi=None, n=1, return_orbit=True, rmin=0.0)

NAME:

sample

PURPOSE:

Return full 6D samples of the DF

INPUT:

R= cylindrical radius at which to generate samples (can be Quantity)

z= height at which to generate samples (can be Quantity)

phi= azimuth at which to generate samples (can be Quantity)

n= number of samples to generate

rmin= (0.) only sample r > rmin (can be Quantity)

OPTIONAL INPUT:

return_orbit= (True) If True output is an orbit.Orbit object, if False output is (R,vR,vT,z,vz,phi)

OUTPUT:

List of samples. Either vector (R,vR,vT,z,vz,phi) or orbit.Orbit; the (R,vR,vT,z,vz,phi) is either in internal units or is a set of Quantities

NOTES:

If R,z,phi are None then sample positions with CMF. If R,z,phi are floats then sample n velocities at location. If array then sample velocities at radii, ignoring n. phi can be None if R,z are set by any above mechanism, will then sample phi for output.

HISTORY:

2020-07-22 - Written - Lane (UofT)