velociraptor.tools.histogram module

Tools for creating histograms. Uses the same API as mass_functions.

velociraptor.tools.histogram.create_histogram_given_bins(masses: unyt.array.unyt_array, bins: unyt.array.unyt_array, box_volume: unyt.array.unyt_quantity, minimum_in_bin: int = 1, cumulative: bool = False, reverse: bool = False)[source]

Creates a mass function (with equal width bins in log M) for you to plot.

Parameters:
  • masses (unyt.unyt_array) – The array that you want to create a mass function of (usually this is for example halo masses or stellar masses).
  • bins (unyt.unyt_array) – The mass bin edges to use.
  • unyt.unyt_quantity (box_volume) – The volume of the box such that we can return n / volume (unused).
  • minimum_in_bin (int, optional) – The number of objects in a bin for it to be classed as valid. Bins with a number of objects smaller than this are not returned. By default this parameter takes a value of 1.
  • cumulative (bool, optional) – Whether to make the histogram cumulative. The default value is false.
  • reverse (bool, optional) – Whether to reverse the cumulative sum, i.e. do the sum from high to low values. The default value is false. Relevant only if cumulative is true.
Returns:

  • bin_centers (unyt.unyt_array) – The centers of the bins (taken to be the linear mean of the bin edges).
  • histogram (unyt.unyt_array) – The value of the mass function at the bin centers.
  • None – Final return is None, as there are no errors associated with this.
velociraptor.tools.histogram.create_histogram(masses: unyt.array.unyt_array, lowest_mass: unyt.array.unyt_quantity, highest_mass: unyt.array.unyt_quantity, box_volume: unyt.array.unyt_quantity, n_bins: int = 25, minimum_in_bin: int = 1, return_bin_edges: bool = False, cumulative: bool = False, reverse: bool = False)[source]

Creates a mass function (with equal width bins in log M) for you to plot.

Parameters:
  • masses (unyt.unyt_array) – The array that you want to create a mass function of (usually this is for example halo masses or stellar masses).
  • lowest_mass (unyt.unyt_quantity) – the lowest mass edge of the bins
  • highest_mass (unyt.unyt_quantity) – the highest mass edge of the bins
  • bins (unyt.unyt_array) – The mass bin edges to use.
  • unyt.unyt_quantity (box_volume) – The volume of the box such that we can return n / volume.
  • minimum_in_bin (int, optional) – The number of objects in a bin for it to be classed as valid. Bins with a number of objects smaller than this are not returned. By default this parameter takes a value of 1.
  • cumulative (bool, optional) – Whether to make the histogram cumulative. The default value is false.
  • reverse (bool, optional) – Whether to reverse the cumulative sum, i.e. do the sum from high to low values. The default value is false. Relevant only if cumulative is true.
  • return_bin_edges (bool, optional) – Return the bin edges used in the binning process? Default is False.
Returns:

  • bin_centers (unyt.unyt_array) – The centers of the bins (taken to be the linear mean of the bin edges).
  • mass_function (unyt.unyt_array) – The value of the mass function at the bin centers.
  • None – Final return is None, as there are no errors associated with this.
  • bin_edges (unyt.unyt_array, optional) – Bin edges that were used in the binning process.