ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::ImageToVTKImageFilter< TInputImage > Class Template Reference
Group Bridge » Module ITKVtkGlue

#include <itkImageToVTKImageFilter.h>

Detailed Description

template<typename TInputImage>
class itk::ImageToVTKImageFilter< TInputImage >

Converts an ITK Image into a VTK image and plugs a ITK data pipeline to a VTK data pipeline.

This class puts together VTKImageExport and vtkImageImport objects. It takes care of the details related to the connection of ITK and VTK pipelines. The User will perceive this filter as an adaptor to which an itk::Image can be plugged as input and a vtkImage is produced as output.

ITK Sphinx Examples:
Examples
SphinxExamples/src/Bridge/VtkGlue/ConvertAnitkImageTovtkImageData/Code.cxx, SphinxExamples/src/Bridge/VtkGlue/ConvertAnRGBitkImageTovtkImageData/Code.cxx, SphinxExamples/src/Core/Common/FindMaxAndMinInImage/Code.cxx, SphinxExamples/src/Core/Common/InPlaceFilterOfImage/Code.cxx, SphinxExamples/src/Core/Common/IterateRegionWithNeighborhood/Code.cxx, SphinxExamples/src/Core/Common/IterateRegionWithWriteAccess/Code.cxx, SphinxExamples/src/Core/Common/MakeOutOfBoundsPixelsReturnConstValue/Code.cxx, SphinxExamples/src/Filtering/ImageGradient/ComputeAndDisplayGradient/Code.cxx, SphinxExamples/src/Filtering/ImageIntensity/AddTwoImages/Code.cxx, SphinxExamples/src/Filtering/ImageIntensity/SubtractTwoImages/Code.cxx, SphinxExamples/src/Registration/Common/WatchRegistration/Code.cxx, SphinxExamples/src/Remote/WikiExamples/DisplayITKImage/Code.cxx, SphinxExamples/src/Segmentation/Classifiers/ClusterPixelsInGrayscaleImage/Code.cxx, SphinxExamples/src/Segmentation/KLMRegionGrowing/BasicRegionGrowing/Code.cxx, and SphinxExamples/src/Segmentation/RegionGrowing/ConnectedComponentsInImage/Code.cxx.

Definition at line 47 of file itkImageToVTKImageFilter.h.

+ Inheritance diagram for itk::ImageToVTKImageFilter< TInputImage >:
+ Collaboration diagram for itk::ImageToVTKImageFilter< TInputImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ExporterFilterPointer = typename ExporterFilterType::Pointer
 
using ExporterFilterType = VTKImageExport< InputImageType >
 
using InputImagePointer = typename InputImageType::ConstPointer
 
using InputImageType = TInputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToVTKImageFilter
 
using Superclass = ProcessObject
 
- 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

ExporterFilterType * GetExporter () const
 
vtkImageImport * GetImporter () const
 
const char * GetNameOfClass () const override
 
vtkImageData * GetOutput () const
 
void Update () override
 
void UpdateLargestPossibleRegion () override
 
void SetInput (const InputImageType *)
 
InputImageType * GetInput ()
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderType * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdType & GetNumberOfWorkUnits () const
 
- 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
 
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) 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

 ImageToVTKImageFilter ()
 
 ~ImageToVTKImageFilter () override
 
