ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | List of all members
itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits > Class Template Reference

#include <itkSpatialObjectWriter.h>

+ Inheritance diagram for itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >:
+ Collaboration diagram for itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >:

Public Types

using MetaConverterBaseType = MetaConverterBase< NDimensions >
 
using MetaSceneConverterType = MetaSceneConverter< NDimensions, PixelType, TMeshTraits >
 
using Pointer = SmartPointer< Self >
 
using Self = SpatialObjectWriter
 
using SpatialObjectPointer = typename SpatialObjectType::Pointer
 
using SpatialObjectType = SpatialObject< NDimensions >
 
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 ::itk::LightObject::Pointer CreateAnother () const
 
virtual bool GetBinaryPoints () const
 
virtual const char * GetFileName () const
 
virtual const char * GetNameOfClass () const
 
unsigned int GetTransformPrecision ()
 
virtual void SetBinaryPoints (bool _arg)
 
virtual void SetFileName (const char *_arg)
 
void SetInput (SpatialObjectType *input)
 
void SetTransformPrecision (unsigned int precision)
 
void Update ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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)
 
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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
std::string m_FileName
 
bool m_BinaryPoints
 
bool m_WriteImagesInSeparateFile
 
SpatialObjectPointer m_SpatialObject
 
MetaSceneConverterType::Pointer m_MetaToSpatialConverter
 
virtual void SetWriteImagesInSeparateFile (bool _arg)
 
virtual bool GetWriteImagesInSeparateFile () const
 
void RegisterMetaConverter (const char *metaTypeName, const char *spatialObjectTypeName, MetaConverterBaseType *converter)
 
 SpatialObjectWriter ()
 
 ~SpatialObjectWriter () override=default
 

Additional Inherited Members

- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

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

TODO.

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

Definition at line 35 of file itkSpatialObjectWriter.h.

Member Typedef Documentation

◆ MetaConverterBaseType

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
using itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::MetaConverterBaseType = MetaConverterBase<NDimensions>

base type for MetaConverters – bidirections conversion btw SpatialObject & MetaObject

Definition at line 53 of file itkSpatialObjectWriter.h.

◆ MetaSceneConverterType

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
using itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::MetaSceneConverterType = MetaSceneConverter<NDimensions, PixelType, TMeshTraits>

Definition at line 55 of file itkSpatialObjectWriter.h.

◆ Pointer

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
using itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::Pointer = SmartPointer<Self>

Definition at line 42 of file itkSpatialObjectWriter.h.

◆ Self

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
using itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::Self = SpatialObjectWriter

SmartPointer type alias support

Definition at line 41 of file itkSpatialObjectWriter.h.

◆ SpatialObjectPointer

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
using itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::SpatialObjectPointer = typename SpatialObjectType::Pointer

Definition at line 48 of file itkSpatialObjectWriter.h.

◆ SpatialObjectType

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
using itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::SpatialObjectType = SpatialObject<NDimensions>

Definition at line 47 of file itkSpatialObjectWriter.h.

◆ Superclass

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
using itk::SpatialObjectWriter< NDimensions, 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 NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::SpatialObjectWriter ( )
protected

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

◆ ~SpatialObjectWriter()

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::~SpatialObjectWriter ( )
overrideprotecteddefault

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

Member Function Documentation

◆ CreateAnother()

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
virtual::itk::LightObject::Pointer itk::SpatialObjectWriter< NDimensions, 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 NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
virtual bool itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::GetBinaryPoints ( ) const
virtual

◆ GetFileName()

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
virtual const char* itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::GetFileName ( ) const
virtual

Get the filename

◆ GetNameOfClass()

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
virtual const char* itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::GetNameOfClass ( ) const
virtual

Standard part of all itk objects.

Reimplemented from itk::Object.

◆ GetTransformPrecision()

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
unsigned int itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::GetTransformPrecision ( )

◆ GetWriteImagesInSeparateFile()

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
virtual bool itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::GetWriteImagesInSeparateFile ( ) const
virtual

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

◆ New()

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
static Pointer itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::New ( )
static

Method for creation through the object factory

◆ RegisterMetaConverter()

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
void itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::RegisterMetaConverter ( const char *  metaTypeName,
const char *  spatialObjectTypeName,
MetaConverterBaseType converter 
)

Add a converter for a new MetaObject/SpatialObject type

◆ SetBinaryPoints()

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
virtual void itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::SetBinaryPoints ( bool  _arg)
virtual

◆ SetFileName()

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
virtual void itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::SetFileName ( const char *  _arg)
virtual

Set the filename

◆ SetInput()

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
void itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::SetInput ( SpatialObjectType input)
inline

Set the Input

Definition at line 74 of file itkSpatialObjectWriter.h.

◆ SetTransformPrecision()

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
void itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::SetTransformPrecision ( unsigned int  precision)

◆ SetWriteImagesInSeparateFile()

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
virtual void itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::SetWriteImagesInSeparateFile ( bool  _arg)
virtual

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

◆ Update()

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
void itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::Update ( )

Load a tube file.

Member Data Documentation

◆ m_BinaryPoints

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
bool itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::m_BinaryPoints
protected

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

Definition at line 101 of file itkSpatialObjectWriter.h.

◆ m_FileName

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
std::string itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::m_FileName
protected

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

Definition at line 100 of file itkSpatialObjectWriter.h.

◆ m_MetaToSpatialConverter

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
MetaSceneConverterType::Pointer itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::m_MetaToSpatialConverter
private

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

Definition at line 110 of file itkSpatialObjectWriter.h.

◆ m_SpatialObject

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
SpatialObjectPointer itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::m_SpatialObject
private

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

Definition at line 108 of file itkSpatialObjectWriter.h.

◆ m_WriteImagesInSeparateFile

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
bool itk::SpatialObjectWriter< NDimensions, PixelType, TMeshTraits >::m_WriteImagesInSeparateFile
protected

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

Definition at line 102 of file itkSpatialObjectWriter.h.


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