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

#include <itkVTKImageExport.h>

Detailed Description

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

Connect the end of an ITK image pipeline to a VTK pipeline.

VTKImageExport can be used at the end of an ITK image pipeline to connect with a VTK pipeline that begins with vtkImageImport. Callbacks provided by VTKImageExport are registered with vtkImageImport to connect the pipeline execution together. Once connected, update requests coming through the VTK pipeline are automatically propagated to the ITK pipeline.

While VTKImageExportBase provides the pipeline functionality independent of image type, instances must be created through VTKImageExport. This class provides the implementations for callbacks that depend on the image type.

Note that not all image types will work correctly. VTK will only support images of 1, 2, or 3 dimensions. Scalar value types can be one of: float, double, char, unsigned char, short, unsigned short, int, unsigned int, long, unsigned long.

VTKImageExport also supports pixel types with multiple components (like RGBPixel).

See also
VTKImageExportBase

Definition at line 55 of file itkVTKImageExport.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using InputImageType = TInputImage
 
using Pointer = SmartPointer< Self >
 
using Self = VTKImageExport
 
using Superclass = VTKImageExportBase
 
- Public Types inherited from itk::VTKImageExportBase
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = VTKImageExportBase
 
using Superclass = ProcessObject
 
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::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

const char * GetNameOfClass () const override
 
void SetInput (const InputImageType *)
 
InputImageTypeGetInput ()
 
- Public Member Functions inherited from itk::VTKImageExportBase
void * GetCallbackUserData ()
 
const char * GetNameOfClass () const override
 
UpdateInformationCallbackType GetUpdateInformationCallback () const
 
PipelineModifiedCallbackType GetPipelineModifiedCallback () const
 
WholeExtentCallbackType GetWholeExtentCallback () const
 
CallbackTypeProxy GetSpacingCallback () const
 
CallbackTypeProxy GetOriginCallback () const
 
DirectionCallbackType GetDirectionCallback () const
 
ScalarTypeCallbackType GetScalarTypeCallback () const
 
NumberOfComponentsCallbackType GetNumberOfComponentsCallback () const
 
PropagateUpdateExtentCallbackType GetPropagateUpdateExtentCallback () const
 
UpdateDataCallbackType GetUpdateDataCallback () const
 
DataExtentCallbackType GetDataExtentCallback () const
 
BufferPointerCallbackType GetBufferPointerCallback () const
 
- 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 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 Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
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 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::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 ()
 

Static Public Attributes

static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 

Protected Types

using InputImagePointer = typename InputImageType::Pointer
 
using InputIndexType = typename InputRegionType::IndexType
 
using InputRegionType = typename InputImageType::RegionType
 
using InputSizeType = typename InputRegionType::SizeType
 
- Protected Types inherited from itk::VTKImageExportBase
using DataObjectPointer = DataObject::Pointer
 

Protected Member Functions

void * BufferPointerCallback () override
 
int * DataExtentCallback () override
 
double * DirectionCallback () override
 
float * FloatOriginCallback () override
 
float * FloatSpacingCallback () override
 
int NumberOfComponentsCallback () override
 
double * OriginCallback () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void PropagateUpdateExtentCallback (int *) override
 
const char * ScalarTypeCallback () override
 
double * SpacingCallback () override
 
 VTKImageExport ()
 
int * WholeExtentCallback () override
 
 ~VTKImageExport () override=default
 
- Protected Member Functions inherited from itk::VTKImageExportBase
 VTKImageExportBase ()
 
 ~VTKImageExportBase () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void UpdateInformationCallback ()
 
virtual int PipelineModifiedCallback ()
 
virtual void UpdateDataCallback ()
 
- 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 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 Attributes

double m_DataDirection [9] {}
 
int m_DataExtent [6] {}
 
double m_DataOrigin [3] {}
 
double m_DataSpacing [3] {}
 
float m_FloatDataOrigin [3] {}
 
float m_FloatDataSpacing [3] {}
 
std::string m_ScalarTypeName {}
 
int m_WholeExtent [6] {}
 

Additional Inherited Members

- 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::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::VTKImageExport< TInputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 64 of file itkVTKImageExport.h.

◆ InputImagePointer

template<typename TInputImage >
using itk::VTKImageExport< TInputImage >::InputImagePointer = typename InputImageType::Pointer
protected

Definition at line 93 of file itkVTKImageExport.h.

◆ InputImageType

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

The type of the input image.

Definition at line 74 of file itkVTKImageExport.h.

◆ InputIndexType

template<typename TInputImage >
using itk::VTKImageExport< TInputImage >::InputIndexType = typename InputRegionType::IndexType
protected

Definition at line 96 of file itkVTKImageExport.h.

◆ InputRegionType

template<typename TInputImage >
using itk::VTKImageExport< TInputImage >::InputRegionType = typename InputImageType::RegionType
protected

Definition at line 94 of file itkVTKImageExport.h.

◆ InputSizeType

template<typename TInputImage >
using itk::VTKImageExport< TInputImage >::InputSizeType = typename InputRegionType::SizeType
protected

Definition at line 95 of file itkVTKImageExport.h.

◆ Pointer

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

Definition at line 63 of file itkVTKImageExport.h.

◆ Self

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

Standard class type aliases.

Definition at line 61 of file itkVTKImageExport.h.

◆ Superclass

template<typename TInputImage >
using itk::VTKImageExport< TInputImage >::Superclass = VTKImageExportBase

Definition at line 62 of file itkVTKImageExport.h.

Constructor & Destructor Documentation

◆ VTKImageExport()

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

◆ ~VTKImageExport()

