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

Computes an image of contours which will be the contour of the first image. More...

#include <sitkSimpleContourExtractorImageFilter.h>

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

Public Types

using PixelIDTypeList = BasicPixelIDTypeList
 
using Self = SimpleContourExtractorImageFilter
 
- 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)
 
double GetInputBackgroundValue () const
 
double GetInputForegroundValue () const
 
std::string GetName () const
 
double GetOutputBackgroundValue () const
 
double GetOutputForegroundValue () const
 
std::vector< unsigned int > GetRadius () const
 
SelfSetInputBackgroundValue (double InputBackgroundValue)
 
SelfSetInputForegroundValue (double InputForegroundValue)
 
SelfSetOutputBackgroundValue (double OutputBackgroundValue)
 
SelfSetOutputForegroundValue (double OutputForegroundValue)
 
SelfSetRadius (std::vector< unsigned int > Radius)
 
SelfSetRadius (unsigned int value)
 
 SimpleContourExtractorImageFilter ()
 
std::string ToString () const
 
virtual ~SimpleContourExtractorImageFilter ()
 
- 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

double m_InputBackgroundValue {0.0}
 
double m_InputForegroundValue {1.0}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
double m_OutputBackgroundValue {0.0}
 
double m_OutputForegroundValue {1.0}
 
std::vector< unsigned int > m_Radius {std::vector<unsigned int>(3, 1)}
 

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

Computes an image of contours which will be the contour of the first image.

A pixel of the source image is considered to belong to the contour if its pixel value is equal to the input foreground value and it has in its neighborhood at least one pixel which its pixel value is equal to the input background value. The output image will have pixels which will be set to the output foreground value if they belong to the contour, otherwise they will be set to the output background value.

The neighborhood "radius" is set thanks to the radius params.

See also
Image
Neighborhood
NeighborhoodOperator
NeighborhoodIterator
itk::simple::SimpleContourExtractor for the procedural interface
itk::SimpleContourExtractorImageFilter for the Doxygen on the original ITK class.

Definition at line 53 of file sitkSimpleContourExtractorImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 134 of file sitkSimpleContourExtractorImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 65 of file sitkSimpleContourExtractorImageFilter.h.

◆ Self

Definition at line 55 of file sitkSimpleContourExtractorImageFilter.h.

Constructor & Destructor Documentation

◆ ~SimpleContourExtractorImageFilter()

virtual itk::simple::SimpleContourExtractorImageFilter::~SimpleContourExtractorImageFilter ( )
virtual

Destructor

◆ SimpleContourExtractorImageFilter()

itk::simple::SimpleContourExtractorImageFilter::SimpleContourExtractorImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ GetInputBackgroundValue()

double itk::simple::SimpleContourExtractorImageFilter::GetInputBackgroundValue ( ) const
inline

Get the background value used in order to identify a background pixel in the input image.

Definition at line 86 of file sitkSimpleContourExtractorImageFilter.h.

◆ GetInputForegroundValue()

double itk::simple::SimpleContourExtractorImageFilter::GetInputForegroundValue ( ) const
inline

Get the foreground value used in order to identify a foreground pixel in the input image.

Definition at line 76 of file sitkSimpleContourExtractorImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 120 of file sitkSimpleContourExtractorImageFilter.h.

◆ GetOutputBackgroundValue()

double itk::simple::SimpleContourExtractorImageFilter::GetOutputBackgroundValue ( ) const
inline

Get the background value used in order to identify a background pixel in the output image.

Definition at line 117 of file sitkSimpleContourExtractorImageFilter.h.

◆ GetOutputForegroundValue()

double itk::simple::SimpleContourExtractorImageFilter::GetOutputForegroundValue ( ) const
inline

Get the foreground value used in order to identify a foreground pixel in the output image.

Definition at line 107 of file sitkSimpleContourExtractorImageFilter.h.

◆ GetRadius()

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

Definition at line 97 of file sitkSimpleContourExtractorImageFilter.h.

◆ SetInputBackgroundValue()

Self& itk::simple::SimpleContourExtractorImageFilter::SetInputBackgroundValue ( double  InputBackgroundValue)
inline

Set the background value used in order to identify a background pixel in the input image.

Definition at line 81 of file sitkSimpleContourExtractorImageFilter.h.

◆ SetInputForegroundValue()

Self& itk::simple::SimpleContourExtractorImageFilter::SetInputForegroundValue ( double  InputForegroundValue)
inline

Set the foreground value used in order to identify a foreground pixel in the input image.

Definition at line 71 of file sitkSimpleContourExtractorImageFilter.h.

◆ SetOutputBackgroundValue()

Self& itk::simple::SimpleContourExtractorImageFilter::SetOutputBackgroundValue ( double  OutputBackgroundValue)
inline

Set the background value used in order to identify a background pixel in the output image.

Definition at line 112 of file sitkSimpleContourExtractorImageFilter.h.

◆ SetOutputForegroundValue()

Self& itk::simple::SimpleContourExtractorImageFilter::SetOutputForegroundValue ( double  OutputForegroundValue)
inline

Set the foreground value used in order to identify a foreground pixel in the output image.

Definition at line 102 of file sitkSimpleContourExtractorImageFilter.h.

◆ SetRadius() [1/2]

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

Definition at line 90 of file sitkSimpleContourExtractorImageFilter.h.

◆ SetRadius() [2/2]

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

Set the values of the Radius vector all to value

Definition at line 93 of file sitkSimpleContourExtractorImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 138 of file sitkSimpleContourExtractorImageFilter.h.

Member Data Documentation

◆ m_InputBackgroundValue

double itk::simple::SimpleContourExtractorImageFilter::m_InputBackgroundValue {0.0}
private

Definition at line 145 of file sitkSimpleContourExtractorImageFilter.h.

◆ m_InputForegroundValue

double itk::simple::SimpleContourExtractorImageFilter::m_InputForegroundValue {1.0}
private

Definition at line 143 of file sitkSimpleContourExtractorImageFilter.h.

◆ m_MemberFactory

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

Definition at line 140 of file sitkSimpleContourExtractorImageFilter.h.

◆ m_OutputBackgroundValue

double itk::simple::SimpleContourExtractorImageFilter::m_OutputBackgroundValue {0.0}
private

Definition at line 152 of file sitkSimpleContourExtractorImageFilter.h.

◆ m_OutputForegroundValue

double itk::simple::SimpleContourExtractorImageFilter::m_OutputForegroundValue {1.0}
private

Definition at line 150 of file sitkSimpleContourExtractorImageFilter.h.

◆ m_Radius

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

Definition at line 148 of file sitkSimpleContourExtractorImageFilter.h.


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