get_mcluster

eridanus_pbh.analyze.snapshot.get_mcluster(file: str, potential: Any, \*, num_rchar: Union[float, list] = (1.0, ), char_type: typing_extensions.Literal['tidal', 'limiting', 'half-mass'] = 'tidal') → Tuple[list, nbodypy.main.cluster.StarCluster]

Mass of Cluster.

Get mass of cluster at characteristic radii

Parameters

file: str, StarCluster

data file

potential: galpy Potential

galaxy potential

num_rchar: float or list, optional

number of characteristic radii can be a list

char_type: {‘tidal’, ‘limiting’, ‘half-mass’}

characteristic radii type

Returns

mtots: list

mass within characteristic radii

cluster: npy.StarCluster

star cluster

Notes

inargs num_rchar outargs []