ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Private Attributes | List of all members
itk::VTKImageToImageFilter< TOutputImage > Class Template Reference

#include <itkVTKImageToImageFilter.h>

Detailed Description

template<typename TOutputImage>
class itk::VTKImageToImageFilter< TOutputImage >

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

This class puts together an itk::VTKImageImport and a vtk::ImageExport. 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 a vtkImageData can be plugged as input and an itk::Image is produced as output.

ITK Sphinx Examples:
Examples
SphinxExamples/src/Bridge/VtkGlue/ConvertRGBvtkImageDataToAnitkImage/Code.cxx, SphinxExamples/src/Bridge/VtkGlue/ConvertvtkImageDataToAnitkImage/Code.cxx, and SphinxExamples/src/Bridge/VtkGlue/VTKImageToITKImage/Code.cxx.

Definition at line 51 of file itkVTKImageToImageFilter.h.

+ Inheritance diagram for itk::VTKImageToImageFilter< TOutputImage >:
+ Collaboration diagram for itk::VTKImageToImageFilter< TOutputImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using OutputImagePointer = typename OutputImageType::ConstPointer
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = VTKImageToImageFilter
 
using Superclass = VTKImageImport< TOutputImage >
 
- Public Types inherited from itk::VTKImageImport< TOutputImage >
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageType = TOutputImage
 
using OutputIndexType = typename OutputImageType::IndexType
 
using OutputPixelType = typename OutputImageType::PixelType
 
using OutputRegionType = typename OutputImageType::RegionType
 
using OutputSizeType = typename OutputImageType::SizeType
 
using Pointer = SmartPointer< Self >
 
using Self = VTKImageImport
 
using Superclass = ImageSource< TOutputImage >
 
using UpdateInformationCallbackType = void(*)(void *)
 
using PipelineModifiedCallbackType = int(*)(void *)
 
using WholeExtentCallbackType = int *(*)(void *)
 
using SpacingCallbackType = double *(*)(void *)
 
using OriginCallbackType = double *(*)(void *)
 
using DirectionCallbackType = double *(*)(void *)
 
using ScalarTypeCallbackType = const char *(*)(void *)
 
using NumberOfComponentsCallbackType = int(*)(void *)
 
using PropagateUpdateExtentCallbackType = void(*)(void *, int *)
 
using UpdateDataCallbackType = void(*)(void *)
 
using DataExtentCallbackType = int *(*)(void *)
 
using BufferPointerCallbackType = void *(*)(void *)
 
using FloatSpacingCallbackType = float *(*)(void *)
 
using FloatOriginCallbackType = float *(*)(void *)
 
- Public Types inherited from itk::ImageSource< TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
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

vtkImageExport * GetExporter () const
 
const SuperclassGetImporter () const
 
const char * GetNameOfClass () const override
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
void SetInput (vtkImageData *)
 
- Public Member Functions inherited from itk::VTKImageImport< TOutputImage >
virtual void SetUpdateInformationCallback (UpdateInformationCallbackType _arg)
 
virtual UpdateInformationCallbackType GetUpdateInformationCallback () const
 
virtual void SetPipelineModifiedCallback (PipelineModifiedCallbackType _arg)
 
virtual PipelineModifiedCallbackType GetPipelineModifiedCallback () const
 
virtual void SetWholeExtentCallback (WholeExtentCallbackType _arg)
 
virtual WholeExtentCallbackType GetWholeExtentCallback () const
 
virtual void SetSpacingCallback (SpacingCallbackType _arg)
 
virtual SpacingCallbackType GetSpacingCallback () const
 
virtual void SetFloatSpacingCallback (FloatSpacingCallbackType _arg)
 
virtual FloatSpacingCallbackType GetFloatSpacingCallback () const
 
void SetSpacingCallback (FloatSpacingCallbackType f)
 
virtual void SetOriginCallback (OriginCallbackType _arg)
 
virtual OriginCallbackType GetOriginCallback () const
 
virtual void SetFloatOriginCallback (FloatOriginCallbackType _arg)
 
virtual FloatOriginCallbackType GetFloatOriginCallback () const
 
void SetOriginCallback (FloatOriginCallbackType f)
 
virtual void SetDirectionCallback (DirectionCallbackType _arg)
 
virtual DirectionCallbackType GetDirectionCallback () const
 
virtual void SetScalarTypeCallback (ScalarTypeCallbackType _arg)
 
virtual ScalarTypeCallbackType GetScalarTypeCallback () const
 
virtual void SetNumberOfComponentsCallback (NumberOfComponentsCallbackType _arg)
 
virtual NumberOfComponentsCallbackType GetNumberOfComponentsCallback () const
 
virtual void SetPropagateUpdateExtentCallback (PropagateUpdateExtentCallbackType _arg)
 
virtual PropagateUpdateExtentCallbackType GetPropagateUpdateExtentCallback () const
 
virtual void SetUpdateDataCallback (UpdateDataCallbackType _arg)
 
