VTK Functions

These are the exposed VTK methods for both the main.CAESAR and group.Group objects.

vtk_funcs.group_vis(group, rotate=True)[source]

Function to visualize a group.Group with VTK.

Parameters

  • group (group.Group) – Group to visualize.

  • rotate (boolean) – If true the positions are rotated so that the angular momentum vector is aligned with the z-axis.

vtk_funcs.sim_vis(obj, ptypes=['dm', 'star', 'gas'], halo_only=True, galaxy_only=False, annotate_halos=False, annotate_galaxies=False, draw_spheres=None)[source]

Function to visualize an entire simulation with VTK.

Parameters

  • obj (main.CAESAR) – Simulation object to visualize.

  • ptypes (list) – List containing one or more of the following: ‘dm’,’gas’,’star’, which dictates which particles to render.

  • halo_only (boolean) – If True only render particles belonging to halos.

  • galaxy_only (boolean) – If True only render particles belonging to galaxies. Note that this overwrites halo_only.

  • annotate_halos (boolean, list, int, optional) – Add labels to the render at the location of halos annotating the group ID and total mass. If True then all halos are annotated, if an integer list then halos of those indexes are annotated, and finally if an integer than the most massive N halos are annotated.

  • annotate_galaxies (boolean, list, int, optional) – Add labels to the render at the location of galaxies annotating the group ID and total mass. If True then all galaxies are annotated, if an integer list then galaxies of those indexes are annotated, and finally if an integer than the most massive N galaxies are annotated.

  • draw_spheres (string, boolean) – Add spheres around your annotated objects. The size is determined by the string you pass, should be from the .radii dict. If a boolean of True is passed it will use the total radii.