ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::VTKPolyDataReader< TOutputMesh > Class Template Reference

#include <itkVTKPolyDataReader.h>

+ Inheritance diagram for itk::VTKPolyDataReader< TOutputMesh >:
+ Collaboration diagram for itk::VTKPolyDataReader< TOutputMesh >:

Detailed Description

template<typename TOutputMesh>
class itk::VTKPolyDataReader< TOutputMesh >

Reads a vtkPolyData file and create an itkMesh.

Caveat1: itkVTKPolyDataReader can only read triangle meshes. Use vtkTriangleFilter to convert your mesh to a triangle mesh. Caviet2: itkVTKPolyDataReader can only read vtk legacy files. Caveat3: itkVTKPolyDataReader cannot read binary vtk files.

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

See Also
MeshFileReader
Examples:
SphinxExamples/src/Core/Common/ReadAPointSet/Code.cxx, SphinxExamples/src/Core/QuadEdgeMesh/ExtractVertexOnMeshBoundaries/Code.cxx, WikiExamples/Meshes/QuadEdgeMeshNormalFilter.cxx, WikiExamples/Meshes/QuadEdgeMeshParameterizationFilter.cxx, and WikiExamples/PointSet/ReadPointSet.cxx.

Definition at line 45 of file itkVTKPolyDataReader.h.

Public Types

using CellAutoPointer = typename OutputMeshType::CellAutoPointer
 
using CellIdentifier = typename OutputMeshType::CellIdentifier
 
using CellTraits = typename OutputMeshType::CellTraits
 
using CellType = typename OutputMeshType::CellType
 
using ConstPointer = SmartPointer< const Self >
 
using IndexPairType = std::pair< IdentifierType, IdentifierType >
 
using MeshTraits = typename OutputMeshType::MeshTraits
 
using OutputMeshPointer = typename OutputMeshType::Pointer
 
using OutputMeshType = TOutputMesh
 
using PixelType = typename MeshTraits::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointIdentifier = typename OutputMeshType::PointIdentifier
 
using PointIdIterator = typename CellTraits::PointIdIterator
 
using PointMapType = MapContainer< IndexPairType, IdentifierType >
 
using PointsContainer = typename OutputMeshType::PointsContainer
 
using PointsContainerPointer = typename OutputMeshType::PointsContainerPointer
 
using PointType = typename OutputMeshType::PointType
 
using Self = VTKPolyDataReader
 
using Superclass = MeshSource< TOutputMesh >
 
using TriangleCellAutoPointer = typename TriangleCellType::SelfAutoPointer
 
using TriangleCellType = TriangleCell< CellType >
 
using VectorType = typename PointType::VectorType
 
- Public Types inherited from itk::MeshSource< TOutputMesh >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using OutputMeshPointer = typename OutputMeshType::Pointer
 
using OutputMeshType = TOutputMesh
 
using Pointer = SmartPointer< Self >
 
using Self = MeshSource
 
using Superclass = ProcessObject
 
using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
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 const char * GetHeader () const
 
virtual const char * GetNameOfClass () const
 
virtual const char * GetVersion () const
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
- Public Member Functions inherited from itk::MeshSource< TOutputMesh >
OutputMeshTypeGetOutput ()
 
OutputMeshTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
void SetOutput (TOutputMesh *output)
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) 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 noexceptoverride
 
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::MeshSource< TOutputMesh >
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 ()
 

Protected Member Functions

void GenerateData () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 VTKPolyDataReader ()
 
 ~VTKPolyDataReader () override=default
 
- Protected Member Functions inherited from itk::MeshSource< TOutputMesh >
void GenerateInputRequestedRegion () override
 
 MeshSource ()
 
 ~MeshSource () override=default
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
 ~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 ()
 

Private Attributes

std::string m_FileName
 
std::string m_Header
 
std::string m_Version
 

Additional Inherited Members

- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::CellAutoPointer = typename OutputMeshType::CellAutoPointer

Definition at line 73 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::CellIdentifier = typename OutputMeshType::CellIdentifier

Definition at line 71 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::CellTraits = typename OutputMeshType::CellTraits

Definition at line 70 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::CellType = typename OutputMeshType::CellType

Definition at line 72 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::ConstPointer = SmartPointer< const Self >

