itk::simple::PhysicalPointImageSource Class Reference

Generate an image of the physical locations of each pixel. More...

#include <sitkPhysicalPointImageSource.h>

Inheritance diagram for itk::simple::PhysicalPointImageSource:

Collaboration diagram for itk::simple::PhysicalPointImageSource:

Detailed Description

Generate an image of the physical locations of each pixel.

This image source supports image which have a multi-component pixel equal to the image dimension, and variable length VectorImages. It is recommended that the component type be a real valued type.

See also

itk::simple::PhysicalPointSource for the procedural interface

itk::PhysicalPointImageSource for the Doxygen on the original ITK class.

Definition at line 41 of file sitkPhysicalPointImageSource.h.

Public Types
using	PixelIDTypeList = VectorPixelIDTypeList
using	Self = PhysicalPointImageSource
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 ()
std::vector< double >	GetDirection () const
std::string	GetName () const
std::vector< double >	GetOrigin () const
PixelIDValueEnum	GetOutputPixelType () const
std::vector< unsigned int >	GetSize () const
std::vector< double >	GetSpacing () const
	PhysicalPointImageSource ()
Self &	SetDirection (std::vector< double > Direction)
Self &	SetOrigin (std::vector< double > Origin)
Self &	SetOutputPixelType (PixelIDValueEnum OutputPixelType)
void	SetReferenceImage (const Image &refImage)
Self &	SetSize (std::vector< unsigned int > Size)
Self &	SetSpacing (std::vector< double > Spacing)
std::string	ToString () const
virtual	~PhysicalPointImageSource ()
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.
virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event.
virtual float	GetProgress () const
	An Active Measurement of the progress of execution.
virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event.
	ProcessObject ()
virtual void	RemoveAllCommands ()
	Remove all registered commands.
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::*)( )

Private Member Functions
template<class TImageType>
Image	ExecuteInternal ()

Private Attributes
std::vector< double >	m_Direction {std::vector<double>()}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
std::vector< double >	m_Origin {std::vector<double>(3, 0.0)}
PixelIDValueEnum	m_OutputPixelType {itk::simple::sitkVectorFloat32}
std::vector< unsigned int >	m_Size {std::vector<unsigned int>(3, 64)}
std::vector< double >	m_Spacing {std::vector<double>(3, 1.0)}

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.
static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces.
static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces.
static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces.
static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects.
static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects.
static void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects.
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<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< 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)

Member Typedef Documentation

MemberFunctionType

using itk::simple::PhysicalPointImageSource::MemberFunctionType = Image (Self::*)( )

private

Setup for member function dispatching

Definition at line 119 of file sitkPhysicalPointImageSource.h.

PixelIDTypeList

using itk::simple::PhysicalPointImageSource::PixelIDTypeList = VectorPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 53 of file sitkPhysicalPointImageSource.h.

Self

using itk::simple::PhysicalPointImageSource::Self = PhysicalPointImageSource

Definition at line 43 of file sitkPhysicalPointImageSource.h.

Constructor & Destructor Documentation

~PhysicalPointImageSource()

virtual itk::simple::PhysicalPointImageSource::~PhysicalPointImageSource ( )

virtual

Destructor

PhysicalPointImageSource()

itk::simple::PhysicalPointImageSource::PhysicalPointImageSource

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Execute()

Image itk::simple::PhysicalPointImageSource::Execute

(

)

Execute the filter on the input image

ExecuteInternal()

template<class TImageType>

Image itk::simple::PhysicalPointImageSource::ExecuteInternal ( )

private

Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.

GetDirection()

std::vector< double > itk::simple::PhysicalPointImageSource::GetDirection ( ) const

inline

Definition at line 97 of file sitkPhysicalPointImageSource.h.

References m_Direction.

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 100 of file sitkPhysicalPointImageSource.h.

GetOrigin()

std::vector< double > itk::simple::PhysicalPointImageSource::GetOrigin ( ) const

inline

Definition at line 81 of file sitkPhysicalPointImageSource.h.

References m_Origin.

GetOutputPixelType()

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

inline

Definition at line 65 of file sitkPhysicalPointImageSource.h.

References m_OutputPixelType.

GetSize()

std::vector< unsigned int > itk::simple::PhysicalPointImageSource::GetSize ( ) const

inline

Definition at line 73 of file sitkPhysicalPointImageSource.h.

References m_Size.

GetSpacing()

std::vector< double > itk::simple::PhysicalPointImageSource::GetSpacing ( ) const

inline

Definition at line 89 of file sitkPhysicalPointImageSource.h.

References m_Spacing.

SetDirection()

Self & itk::simple::PhysicalPointImageSource::SetDirection ( std::vector< double > Direction )

inline

Definition at line 93 of file sitkPhysicalPointImageSource.h.

References m_Direction.

SetOrigin()

Self & itk::simple::PhysicalPointImageSource::SetOrigin ( std::vector< double > Origin )

inline

Definition at line 77 of file sitkPhysicalPointImageSource.h.

References m_Origin.

SetOutputPixelType()

Self & itk::simple::PhysicalPointImageSource::SetOutputPixelType ( PixelIDValueEnum OutputPixelType )

inline

Definition at line 61 of file sitkPhysicalPointImageSource.h.

References m_OutputPixelType.

SetReferenceImage()

void itk::simple::PhysicalPointImageSource::SetReferenceImage

(

const Image &

refImage

)

This methods sets the size, origin, spacing and direction to that of the provided image

SetSize()

Self & itk::simple::PhysicalPointImageSource::SetSize ( std::vector< unsigned int > Size )

inline

Definition at line 69 of file sitkPhysicalPointImageSource.h.

References m_Size.

SetSpacing()

Self & itk::simple::PhysicalPointImageSource::SetSpacing ( std::vector< double > Spacing )

inline

Definition at line 85 of file sitkPhysicalPointImageSource.h.

References m_Spacing.

ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Symbol Documentation

detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 120 of file sitkPhysicalPointImageSource.h.

References ExecuteInternal().

Member Data Documentation

m_Direction

std::vector<double> itk::simple::PhysicalPointImageSource::m_Direction {std::vector<double>()}

private

Definition at line 137 of file sitkPhysicalPointImageSource.h.

Referenced by GetDirection(), and SetDirection().

m_MemberFactory

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

private

Definition at line 125 of file sitkPhysicalPointImageSource.h.

m_Origin

std::vector<double> itk::simple::PhysicalPointImageSource::m_Origin {std::vector<double>(3, 0.0)}

private

Definition at line 132 of file sitkPhysicalPointImageSource.h.

Referenced by GetOrigin(), and SetOrigin().

m_OutputPixelType

PixelIDValueEnum itk::simple::PhysicalPointImageSource::m_OutputPixelType {itk::simple::sitkVectorFloat32}

private

Definition at line 128 of file sitkPhysicalPointImageSource.h.

Referenced by GetOutputPixelType(), and SetOutputPixelType().

m_Size

std::vector<unsigned int> itk::simple::PhysicalPointImageSource::m_Size {std::vector<unsigned int>(3, 64)}

private

Definition at line 130 of file sitkPhysicalPointImageSource.h.

Referenced by GetSize(), and SetSize().

m_Spacing

std::vector<double> itk::simple::PhysicalPointImageSource::m_Spacing {std::vector<double>(3, 1.0)}

private

Definition at line 134 of file sitkPhysicalPointImageSource.h.

Referenced by GetSpacing(), and SetSpacing().

---

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

• sitkPhysicalPointImageSource.h