SimpleITK  2.1.0.dev86
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::ZeroCrossingBasedEdgeDetectionImageFilter Class Reference

This filter implements a zero-crossing based edge detecor. More...

#include <sitkZeroCrossingBasedEdgeDetectionImageFilter.h>

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

Public Types

using PixelIDTypeList = RealPixelIDTypeList
 
using Self = ZeroCrossingBasedEdgeDetectionImageFilter
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

Image Execute (const Image &image1)
 
uint8_t GetBackgroundValue () const
 
uint8_t GetForegroundValue () const
 
double GetMaximumError () const
 
std::string GetName () const
 
double GetVariance () const
 
SelfSetBackgroundValue (uint8_t BackgroundValue)
 
SelfSetForegroundValue (uint8_t ForegroundValue)
 
SelfSetMaximumError (double MaximumError)
 
SelfSetVariance (double Variance)
 
std::string ToString () const
 
 ZeroCrossingBasedEdgeDetectionImageFilter ()
 
virtual ~ZeroCrossingBasedEdgeDetectionImageFilter ()
 
- 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

uint8_t m_BackgroundValue {0u}
 
uint8_t m_ForegroundValue {1u}
 
double m_MaximumError {0.1}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
double m_Variance {1.0}
 

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

This filter implements a zero-crossing based edge detecor.

The zero-crossing based edge detector looks for pixels in the Laplacian of an image where the value of the Laplacian passes through zero points where the Laplacian changes sign. Such points often occur at "edges" in images i.e. points where the intensity of the image changes rapidly, but they also occur at places that are not as easy to associate with edges. It is best to think of the zero crossing detector as some sort of feature detector rather than as a specific edge detector.

Zero crossings always lie on closed contours and so the output from the zero crossing detector is usually a binary image with single pixel thickness lines showing the positions of the zero crossing points.
In this implementation, the input image is first smoothed with a Gaussian filter, then the LaplacianImageFilter is applied to smoothed image. Finally the zero-crossing of the Laplacian of the smoothed image is detected. The output is a binary image.
Inputs and Outputs
The input to the filter should be a scalar, itk::Image of arbitrary dimension. The output image is a binary, labeled image. See itkZeroCrossingImageFilter for more information on requirements of the data type of the output.
To use this filter, first set the parameters (variance and maximum error) needed by the embedded DiscreteGaussianImageFilter , i.e. See DiscreteGaussianImageFilter for information about these parameters. Optionally, you may also set foreground and background values for the zero-crossing filter. The default label values are Zero for the background and One for the foreground, as defined in NumericTraits for the data type of the output image.
See also
DiscreteGaussianImageFilter
LaplacianImageFilter
ZeroCrossingImageFilter
itk::simple::ZeroCrossingBasedEdgeDetection for the procedural interface
itk::ZeroCrossingBasedEdgeDetectionImageFilter for the Doxygen on the original ITK class.

Definition at line 66 of file sitkZeroCrossingBasedEdgeDetectionImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 136 of file sitkZeroCrossingBasedEdgeDetectionImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 78 of file sitkZeroCrossingBasedEdgeDetectionImageFilter.h.

◆ Self

Constructor & Destructor Documentation

◆ ~ZeroCrossingBasedEdgeDetectionImageFilter()

virtual itk::simple::ZeroCrossingBasedEdgeDetectionImageFilter::~ZeroCrossingBasedEdgeDetectionImageFilter ( )
virtual

Destructor

◆ ZeroCrossingBasedEdgeDetectionImageFilter()

itk::simple::ZeroCrossingBasedEdgeDetectionImageFilter::ZeroCrossingBasedEdgeDetectionImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ GetBackgroundValue()

uint8_t itk::simple::ZeroCrossingBasedEdgeDetectionImageFilter::GetBackgroundValue ( ) const
inline

Get/Set the label values for the ZeroCrossingImageFilter

Definition at line 109 of file sitkZeroCrossingBasedEdgeDetectionImageFilter.h.

◆ GetForegroundValue()

uint8_t itk::simple::ZeroCrossingBasedEdgeDetectionImageFilter::GetForegroundValue ( ) const
inline

Get/Set the label values for the ZeroCrossingImageFilter

Definition at line 99 of file sitkZeroCrossingBasedEdgeDetectionImageFilter.h.

◆ GetMaximumError()

double itk::simple::ZeroCrossingBasedEdgeDetectionImageFilter::GetMaximumError ( ) const
inline

Standard get/set macros for Gaussian filter parameters.

Definition at line 119 of file sitkZeroCrossingBasedEdgeDetectionImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 122 of file sitkZeroCrossingBasedEdgeDetectionImageFilter.h.

◆ GetVariance()

double itk::simple::ZeroCrossingBasedEdgeDetectionImageFilter::GetVariance ( ) const
inline

Standard get/set macros for Gaussian filter parameters.

Definition at line 89 of file sitkZeroCrossingBasedEdgeDetectionImageFilter.h.

◆ SetBackgroundValue()

Self& itk::simple::ZeroCrossingBasedEdgeDetectionImageFilter::SetBackgroundValue ( uint8_t  BackgroundValue)
inline

Get/Set the label values for the ZeroCrossingImageFilter

Definition at line 104 of file sitkZeroCrossingBasedEdgeDetectionImageFilter.h.

◆ SetForegroundValue()

Self& itk::simple::ZeroCrossingBasedEdgeDetectionImageFilter::SetForegroundValue ( uint8_t  ForegroundValue)
inline

Get/Set the label values for the ZeroCrossingImageFilter

Definition at line 94 of file sitkZeroCrossingBasedEdgeDetectionImageFilter.h.

◆ SetMaximumError()

Self& itk::simple::ZeroCrossingBasedEdgeDetectionImageFilter::SetMaximumError ( double  MaximumError)
inline

Set the MaximumError parameter needed by the embedded gaussian filter This value is used to set the desired maximum error of the gaussian approximation. Maximum error is the difference between the area under the discrete Gaussian curve and the area under the continuous Gaussian. Maximum error affects the Gaussian operator size. The value must be between 0.0 and 1.0.

Definition at line 114 of file sitkZeroCrossingBasedEdgeDetectionImageFilter.h.

◆ SetVariance()

Self& itk::simple::ZeroCrossingBasedEdgeDetectionImageFilter::SetVariance ( double  Variance)
inline

Set the variance parameter needed by the embedded gaussian filter

Definition at line 84 of file sitkZeroCrossingBasedEdgeDetectionImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_BackgroundValue

uint8_t itk::simple::ZeroCrossingBasedEdgeDetectionImageFilter::m_BackgroundValue {0u}
private

◆ m_ForegroundValue

uint8_t itk::simple::ZeroCrossingBasedEdgeDetectionImageFilter::m_ForegroundValue {1u}
private

◆ m_MaximumError

double itk::simple::ZeroCrossingBasedEdgeDetectionImageFilter::m_MaximumError {0.1}
private

◆ m_MemberFactory

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

◆ m_Variance

double itk::simple::ZeroCrossingBasedEdgeDetectionImageFilter::m_Variance {1.0}
private

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