itk::AdaptiveHistogramEqualizationImageFilter< TImageType > Class Template Reference
[Image Enhancement Filters]

#include <itkAdaptiveHistogramEqualizationImageFilter.h>

Inheritance diagram for itk::AdaptiveHistogramEqualizationImageFilter< TImageType >:

[legend]Collaboration diagram for itk::AdaptiveHistogramEqualizationImageFilter< TImageType >:

[legend]List of all members.

Public Types
typedef AdaptiveHistogramEqualizationImageFilter	Self
typedef ImageToImageFilter< TImageType, TImageType >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	constPointer
typedef TImageType	ImageType
typedef ImageType::SizeType	ImageSizeType
Public Member Functions
	itkStaticConstMacro (ImageDimension, unsigned int, TImageType::ImageDimension)
virtual const char *	GetNameOfClass () const
virtual void	SetAlpha (float _arg)
virtual float	GetAlpha ()
virtual void	SetBeta (float _arg)
virtual float	GetBeta ()
virtual void	SetRadius (ImageSizeType _arg)
virtual const ImageSizeType &	GetRadius ()
virtual void	SetUseLookupTable (bool _arg)
virtual bool	GetUseLookupTable ()
virtual void	UseLookupTableOn ()
virtual void	UseLookupTableOff ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	AdaptiveHistogramEqualizationImageFilter ()
virtual	~AdaptiveHistogramEqualizationImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	GenerateData ()
void	GenerateInputRequestedRegion ()

---

Detailed Description

template<class TImageType>
class itk::AdaptiveHistogramEqualizationImageFilter< TImageType >

/class AdaptiveHistogramEqualizationImageFilter /brief Power Law Adaptive Histogram Equalization

Histogram equalization modifies the contrast in an image. The AdaptiveHistogramEqualizationImageFilter is a superset of many contrast enhancing filters. By modifying its parameters (alpha, beta, and window), the AdaptiveHistogramEqualizationImageFilter can produce an adaptively equalized histogram or a version of unsharp mask (local mean subtraction). Instead of applying a strict histogram equalization in a window about a pixel, this filter prescribes a mapping function (power law) controlled by the parameters alpha and beta.

The parameter alpha controls how much the filter acts like the classical histogram equalization method (alpha=0) to how much the filter acts like an unsharp mask (alpha=1).

The parameter beta controls how much the filter acts like an unsharp mask (beta=0) to much the filter acts like pass through (beta=1, with alpha=1).

The parameter window controls the size of the region over which local statistics are calculated.

By altering alpha, beta and window, a host of equalization and unsharp masking filters is available.

For detail description, reference "Adaptive Image Contrast Enhancement using Generalizations of Histogram Equalization." J.Alex Stark. IEEE Transactions on Image Processing, May 2000.

Definition at line 60 of file itkAdaptiveHistogramEqualizationImageFilter.h.

---

Member Typedef Documentation

template<class TImageType> typedef SmartPointer<const Self> itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::constPointer

Definition at line 69 of file itkAdaptiveHistogramEqualizationImageFilter.h.

template<class TImageType> typedef ImageType::SizeType itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::ImageSizeType

Definition at line 82 of file itkAdaptiveHistogramEqualizationImageFilter.h. Referenced by itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::~AdaptiveHistogramEqualizationImageFilter().

template<class TImageType> typedef TImageType itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::ImageType

Image type typedef support. Definition at line 81 of file itkAdaptiveHistogramEqualizationImageFilter.h.

template<class TImageType> typedef SmartPointer<Self> itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::Pointer

Reimplemented from itk::ImageToImageFilter< TImageType, TImageType >. Definition at line 68 of file itkAdaptiveHistogramEqualizationImageFilter.h.

template<class TImageType> typedef AdaptiveHistogramEqualizationImageFilter itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::Self

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TImageType, TImageType >. Definition at line 66 of file itkAdaptiveHistogramEqualizationImageFilter.h. Referenced by itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::~AdaptiveHistogramEqualizationImageFilter().

