Euclid::Histogram::Binning::Scott< VarType > Class Template Reference

#include <Scott.h>

Inheritance diagram for Euclid::Histogram::Binning::Scott< VarType >:

Collaboration diagram for Euclid::Histogram::Binning::Scott< VarType >:

Public Member Functions
template<typename Iterator >
void	computeBins (Iterator begin, Iterator end)
ssize_t	getBinIndex (VarType value) const final
std::pair< VarType, VarType >	getBinEdges (size_t i) const final
VarType	getEdge (size_t i) const final
Public Member Functions inherited from Euclid::Histogram::BinStrategy< VarType >
	BinStrategy ()
virtual	~BinStrategy ()=default
size_t	getBinCount () const
virtual std::vector< VarType >	getEdges () const
virtual VarType	getBin (size_t i) const

Private Attributes
VarType	m_start
VarType	m_step
VarType	m_end

Additional Inherited Members
Protected Attributes inherited from Euclid::Histogram::BinStrategy< VarType >
size_t	m_nbins

Detailed Description

template<typename VarType>
class Euclid::Histogram::Binning::Scott< VarType >

Bin strategy that estimates the number of bins applying Scott's normal reference rule

A proposed bin width is given by \( h = \frac{3.5\sigma}{\sqrt[3]{n}} \) Where \( \sigma \) is the standard deviation of the data set

The final number of bins is computed with \( k = \left \lceil \frac{\max x - \min x}{h} \right \rceil \)

See Also

https://en.wikipedia.org/wiki/Histogram#Scott's_normal_reference_rule

Definition at line 54 of file Scott.h.

Member Function Documentation

template<typename VarType >

template<typename Iterator >

void Euclid::Histogram::Binning::Scott< VarType >::computeBins ( Iterator  begin, Iterator  end  )

inline

Definition at line 57 of file Scott.h.

References std::ceil(), std::for_each(), Euclid::Histogram::Binning::Scott< VarType >::m_end, Euclid::Histogram::BinStrategy< VarType >::m_nbins, Euclid::Histogram::Binning::Scott< VarType >::m_start, Euclid::Histogram::Binning::Scott< VarType >::m_step, std::pow(), std::ref(), and std::sqrt().

Here is the call graph for this function:

template<typename VarType >

std::pair<VarType, VarType> Euclid::Histogram::Binning::Scott< VarType >::getBinEdges ( size_t  i ) const

inlinefinalvirtual

Get the two edges corresponding to the bin i

Parameters

i	The bin index

Returns

The two bin edges

Reimplemented from Euclid::Histogram::BinStrategy< VarType >.

Definition at line 91 of file Scott.h.

References Euclid::Histogram::Binning::Scott< VarType >::m_start, Euclid::Histogram::Binning::Scott< VarType >::m_step, and std::make_pair().

Here is the call graph for this function:

template<typename VarType >

ssize_t Euclid::Histogram::Binning::Scott< VarType >::getBinIndex ( VarType  value ) const

inlinefinalvirtual

Get the bin index corresponding to the given value

Parameters

value

The value to map to a bin

Returns

The bin index. If value is outside of the bounds, a negative number or a value bigger or equal to m_nbins can be used to mark the fact

Implements Euclid::Histogram::BinStrategy< VarType >.

Definition at line 85 of file Scott.h.

References Euclid::Histogram::Binning::Scott< VarType >::m_end, Euclid::Histogram::BinStrategy< VarType >::m_nbins, Euclid::Histogram::Binning::Scott< VarType >::m_start, and Euclid::Histogram::Binning::Scott< VarType >::m_step.

template<typename VarType >

VarType Euclid::Histogram::Binning::Scott< VarType >::getEdge ( size_t  e ) const

inlinefinalvirtual

Get the edge value e. Note that there are always one more edge than bins: i.e. the bin 0 has the edges (0, 1), the bin 1 the edges (1, 2), etc...

Implements Euclid::Histogram::BinStrategy< VarType >.

Definition at line 95 of file Scott.h.

References Euclid::Histogram::Binning::Scott< VarType >::m_start, and Euclid::Histogram::Binning::Scott< VarType >::m_step.

Member Data Documentation

template<typename VarType >

VarType Euclid::Histogram::Binning::Scott< VarType >::m_end

private

Definition at line 101 of file Scott.h.

Referenced by Euclid::Histogram::Binning::Scott< VarType >::computeBins(), and Euclid::Histogram::Binning::Scott< VarType >::getBinIndex().

template<typename VarType >

VarType Euclid::Histogram::Binning::Scott< VarType >::m_start

private

Definition at line 101 of file Scott.h.

Referenced by Euclid::Histogram::Binning::Scott< VarType >::computeBins(), Euclid::Histogram::Binning::Scott< VarType >::getBinEdges(), Euclid::Histogram::Binning::Scott< VarType >::getBinIndex(), and Euclid::Histogram::Binning::Scott< VarType >::getEdge().

template<typename VarType >

VarType Euclid::Histogram::Binning::Scott< VarType >::m_step

private

Definition at line 101 of file Scott.h.

Referenced by Euclid::Histogram::Binning::Scott< VarType >::computeBins(), Euclid::Histogram::Binning::Scott< VarType >::getBinEdges(), Euclid::Histogram::Binning::Scott< VarType >::getBinIndex(), and Euclid::Histogram::Binning::Scott< VarType >::getEdge().

---

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

• Histogram/Histogram/Binning/Scott.h