galpy.potential.Potential.plot

Potential.plot(t=0.0, rmin=0.0, rmax=1.5, nrs=21, zmin=-0.5, zmax=0.5, nzs=21, effective=False, Lz=None, phi=None, xy=False, xrange=None, yrange=None, justcontours=False, levels=None, cntrcolors=None, ncontours=21, savefilename=None)

NAME:

plot

PURPOSE:

plot the potential

INPUT:

t= time to plot potential at

rmin= minimum R (can be Quantity) [xmin if xy]

rmax= maximum R (can be Quantity) [ymax if xy]

nrs= grid in R

zmin= minimum z (can be Quantity) [ymin if xy]

zmax= maximum z (can be Quantity) [ymax if xy]

nzs= grid in z

phi= (None) azimuth to use for non-axisymmetric potentials

xy= (False) if True, plot the potential in X-Y

effective= (False) if True, plot the effective potential Phi + Lz^2/2/R^2

Lz= (None) angular momentum to use for the effective potential when effective=True

justcontours= (False) if True, just plot contours

savefilename - save to or restore from this savefile (pickle)

xrange, yrange= can be specified independently from rmin,zmin, etc.; when x/yrange is set, the grid is set up as numpy.linspace(x/yrange[0],x/yrange[1],nrs/zs)

levels= (None) contours to plot

ncontours - number of contours when levels is None

cntrcolors= (None) colors of the contours (single color or array with length ncontours)

OUTPUT:

plot to output device

HISTORY:

2010-07-09 - Written - Bovy (NYU)

2014-04-08 - Added effective= - Bovy (IAS)