orbital_path

clustertools.analysis.orbits.orbital_path(cluster, tfinal=0.1, nt=1000, pot=None, from_centre=False, skypath=False, initialize=False, ro=None, vo=None, zo=None, solarmotion=None, plot=False, **kwargs)

Calculate the cluster’s orbital path

Parameters:

clusterclass

StarCluster

tfinalfloat

final time (in cluster.units) to integrate orbit to (default: 0.1 Gyr)

ntint

number of timesteps

potclass

galpy Potential that orbit is to be integrate in (default: None)

from_centrebool

genrate orbit from cluster’s exact centre instead of its assigned galactocentric coordinates (default: False)

skypathbool

return sky coordinates instead of cartesian coordinates (default: False)

initializebool

Initialize and return Orbit (default: False)

rofloat

distance to the Galactic centre (Default: None)

vofloat

circular velocity at ro (Default: None)

zofloat

Sun’s distance above the Galactic plane (default: None)

solarmotionfloat

array representing U,V,W of Sun (default: None)

plotbool

plot a snapshot of the cluster in galactocentric coordinates with the orbital path (defualt: False)

Returns:

tfloat

times for which path is provided

x,y,zfloat

orbit positions

vx,vy,vzfloat

orbit velocity

oclass

galpy orbit (if initialize==True)

History

2018 - Written - Webb (UofT)