template<typename TInputImage >
itk::VTKImageExport< TInputImage >::~VTKImageExport ( )
overrideprotecteddefault

Member Function Documentation

◆ BufferPointerCallback()

template<typename TInputImage >
void* itk::VTKImageExport< TInputImage >::BufferPointerCallback ( )
overrideprotectedvirtual

PipelineMTime from the last call to PipelineModifiedCallback.

Implements itk::VTKImageExportBase.

◆ DataExtentCallback()

template<typename TInputImage >
int* itk::VTKImageExport< TInputImage >::DataExtentCallback ( )
overrideprotectedvirtual

PipelineMTime from the last call to PipelineModifiedCallback.

Implements itk::VTKImageExportBase.

◆ DirectionCallback()

template<typename TInputImage >
double* itk::VTKImageExport< TInputImage >::DirectionCallback ( )
overrideprotectedvirtual

PipelineMTime from the last call to PipelineModifiedCallback.

Implements itk::VTKImageExportBase.

◆ FloatOriginCallback()

template<typename TInputImage >
float* itk::VTKImageExport< TInputImage >::FloatOriginCallback ( )
overrideprotectedvirtual

PipelineMTime from the last call to PipelineModifiedCallback.

Implements itk::VTKImageExportBase.

◆ FloatSpacingCallback()

template<typename TInputImage >
float* itk::VTKImageExport< TInputImage >::FloatSpacingCallback ( )
overrideprotectedvirtual

PipelineMTime from the last call to PipelineModifiedCallback.

Implements itk::VTKImageExportBase.

◆ GetInput()

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

◆ GetNameOfClass()

template<typename TInputImage >
const char* itk::VTKImageExport< TInputImage >::GetNameOfClass ( ) const
overridevirtual

◆ New()

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

Method for creation through the object factory.

◆ NumberOfComponentsCallback()

template<typename TInputImage >
int itk::VTKImageExport< TInputImage >::NumberOfComponentsCallback ( )
overrideprotectedvirtual

PipelineMTime from the last call to PipelineModifiedCallback.

Implements itk::VTKImageExportBase.

◆ OriginCallback()

template<typename TInputImage >
double* itk::VTKImageExport< TInputImage >::OriginCallback ( )
overrideprotectedvirtual

PipelineMTime from the last call to PipelineModifiedCallback.

Implements itk::VTKImageExportBase.

◆ PrintSelf()

template<typename TInputImage >
void itk::VTKImageExport< TInputImage >::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::ProcessObject.

◆ PropagateUpdateExtentCallback()

template<typename TInputImage >
void itk::VTKImageExport< TInputImage >::PropagateUpdateExtentCallback ( int *  )
overrideprotectedvirtual

PipelineMTime from the last call to PipelineModifiedCallback.

Implements itk::VTKImageExportBase.

◆ ScalarTypeCallback()

template<typename TInputImage >
const char* itk::VTKImageExport< TInputImage >::ScalarTypeCallback ( )
overrideprotectedvirtual

PipelineMTime from the last call to PipelineModifiedCallback.

Implements itk::VTKImageExportBase.

◆ SetInput()

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

◆ SpacingCallback()

template<typename TInputImage >
double* itk::VTKImageExport< TInputImage >::SpacingCallback ( )
overrideprotectedvirtual

PipelineMTime from the last call to PipelineModifiedCallback.

Implements itk::VTKImageExportBase.

◆ WholeExtentCallback()

template<typename TInputImage >
int* itk::VTKImageExport< TInputImage >::WholeExtentCallback ( )
overrideprotectedvirtual

These callbacks are image-type specific, and are implemented in VTKImageExport.

Implements itk::VTKImageExportBase.

Member Data Documentation

◆ InputImageDimension

template<typename TInputImage >
constexpr unsigned int itk::VTKImageExport< TInputImage >::InputImageDimension = TInputImage::ImageDimension
staticconstexpr

Definition at line 65 of file itkVTKImageExport.h.

◆ m_DataDirection

template<typename TInputImage >
double itk::VTKImageExport< TInputImage >::m_DataDirection[9] {}
private

Definition at line 137 of file itkVTKImageExport.h.

◆ m_DataExtent

template<typename TInputImage >
int itk::VTKImageExport< TInputImage >::m_DataExtent[6] {}
private

Definition at line 134 of file itkVTKImageExport.h.

◆ m_DataOrigin

template<typename TInputImage >
double itk::VTKImageExport< TInputImage >::m_DataOrigin[3] {}
private

Definition at line 136 of file itkVTKImageExport.h.

◆ m_DataSpacing

template<typename TInputImage >
double itk::VTKImageExport< TInputImage >::m_DataSpacing[3] {}
private

Definition at line 135 of file itkVTKImageExport.h.

◆ m_FloatDataOrigin

template<typename TInputImage >
float itk::VTKImageExport< TInputImage >::m_FloatDataOrigin[3] {}
private

Definition at line 139 of file itkVTKImageExport.h.

◆ m_FloatDataSpacing

template<typename TInputImage >
float itk::VTKImageExport< TInputImage >::m_FloatDataSpacing[3] {}
private

Definition at line 138 of file itkVTKImageExport.h.

◆ m_ScalarTypeName

template<typename TInputImage >
std::string itk::VTKImageExport< TInputImage >::m_ScalarTypeName {}
private

Definition at line 132 of file itkVTKImageExport.h.

◆ m_WholeExtent

template<typename TInputImage >
int itk::VTKImageExport< TInputImage >::m_WholeExtent[6] {}
private

Definition at line 133 of file itkVTKImageExport.h.


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