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

#include <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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::VTKImageExportBase
void * GetCallbackUserData ()
 
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 AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
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 PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
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
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- 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
 
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
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 ()
 

Static Public Attributes

static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputRegionType = typename InputImageType::RegionType
 
using InputSizeType = typename InputRegionType::SizeType
 
using InputIndexType = typename InputRegionType::IndexType
 
std::string m_ScalarTypeName
 
int m_WholeExtent [6]
 
int m_DataExtent [6]
 
double m_DataSpacing [3]
 
double m_DataOrigin [3]
 
double m_DataDirection [9]
 
float m_FloatDataSpacing [3]
 
float m_FloatDataOrigin [3]
 
void SetInput (const InputImageType *)
 
InputImageTypeGetInput ()
 
 VTKImageExport ()
 
 ~VTKImageExport () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
int * WholeExtentCallback () override
 
double * SpacingCallback () override
 
double * OriginCallback () override
 
double * DirectionCallback () override
 
float * FloatSpacingCallback () override
 
float * FloatOriginCallback () override
 
const char * ScalarTypeCallback () override
 
int NumberOfComponentsCallback () override
 
void PropagateUpdateExtentCallback (int *) override
 
int * DataExtentCallback () override
 
void * BufferPointerCallback () override
 

Additional Inherited Members

- Protected Types inherited from itk::VTKImageExportBase
using DataObjectPointer = DataObject::Pointer
 
- 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
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
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
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateData ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void ThreaderUpdateProgressOff ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- 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
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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.

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

The function pointer type expected for a callback.

Implements itk::VTKImageExportBase.

◆ CreateAnother()

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

◆ DataExtentCallback()

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

The function pointer type expected for a callback.

Implements itk::VTKImageExportBase.

◆ DirectionCallback()

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

The function pointer type expected for a callback.

Implements itk::VTKImageExportBase.

◆ FloatOriginCallback()

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

The function pointer type expected for a callback.

Implements itk::VTKImageExportBase.

◆ FloatSpacingCallback()

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

The function pointer type expected for a callback.

Implements itk::VTKImageExportBase.

◆ GetInput()

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

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::VTKImageExportBase.

◆ 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

The function pointer type expected for a callback.

Implements itk::VTKImageExportBase.

◆ OriginCallback()

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

The function pointer type expected for a callback.

Implements itk::VTKImageExportBase.

◆ PrintSelf()

template<typename TInputImage >
void itk::VTKImageExport< TInputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

STL map to store the named inputs and outputs

Reimplemented from itk::ProcessObject.

◆ PropagateUpdateExtentCallback()

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

The function pointer type expected for a callback.

Implements itk::VTKImageExportBase.

◆ ScalarTypeCallback()

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

The function pointer type expected for a callback.

Implements itk::VTKImageExportBase.

◆ SetInput()

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

◆ SpacingCallback()

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

The function pointer type expected for a callback.

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: