yt.visualization.plot_modifications.HaloCatalogCallback

class yt.visualization.plot_modifications.HaloCatalogCallback(halo_catalog, circle_args=None, width=None, annotate_field=None, text_args=None, factor=1.0)[source]

Plots circles at the locations of all the halos in a halo catalog with radii corresponding to the virial radius of each halo.

circle_args: Contains the arguments controlling the
appearance of the circles, supplied to the Matplotlib patch Circle.
width: the width over which to select halos to plot,
useful when overplotting to a slice plot. Accepts a tuple in the form (1.0, ‘Mpc’).
annotate_field: Accepts a field contained in the
halo catalog to add text to the plot near the halo. Example: annotate_field = ‘particle_mass’ will write the halo mass next to each halo.
text_args: Contains the arguments controlling the text
appearance of the annotated field.
factor: A number the virial radius is multiplied by for
plotting the circles. Ex: factor = 2.0 will plot circles with twice the radius of each halo virial radius.

Attributes

Methods