ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::VTKPolyDataWriter< TInputMesh > Class Template Reference
Group Core » Module ITKMesh

#include <itkVTKPolyDataWriter.h>

Detailed Description

template<typename TInputMesh>
class itk::VTKPolyDataWriter< TInputMesh >

Writes an itkMesh to a file in VTK file format.

Caveat: The input to itkVTKPolyDataWriter must be a triangle mesh. Use vtkTriangleFilter to convert your mesh to a triangle mesh.

This class may be deprecated in the future. The MeshFileWriter is preferred.

See also
MeshFileWriter
ITK Sphinx Examples:
Examples
SphinxExamples/src/Core/Mesh/WriteMeshToVTP/Code.cxx, and SphinxExamples/src/Segmentation/Voronoi/VoronoiDiagram/Code.cxx.

Definition at line 46 of file itkVTKPolyDataWriter.h.

+ Inheritance diagram for itk::VTKPolyDataWriter< TInputMesh >:
+ Collaboration diagram for itk::VTKPolyDataWriter< TInputMesh >:

Public Types

using CellInterfaceType = CellInterface< PixelType, CellTraits >
 
using CellIterator = typename CellsContainer::ConstIterator
 
using CellsContainer = typename InputMeshType::CellsContainer
 
using CellTraits = typename InputMeshType::CellTraits
 
using CellType = typename InputMeshType::CellType
 
using ConstPointer = SmartPointer< const Self >
 
using InputMeshPointer = typename InputMeshType::ConstPointer
 
using InputMeshType = TInputMesh
 
using PixelType = typename InputMeshType::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointIdentifier = typename InputMeshType::PointIdentifier
 
using PointIdIterator = typename CellType::PointIdIterator
 
using PointIterator = typename PointsContainer::ConstIterator
 
using PointsContainer = typename InputMeshType::PointsContainer
 
using PointType = typename InputMeshType::PointType
 
using Self = VTKPolyDataWriter
 
using Superclass = Object
 
using TriangleCellType = TriangleCell< CellInterfaceType >
 
- 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

const char * GetNameOfClass () const override
 
void SetInput (const InputMeshType *input)
 
void Update ()
 
void Write ()
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
- 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
 
LightObject::Pointer CreateAnother () const override
 
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)
 
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

virtual void GenerateData ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 VTKPolyDataWriter ()
 
 ~VTKPolyDataWriter () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
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

std::string m_FileName {}
 
