#include <itkSpatialObjectWriter.h>

Detailed Description

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
class itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >

TODO.

Examples: Examples/SpatialObjects/MeshSpatialObject.cxx, and Examples/SpatialObjects/ReadWriteSpatialObject.cxx.

Definition at line 35 of file itkSpatialObjectWriter.h.

Inheritance diagram for itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >:

Collaboration diagram for itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >:

Public Types
using	MetaConverterBaseType = MetaConverterBase<VDimension>

using	MetaSceneConverterType = MetaSceneConverter<VDimension, PixelType, TMeshTraits>

using	Pointer = SmartPointer<Self>

using	Self = SpatialObjectWriter

using	SpatialObjectConstPointer = typename SpatialObjectType::ConstPointer

using	SpatialObjectPointer = typename SpatialObjectType::Pointer

using	SpatialObjectType = SpatialObject<VDimension>

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = LightObject

Public Member Functions
virtual void	BinaryPointsOff ()

virtual void	BinaryPointsOn ()

virtual::itk::LightObject::Pointer	CreateAnother () const

virtual bool	GetBinaryPoints () const

virtual const char *	GetFileName () const

unsigned int	GetMetaIOVersion () const

const char *	GetNameOfClass () const override

unsigned int	GetTransformPrecision ()

void	RegisterMetaConverter (const char metaTypeName, const char spatialObjectTypeName, MetaConverterBaseType *converter)

virtual void	SetBinaryPoints (bool _arg)

virtual void	SetFileName (const char *_arg)

void	SetInput (const SpatialObjectType *input)

void	SetMetaIOVersion (unsigned int ver)

void	SetTransformPrecision (unsigned int precision)

void	Update ()


virtual void	SetWriteImagesInSeparateFile (bool _arg)

virtual bool	GetWriteImagesInSeparateFile () const

virtual void	WriteImagesInSeparateFileOn ()

virtual void	WriteImagesInSeparateFileOff ()

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
	SpatialObjectWriter ()

	~SpatialObjectWriter () override=default

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Protected Attributes
bool	m_BinaryPoints {}

std::string	m_FileName {}

