yt.analysis_modules.halo_analysis.halo_callbacks.halo_sphere

yt.analysis_modules.halo_analysis.halo_callbacks.halo_sphere(halo, radius_field='virial_radius', factor=1.0, field_parameters=None)[source]

Create a sphere data container to associate with a halo.

Parameters:

halo : Halo object

The Halo object to be provided by the HaloCatalog.

radius_field : string

Field to be retrieved from the quantities dictionary as the basis of the halo radius. Default: “virial_radius”.

factor : float

Factor to be multiplied by the base radius for defining the radius of the sphere. Defautl: 1.0.

field_parameters : dict

Dictionary of field parameters to be set with the sphere created.