yt.lagos.BinnedProfile3D

class yt.lagos.BinnedProfile3D(data_source, x_n_bins, x_bin_field, x_lower_bound, x_upper_bound, x_log, y_n_bins, y_bin_field, y_lower_bound, y_upper_bound, y_log, z_n_bins, z_bin_field, z_lower_bound, z_upper_bound, z_log, lazy_reader=False, end_collect=False)

A ‘Profile’ produces either a weighted (or unweighted) average or a straight sum of a field in a bin defined by two other fields. In the case of a weighted average, we have: p_i = sum( w_i * v_i ) / sum(w_i)

We accept a data_source, which will be binned into (x,y,z)_n_bins by the field (x,y,z)_bin_field between the (x,y,z)_lower_bound and the (x,y,z)_upper_bound. These bins may or may not be equally divided in log-space as specified by (x,y,z)_log, and the lazy_reader flag controls whether we use a memory conservative approach. If end_collect is True, take all values outside the given bounds and store them in the 0 and n_bins-1 values.

Methods

add_fields(fields[, weight, accumulation, ...]) We accept a list of fields which will be binned if weight is not
choose_bins(bin_style)
keys()
store_profile(name[, force]) By identifying the profile with a fixed, user-input name we can store it in the serialized data section of the hierarchy file.
write_out(filename[, format])
write_out_h5(filename[, group_prefix, bin_style]) Write out data in an hdf5 file.

Previous topic

yt.lagos.BinnedProfile2D.write_out_h5

Next topic

yt.lagos.BinnedProfile3D.add_fields

This Page