DGtal: DGtal::RegularBinner< TQuantity > Struct Template Reference

Aim: Represents an elementary functor that partitions quantities into regular intervals, given a range [min,max] range and a number nb of intervals (each interval is called a bin). More...

#include <DGtal/math/Histogram.h>

Public Types
typedef TQuantity	Quantity

typedef RegularBinner< Quantity >	Self

typedef DGtal::uint32_t	Bin

Public Member Functions
	RegularBinner (const Quantity &min, const Quantity &max, Bin n)

Bin	size () const

Bin	operator() (const Quantity &q) const

Data Fields
Quantity	myMin

Quantity	myMax

Bin	myNb

Quantity	myWidth

Detailed Description

template<typename TQuantity>
struct DGtal::RegularBinner< TQuantity >

Aim: Represents an elementary functor that partitions quantities into regular intervals, given a range [min,max] range and a number nb of intervals (each interval is called a bin).

Description of template class 'RegularBinner'

Model of CBinner.

Template Parameters

TQuantity any number type, model of CEuclideanRing.

Definition at line 64 of file Histogram.h.

Member Typedef Documentation

◆ Bin

template<typename TQuantity >

typedef DGtal::uint32_t DGtal::RegularBinner< TQuantity >::Bin

Definition at line 67 of file Histogram.h.

◆ Quantity

template<typename TQuantity >

typedef TQuantity DGtal::RegularBinner< TQuantity >::Quantity

Definition at line 65 of file Histogram.h.

◆ Self

template<typename TQuantity >

typedef RegularBinner< Quantity > DGtal::RegularBinner< TQuantity >::Self

Definition at line 66 of file Histogram.h.

Constructor & Destructor Documentation

◆ RegularBinner()

template<typename TQuantity >

DGtal::RegularBinner< TQuantity >::RegularBinner	(	const Quantity &	min,
		const Quantity &	max,
		Bin	n
	)

inline

Creates a regular binner that place quantities in range [min,max] in n bins (numbered from 0 to n-1), such that all bins have equal width \(\frac{max-min}{n}\).

Parameters

min	any quantity smaller than min falls into bin 0.
max	any quantity greater than max falls into bin n-1.
n	the number of bins.

Precondition: n>0.

Definition at line 84 of file Histogram.h.

       : myMin( min ), myMax( max ), myNb( n )
     {
       ASSERT( max > min );
       ASSERT( n > 0 );
       myWidth = ( max - min ) / static_cast<Quantity>( n );
     }

References max(), and DGtal::RegularBinner< TQuantity >::myWidth.

Member Function Documentation

◆ operator()()

template<typename TQuantity >

Bin DGtal::RegularBinner< TQuantity >::operator() ( const Quantity & q ) const

inline

Places the quantity q into the correct bin.

Parameters

q	any quantity

Returns: the associated bin (integer in [0,size()-1].

Definition at line 105 of file Histogram.h.

     {
       if ( q <= myMin )      return NumberTraits<Bin>::ZERO;
       else if ( q >= myMax ) return myNb - NumberTraits<Bin>::ONE;
       else return static_cast<Bin>( floor( NumberTraits<Quantity>::castToDouble( ( q - myMin ) / myWidth ) ) );
     }