aims::RegularBinnedHistogram< T > Class Template Reference

Histogram container class, with a specified number of regular bins. More...

#include <aims/histogram/regularBinnedHisto.h>

Inheritance diagram for aims::RegularBinnedHistogram< T >:

Collaboration diagram for aims::RegularBinnedHistogram< T >:

Public Member Functions
	RegularBinnedHistogram (unsigned bins=0)
	RegularBinnedHistogram (const RegularBinnedHistogram< T > &other)
virtual	~RegularBinnedHistogram ()
void	doit (const carto::rc_ptr< carto::Volume< T > > &thing)
	classical histogram computation function.
void	doit (const carto::rc_ptr< carto::Volume< T > > &thing, T mindataval, T maxdataval)
unsigned	bins () const
void	setBins (unsigned bins)
T	minDataValue () const
T	maxDataValue () const
std::vector< T > *	unique (const carto::rc_ptr< carto::Volume< T > > &thing, size_t abort_max=0) const
Public Member Functions inherited from Histogram< T >
	Histogram ()
	constructor.
	Histogram (const Histogram< T > &other)
	copy constructor.
virtual	~Histogram ()
	destructor.
carto::VolumeRef< int32_t > &	data ()
	return a reference to the data field of the histogram class.
const carto::VolumeRef< int32_t > &	data () const
	return a constant reference to the data field of the histogram class.
int32_t *	beginValid ()
	return the iterator to the first valid value of the histogram
int32_t *	endValid ()
	return the iterator to the last valid value of the histogram
const int32_t *	beginValid () const
	return the constant iterator to the first valid value of the histogram
const int32_t *	endValid () const
	return the constant iterator to the last valid value of the histogram
int	minValid () const
	return the minimum valid (used) value of the histogram
int	maxValid () const
	returnn the maximum valid (used) value of the histogram
int	totalPoints () const
	return the total number of points in the histogram

Additional Inherited Members
int	_nPoints
	total number of points
int	_minValid
	minimum used value
int	_maxValid
	maximum used value
carto::VolumeRef< int32_t >	_data
	histogram datas

Detailed Description

template<typename T>
class aims::RegularBinnedHistogram< T >

Histogram container class, with a specified number of regular bins.

Definition at line 50 of file regularBinnedHisto.h.

Constructor & Destructor Documentation

RegularBinnedHistogram() [1/2]

template<typename T>

aims::RegularBinnedHistogram< T >::RegularBinnedHistogram ( unsigned bins = 0 )

inline

Definition at line 79 of file regularBinnedHisto.h.

References bins(), and Histogram< T >::Histogram().

Referenced by RegularBinnedHistogram().

RegularBinnedHistogram() [2/2]

template<typename T>

aims::RegularBinnedHistogram< T >::RegularBinnedHistogram ( const RegularBinnedHistogram< T > & other )

inline

Definition at line 86 of file regularBinnedHisto.h.

References Histogram< T >::Histogram(), and RegularBinnedHistogram().

~RegularBinnedHistogram()

template<typename T>

virtual aims::RegularBinnedHistogram< T >::~RegularBinnedHistogram ( )

inlinevirtual

Definition at line 56 of file regularBinnedHisto.h.

Member Function Documentation

bins()

template<typename T>

unsigned aims::RegularBinnedHistogram< T >::bins ( ) const

inline

Definition at line 64 of file regularBinnedHisto.h.

Referenced by RegularBinnedHistogram(), and setBins().

doit() [1/2]

template<typename T>

void aims::RegularBinnedHistogram< T >::doit ( const carto::rc_ptr< carto::Volume< T > > & thing )

inlinevirtual

classical histogram computation function.

Reimplemented from Histogram< T >.

Definition at line 103 of file regularBinnedHisto.h.

References doit().

Referenced by doit(), and AimsEMThreshold< T, U >::processEMThresholds().

doit() [2/2]

template<typename T>

void aims::RegularBinnedHistogram< T >::doit ( const carto::rc_ptr< carto::Volume< T > > & thing, T mindataval, T maxdataval )

inline

Definition at line 111 of file regularBinnedHisto.h.

References Histogram< T >::_data, carto::NDIterator_base::ended(), carto::const_line_NDIterator< typename T >::inc_line_ptr(), and carto::const_line_NDIterator< typename T >::line_length().

maxDataValue()

template<typename T>

T aims::RegularBinnedHistogram< T >::maxDataValue ( ) const

inline

Definition at line 67 of file regularBinnedHisto.h.

minDataValue()

template<typename T>

T aims::RegularBinnedHistogram< T >::minDataValue ( ) const

inline

Definition at line 66 of file regularBinnedHisto.h.

setBins()

template<typename T>

void aims::RegularBinnedHistogram< T >::setBins ( unsigned bins )

inline

Definition at line 95 of file regularBinnedHisto.h.

References Histogram< T >::_data, and bins().

unique()

template<typename T>

std::vector< T > * aims::RegularBinnedHistogram< T >::unique ( const carto::rc_ptr< carto::Volume< T > > & thing, size_t abort_max = 0 ) const

inline

Definition at line 155 of file regularBinnedHisto.h.

References carto::NDIterator_base::ended(), carto::const_line_NDIterator< typename T >::inc_line_ptr(), and carto::const_line_NDIterator< typename T >::line_length().

---

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

• aims/histogram/regularBinnedHisto.h