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

binary reconstruction by erosion of an image More...

#include <sitkBinaryReconstructionByErosionImageFilter.h>

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

Public Types

using PixelIDTypeList = IntegerPixelIDTypeList
 
using Self = BinaryReconstructionByErosionImageFilter
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

 BinaryReconstructionByErosionImageFilter ()
 
Image Execute (const Image &markerImage, const Image &maskImage)
 
SelfFullyConnectedOff ()
 
SelfFullyConnectedOn ()
 
double GetBackgroundValue () const
 
double GetForegroundValue () const
 
bool GetFullyConnected () const
 
std::string GetName () const
 
SelfSetBackgroundValue (double BackgroundValue)
 
SelfSetForegroundValue (double ForegroundValue)
 
SelfSetFullyConnected (bool FullyConnected)
 
std::string ToString () const
 
virtual ~BinaryReconstructionByErosionImageFilter ()
 
- 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 *markerImage, const Image *maskImage)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image *markerImage, const Image *maskImage)
 

Private Attributes

double m_BackgroundValue {0.0}
 
double m_ForegroundValue {1.0}
 
bool m_FullyConnected {false}
 
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

binary reconstruction by erosion of an image

Reconstruction by erosion operates on a "marker" image and a "mask" image, and is defined as the erosion of the marker image with respect to the mask image iterated until stability.

Geodesic morphology is described in Chapter 6.2 of Pierre Soille's book "Morphological Image Analysis: Principles and Applications", Second Edition, Springer, 2003.

Author
Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

This implementation was taken from the Insight Journal paper: https://hdl.handle.net/1926/584 or http://www.insight-journal.org/browse/publication/176

See also
MorphologyImageFilter , ReconstructionByErosionImageFilter , BinaryReconstructionByDilationImageFilter
itk::simple::BinaryReconstructionByErosion for the procedural interface
itk::BinaryReconstructionByErosionImageFilter for the Doxygen on the original ITK class.

Definition at line 51 of file sitkBinaryReconstructionByErosionImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::BinaryReconstructionByErosionImageFilter::MemberFunctionType = Image (Self::*)( const Image * markerImage, const Image * maskImage )
private

Setup for member function dispatching

Definition at line 115 of file sitkBinaryReconstructionByErosionImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 63 of file sitkBinaryReconstructionByErosionImageFilter.h.

◆ Self

Constructor & Destructor Documentation

◆ ~BinaryReconstructionByErosionImageFilter()

virtual itk::simple::BinaryReconstructionByErosionImageFilter::~BinaryReconstructionByErosionImageFilter ( )
virtual

Destructor

◆ BinaryReconstructionByErosionImageFilter()

itk::simple::BinaryReconstructionByErosionImageFilter::BinaryReconstructionByErosionImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

Image itk::simple::BinaryReconstructionByErosionImageFilter::Execute ( const Image markerImage,
const Image maskImage 
)

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::BinaryReconstructionByErosionImageFilter::ExecuteInternal ( const Image markerImage,
const Image maskImage 
)
private

◆ FullyConnectedOff()

Self& itk::simple::BinaryReconstructionByErosionImageFilter::FullyConnectedOff ( )
inline

◆ FullyConnectedOn()

Self& itk::simple::BinaryReconstructionByErosionImageFilter::FullyConnectedOn ( )
inline

Set the value of FullyConnected to true or false respectfully.

Definition at line 92 of file sitkBinaryReconstructionByErosionImageFilter.h.

◆ GetBackgroundValue()

double itk::simple::BinaryReconstructionByErosionImageFilter::GetBackgroundValue ( ) const
inline

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::NonpositiveMin() .

Definition at line 74 of file sitkBinaryReconstructionByErosionImageFilter.h.

◆ GetForegroundValue()

double itk::simple::BinaryReconstructionByErosionImageFilter::GetForegroundValue ( ) const
inline

Set/Get the value used as "foreground" in the output image. Defaults to NumericTraits<PixelType>::max() .

Definition at line 84 of file sitkBinaryReconstructionByErosionImageFilter.h.

◆ GetFullyConnected()

bool itk::simple::BinaryReconstructionByErosionImageFilter::GetFullyConnected ( ) const
inline

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

Definition at line 98 of file sitkBinaryReconstructionByErosionImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 101 of file sitkBinaryReconstructionByErosionImageFilter.h.

◆ SetBackgroundValue()

Self& itk::simple::BinaryReconstructionByErosionImageFilter::SetBackgroundValue ( double  BackgroundValue)
inline

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::NonpositiveMin() .

Definition at line 69 of file sitkBinaryReconstructionByErosionImageFilter.h.

◆ SetForegroundValue()

Self& itk::simple::BinaryReconstructionByErosionImageFilter::SetForegroundValue ( double  ForegroundValue)
inline

Set/Get the value used as "foreground" in the output image. Defaults to NumericTraits<PixelType>::max() .

Definition at line 79 of file sitkBinaryReconstructionByErosionImageFilter.h.

◆ SetFullyConnected()

Self& itk::simple::BinaryReconstructionByErosionImageFilter::SetFullyConnected ( bool  FullyConnected)
inline

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

Definition at line 89 of file sitkBinaryReconstructionByErosionImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_BackgroundValue

double itk::simple::BinaryReconstructionByErosionImageFilter::m_BackgroundValue {0.0}
private

◆ m_ForegroundValue

double itk::simple::BinaryReconstructionByErosionImageFilter::m_ForegroundValue {1.0}
private

◆ m_FullyConnected

bool itk::simple::BinaryReconstructionByErosionImageFilter::m_FullyConnected {false}
private

◆ m_MemberFactory

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

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