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

This filter finds the closest pixel to the zero-crossings (sign changes) in a signed itk::Image . More...

#include <sitkZeroCrossingImageFilter.h>

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

Public Types

using PixelIDTypeList = SignedPixelIDTypeList
 
using Self = ZeroCrossingImageFilter
 
- 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
 
std::string GetName () const
 
SelfSetBackgroundValue (uint8_t BackgroundValue)
 
SelfSetForegroundValue (uint8_t ForegroundValue)
 
std::string ToString () const
 
 ZeroCrossingImageFilter ()
 
virtual ~ZeroCrossingImageFilter ()
 
- 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}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 

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 finds the closest pixel to the zero-crossings (sign changes) in a signed itk::Image .

Pixels closest to zero-crossings are labeled with a foreground value. All other pixels are marked with a background value. The algorithm works by detecting differences in sign among neighbors using city-block style connectivity (4-neighbors in 2d, 6-neighbors in 3d, etc.).

Inputs and Outputs
The input to this filter is an itk::Image of arbitrary dimension. The algorithm assumes a signed data type (zero-crossings are not defined for unsigned data types), and requires that operator>, operator<, operator==, and operator!= are defined.
The output of the filter is a binary, labeled image of user-specified type. By default, zero-crossing pixels are labeled with a default "foreground" value of itk::NumericTraits<OutputDataType>::OneValue() , where OutputDataType is the data type of the output image. All other pixels are labeled with a default "background" value of itk::NumericTraits<OutputDataType>::ZeroValue() .
Parameters
There are two parameters for this filter. ForegroundValue is the value that marks zero-crossing pixels. The BackgroundValue is the value given to all other pixels.
See also
Image
Neighborhood
NeighborhoodOperator
NeighborhoodIterator
itk::simple::ZeroCrossing for the procedural interface
itk::ZeroCrossingImageFilter for the Doxygen on the original ITK class.

Definition at line 65 of file sitkZeroCrossingImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::ZeroCrossingImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )
private

Setup for member function dispatching

Definition at line 115 of file sitkZeroCrossingImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 77 of file sitkZeroCrossingImageFilter.h.

◆ Self

Definition at line 67 of file sitkZeroCrossingImageFilter.h.

Constructor & Destructor Documentation

◆ ~ZeroCrossingImageFilter()

virtual itk::simple::ZeroCrossingImageFilter::~ZeroCrossingImageFilter ( )
virtual

Destructor

◆ ZeroCrossingImageFilter()

itk::simple::ZeroCrossingImageFilter::ZeroCrossingImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ GetBackgroundValue()

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

Set/Get the label value for non-zero-crossing pixels.

Definition at line 98 of file sitkZeroCrossingImageFilter.h.

◆ GetForegroundValue()

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

Set/Get the label value for zero-crossing pixels.

Definition at line 88 of file sitkZeroCrossingImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 101 of file sitkZeroCrossingImageFilter.h.

◆ SetBackgroundValue()

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

Set/Get the label value for non-zero-crossing pixels.

Definition at line 93 of file sitkZeroCrossingImageFilter.h.

◆ SetForegroundValue()

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

Set/Get the label value for zero-crossing pixels.

Definition at line 83 of file sitkZeroCrossingImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 119 of file sitkZeroCrossingImageFilter.h.

Member Data Documentation

◆ m_BackgroundValue

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

Definition at line 126 of file sitkZeroCrossingImageFilter.h.

◆ m_ForegroundValue

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

Definition at line 124 of file sitkZeroCrossingImageFilter.h.

◆ m_MemberFactory

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

Definition at line 121 of file sitkZeroCrossingImageFilter.h.


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