aimsalgo  5.1.2
Neuroimaging image processing
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. More...
 
void doit (const carto::rc_ptr< carto::Volume< T > > &thing, T mindataval, T maxdataval)
 
unsigned bins () const
 
void setBins (unsigned bins)
 
minDataValue () const
 
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. More...
 
 Histogram (const Histogram< T > &other)
 copy constructor. More...
 
virtual ~Histogram ()
 destructor. More...
 
carto::VolumeRef< int32_t > & data ()
 return a reference to the data field of the histogram class. More...
 
const carto::VolumeRef< int32_t > & data () const
 return a constant reference to the data field of the histogram class. More...
 
int32_t * beginValid ()
 return the iterator to the first valid value of the histogram More...
 
int32_t * endValid ()
 return the iterator to the last valid value of the histogram More...
 
int32_t * beginValid () const
 return the constant iterator to the first valid value of the histogram More...
 
int32_t * endValid () const
 return the constant iterator to the last valid value of the histogram More...
 
int minValid () const
 return the minimum valid (used) value of the histogram More...
 
int maxValid () const
 returnn the maximum valid (used) value of the histogram More...
 
int totalPoints () const
 return the total number of points in the histogram More...
 

Additional Inherited Members

- Protected Attributes inherited from Histogram< T >
int _nPoints
 total number of points More...
 
int _minValid
 minimum used value More...
 
int _maxValid
 maximum used value More...
 
carto::VolumeRef< int32_t > _data
 histogram datas More...
 

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.

◆ RegularBinnedHistogram() [2/2]

template<typename T >
aims::RegularBinnedHistogram< T >::RegularBinnedHistogram ( const RegularBinnedHistogram< T > &  other)
inline

Definition at line 86 of file regularBinnedHisto.h.

◆ ~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.

◆ 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.

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

◆ doit() [2/2]

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

◆ 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.

◆ 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

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