yt.analysis_modules.halo_analysis.halo_callbacks.profile

yt.analysis_modules.halo_analysis.halo_callbacks.profile(halo, bin_fields, profile_fields, n_bins=32, extrema=None, logs=None, units=None, weight_field='cell_mass', accumulation=False, fractional=False, storage='profiles', output_dir='.')[source]

Create 1, 2, or 3D profiles of a halo.

Store profile data in a dictionary associated with the halo object.

Parameters:

halo : Halo object

The Halo object to be provided by the HaloCatalog.

bin_fields : list of strings

The binning fields for the profile.

profile_fields : string or list of strings

The fields to be propython filed.

n_bins : int or list of ints

The number of bins in each dimension. If None, 32 bins for each bin are used for each bin field. Default: 32.

extrema : dict of min, max tuples

Minimum and maximum values of the bin_fields for the profiles. The keys correspond to the field names. Defaults to the extrema of the bin_fields of the dataset. If a units dict is provided, extrema are understood to be in the units specified in the dictionary.

logs : dict of boolean values

Whether or not to log the bin_fields for the profiles. The keys correspond to the field names. Defaults to the take_log attribute of the field.

units : dict of strings

The units of the fields in the profiles, including the bin_fields.

weight_field : string

Weight field for profiling. Default : “cell_mass”

accumulation : bool or list of bools

If True, the profile values for a bin n are the cumulative sum of all the values from bin 0 to n. If -True, the sum is reversed so that the value for bin n is the cumulative sum from bin N (total bins) to n. If the profile is 2D or 3D, a list of values can be given to control the summation in each dimension independently. Default: False.

fractional : If True the profile values are divided by the sum of all

the profile data such that the profile represents a probability distribution function.

storage : string

Name of the dictionary to store profiles. Default: “profiles”

output_dir : string

Name of directory where profile data will be written. The full path will be the output_dir of the halo catalog concatenated with this directory. Default : ”.”