Definition at line 54 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::IndexPairType = std::pair< IdentifierType, IdentifierType >

Definition at line 85 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::MeshTraits = typename OutputMeshType::MeshTraits

Definition at line 64 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::OutputMeshPointer = typename OutputMeshType::Pointer

Some convenient type alias.

Definition at line 69 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::OutputMeshType = TOutputMesh

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

Definition at line 63 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::PixelType = typename MeshTraits::PixelType

Definition at line 66 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::Pointer = SmartPointer< Self >

Definition at line 53 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::PointIdentifier = typename OutputMeshType::PointIdentifier

Definition at line 74 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::PointIdIterator = typename CellTraits::PointIdIterator

Definition at line 75 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::PointMapType = MapContainer< IndexPairType, IdentifierType >

Definition at line 86 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::PointsContainer = typename OutputMeshType::PointsContainer

Definition at line 78 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::PointsContainerPointer = typename OutputMeshType::PointsContainerPointer

Definition at line 77 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::PointType = typename OutputMeshType::PointType

Definition at line 65 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::Self = VTKPolyDataReader

Standard "Self" type alias.

Definition at line 51 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::Superclass = MeshSource< TOutputMesh >

Definition at line 52 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::TriangleCellAutoPointer = typename TriangleCellType::SelfAutoPointer

Definition at line 83 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::TriangleCellType = TriangleCell< CellType >

Define the triangular cell types which form the surface

Definition at line 81 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
using itk::VTKPolyDataReader< TOutputMesh >::VectorType = typename PointType::VectorType

Definition at line 87 of file itkVTKPolyDataReader.h.

Constructor & Destructor Documentation

template<typename TOutputMesh >
itk::VTKPolyDataReader< TOutputMesh >::VTKPolyDataReader ( )
protected
template<typename TOutputMesh >
itk::VTKPolyDataReader< TOutputMesh >::~VTKPolyDataReader ( )
overrideprotecteddefault

Member Function Documentation

template<typename TOutputMesh >
virtual::itk::LightObject::Pointer itk::VTKPolyDataReader< TOutputMesh >::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::MeshSource< TOutputMesh >.

template<typename TOutputMesh >
void itk::VTKPolyDataReader< TOutputMesh >::GenerateData ( )
overrideprotectedvirtual

Reads the file

Reimplemented from itk::ProcessObject.

template<typename TOutputMesh >
virtual const char* itk::VTKPolyDataReader< TOutputMesh >::GetFileName ( ) const
virtual

Set the resolution level to be used for generating cells in the Sphere. High values of this parameter will produce sphere with more triangles. Set/Get the name of the file to be read.

template<typename TOutputMesh >
virtual const char* itk::VTKPolyDataReader< TOutputMesh >::GetHeader ( ) const
virtual

Get the file header line

template<typename TOutputMesh >
virtual const char* itk::VTKPolyDataReader< TOutputMesh >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::MeshSource< TOutputMesh >.

template<typename TOutputMesh >
virtual const char* itk::VTKPolyDataReader< TOutputMesh >::GetVersion ( ) const
virtual

Get the file version line

template<typename TOutputMesh >
static Pointer itk::VTKPolyDataReader< TOutputMesh >::New ( )
static

Method for creation through the object factory.

template<typename TOutputMesh >
void itk::VTKPolyDataReader< TOutputMesh >::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::MeshSource< TOutputMesh >.

template<typename TOutputMesh >
virtual void itk::VTKPolyDataReader< TOutputMesh >::SetFileName ( const char *  _arg)
virtual

Set the resolution level to be used for generating cells in the Sphere. High values of this parameter will produce sphere with more triangles. Set/Get the name of the file to be read.

Member Data Documentation

template<typename TOutputMesh >
std::string itk::VTKPolyDataReader< TOutputMesh >::m_FileName
private

Filename to read

Definition at line 115 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
std::string itk::VTKPolyDataReader< TOutputMesh >::m_Header
private

Definition at line 116 of file itkVTKPolyDataReader.h.

template<typename TOutputMesh >
std::string itk::VTKPolyDataReader< TOutputMesh >::m_Version
private

Definition at line 117 of file itkVTKPolyDataReader.h.


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