Power Law Adaptive Histogram Equalization. More...

#include <sitkAdaptiveHistogramEqualizationImageFilter.h>

Inheritance diagram for itk::simple::AdaptiveHistogramEqualizationImageFilter:

Collaboration diagram for itk::simple::AdaptiveHistogramEqualizationImageFilter:

Public Types
typedef BasicPixelIDTypeList	PixelIDTypeList

typedef AdaptiveHistogramEqualizationImageFilter	Self

Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter	Self

Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
	AdaptiveHistogramEqualizationImageFilter ()

Image	Execute (const Image &image1)

Image	Execute (const Image &image1, const std::vector< unsigned int > &radius, float alpha, float beta, bool useLookupTable)

float	GetAlpha () const

float	GetBeta () const

std::string	GetName () const

std::vector< unsigned int >	GetRadius () const

bool	GetUseLookupTable () const

Self &	SetAlpha (float Alpha)

Self &	SetBeta (float Beta)

Self &	SetRadius (const std::vector< unsigned int > &Radius)

Self &	SetRadius (unsigned int value)

Self &	SetUseLookupTable (bool UseLookupTable)

std::string	ToString () const

Self &	UseLookupTableOff ()

Self &	UseLookupTableOn ()

	~AdaptiveHistogramEqualizationImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter< 1 >
	ImageFilter ()

virtual	~ImageFilter ()=0

Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()

virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...

virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...

virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands. More...

virtual	~ProcessObject ()

virtual void	DebugOn ()

virtual void	DebugOff ()

virtual bool	GetDebug () const

virtual void	SetDebug (bool debugFlag)

virtual void	SetNumberOfThreads (unsigned int n)

virtual unsigned int	GetNumberOfThreads () const

Private Types
typedef Image(Self::*	MemberFunctionType) (const Image &image1)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image &image1)

Private Attributes
float	m_Alpha

float	m_Beta

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

std::vector< unsigned int >	m_Radius

bool	m_UseLookupTable

Friends
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()

static void	GlobalDefaultDebugOff ()

static void	GlobalDefaultDebugOn ()

static void	SetGlobalDefaultDebug (bool debugFlag)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static void	SetGlobalWarningDisplay (bool flag)

static bool	GetGlobalWarningDisplay ()

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()

static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)

virtual itk::ProcessObject *	GetActiveProcess ()

virtual void	OnActiveProcessDelete ()

virtual void	onCommandDelete (const itk::simple::Command *cmd) throw ()

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()

Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
static void	FixNonZeroIndex (TImageType *img)

Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer	CastImageToITK (const Image &img)

template<class TImageType >
static Image	CastITKToImage (TImageType *img)

template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)

static const itk::EventObject &	GetITKEventObject (EventEnum e)

template<typename T >
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)

static std::ostream &	ToStringHelper (std::ostream &os, const char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Detailed Description

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.

The boundary condition ignores the part of the neighborhood outside the image, and over-weights the valid part of the neighborhood.

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

Wiki Examples:

All Examples

Adaptive histogram equalization
See also
itk::simple::AdaptiveHistogramEqualization for the procedural interface

itk::AdaptiveHistogramEqualizationImageFilter for the Doxygen on the original ITK class.

Definition at line 61 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::AdaptiveHistogramEqualizationImageFilter::MemberFunctionType) (const Image &image1)

private

Setup for member function dispatching

Definition at line 141 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::AdaptiveHistogramEqualizationImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 73 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

typedef AdaptiveHistogramEqualizationImageFilter itk::simple::AdaptiveHistogramEqualizationImageFilter::Self

Definition at line 63 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

Constructor & Destructor Documentation

itk::simple::AdaptiveHistogramEqualizationImageFilter::AdaptiveHistogramEqualizationImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

itk::simple::AdaptiveHistogramEqualizationImageFilter::~AdaptiveHistogramEqualizationImageFilter ( )

Destructor

Member Function Documentation

Image itk::simple::AdaptiveHistogramEqualizationImageFilter::Execute ( const Image & image1 )

Execute the filter on the input image

Image itk::simple::AdaptiveHistogramEqualizationImageFilter::Execute	(	const Image &	image1,
		const std::vector< unsigned int > &	radius,
		float	alpha,
		float	beta,
		bool	useLookupTable
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

Image itk::simple::AdaptiveHistogramEqualizationImageFilter::ExecuteInternal ( const Image & image1 )

private

float itk::simple::AdaptiveHistogramEqualizationImageFilter::GetAlpha ( ) const

inline

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.

Definition at line 97 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

float itk::simple::AdaptiveHistogramEqualizationImageFilter::GetBeta ( ) const

inline

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.

Definition at line 107 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

std::string itk::simple::AdaptiveHistogramEqualizationImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 123 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

std::vector<unsigned int> itk::simple::AdaptiveHistogramEqualizationImageFilter::GetRadius ( ) const

inline

Definition at line 87 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

bool itk::simple::AdaptiveHistogramEqualizationImageFilter::GetUseLookupTable ( ) const

inline

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

Definition at line 121 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

Self& itk::simple::AdaptiveHistogramEqualizationImageFilter::SetAlpha ( float Alpha )

inline

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.

Definition at line 92 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

Self& itk::simple::AdaptiveHistogramEqualizationImageFilter::SetBeta ( float Beta )

inline

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.

Definition at line 102 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

Self& itk::simple::AdaptiveHistogramEqualizationImageFilter::SetRadius ( const std::vector< unsigned int > & Radius )

inline

Definition at line 79 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

Self& itk::simple::AdaptiveHistogramEqualizationImageFilter::SetRadius ( unsigned int value )

inline

Set the values of the Radius vector all to value

Definition at line 82 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

Self& itk::simple::AdaptiveHistogramEqualizationImageFilter::SetUseLookupTable ( bool UseLookupTable )

inline

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

Definition at line 112 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

std::string itk::simple::AdaptiveHistogramEqualizationImageFilter::ToString ( ) const

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Self& itk::simple::AdaptiveHistogramEqualizationImageFilter::UseLookupTableOff ( )

inline

Definition at line 116 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

Self& itk::simple::AdaptiveHistogramEqualizationImageFilter::UseLookupTableOn ( )

inline

Set the value of UseLookupTable to true or false respectfully.

Definition at line 115 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

Friends And Related Function Documentation

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 146 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

Member Data Documentation

float itk::simple::AdaptiveHistogramEqualizationImageFilter::m_Alpha

private

Definition at line 152 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

float itk::simple::AdaptiveHistogramEqualizationImageFilter::m_Beta

private

Definition at line 153 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::AdaptiveHistogramEqualizationImageFilter::m_MemberFactory

private

Definition at line 148 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

std::vector<unsigned int> itk::simple::AdaptiveHistogramEqualizationImageFilter::m_Radius

private

Definition at line 151 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

bool itk::simple::AdaptiveHistogramEqualizationImageFilter::m_UseLookupTable

private

Definition at line 154 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

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

sitkAdaptiveHistogramEqualizationImageFilter.h

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation