itk::AdaptiveHistogramEqualizationImageFilter< TImageType > Class Template Reference

#include <itkAdaptiveHistogramEqualizationImageFilter.h>

Inheritance diagram for itk::AdaptiveHistogramEqualizationImageFilter< TImageType >:

Collaboration diagram for itk::AdaptiveHistogramEqualizationImageFilter< TImageType >:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef ImageType::SizeType	ImageSizeType
typedef TImageType	ImageType
typedef SmartPointer< Self >	Pointer
typedef AdaptiveHistogramEqualizationImageFilter	Self
typedef ImageToImageFilter < TImageType, TImageType >	Superclass
Public Types inherited from itk::BoxImageFilter< TImageType, TImageType >
typedef TImageType::IndexType	IndexType
typedef TImageType	InputImageType
typedef TImageType::PixelType	InputPixelType
typedef TImageType::OffsetType	OffsetType
typedef TImageType	OutputImageType
typedef TImageType::PixelType	OutputPixelType
typedef TImageType::SizeType	RadiusType
typedef TImageType::SizeValueType	RadiusValueType
typedef TImageType::RegionType	RegionType
typedef TImageType::SizeType	SizeType
Public Types inherited from itk::ImageToImageFilter< TImageType, TImageType >
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
Public Types inherited from itk::ImageSource< TImageType >
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef OutputImageType::Pointer	OutputImagePointer
Public Types inherited from itk::ProcessObject
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef std::vector < DataObjectIdentifierType >	NameArray
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
virtual void	SetAlpha (float _arg)
virtual float	GetAlpha () const
virtual void	SetBeta (float _arg)
virtual float	GetBeta () const
Public Member Functions inherited from itk::BoxImageFilter< TImageType, TImageType >
void	GenerateInputRequestedRegion ()
virtual const RadiusType &	GetRadius ()
virtual void	SetRadius (const RadiusType &radius)
virtual void	SetRadius (const RadiusValueType &radius)
Public Member Functions inherited from itk::ImageToImageFilter< TImageType, TImageType >
const InputImageType *	GetInput (void) const
const InputImageType *	GetInput (unsigned int idx) const
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
virtual void	SetInput (const InputImageType *image)
virtual void	SetInput (unsigned int, const TImageType *image)
Public Member Functions inherited from itk::ImageSource< TImageType >
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType *	GetOutput (void)
const OutputImageType *	GetOutput (void) const
virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static const unsigned int	ImageDimension = TImageType::ImageDimension
Static Public Attributes inherited from itk::BoxImageFilter< TImageType, TImageType >
Static Public Attributes inherited from itk::ImageToImageFilter< TImageType, TImageType >
static const unsigned int	InputImageDimension
static const unsigned int	OutputImageDimension
Static Public Attributes inherited from itk::ImageSource< TImageType >

Protected Member Functions
void	GenerateData ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~AdaptiveHistogramEqualizationImageFilter ()
Protected Member Functions inherited from itk::BoxImageFilter< TImageType, TImageType >
	BoxImageFilter ()
	~BoxImageFilter ()
Protected Member Functions inherited from itk::ImageToImageFilter< TImageType, TImageType >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
	ImageToImageFilter ()
virtual void	VerifyInputInformation ()
	~ImageToImageFilter ()
void	PushBackInput (const DataObject *input)
void	PushFrontInput (const DataObject *input)
Protected Member Functions inherited from itk::ImageSource< TImageType >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual	~ImageSource ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Member Functions
	AdaptiveHistogramEqualizationImageFilter (const Self &)
void	operator= (const Self &)
float	CumulativeFunction (float u, float v)

Private Attributes
float	m_Alpha
float	m_Beta
bool	m_UseLookupTable
virtual void	SetUseLookupTable (bool _arg)
virtual bool	GetUseLookupTable () const
virtual void	UseLookupTableOn ()
virtual void	UseLookupTableOff ()
	AdaptiveHistogramEqualizationImageFilter ()

---

Detailed Description

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

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.