- 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 GenerateData ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (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 ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 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 idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation () const
 
virtual void VerifyPreconditions () const
 
 ~ProcessObject () override
 
DataObject * GetInput (DataObjectPointerArraySizeType idx)
 
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
 
DataObject * GetPrimaryInput ()
 
const DataObject * GetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObject * GetOutput (const DataObjectIdentifierType &key)
 
const DataObject * GetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObject * GetOutput (DataObjectPointerArraySizeType i)
 
const DataObject * GetOutput (DataObjectPointerArraySizeType i) const
 
DataObject * GetPrimaryOutput ()
 
const DataObject * GetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- 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 ()
 

Private Attributes

ExporterFilterPointer m_Exporter {}
 
vtkImageImport * m_Importer {}
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
 
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- 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

◆ ConstPointer

template<typename TInputImage >
using itk::ImageToVTKImageFilter< TInputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 56 of file itkImageToVTKImageFilter.h.

◆ ExporterFilterPointer

template<typename TInputImage >
using itk::ImageToVTKImageFilter< TInputImage >::ExporterFilterPointer = typename ExporterFilterType::Pointer

Definition at line 69 of file itkImageToVTKImageFilter.h.

◆ ExporterFilterType

template<typename TInputImage >
using itk::ImageToVTKImageFilter< TInputImage >::ExporterFilterType = VTKImageExport<InputImageType>

Definition at line 68 of file itkImageToVTKImageFilter.h.

◆ InputImagePointer

template<typename TInputImage >
using itk::ImageToVTKImageFilter< TInputImage >::InputImagePointer = typename InputImageType::ConstPointer

Definition at line 66 of file itkImageToVTKImageFilter.h.

◆ InputImageType

template<typename TInputImage >
using itk::ImageToVTKImageFilter< TInputImage >::InputImageType = TInputImage

Some type alias.

Definition at line 65 of file itkImageToVTKImageFilter.h.

◆ Pointer

template<typename TInputImage >
using itk::ImageToVTKImageFilter< TInputImage >::Pointer = SmartPointer<Self>

Definition at line 55 of file itkImageToVTKImageFilter.h.

◆ Self

template<typename TInputImage >
using itk::ImageToVTKImageFilter< TInputImage >::Self = ImageToVTKImageFilter

Standard class type aliases.

Definition at line 53 of file itkImageToVTKImageFilter.h.

◆ Superclass

template<typename TInputImage >
using itk::ImageToVTKImageFilter< TInputImage >::Superclass = ProcessObject

Definition at line 54 of file itkImageToVTKImageFilter.h.

Constructor & Destructor Documentation

◆ ImageToVTKImageFilter()

template<typename TInputImage >
itk::ImageToVTKImageFilter< TInputImage >::ImageToVTKImageFilter ( )
protected

◆ ~ImageToVTKImageFilter()

template<typename TInputImage >
itk::ImageToVTKImageFilter< TInputImage >::~ImageToVTKImageFilter ( )
overrideprotected

Member Function Documentation

◆ GetExporter()

template<typename TInputImage >
ExporterFilterType* itk::ImageToVTKImageFilter< TInputImage >::GetExporter ( ) const

Return the internal ITK image exporter filter.

Intended to facilitate users the access to methods in the exporter.

◆ GetImporter()

template<typename TInputImage >
vtkImageImport* itk::ImageToVTKImageFilter< TInputImage >::GetImporter ( ) const

Return the internal VTK image importer filter.

Intended to facilitate users the access to methods in the importer.

◆ GetInput()

template<typename TInputImage >
InputImageType* itk::ImageToVTKImageFilter< TInputImage >::GetInput ( )

◆ GetNameOfClass()

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

Reimplemented from itk::ProcessObject.

◆ GetOutput()

template<typename TInputImage >
vtkImageData* itk::ImageToVTKImageFilter< TInputImage >::GetOutput ( ) const

Get the output in the form of a vtkImage.

This call is delegated to the internal vtkImageImport filter.

◆ New()

template<typename TInputImage >
static Pointer itk::ImageToVTKImageFilter< TInputImage >::New ( )
static

Method for creation through the object factory.

◆ SetInput()

template<typename TInputImage >
void itk::ImageToVTKImageFilter< TInputImage >::SetInput ( const InputImageType *  )

◆ Update()

template<typename TInputImage >
void itk::ImageToVTKImageFilter< TInputImage >::Update ( )
overridevirtual

This call delegates the update to the importer.

Reimplemented from itk::ProcessObject.

◆ UpdateLargestPossibleRegion()

template<typename TInputImage >
void itk::ImageToVTKImageFilter< TInputImage >::UpdateLargestPossibleRegion ( )
overridevirtual

This call delegates the update to the importer.

Reimplemented from itk::ProcessObject.

Member Data Documentation

◆ m_Exporter

template<typename TInputImage >
ExporterFilterPointer itk::ImageToVTKImageFilter< TInputImage >::m_Exporter {}
private

Definition at line 113 of file itkImageToVTKImageFilter.h.

◆ m_Importer

template<typename TInputImage >
vtkImageImport* itk::ImageToVTKImageFilter< TInputImage >::m_Importer {}
private

Definition at line 114 of file itkImageToVTKImageFilter.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