SimpleITK  1.3.0.dev391
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::UnsharpMaskImageFilter Class Reference

Edge enhancement filter. More...

#include <sitkUnsharpMaskImageFilter.h>

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

Public Types

typedef RealPixelIDTypeList PixelIDTypeList
 
typedef UnsharpMaskImageFilter 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

Image Execute (const Image &image1)
 
Image Execute (const Image &image1, const std::vector< double > &sigmas, double amount, double threshold)
 
double GetAmount () const
 
std::string GetName () const
 
std::vector< double > GetSigmas () const
 
double GetThreshold () const
 
SelfSetAmount (double Amount)
 
SelfSetSigmas (double s)
 
SelfSetSigmas (const std::vector< double > &Sigmas)
 
SelfSetThreshold (double Threshold)
 
std::string ToString () const
 
 UnsharpMaskImageFilter ()
 
virtual ~UnsharpMaskImageFilter ()
 
- 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

double m_Amount
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
std::vector< double > m_Sigmas
 
double m_Threshold
 

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::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) SITK_NOEXCEPT
 
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::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

Edge enhancement filter.

This filter subtracts a smoothed version of the image from the image to achieve the edge enhancing effect. https://en.wikipedia.org/w/index.php?title=Unsharp_masking&oldid=750486803#Photographic_unsharp_masking

It has configurable amount, radius (sigma) and threshold, and whether to clamp the resulting values to the range of output type.

Formula: sharpened=original+[abs(original-blurred)-threshold]*amount

If clamping is turned off (it is on by default), casting to output pixel format is done using C++ defaults, meaning that values are not clamped but rather wrap around e.g. 260 -> 4 (unsigned char).

See also
ImageToImageFilter
SmoothingRecursiveGaussianImageFilter
RescaleIntensityImageFilter
itk::simple::UnsharpMask for the procedural interface
itk::UnsharpMaskImageFilter for the Doxygen on the original ITK class.

Definition at line 54 of file sitkUnsharpMaskImageFilter.h.

Member Typedef Documentation

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

Setup for member function dispatching

Definition at line 119 of file sitkUnsharpMaskImageFilter.h.

Define the pixels types supported by this filter

Definition at line 66 of file sitkUnsharpMaskImageFilter.h.

Definition at line 56 of file sitkUnsharpMaskImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::UnsharpMaskImageFilter::~UnsharpMaskImageFilter ( )
virtual

Destructor

itk::simple::UnsharpMaskImageFilter::UnsharpMaskImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input image

Image itk::simple::UnsharpMaskImageFilter::Execute ( const Image image1,
const std::vector< double > &  sigmas,
double  amount,
double  threshold 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::UnsharpMaskImageFilter::ExecuteInternal ( const Image image1)
private
double itk::simple::UnsharpMaskImageFilter::GetAmount ( ) const
inline

Set/Get amount of enhancement. Usual range: 0.1 to 2.0. Default: 0.5.

Definition at line 90 of file sitkUnsharpMaskImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 102 of file sitkUnsharpMaskImageFilter.h.

std::vector<double> itk::simple::UnsharpMaskImageFilter::GetSigmas ( ) const
inline

Set/Get Sigma values measured in the units of image spacing. Default: 1.0.

Definition at line 80 of file sitkUnsharpMaskImageFilter.h.

double itk::simple::UnsharpMaskImageFilter::GetThreshold ( ) const
inline

Set/Get threshold for enhancement. Default: 0.

Definition at line 100 of file sitkUnsharpMaskImageFilter.h.

Self& itk::simple::UnsharpMaskImageFilter::SetAmount ( double  Amount)
inline

Set/Get amount of enhancement. Usual range: 0.1 to 2.0. Default: 0.5.

Definition at line 85 of file sitkUnsharpMaskImageFilter.h.

Self& itk::simple::UnsharpMaskImageFilter::SetSigmas ( double  s)
inline

Custom public declarations

Definition at line 68 of file sitkUnsharpMaskImageFilter.h.

Self& itk::simple::UnsharpMaskImageFilter::SetSigmas ( const std::vector< double > &  Sigmas)
inline

Set/Get Sigma values measured in the units of image spacing. Default: 1.0.

Definition at line 75 of file sitkUnsharpMaskImageFilter.h.

Self& itk::simple::UnsharpMaskImageFilter::SetThreshold ( double  Threshold)
inline

Set/Get threshold for enhancement. Default: 0.

Definition at line 95 of file sitkUnsharpMaskImageFilter.h.

References itk::simple::Threshold().

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 123 of file sitkUnsharpMaskImageFilter.h.

Member Data Documentation

double itk::simple::UnsharpMaskImageFilter::m_Amount
private

Definition at line 129 of file sitkUnsharpMaskImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::UnsharpMaskImageFilter::m_MemberFactory
private

Definition at line 125 of file sitkUnsharpMaskImageFilter.h.

std::vector<double> itk::simple::UnsharpMaskImageFilter::m_Sigmas
private

Definition at line 128 of file sitkUnsharpMaskImageFilter.h.

double itk::simple::UnsharpMaskImageFilter::m_Threshold
private

Definition at line 130 of file sitkUnsharpMaskImageFilter.h.


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