mass_function

clustertools.analysis.functions.mass_function(cluster, mmin=None, mmax=None, nmass=10, rmin=None, rmax=None, vmin=None, vmax=None, emin=None, emax=None, kwmin=0, kwmax=1, npop=None, indx=None, projected=False, mcorr=None, plot=False, **kwargs)[source]

Find mass function over a given mass range

  • mass bins are set up so that there are an equal number of stars in each bin

Parameters:
clusterclass

StarCluster instance

mmin/mmaxfloat

specific mass range

nmass

number of mass bins used to calculate alpha

rmin/rmax

specific radial range

vmin/vmaxfloat

specific velocity range

emin/emaxfloat

specific energy range

kwmin/kwmaxint

specific stellar evolution type range

npopint

population number

indxbool

specific subset of stars

projectedbool

use projected values (default: False)

mcorrfloat

completeness correction for masses

plotbool

plot the mass function

Returns:
m_meanfloat

mean mass in each bin

m_histfloat

number of stars in each bin

dmfloat

dN/dm of each bin

alphafloat

power-law slope of the mass function (dN/dm ~ m^alpha)

ealphafloat

error in alpha

yalphafloat

y-intercept of fit to log(dN/dm) vs log(m)

eyalphafloat

error in yalpha

Other Parameters:
kwargsstr

key words for plotting