virtual UpdateDataCallbackType GetUpdateDataCallback () const
 
virtual void SetDataExtentCallback (DataExtentCallbackType _arg)
 
virtual DataExtentCallbackType GetDataExtentCallback () const
 
virtual void SetBufferPointerCallback (BufferPointerCallbackType _arg)
 
virtual BufferPointerCallbackType GetBufferPointerCallback () const
 
 itkSetMacro2 (CallbackUserData, void *)
 
virtual void * GetCallbackUserData () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- 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 ()
 
MultiThreaderTypeGetMultiThreader () 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 void PrepareOutputs ()
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
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 ThreadIdTypeGetNumberOfWorkUnits () 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
 
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
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::VTKImageImport< TOutputImage >
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

 VTKImageToImageFilter ()
 
 ~VTKImageToImageFilter () override
 
- Protected Member Functions inherited from itk::VTKImageImport< TOutputImage >
void GenerateData () override
 
void GenerateOutputInformation () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void PropagateRequestedRegion (DataObject *) override
 
void UpdateOutputInformation () override
 
 VTKImageImport ()
 
 ~VTKImageImport () override=default
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual void ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
- 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 GenerateInputRequestedRegion ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () 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 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 () 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 i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () 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 Types

using ImageExportPointer = vtkSmartPointer< vtkImageExport >
 

Private Attributes

ImageExportPointer m_Exporter {}
 

Additional Inherited Members

- Static Public Attributes inherited from itk::VTKImageImport< TOutputImage >
static constexpr unsigned int OutputImageDimension = OutputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading {}
 
- 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 TOutputImage >
using itk::VTKImageToImageFilter< TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 60 of file itkVTKImageToImageFilter.h.

◆ ImageExportPointer

template<typename TOutputImage >
using itk::VTKImageToImageFilter< TOutputImage >::ImageExportPointer = vtkSmartPointer<vtkImageExport>
private

Definition at line 96 of file itkVTKImageToImageFilter.h.

◆ OutputImagePointer

template<typename TOutputImage >
using itk::VTKImageToImageFilter< TOutputImage >::OutputImagePointer = typename OutputImageType::ConstPointer

Definition at line 70 of file itkVTKImageToImageFilter.h.

◆ OutputImageType

template<typename TOutputImage >
using itk::VTKImageToImageFilter< TOutputImage >::OutputImageType = TOutputImage

Some type alias.

Definition at line 69 of file itkVTKImageToImageFilter.h.

◆ Pointer

template<typename TOutputImage >
using itk::VTKImageToImageFilter< TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 59 of file itkVTKImageToImageFilter.h.

◆ Self

template<typename TOutputImage >
using itk::VTKImageToImageFilter< TOutputImage >::Self = VTKImageToImageFilter

Standard class type aliases.

Definition at line 57 of file itkVTKImageToImageFilter.h.

◆ Superclass

template<typename TOutputImage >
using itk::VTKImageToImageFilter< TOutputImage >::Superclass = VTKImageImport<TOutputImage>

Definition at line 58 of file itkVTKImageToImageFilter.h.

Constructor & Destructor Documentation

◆ VTKImageToImageFilter()

template<typename TOutputImage >
itk::VTKImageToImageFilter< TOutputImage >::VTKImageToImageFilter ( )
protected

◆ ~VTKImageToImageFilter()

template<typename TOutputImage >
itk::VTKImageToImageFilter< TOutputImage >::~VTKImageToImageFilter ( )
overrideprotected

Member Function Documentation

◆ GetExporter()

template<typename TOutputImage >
vtkImageExport* itk::VTKImageToImageFilter< TOutputImage >::GetExporter ( ) const

Get the internal VTK image exporter filter.

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

◆ GetImporter()

template<typename TOutputImage >
const Superclass* itk::VTKImageToImageFilter< TOutputImage >::GetImporter ( ) const

Get the internal ITK image importer filter.

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

◆ GetNameOfClass()

template<typename TOutputImage >
const char* itk::VTKImageToImageFilter< TOutputImage >::GetNameOfClass ( ) const
overridevirtual

◆ New()

template<typename TOutputImage >
static Pointer itk::VTKImageToImageFilter< TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ SetInput() [1/2]

template<typename TOutputImage >
virtual void itk::ProcessObject::SetInput

Protected method for setting indexed and named inputs.

Subclasses make use of them for setting input. As this method only used the base DataObject pointer, derived classes should expose a type check methods.

◆ SetInput() [2/2]

template<typename TOutputImage >
void itk::VTKImageToImageFilter< TOutputImage >::SetInput ( vtkImageData *  )

Set the input in the form of a vtkImageData.

Member Data Documentation

◆ m_Exporter

template<typename TOutputImage >
ImageExportPointer itk::VTKImageToImageFilter< TOutputImage >::m_Exporter {}
private

Definition at line 97 of file itkVTKImageToImageFilter.h.


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