Utils::CylindricalHistogram< T, N, M, U > Class Template Reference

Histogram in cylindrical coordinates. More...

#include <Histogram.hpp>

Inheritance diagram for Utils::CylindricalHistogram< T, N, M, U >:

Collaboration diagram for Utils::CylindricalHistogram< T, N, M, U >:

Public Member Functions
void	normalize () override
	Histogram (std::array< std::size_t, M > n_bins, std::array< std::pair< U, U >, M > limits)
	Histogram constructor.
Public Member Functions inherited from Utils::Histogram< T, N, M, U >
	Histogram (std::array< std::size_t, M > n_bins, std::array< std::pair< U, U >, M > limits)
	Histogram constructor.
virtual	~Histogram ()=default
std::array< std::size_t, M >	get_n_bins () const
	Get the number of bins for each dimension.
std::vector< T >	get_histogram () const
	Get the histogram data.
std::vector< std::size_t >	get_tot_count () const
	Get the histogram count data.
std::array< std::pair< U, U >, M >	get_limits () const
	Get the ranges (min, max) for each dimension.
std::array< U, M >	get_bin_sizes () const
	Get the bin sizes.
void	update (std::span< const U > pos)
	Add data to the histogram.
void	update (std::span< const U > pos, std::span< const T > value)
	Add data to the histogram.

Additional Inherited Members
Protected Types inherited from Utils::Histogram< T, N, M, U >
using	array_index = typename array_type::index
Protected Attributes inherited from Utils::Histogram< T, N, M, U >
std::array< std::size_t, M >	m_n_bins
	Number of bins for each dimension.
std::array< std::pair< U, U >, M >	m_limits
	Min and max values for each dimension.
std::array< U, M >	m_bin_sizes
	Bin sizes for each dimension.
array_type	m_array
	Histogram data.
count_type	m_count
	Track the number of total hits per bin entry.
std::array< T, N >	m_ones

Detailed Description

template<typename T, std::size_t N, std::size_t M = 3, typename U = double>
class Utils::CylindricalHistogram< T, N, M, U >

Histogram in cylindrical coordinates.

Template Parameters

T	Histogram data type.
N	Histogram data dimensionality.
M	Coordinates data dimensionality.
U	Coordinates data type.

Definition at line 201 of file Histogram.hpp.

Member Function Documentation

Histogram()

template<typename T , std::size_t N, std::size_t M = 3, typename U = double>

Utils::Histogram< T, N, M, U >::Histogram ( std::array< std::size_t, M >  n_bins, std::array< std::pair< U, U >, M >  limits  )

inline

Histogram constructor.

Parameters

n_bins	the number of bins in each histogram dimension.
limits	the minimum/maximum data values to consider for the histogram.

Definition at line 60 of file Histogram.hpp.

normalize()

template<typename T , std::size_t N, std::size_t M = 3, typename U = double>

void Utils::CylindricalHistogram< T, N, M, U >::normalize ( )

inlineoverridevirtual

Reimplemented from Utils::Histogram< T, N, M, U >.

Definition at line 212 of file Histogram.hpp.

Referenced by Observables::CylindricalDensityProfile::evaluate(), and Observables::CylindricalFluxDensityProfile::evaluate().

---

The documentation for this class was generated from the following file:

• Histogram.hpp