Wiki Examples:

• All Examples

• Adaptive histogram equalization

Definition at line 66 of file itkAdaptiveHistogramEqualizationImageFilter.h.

---

Member Typedef Documentation

template<class TImageType >

typedef SmartPointer< const Self > itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::ConstPointer

Reimplemented from itk::BoxImageFilter< TImageType, TImageType >.

Definition at line 77 of file itkAdaptiveHistogramEqualizationImageFilter.h.

template<class TImageType >

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

Definition at line 90 of file itkAdaptiveHistogramEqualizationImageFilter.h.

template<class TImageType >

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

Image type typedef support.

Definition at line 86 of file itkAdaptiveHistogramEqualizationImageFilter.h.

template<class TImageType >

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

Reimplemented from itk::BoxImageFilter< TImageType, TImageType >.

Definition at line 76 of file itkAdaptiveHistogramEqualizationImageFilter.h.

template<class TImageType >

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

Standard class typedefs

Reimplemented from itk::BoxImageFilter< TImageType, TImageType >.

Definition at line 74 of file itkAdaptiveHistogramEqualizationImageFilter.h.

template<class TImageType >

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

Reimplemented from itk::BoxImageFilter< TImageType, TImageType >.

Definition at line 75 of file itkAdaptiveHistogramEqualizationImageFilter.h.

---

Constructor & Destructor Documentation

template<class TImageType >

itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::AdaptiveHistogramEqualizationImageFilter ( )

inlineprotected

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

Definition at line 113 of file itkAdaptiveHistogramEqualizationImageFilter.h.

template<class TImageType >

virtual itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::~AdaptiveHistogramEqualizationImageFilter ( )

inlineprotectedvirtual

Definition at line 122 of file itkAdaptiveHistogramEqualizationImageFilter.h.

template<class TImageType >

itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::AdaptiveHistogramEqualizationImageFilter ( const Self &  )

private

---

Member Function Documentation

template<class TImageType >

virtual::itk::LightObject::Pointer itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::CreateAnother ( void  ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::BoxImageFilter< TImageType, TImageType >.

template<class TImageType >

float itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::CumulativeFunction ( float  u, float  v  )

private

A function which is used in GenerateData().

template<class TImageType >

void itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::GenerateData ( )

protectedvirtual

Standard pipeline method

Reimplemented from itk::ImageSource< TImageType >.

template<class TImageType >

virtual float itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::GetAlpha ( ) const

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 ( ) const

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::BoxImageFilter< TImageType, TImageType >.

template<class TImageType >

virtual bool itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::GetUseLookupTable ( ) const

virtual

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

template<class TImageType >

static Pointer itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::BoxImageFilter< TImageType, TImageType >.

template<class TImageType >

void itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::operator= ( const Self &  )

private

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::BoxImageFilter< TImageType, TImageType >.

template<class TImageType >

void itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

protectedvirtual

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::BoxImageFilter< 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 >::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.

---

Member Data Documentation

template<class TImageType >

const unsigned int itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::ImageDimension = TImageType::ImageDimension

static

Image related typedefs.

Reimplemented from itk::BoxImageFilter< TImageType, TImageType >.

Definition at line 80 of file itkAdaptiveHistogramEqualizationImageFilter.h.

template<class TImageType >

float itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::m_Alpha

private

The beta parameter of the AdaptiveHistogramEqualization.

Definition at line 138 of file itkAdaptiveHistogramEqualizationImageFilter.h.

template<class TImageType >

float itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::m_Beta

private

The alpha parameter of the AdaptiveHistogramEqualization.

Definition at line 141 of file itkAdaptiveHistogramEqualizationImageFilter.h.

template<class TImageType >

bool itk::AdaptiveHistogramEqualizationImageFilter< TImageType >::m_UseLookupTable

private

Should we use a lookup table to optimize the use of the intensity mapping function?

Definition at line 145 of file itkAdaptiveHistogramEqualizationImageFilter.h.

---

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

• itkAdaptiveHistogramEqualizationImageFilter.h