bool	m_WriteImagesInSeparateFile {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Private Attributes
MetaSceneConverterType::Pointer	m_MetaToSpatialConverter {}

SpatialObjectConstPointer	m_SpatialObject {}

Member Typedef Documentation

◆ MetaConverterBaseType

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

using itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::MetaConverterBaseType = MetaConverterBase<VDimension>

base type for MetaConverters – bidirectional conversion btw SpatialObject & MetaObject

Definition at line 54 of file itkSpatialObjectWriter.h.

◆ MetaSceneConverterType

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

using itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::MetaSceneConverterType = MetaSceneConverter<VDimension, PixelType, TMeshTraits>

Definition at line 56 of file itkSpatialObjectWriter.h.

◆ Pointer

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

using itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::Pointer = SmartPointer<Self>

Definition at line 42 of file itkSpatialObjectWriter.h.

◆ Self

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

using itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::Self = SpatialObjectWriter

SmartPointer type alias support

Definition at line 41 of file itkSpatialObjectWriter.h.

◆ SpatialObjectConstPointer

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

using itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::SpatialObjectConstPointer = typename SpatialObjectType::ConstPointer

Definition at line 49 of file itkSpatialObjectWriter.h.

◆ SpatialObjectPointer

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

using itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::SpatialObjectPointer = typename SpatialObjectType::Pointer

Definition at line 48 of file itkSpatialObjectWriter.h.

◆ SpatialObjectType

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

using itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::SpatialObjectType = SpatialObject<VDimension>

Definition at line 47 of file itkSpatialObjectWriter.h.

◆ Superclass

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

using itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::Superclass = Object

Run-time type information (and related methods).

Definition at line 45 of file itkSpatialObjectWriter.h.

Constructor & Destructor Documentation

◆ SpatialObjectWriter()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::SpatialObjectWriter ( )

protected

Referenced by GetNameOfClass().

◆ ~SpatialObjectWriter()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::~SpatialObjectWriter ( )

overrideprotecteddefault

Member Function Documentation

◆ BinaryPointsOff()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

virtual void itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::BinaryPointsOff ( )

virtual

◆ BinaryPointsOn()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

virtual void itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::BinaryPointsOn ( )

virtual

◆ CreateAnother()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

virtual::itk::LightObject::Pointer itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

◆ GetBinaryPoints()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

virtual bool itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::GetBinaryPoints ( ) const

virtual

◆ GetFileName()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

virtual const char * itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::GetFileName ( ) const

virtual

Get the filename

◆ GetMetaIOVersion()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

unsigned int itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::GetMetaIOVersion ( ) const

◆ GetNameOfClass()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

const char * itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

References SpatialObjectWriter().

◆ GetTransformPrecision()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

unsigned int itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::GetTransformPrecision ( )

◆ GetWriteImagesInSeparateFile()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

virtual bool itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::GetWriteImagesInSeparateFile ( ) const

virtual

Set/Get if the images should be written in a different file

◆ New()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

static Pointer itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::New ( )

static

Method for creation through the object factory

◆ RegisterMetaConverter()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

void itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::RegisterMetaConverter	(	const char *	metaTypeName,
		const char *	spatialObjectTypeName,
		MetaConverterBaseType *	converter )

Add a converter for a new MetaObject/SpatialObject type

◆ SetBinaryPoints()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

virtual void itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::SetBinaryPoints ( bool _arg )

virtual

◆ SetFileName()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

virtual void itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::SetFileName ( const char * _arg )

virtual

Set the filename

◆ SetInput()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

void itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::SetInput ( const SpatialObjectType * input )

inline

Set the Input

Definition at line 75 of file itkSpatialObjectWriter.h.

References m_SpatialObject.

◆ SetMetaIOVersion()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

void itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::SetMetaIOVersion ( unsigned int ver )

Set the version of MetaIO to use. Version 0 cannot accurately represented ImageSpatialObjects. Version 1 fixes bugs in Version 0, but introduces new tag-value pairs that might throw warnings on older readers.

◆ SetTransformPrecision()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

void itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::SetTransformPrecision ( unsigned int precision )

◆ SetWriteImagesInSeparateFile()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

virtual void itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::SetWriteImagesInSeparateFile ( bool _arg )

virtual

Set/Get if the images should be written in a different file

◆ Update()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

void itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::Update ( )

Load a tube file.

◆ WriteImagesInSeparateFileOff()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

virtual void itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::WriteImagesInSeparateFileOff ( )

virtual

Set/Get if the images should be written in a different file

◆ WriteImagesInSeparateFileOn()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

virtual void itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::WriteImagesInSeparateFileOn ( )

virtual

Set/Get if the images should be written in a different file

Member Data Documentation

◆ m_BinaryPoints

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

bool itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::m_BinaryPoints {}

protected

Definition at line 114 of file itkSpatialObjectWriter.h.

◆ m_FileName

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

std::string itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::m_FileName {}

protected

Definition at line 113 of file itkSpatialObjectWriter.h.

◆ m_MetaToSpatialConverter

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

MetaSceneConverterType::Pointer itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::m_MetaToSpatialConverter {}

private

Definition at line 123 of file itkSpatialObjectWriter.h.

◆ m_SpatialObject

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

SpatialObjectConstPointer itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::m_SpatialObject {}

private

Definition at line 121 of file itkSpatialObjectWriter.h.

Referenced by SetInput().

◆ m_WriteImagesInSeparateFile

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>

bool itk::SpatialObjectWriter< VDimension, PixelType, TMeshTraits >::m_WriteImagesInSeparateFile {}

protected

Definition at line 115 of file itkSpatialObjectWriter.h.

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

itkSpatialObjectWriter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Member Typedef Documentation

◆ MetaConverterBaseType

◆ MetaSceneConverterType

◆ Pointer

◆ Self

◆ SpatialObjectConstPointer

◆ SpatialObjectPointer

◆ SpatialObjectType

◆ Superclass

Constructor & Destructor Documentation

◆ SpatialObjectWriter()

◆ ~SpatialObjectWriter()

Member Function Documentation

◆ BinaryPointsOff()

◆ BinaryPointsOn()

◆ CreateAnother()

◆ GetBinaryPoints()

◆ GetFileName()

◆ GetMetaIOVersion()

◆ GetNameOfClass()

◆ GetTransformPrecision()

◆ GetWriteImagesInSeparateFile()

◆ New()

◆ RegisterMetaConverter()

◆ SetBinaryPoints()

◆ SetFileName()

◆ SetInput()

◆ SetMetaIOVersion()

◆ SetTransformPrecision()

◆ SetWriteImagesInSeparateFile()

◆ Update()

◆ WriteImagesInSeparateFileOff()

◆ WriteImagesInSeparateFileOn()

Member Data Documentation

◆ m_BinaryPoints

◆ m_FileName

◆ m_MetaToSpatialConverter

◆ m_SpatialObject

◆ m_WriteImagesInSeparateFile