template<class TImageType> typedef ImageToImageFilter< TImageType, TImageType > itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::Superclass

Reimplemented from itk::ImageToImageFilter< TImageType, TImageType >. Definition at line 67 of file itkAdaptiveHistogramEqualizationImageFilter.h.

---

Constructor & Destructor Documentation

template<class TImageType> itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::AdaptiveHistogramEqualizationImageFilter (   )  [inline, protected]

Definition at line 114 of file itkAdaptiveHistogramEqualizationImageFilter.h.

template<class TImageType> virtual itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::~AdaptiveHistogramEqualizationImageFilter (   )  [inline, protected, virtual]

Definition at line 121 of file itkAdaptiveHistogramEqualizationImageFilter.h. References itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::ImageSizeType, and itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::Self.

---

Member Function Documentation

template<class TImageType> void itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::GenerateData (   )  [protected, virtual]

Standard pipeline method. Reimplemented from itk::ImageSource< TImageType >.

template<class TImageType> void itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::GenerateInputRequestedRegion (   )  [protected, virtual]

Adaptive histogram equalization requires more input that it outputs. It needs request an input region that is padded by the radius. See also: ProcessObject::GenerateInputRequestedRegion() Reimplemented from itk::ImageToImageFilter< TImageType, TImageType >.

template<class TImageType> virtual float itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::GetAlpha (   )  [virtual]

Set/Get the value of alpha. Alpha=0 produces the adaptive histogram equalization (provided beta=0). Alpha=1 produces an unsharp mask. Default is 0.3.

template<class TImageType> virtual float itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::GetBeta (   )  [virtual]

Set/Get the value of beta. If beta=1 (and alpha=1), then the output image matches the input image. As beta approaches 0, the filter behaves as an unsharp mask. Default is 0.3.

template<class TImageType> virtual const char* itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ImageToImageFilter< TImageType, TImageType >.

template<class TImageType> virtual const ImageSizeType& itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::GetRadius (   )  [virtual]

Set/Get the radius of the neighborhood used to compute local statistics. Radius sizes of 10 and 20 are common. Default is a radius of 5.

template<class TImageType> virtual bool itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::GetUseLookupTable (   )  [virtual]

Set/Get whether an optimized lookup table for the intensity mapping function is used. Default is off.

template<class TImageType> itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::itkStaticConstMacro (  ImageDimension  , unsigned  int, TImageType::ImageDimension  )

template<class TImageType> Pointer itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TImageType> void itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes. Reimplemented from itk::ImageToImageFilter< TImageType, TImageType >.

template<class TImageType> virtual void itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::SetAlpha (  float  _arg  )  [virtual]

Set/Get the value of alpha. Alpha=0 produces the adaptive histogram equalization (provided beta=0). Alpha=1 produces an unsharp mask. Default is 0.3.

template<class TImageType> virtual void itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::SetBeta (  float  _arg  )  [virtual]

Set/Get the value of beta. If beta=1 (and alpha=1), then the output image matches the input image. As beta approaches 0, the filter behaves as an unsharp mask. Default is 0.3.

template<class TImageType> virtual void itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::SetRadius (  ImageSizeType  _arg  )  [virtual]

Set/Get the radius of the neighborhood used to compute local statistics. Radius sizes of 10 and 20 are common. Default is a radius of 5.

template<class TImageType> virtual void itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::SetUseLookupTable (  bool  _arg  )  [virtual]

Set/Get whether an optimized lookup table for the intensity mapping function is used. Default is off.

template<class TImageType> virtual void itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::UseLookupTableOff (   )  [virtual]

Set/Get whether an optimized lookup table for the intensity mapping function is used. Default is off.

template<class TImageType> virtual void itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::UseLookupTableOn (   )  [virtual]

Set/Get whether an optimized lookup table for the intensity mapping function is used. Default is off.

---

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

• itkAdaptiveHistogramEqualizationImageFilter.h

---