rlimiting¶
- clustertools.analysis.functions.rlimiting(cluster, pot=None, rgc=None, zgc=None, nrad=20, projected=False, plot=False, from_centre=False, **kwargs)[source]¶
Calculate limiting radius of the cluster
The limiting radius is defined to be where the cluster’s density reaches the local background density of the host galaxy
for cases where the cluster’s orbital parameters are not set, it is possible to manually set rgc which is assumed to be in kpc.
- Parameters:
- clusterclass
StarCluster
- potclass
GALPY potential used to calculate actions
- rgc
Manually set galactocentric distance in kpc at which the tidal radius is to be evaluated (default: None)
- zgcfloat
For non-spherically symmetric potentials, manually set distance in kpc above disk at which the tidal radius is to be evaluated. When set, rgc becomes radius in cylindrical coordinates (default: None)
- nradint
number of radial bins used to calculate density profile (Default: 20)
- projectedbool
use projected values (default: False)
- plotbool
plot the density profile and mark the limiting radius of the cluster (default: False)
- from_centrebool
calculate tidal radius based on location of cluster’s exact centre instead of its assigned galactocentric coordinates (default: False)
- verbosebool
- Returns
- ——-
- rlfloat
limiting radius
- Other Parameters:
- kwargsstr
key words for plotting