galpy.df contains tools for dealing with distribution functions of
stars in galaxies. It mainly contains a number of classes that define
different types of distribution function, but galpy.df.jeans also
has some tools for solving the Jeans equations for equilibrium
systems.
.. toctree:: :maxdepth: 2 sigmar <dfjeanssigmar.rst> sigmalos <dfjeanssigmalos.rst>
.. toctree:: :maxdepth: 2 turn_physical_off <dfturnphysicaloff.rst> turn_physical_on <dfturnphysicalon.rst>
Isotropic and anisotropic distribution functions for spherical systems.
.. toctree:: :maxdepth: 2 __call__ <sphericaldfcall.rst> beta <sphericaldfbeta.rst> sigmar <sphericaldfsigmar.rst> sigmar <sphericaldfsigmat.rst> vmomentdensity <sphericaldfvmomentdensity.rst>
.. toctree:: :maxdepth: 2 sample <sphericaldfsample.rst>
The following are isotropic distribution functions
.. toctree:: :maxdepth: 2 Hernquist DF <dfhernquist.rst> King DF <dfking.rst> Plummer DF <dfplummer.rst>
Anisotropic versions also exist:
.. toctree:: :maxdepth: 2 Hernquist DF with constant anisotropy beta <dfhernquistconstantbeta.rst> Hernquist DF with Osipkov-Merritt anisotropy <dfhernquistosipkov.rst>
Distribution function for orbits in the plane of a galactic disk.
.. toctree:: :maxdepth: 2 __call__ <diskdfcall.rst> asymmetricdrift <diskdfasymmetricdrift.rst> kurtosisvR <diskdfkurtosisvR.rst> kurtosisvT <diskdfkurtosisvT.rst> meanvR <diskdfmeanvR.rst> meanvT <diskdfmeanvT.rst> oortA <diskdfoortA.rst> oortB <diskdfoortB.rst> oortC <diskdfoortC.rst> oortK <diskdfoortK.rst> sigma2surfacemass <diskdfsigma2surfacemass.rst> sigma2 <diskdfsigma2.rst> sigmaR2 <diskdfsigmaR2.rst> sigmaT2 <diskdfsigmaT2.rst> skewvR <diskdfskewvR.rst> skewvT <diskdfskewvT.rst> surfacemass <diskdfsurfacemass.rst> surfacemassLOS <diskdfsurfacemassLOS.rst> targetSigma2 <diskdftargetSigma2.rst> targetSurfacemass <diskdftargetSurfacemass.rst> targetSurfacemassLOS <diskdftargetSurfacemassLOS.rst> vmomentsurfacemass <diskdfvmomentsurfacemass.rst>
.. toctree:: :maxdepth: 2 sample <diskdfsample.rst> sampledSurfacemassLOS <diskdfsampledSurfacemassLOS.rst> sampleLOS <diskdfsampleLOS.rst> sampleVRVT <diskdfsampleVRVT.rst>
.. toctree:: :maxdepth: 2 Dehnen DF <dfdehnen.rst> Schwarzschild DF <dfschwarzschild.rst> Shu DF <dfshu.rst>
Distribution function for orbits in the plane of a galactic disk in
non-axisymmetric potentials. These are calculated using the technique
of Dehnen 2000,
where the DF at the current time is obtained as the evolution of an
initially-axisymmetric DF at time to in the non-axisymmetric
potential until the current time.
.. toctree:: :maxdepth: 2 __call__ <edfcall.rst> __init__ <edf.rst> meanvR <edfmeanvr.rst> meanvT <edfmeanvt.rst> oortA <edfoorta.rst> oortB <edfoortb.rst> oortC <edfoortc.rst> oortK <edfoortk.rst> sigmaR2 <edfsigmar2.rst> sigmaRT <edfsigmart.rst> sigmaT2 <edfsigmat2.rst> vertexdev <edfvertexdev.rst> vmomentsurfacemass <edfvmomentsurfacemass.rst>
Distribution functions for orbits in galactic disks, including the vertical motion for stars reaching large heights above the plane. Currently only the quasi-isothermal DF.
.. toctree:: :maxdepth: 2 __call__ <quasidfcall.rst> density <quasidfdensity.rst> estimate_hr <quasidfestimatehr.rst> estimate_hsr <quasidfestimatehsr.rst> estimate_hsz <quasidfestimatehsz.rst> estimate_hz <quasidfestimatehz.rst> jmomentdensity <quasidfjmomentdensity.rst> meanjr <quasidfmeanjr.rst> meanjz <quasidfmeanjz.rst> meanlz <quasidfmeanlz.rst> meanvR <quasidfmeanvr.rst> meanvT <quasidfmeanvt.rst> meanvz <quasidfmeanvz.rst> pvR <quasidfpvr.rst> pvRvT <quasidfpvrvt.rst> pvRvz <quasidfpvrvz.rst> pvT <quasidfpvt.rst> pvTvz <quasidfpvtvz.rst> pvz <quasidfpvz.rst> sampleV <quasidfsamplev.rst> sampleV_interpolate <quasidfsamplevinterpolate.rst> sigmaR2 <quasidfsigmar2.rst> sigmaRz <quasidfsigmarz.rst> sigmaT2 <quasidfsigmat2.rst> sigmaz2 <quasidfsigmaz2.rst> surfacemass_z <quasidfsurfacemass_z.rst> tilt <quasidftilt.rst> vmomentdensity <quasidfvmomentdensity.rst>
.. toctree:: :maxdepth: 2 quasiisothermal DF <dfquasiisothermal.rst>
From Bovy 2014; see :ref:`stream-tutorial`.
.. toctree:: :maxdepth: 2 __call__ <streamdfcall.rst> __init__ <streamdf.rst> calc_stream_lb <streamdfcalcstreamlb.rst> callMarg <streamdfcallmarg.rst> density_par <streamdfdenspar.rst> estimateTdisrupt <streamdfestimatetdisrupt.rst> find_closest_trackpoint <streamdffindclosesttrackpoint.rst> find_closest_trackpointLB <streamdffindclosesttrackpointlb.rst> freqEigvalRatio <streamdffreqeigvalratio.rst> gaussApprox <streamdfgaussapprox.rst> length <streamdflength.rst> meanangledAngle <streamdfmeanangledangle.rst> meanOmega <streamdfmeanomega.rst> meantdAngle <streamdfmeantdangle.rst> misalignment <streamdfmisalignment.rst> pangledAngle <streamdfpangledangle.rst> plotCompareTrackAAModel <streamdfplotcomparetrackaamodel.rst> plotProgenitor <streamdfplotprogenitor.rst> plotTrack <streamdfplottrack.rst> pOparapar <streamdfpoparapar.rst> ptdAngle <streamdfptdangle.rst> sample <streamdfsample.rst> sigangledAngle <streamdfsigangledangle.rst> sigOmega <streamdfsigomega.rst> sigtdAngle <streamdfsigtdangle.rst> subhalo_encounters <streamdfsubhaloencounters.rst>
From Sanders, Bovy, & Erkal 2015;
see :ref:`streamgap-tutorial`. Implemented as a subclass of
streamdf. No full implementation is available currently, but the
model can be set up and sampled as in the above paper.
.. toctree:: :maxdepth: 2 __init__ <streamgapdf.rst> sample <streamdfsample.rst>
.. toctree:: :maxdepth: 2 impulse_deltav_plummer <impulse_deltav_plummer.rst> impulse_deltav_plummer_curvedstream <impulse_deltav_plummer_curvedstream.rst> impulse_deltav_hernquist <impulse_deltav_hernquist.rst> impulse_deltav_hernquist_curvedstream <impulse_deltav_hernquist_curvedstream.rst> impulse_deltav_general <impulse_deltav_general.rst> impulse_deltav_general_curvedstream <impulse_deltav_general_curvedstream.rst> impulse_deltav_general_orbitintegration <impulse_deltav_general_orbitintegration.rst> impulse_deltav_general_fullplummerintegration <impulse_deltav_general_fullplummerintegration.rst>