cmtk::LogHistogram< T > Class Template Reference [cmtkBase Library]

Histogram of log intensities. More...

#include <cmtkLogHistogram.h>

Inheritance diagram for cmtk::LogHistogram< T >:

Collaboration diagram for cmtk::LogHistogram< T >:

List of all members.

Public Types
typedef LogHistogram< T >	Self
	This class.
typedef SmartPointer< Self >	SmartPtr
	Smart pointer.
typedef Histogram< T >	Superclass
	Parent class.
Public Member Functions
	LogHistogram (const size_t numBins=0)
	Constructor.
virtual	~LogHistogram ()
	Destructor.
virtual void	Resize (const size_t numberOfBins, const bool reset=true)
	Resize and allocate histogram bins.
Self::SmartPtr	Clone () const
	Make an identical copy of this object.
virtual size_t	ValueToBin (const Types::DataItem value) const
	Return bin corresponding to a certain value of the distribution.
virtual Types::DataItem	ValueToBinFractional (const Types::DataItem value) const
	Return fractional bin corresponding to a value of the distribution.
virtual const Types::DataItemRange	GetRangeBin (const size_t bin) const
	Get value range of a given bin.
virtual Types::DataItem	BinToValue (const size_t bin) const
	Return center of values represented by a certain bin.
Protected Member Functions
virtual Self *	CloneVirtual () const
	Make an identical copy of this object including derived class objects.
Private Attributes
double	m_LogNumBins
	Pre-computed log of number of bins.

---

Detailed Description

template<class T>
class cmtk::LogHistogram< T >

Histogram of log intensities.

Definition at line 52 of file cmtkLogHistogram.h.

---

Member Typedef Documentation

template<class T >

typedef LogHistogram<T> cmtk::LogHistogram< T >::Self

This class.

Reimplemented from cmtk::Histogram< T >.

Definition at line 58 of file cmtkLogHistogram.h.

template<class T >

typedef SmartPointer<Self> cmtk::LogHistogram< T >::SmartPtr

Smart pointer.

Reimplemented from cmtk::Histogram< T >.

Definition at line 61 of file cmtkLogHistogram.h.

template<class T >

typedef Histogram<T> cmtk::LogHistogram< T >::Superclass

Parent class.

Reimplemented from cmtk::Histogram< T >.

Definition at line 64 of file cmtkLogHistogram.h.

---

Constructor & Destructor Documentation

template<class T >

cmtk::LogHistogram< T >::LogHistogram

(

const size_t

numBins = 0 )

[inline]

Constructor.

Definition at line 68 of file cmtkLogHistogram.h.

template<class T >

virtual cmtk::LogHistogram< T >::~LogHistogram

(

)

[inline, virtual]

Destructor.

All bin arrays and the precomputed data bin index arrays are de-allocated.

Definition at line 74 of file cmtkLogHistogram.h.

---

Member Function Documentation

template<class T >

virtual Types::DataItem cmtk::LogHistogram< T >::BinToValue

(

const size_t

bin )

const [inline, virtual]

Return center of values represented by a certain bin.

Parameters:

bin	Index of a bin from the distribution.

Returns:

Average of upper and lower margin values of the given bin.

Reimplemented from cmtk::HistogramBase.

Definition at line 121 of file cmtkLogHistogram.h.

template<class T >

Self::SmartPtr cmtk::LogHistogram< T >::Clone

(

)

const [inline]

Make an identical copy of this object.

Reimplemented from cmtk::Histogram< T >.

Definition at line 84 of file cmtkLogHistogram.h.

template<class T >

virtual Self* cmtk::LogHistogram< T >::CloneVirtual

(

)

const [inline, protected, virtual]

Make an identical copy of this object including derived class objects.

Reimplemented from cmtk::Histogram< T >.

Definition at line 128 of file cmtkLogHistogram.h.

template<class T >

virtual const Types::DataItemRange cmtk::LogHistogram< T >::GetRangeBin

(

const size_t

bin )

const [inline, virtual]

Get value range of a given bin.

Reimplemented from cmtk::HistogramBase.

Definition at line 112 of file cmtkLogHistogram.h.

template<class T >

virtual void cmtk::LogHistogram< T >::Resize	(	const size_t	numberOfBins,
		const bool	reset = true
	)		[inline, virtual]

Resize and allocate histogram bins.

Reimplemented from cmtk::Histogram< T >.

Definition at line 77 of file cmtkLogHistogram.h.

template<class T >

virtual size_t cmtk::LogHistogram< T >::ValueToBin

(

const Types::DataItem

value )

const [inline, virtual]

Return bin corresponding to a certain value of the distribution.

Parameters:

value

A value from the distribution.

Returns:

The index of the bin corresponding to the given value.

Reimplemented from cmtk::HistogramBase.

Definition at line 93 of file cmtkLogHistogram.h.

template<class T >

virtual Types::DataItem cmtk::LogHistogram< T >::ValueToBinFractional

(

const Types::DataItem

value )

const [inline, virtual]

Return fractional bin corresponding to a value of the distribution.

Parameters:

value

A value from the distribution.

Returns:

The index of the fractional bin index corresponding to the given value. This value is an integer if and only if the given value is identical to the lower bound of a bin.

Reimplemented from cmtk::HistogramBase.

Definition at line 104 of file cmtkLogHistogram.h.

---

Member Data Documentation

template<class T >

double cmtk::LogHistogram< T >::m_LogNumBins [private]

Pre-computed log of number of bins.

Definition at line 135 of file cmtkLogHistogram.h.

---

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

• libs/Base/cmtkLogHistogram.h