A hybrid cast image filter to convert images to other types of images. More...

#include <sitkCastImageFilter.h>

Inheritance diagram for itk::simple::CastImageFilter:

Collaboration diagram for itk::simple::CastImageFilter:

Classes
struct	CastAddressor

struct	LabelToAddressor

struct	ToLabelAddressor

struct	ToVectorAddressor

Public Types
using	Self = CastImageFilter

Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter

Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
	CastImageFilter ()

Image	Execute (const Image &)

std::string	GetName () const override

PixelIDValueEnum	GetOutputPixelType () const

Self &	SetOutputPixelType (PixelIDValueEnum pixelID)

std::string	ToString () const override

	~CastImageFilter () override

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
typedef Image(Self::*	MemberFunctionType) (const Image &)

Private Member Functions

template<typename TImageType , typename TOutputImageType >
Image	ExecuteInternalCast (const Image &inImage)

template<typename TImageType , typename TOutputImageType >
Image	ExecuteInternalToVector (const Image &inImage)

template<typename TImageType , typename TOutputImageType >
Image	ExecuteInternalToLabel (const Image &inImage)

template<typename TImageType , typename TOutputImageType >
Image	ExecuteInternalLabelToImage (const Image &inImage)


void	RegisterMemberFactory2 ()

void	RegisterMemberFactory2v ()

void	RegisterMemberFactory2l ()

void	RegisterMemberFactory3 ()

void	RegisterMemberFactory3v ()

void	RegisterMemberFactory3l ()

Private Attributes
std::unique_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > >	m_DualMemberFactory

PixelIDValueEnum	m_OutputPixelType

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::ProcessObject *	GetActiveProcess ()

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

NonCopyable &	operator= (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::EventObject &	GetITKEventObject (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

A hybrid cast image filter to convert images to other types of images.

Several different ITK classes are implemented under the hood, to convert between different image types.

See also: itk::simple::Cast for the procedural interface

Examples: FilterProgressReporting/FilterProgressReporting.cxx, ITKIntegration/ITKIntegration.cxx, and SimpleGaussian/SimpleGaussian.cxx.

Definition at line 41 of file sitkCastImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

typedef Image(Self::* itk::simple::CastImageFilter::MemberFunctionType) (const Image &)

private

Definition at line 172 of file sitkCastImageFilter.h.

◆ Self

using itk::simple::CastImageFilter::Self = CastImageFilter

Definition at line 45 of file sitkCastImageFilter.h.

Constructor & Destructor Documentation

◆ ~CastImageFilter()

itk::simple::CastImageFilter::~CastImageFilter ( )

override

◆ CastImageFilter()

itk::simple::CastImageFilter::CastImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

Image itk::simple::CastImageFilter::Execute ( const Image & )

Examples: FilterProgressReporting/FilterProgressReporting.cxx, ITKIntegration/ITKIntegration.cxx, and SimpleGaussian/SimpleGaussian.cxx.

◆ ExecuteInternalCast()

template<typename TImageType , typename TOutputImageType >

Image itk::simple::CastImageFilter::ExecuteInternalCast ( const Image & inImage )

private

Methods to actually implement conversion from one image type to another.

These methods implement CastImageFilter, ComposeImageFilter, and LabelImageToLabelMapImageFilter respectively.

◆ ExecuteInternalLabelToImage()

template<typename TImageType , typename TOutputImageType >

Image itk::simple::CastImageFilter::ExecuteInternalLabelToImage ( const Image & inImage )

private

Methods to actually implement conversion from one image type to another.

These methods implement CastImageFilter, ComposeImageFilter, and LabelImageToLabelMapImageFilter respectively.

◆ ExecuteInternalToLabel()

template<typename TImageType , typename TOutputImageType >

Image itk::simple::CastImageFilter::ExecuteInternalToLabel ( const Image & inImage )

private

Methods to actually implement conversion from one image type to another.

These methods implement CastImageFilter, ComposeImageFilter, and LabelImageToLabelMapImageFilter respectively.

◆ ExecuteInternalToVector()

template<typename TImageType , typename TOutputImageType >

Image itk::simple::CastImageFilter::ExecuteInternalToVector ( const Image & inImage )

private

Methods to actually implement conversion from one image type to another.

These methods implement CastImageFilter, ComposeImageFilter, and LabelImageToLabelMapImageFilter respectively.

◆ GetName()

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

inlineoverridevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 60 of file sitkCastImageFilter.h.

◆ GetOutputPixelType()

PixelIDValueEnum itk::simple::CastImageFilter::GetOutputPixelType ( ) const