InputMeshPointer m_Input {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ CellInterfaceType

template<typename TInputMesh>
using itk::VTKPolyDataWriter< TInputMesh >::CellInterfaceType = CellInterface<PixelType, CellTraits>

Define the triangular cell types which form the surface

Definition at line 84 of file itkVTKPolyDataWriter.h.

◆ CellIterator

template<typename TInputMesh>
using itk::VTKPolyDataWriter< TInputMesh >::CellIterator = typename CellsContainer::ConstIterator

Definition at line 91 of file itkVTKPolyDataWriter.h.

◆ CellsContainer

template<typename TInputMesh>
using itk::VTKPolyDataWriter< TInputMesh >::CellsContainer = typename InputMeshType::CellsContainer

Definition at line 88 of file itkVTKPolyDataWriter.h.

◆ CellTraits

template<typename TInputMesh>
using itk::VTKPolyDataWriter< TInputMesh >::CellTraits = typename InputMeshType::CellTraits

Definition at line 81 of file itkVTKPolyDataWriter.h.

◆ CellType

template<typename TInputMesh>
using itk::VTKPolyDataWriter< TInputMesh >::CellType = typename InputMeshType::CellType

Definition at line 76 of file itkVTKPolyDataWriter.h.

◆ ConstPointer

template<typename TInputMesh>
using itk::VTKPolyDataWriter< TInputMesh >::ConstPointer = SmartPointer<const Self>

Definition at line 55 of file itkVTKPolyDataWriter.h.

◆ InputMeshPointer

template<typename TInputMesh>
using itk::VTKPolyDataWriter< TInputMesh >::InputMeshPointer = typename InputMeshType::ConstPointer

Some convenient type alias.

Definition at line 80 of file itkVTKPolyDataWriter.h.

◆ InputMeshType

template<typename TInputMesh>
using itk::VTKPolyDataWriter< TInputMesh >::InputMeshType = TInputMesh

Hold on to the type information specified by the template parameters.

Definition at line 73 of file itkVTKPolyDataWriter.h.

◆ PixelType

template<typename TInputMesh>
using itk::VTKPolyDataWriter< TInputMesh >::PixelType = typename InputMeshType::PixelType

Definition at line 74 of file itkVTKPolyDataWriter.h.

◆ Pointer

template<typename TInputMesh>
using itk::VTKPolyDataWriter< TInputMesh >::Pointer = SmartPointer<Self>

Definition at line 54 of file itkVTKPolyDataWriter.h.

◆ PointIdentifier

template<typename TInputMesh>
using itk::VTKPolyDataWriter< TInputMesh >::PointIdentifier = typename InputMeshType::PointIdentifier

Definition at line 77 of file itkVTKPolyDataWriter.h.

◆ PointIdIterator

template<typename TInputMesh>
using itk::VTKPolyDataWriter< TInputMesh >::PointIdIterator = typename CellType::PointIdIterator

Definition at line 93 of file itkVTKPolyDataWriter.h.

◆ PointIterator

template<typename TInputMesh>
using itk::VTKPolyDataWriter< TInputMesh >::PointIterator = typename PointsContainer::ConstIterator

Definition at line 90 of file itkVTKPolyDataWriter.h.

◆ PointsContainer

template<typename TInputMesh>
using itk::VTKPolyDataWriter< TInputMesh >::PointsContainer = typename InputMeshType::PointsContainer

Definition at line 87 of file itkVTKPolyDataWriter.h.

◆ PointType

template<typename TInputMesh>
using itk::VTKPolyDataWriter< TInputMesh >::PointType = typename InputMeshType::PointType

Definition at line 75 of file itkVTKPolyDataWriter.h.

◆ Self

template<typename TInputMesh>
using itk::VTKPolyDataWriter< TInputMesh >::Self = VTKPolyDataWriter

Standard "Self" type alias.

Definition at line 52 of file itkVTKPolyDataWriter.h.

◆ Superclass

template<typename TInputMesh>
using itk::VTKPolyDataWriter< TInputMesh >::Superclass = Object

Definition at line 53 of file itkVTKPolyDataWriter.h.

◆ TriangleCellType

template<typename TInputMesh>
using itk::VTKPolyDataWriter< TInputMesh >::TriangleCellType = TriangleCell<CellInterfaceType>

Definition at line 85 of file itkVTKPolyDataWriter.h.

Constructor & Destructor Documentation

◆ VTKPolyDataWriter()

template<typename TInputMesh>
itk::VTKPolyDataWriter< TInputMesh >::VTKPolyDataWriter ( )
protected

◆ ~VTKPolyDataWriter()

template<typename TInputMesh>
itk::VTKPolyDataWriter< TInputMesh >::~VTKPolyDataWriter ( )
overrideprotecteddefault

Member Function Documentation

◆ GenerateData()

template<typename TInputMesh>
virtual void itk::VTKPolyDataWriter< TInputMesh >::GenerateData ( )
protectedvirtual

Reimplemented in itk::QuadEdgeMeshScalarDataVTKPolyDataWriter< TMesh >.

◆ GetFileName()

template<typename TInputMesh>
virtual const char* itk::VTKPolyDataWriter< TInputMesh >::GetFileName ( ) const
virtual

Set/Get the name of the file where data are written.

◆ GetNameOfClass()

template<typename TInputMesh>
const char* itk::VTKPolyDataWriter< TInputMesh >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ New()

template<typename TInputMesh>
static Pointer itk::VTKPolyDataWriter< TInputMesh >::New ( )
static

Method for creation through the object factory

◆ PrintSelf()

template<typename TInputMesh>
void itk::VTKPolyDataWriter< TInputMesh >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Object.

◆ SetFileName()

template<typename TInputMesh>
virtual void itk::VTKPolyDataWriter< TInputMesh >::SetFileName ( const char *  _arg)
virtual

Set/Get the name of the file where data are written.

◆ SetInput()

template<typename TInputMesh>
void itk::VTKPolyDataWriter< TInputMesh >::SetInput ( const InputMeshType *  input)

Set the Input

◆ Update()

template<typename TInputMesh>
void itk::VTKPolyDataWriter< TInputMesh >::Update ( )

Write the Input mesh to the Output file. Use either Update() or Write().

◆ Write()

template<typename TInputMesh>
void itk::VTKPolyDataWriter< TInputMesh >::Write ( )

Member Data Documentation

◆ m_FileName

template<typename TInputMesh>
std::string itk::VTKPolyDataWriter< TInputMesh >::m_FileName {}
protected

Definition at line 111 of file itkVTKPolyDataWriter.h.

◆ m_Input

template<typename TInputMesh>
InputMeshPointer itk::VTKPolyDataWriter< TInputMesh >::m_Input {}
protected

Definition at line 113 of file itkVTKPolyDataWriter.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16