SimpleITK  2.0.0rc2.post38
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::AdaptiveHistogramEqualizationImageFilter Class Reference

Power Law Adaptive Histogram Equalization. More...

#include <sitkAdaptiveHistogramEqualizationImageFilter.h>

+ Inheritance diagram for itk::simple::AdaptiveHistogramEqualizationImageFilter:
+ Collaboration diagram for itk::simple::AdaptiveHistogramEqualizationImageFilter:

Public Types

using PixelIDTypeList = BasicPixelIDTypeList
 
using Self = AdaptiveHistogramEqualizationImageFilter
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

 AdaptiveHistogramEqualizationImageFilter ()
 
Image Execute (const Image &image1)
 
float GetAlpha () const
 
float GetBeta () const
 
std::string GetName () const
 
std::vector< unsigned int > GetRadius () const
 
SelfSetAlpha (float Alpha)
 
SelfSetBeta (float Beta)
 
SelfSetRadius (std::vector< unsigned int > Radius)
 
SelfSetRadius (unsigned int value)
 
std::string ToString () const
 
virtual ~AdaptiveHistogramEqualizationImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
 Directly add a callback to observe an event. More...
 
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
 
virtual void SetNumberOfWorkUnits (unsigned int n)
 
virtual unsigned int GetNumberOfWorkUnits () const
 

Private Types

using MemberFunctionType = Image(Self::*)(const Image &image1)
 

Private Member Functions

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

Private Attributes

float m_Alpha {0.3f}
 
float m_Beta {0.3f}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
std::vector< unsigned int > m_Radius {std::vector<unsigned int>(3, 5)}
 

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 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...
 
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
 
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
 
- Protected Member Functions inherited from itk::simple::ImageFilter
void CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
 
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
 
virtual itk::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) noexcept
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 
 NonCopyable (const NonCopyable &)=delete
 
NonCopyableoperator= (const NonCopyable &)=delete
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
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 TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
 
template<class TImageType >
static Image CastITKToImage (TImageType *img)
 
static const itk::EventObjectGetITKEventObject (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. The size of the window is controlled by SetRadius the default Radius is 5 in all directions.

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.

See also
itk::simple::AdaptiveHistogramEqualization for the procedural interface
itk::AdaptiveHistogramEqualizationImageFilter for the Doxygen on the original ITK class.

Definition at line 55 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 116 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 67 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

◆ Self

Constructor & Destructor Documentation

◆ ~AdaptiveHistogramEqualizationImageFilter()

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

Destructor

◆ AdaptiveHistogramEqualizationImageFilter()

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::AdaptiveHistogramEqualizationImageFilter::ExecuteInternal ( const Image image1)
private

◆ GetAlpha()

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 89 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

◆ GetBeta()

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 99 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 102 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

◆ GetRadius()

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

◆ SetAlpha()

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 84 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

◆ SetBeta()

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 94 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

◆ SetRadius() [1/2]

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

◆ SetRadius() [2/2]

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

Set the values of the Radius vector all to value

Definition at line 75 of file sitkAdaptiveHistogramEqualizationImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_Alpha

float itk::simple::AdaptiveHistogramEqualizationImageFilter::m_Alpha {0.3f}
private

◆ m_Beta

float itk::simple::AdaptiveHistogramEqualizationImageFilter::m_Beta {0.3f}
private

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::AdaptiveHistogramEqualizationImageFilter::m_MemberFactory
private

◆ m_Radius

std::vector<unsigned int> itk::simple::AdaptiveHistogramEqualizationImageFilter::m_Radius {std::vector<unsigned int>(3, 5)}
private

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