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

Change Sets of Labels. More...

#include <sitkChangeLabelImageFilter.h>

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

Public Types

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

Public Member Functions

 ChangeLabelImageFilter ()
Image Execute (const Image &image1)
Image Execute (Image &&image1)
std::map< double, double > GetChangeMap () const
std::string GetName () const
SelfSetChangeMap (std::map< double, double > ChangeMap)
std::string ToString () const
virtual ~ChangeLabelImageFilter ()
- 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

std::map< double, double > m_ChangeMap {std::map<double,double>()}
bool m_InPlace {false}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory


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

Change Sets of Labels.

This filter produces an output image whose pixels are either copied from the input if they are not being changed or are rewritten based on the change parameters

This filter is templated over the input image type and the output image type.

The filter expect both images to have the same number of dimensions.

Tim Kelliher. GE Research, Niskayuna, NY.
This work was supported by a grant from DARPA, executed by the U.S. Army Medical Research and Materiel Command/TATRC Assistance Agreement, Contract::W81XWH-05-2-0059.
See also
itk::simple::ChangeLabel for the procedural interface
itk::ChangeLabelImageFilter for the Doxygen on the original ITK class.

Definition at line 51 of file sitkChangeLabelImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 92 of file sitkChangeLabelImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 63 of file sitkChangeLabelImageFilter.h.

◆ Self

Definition at line 53 of file sitkChangeLabelImageFilter.h.

Constructor & Destructor Documentation

◆ ~ChangeLabelImageFilter()

virtual itk::simple::ChangeLabelImageFilter::~ChangeLabelImageFilter ( )


◆ ChangeLabelImageFilter()

itk::simple::ChangeLabelImageFilter::ChangeLabelImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

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

◆ Execute() [2/2]

Image itk::simple::ChangeLabelImageFilter::Execute ( Image &&  image1)

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ GetChangeMap()

std::map<double,double> itk::simple::ChangeLabelImageFilter::GetChangeMap ( ) const

Definition at line 73 of file sitkChangeLabelImageFilter.h.

◆ GetName()

std::string itk::simple::ChangeLabelImageFilter::GetName ( ) const

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 76 of file sitkChangeLabelImageFilter.h.

◆ SetChangeMap()

Self& itk::simple::ChangeLabelImageFilter::SetChangeMap ( std::map< double, double >  ChangeMap)

Set the entire change map

Definition at line 69 of file sitkChangeLabelImageFilter.h.

◆ ToString()

std::string itk::simple::ChangeLabelImageFilter::ToString ( ) const

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 96 of file sitkChangeLabelImageFilter.h.

Member Data Documentation

◆ m_ChangeMap

std::map<double,double> itk::simple::ChangeLabelImageFilter::m_ChangeMap {std::map<double,double>()}

Definition at line 101 of file sitkChangeLabelImageFilter.h.

◆ m_InPlace

bool itk::simple::ChangeLabelImageFilter::m_InPlace {false}

Definition at line 104 of file sitkChangeLabelImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::ChangeLabelImageFilter::m_MemberFactory

Definition at line 98 of file sitkChangeLabelImageFilter.h.

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