sigv_prof¶
- clustertools.analysis.profiles.sigv_prof(cluster, mmin=None, mmax=None, rmin=None, rmax=None, nrad=20, vmin=None, vmax=None, emin=None, emax=None, kwmin=0, kwmax=15, npop=None, indx=None, bins=None, projected=False, coord=None, normalize=False, plot=False, **kwargs)[source]¶
Measure the radial variation in the velocity dispersion
- Parameters:
- clusterclass
StarCluster
- mmin/mmaxfloat
minimum and maximum stellar mass
- rmin/rmaxfloat
minimum and maximum stellar radii
- nradint
number of radial bins
- vmin/vmaxfloat
minimum and maximum stellar velocity
- emin/emaxfloat
minimum and maximum stellar energy
- kwmin/kwmaxfloat
minimum and maximum stellar type (kw)
- npopint
population number
- indxfloat
user defined boolean array from which to extract the subset
- binsfloat
User defined bins in the form of (rlower,rmean,rupper) (default: None)
- projectedbool
use projected values and constraints (default:False)
- coordstr
choose what coordinate the velocity dispersion profile is to be returned in (default None returns (sigx**2.+sigy**2.+sigz**2.)^1/2). Alternatively can ask for ‘r’, ‘phi’, or ‘theta’ for spherical coordinate velocity dispersions.
- normalizebool
normalize radial bins by cluster’s half-mass radius (default: False)
- plotbool
plot the velocity disperions profile (default: False)
- Returns:
- rprofnfloat
natural log of radius (normalized by half-mass radius)
- sigvproffloat
velocity dispersion
- Other Parameters:
- kwragsstr
key word arguments for plotting