clustertools.util.plots module

A matplotlib.pyplot wrapper for making key StarCluster plots

clustertools.util.plots.skyplot(cluster, coords='radec', xlim=None, ylim=None, legend=False, filename=None, overplot=False, do_centre=False, **kwargs)[source]

Plot the ra/dec or pmra/pmdec coordinates of each star in the cluster

Parameters:
clusterclass

StarCluster

coordsstr

coordinates to be plotted (‘radec’,’pm’) (default: ‘radec’)

xlimfloat

X-axis limits (list)

ylimfloat

Y-axis limits (list)

legendbool

Plot legend (default: False)

filenamestr

filename to save figure to

overplotbool

overplot onto existing figure (default: False)

do_centrebool

plot centre of cluster (default:False)

Returns:
pyplot.figure()
Other Parameters:
kwargsstr

key word arguments for matplotlib.pyplot.plot

clustertools.util.plots.starplot(cluster, coords='xyz', xlim=None, ylim=None, legend=False, filename=None, overplot=False, do_centre=False, **kwargs)[source]

Plot the xy/xz/yz coordinates of each star in the cluster

Parameters:
clusterclass

StarCluster

coordsstr

coordinates to be plotted (‘xy’,’xz’,’yz’,’xyz’) (default: ‘xyz’ returns a two panel plot)

xlimfloat

X-axis limits (list)

ylimfloat

Y-axis limits (list)

legendbool

Plot legend (default: False)

filenamestr

filename to save figure to

overplotbool

overplot onto existing figure (default: False)

do_centrebool

plot centre of cluster (default:False)

Returns:
pyplot.figure()
Other Parameters:
kwargsstr

key word arguments for matplotlib.pyplot.plot