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::ImageToVTKImageFilter< TInputImage > Class Template Reference

#include <itkImageToVTKImageFilter.h>

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

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 datapipeline.

This class puts together an itkVTKImageExporter and a vtkImageImporter. 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.

Wiki Examples:
Examples:
SphinxExamples/src/Bridge/VtkGlue/ConvertAnitkImageTovtkImageData/Code.cxx, SphinxExamples/src/Bridge/VtkGlue/ConvertAnRGBitkImageTovtkImageData/Code.cxx, WikiExamples/ImageProcessing/AddImageFilter.cxx, WikiExamples/ImageProcessing/MinimumMaximumImageCalculator.cxx, WikiExamples/ImageProcessing/PermuteAxesImageFilter.cxx, WikiExamples/ImageProcessing/RescaleIntensityImageFilter.cxx, WikiExamples/ImageProcessing/SubtractImageFilter.cxx, WikiExamples/IO/ImageToVTKImageFilter.cxx, WikiExamples/Iterators/ConstantBoundaryCondition.cxx, WikiExamples/Iterators/ImageRegionIterator.cxx, WikiExamples/Iterators/NeighborhoodIterator.cxx, WikiExamples/Registration/WatchRegistration.cxx, WikiExamples/SimpleOperations/SetPixels.cxx, and WikiExamples/Statistics/ScalarImageKmeansImageFilter.cxx.

Definition at line 46 of file itkImageToVTKImageFilter.h.

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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
ExporterFilterTypeGetExporter () const
 
vtkImageImport * GetImporter () const
 
virtual const char * GetNameOfClass () const
 
vtkImageData * GetOutput () const
 
void Update () override
 
void UpdateLargestPossibleRegion () override
 
void SetInput (const InputImageType *)
 
InputImageTypeGetInput ()
 
- 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 (DataObjectPointerArraySizeType idx)
 
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 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::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

 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)
 
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 ()
 
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 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

ExporterFilterPointer m_Exporter
 
vtkImageImport * m_Importer
 

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 TInputImage >
using itk::ImageToVTKImageFilter< TInputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 55 of file itkImageToVTKImageFilter.h.

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

Definition at line 68 of file itkImageToVTKImageFilter.h.

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

Definition at line 67 of file itkImageToVTKImageFilter.h.

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

Definition at line 65 of file itkImageToVTKImageFilter.h.

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

Some type alias.

Definition at line 64 of file itkImageToVTKImageFilter.h.

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

Definition at line 54 of file itkImageToVTKImageFilter.h.

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

Standard class type aliases.

Definition at line 52 of file itkImageToVTKImageFilter.h.

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

Definition at line 53 of file itkImageToVTKImageFilter.h.

Constructor & Destructor Documentation

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

Member Function Documentation

template<typename TInputImage >
virtual::itk::LightObject::Pointer itk::ImageToVTKImageFilter< TInputImage >::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.

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

Return the internal ITK image exporter filter. This is intended to facilitate users the access to methods in the exporter

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

Return the internal VTK image importer filter. This is intended to facilitate users the access to methods in the importer

template<typename TInputImage >
InputImageType* itk::ImageToVTKImageFilter< TInputImage >::GetInput ( )
template<typename TInputImage >
virtual const char* itk::ImageToVTKImageFilter< TInputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

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 vtkImageImporter filter

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

Method for creation through the object factory.

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

This call delegates the update to the importer

Reimplemented from itk::ProcessObject.

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

This call delegates the update to the importer

Reimplemented from itk::ProcessObject.

Member Data Documentation

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

Definition at line 101 of file itkImageToVTKImageFilter.h.

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

Definition at line 102 of file itkImageToVTKImageFilter.h.


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