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

#include <itkVTKImageImport.h>

Detailed Description

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

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

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

Note that the VTK images are assumed to be 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. The images can also have pixel types with more than one component.

See also
VTKImageImport

Definition at line 57 of file itkVTKImageImport.h.

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

Public Types

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

 itkOverrideGetNameOfClassMacro (VTKImageImport)
 
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)
 
 itkOverrideGetNameOfClassMacro (ImageSource)
 
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)
 
 itkOverrideGetNameOfClassMacro (ProcessObject)
 
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
 
 itkOverrideGetNameOfClassMacro (Object)
 
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
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
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 OutputImageDimension = OutputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 

Protected Member Functions

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 Attributes

BufferPointerCallbackType m_BufferPointerCallback { nullptr }
 
void * m_CallbackUserData { nullptr }
 
DataExtentCallbackType m_DataExtentCallback { nullptr }
 
DirectionCallbackType m_DirectionCallback { nullptr }
 
FloatOriginCallbackType m_FloatOriginCallback { nullptr }
 
FloatSpacingCallbackType m_FloatSpacingCallback { nullptr }
 
NumberOfComponentsCallbackType m_NumberOfComponentsCallback { nullptr }
 
OriginCallbackType m_OriginCallback { nullptr }
 
PipelineModifiedCallbackType m_PipelineModifiedCallback { nullptr }
 
PropagateUpdateExtentCallbackType m_PropagateUpdateExtentCallback { nullptr }
 
ScalarTypeCallbackType m_ScalarTypeCallback { nullptr }
 
std::string m_ScalarTypeName {}
 
SpacingCallbackType m_SpacingCallback { nullptr }
 
UpdateDataCallbackType m_UpdateDataCallback { nullptr }
 
UpdateInformationCallbackType m_UpdateInformationCallback { nullptr }
 
WholeExtentCallbackType m_WholeExtentCallback { nullptr }
 

Additional Inherited Members

- 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

◆ BufferPointerCallbackType

template<typename TOutputImage >
using itk::VTKImageImport< TOutputImage >::BufferPointerCallbackType = void * (*)(void *)

These are function pointer types for the pipeline connection callbacks.

Definition at line 97 of file itkVTKImageImport.h.

◆ DataExtentCallbackType

template<typename TOutputImage >
using itk::VTKImageImport< TOutputImage >::DataExtentCallbackType = int * (*)(void *)

These are function pointer types for the pipeline connection callbacks.

Definition at line 96 of file itkVTKImageImport.h.

◆ DirectionCallbackType

template<typename TOutputImage >
using itk::VTKImageImport< TOutputImage >::DirectionCallbackType = double * (*)(void *)

These are function pointer types for the pipeline connection callbacks.

Definition at line 91 of file itkVTKImageImport.h.

◆ FloatOriginCallbackType

template<typename TOutputImage >
using itk::VTKImageImport< TOutputImage >::FloatOriginCallbackType = float * (*)(void *)

Compatibility for VTK older than 4.4.

Definition at line 102 of file itkVTKImageImport.h.

◆ FloatSpacingCallbackType

template<typename TOutputImage >
using itk::VTKImageImport< TOutputImage >::FloatSpacingCallbackType = float * (*)(void *)

Compatibility for VTK older than 4.4.

Definition at line 101 of file itkVTKImageImport.h.

◆ NumberOfComponentsCallbackType

template<typename TOutputImage >
using itk::VTKImageImport< TOutputImage >::NumberOfComponentsCallbackType = int (*)(void *)

These are function pointer types for the pipeline connection callbacks.

Definition at line 93 of file itkVTKImageImport.h.

◆ OriginCallbackType

template<typename TOutputImage >
using itk::VTKImageImport< TOutputImage >::OriginCallbackType = double * (*)(void *)

These are function pointer types for the pipeline connection callbacks.

Definition at line 90 of file itkVTKImageImport.h.

◆ OutputImagePointer

template<typename TOutputImage >
using itk::VTKImageImport< TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 75 of file itkVTKImageImport.h.

◆ OutputImageType

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

Convenient type alias from the output image.

Definition at line 74 of file itkVTKImageImport.h.

◆ OutputIndexType

template<typename TOutputImage >
using itk::VTKImageImport< TOutputImage >::OutputIndexType = typename OutputImageType::IndexType

Definition at line 78 of file itkVTKImageImport.h.

◆ OutputPixelType

template<typename TOutputImage >
using itk::VTKImageImport< TOutputImage >::OutputPixelType = typename OutputImageType::PixelType

Definition at line 76 of file itkVTKImageImport.h.

◆ OutputRegionType

template<typename TOutputImage >
using itk::VTKImageImport< TOutputImage >::OutputRegionType = typename OutputImageType::RegionType

Definition at line 79 of file itkVTKImageImport.h.

◆ OutputSizeType

template<typename TOutputImage >
using itk::VTKImageImport< TOutputImage >::OutputSizeType = typename OutputImageType::SizeType

Definition at line 77 of file itkVTKImageImport.h.

◆ PipelineModifiedCallbackType

template<typename TOutputImage >
using itk::VTKImageImport< TOutputImage >::PipelineModifiedCallbackType = int (*)(void *)

These are function pointer types for the pipeline connection callbacks.

Definition at line 87 of file itkVTKImageImport.h.

◆ Pointer

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

Definition at line 65 of file itkVTKImageImport.h.

◆ PropagateUpdateExtentCallbackType

template<typename TOutputImage >
using itk::VTKImageImport< TOutputImage >::PropagateUpdateExtentCallbackType = void (*)(void *, int *)

These are function pointer types for the pipeline connection callbacks.

Definition at line 94 of file itkVTKImageImport.h.

◆ ScalarTypeCallbackType

template<typename TOutputImage >
using itk::VTKImageImport< TOutputImage >::ScalarTypeCallbackType = const char * (*)(void *)

These are function pointer types for the pipeline connection callbacks.

Definition at line 92 of file itkVTKImageImport.h.

◆ Self

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

Standard class type aliases.

Definition at line 63 of file itkVTKImageImport.h.

◆ SpacingCallbackType

template<typename TOutputImage >
using itk::VTKImageImport< TOutputImage >::SpacingCallbackType = double * (*)(void *)

These are function pointer types for the pipeline connection callbacks.

Definition at line 89 of file itkVTKImageImport.h.

◆ Superclass

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

Definition at line 64 of file itkVTKImageImport.h.

◆ UpdateDataCallbackType

template<typename TOutputImage >
using itk::VTKImageImport< TOutputImage >::UpdateDataCallbackType = void (*)(void *)

These are function pointer types for the pipeline connection callbacks.

Definition at line 95 of file itkVTKImageImport.h.

◆ UpdateInformationCallbackType

template<typename TOutputImage >
using itk::VTKImageImport< TOutputImage >::UpdateInformationCallbackType = void (*)(void *)

These are function pointer types for the pipeline connection callbacks.

Definition at line 86 of file itkVTKImageImport.h.

◆ WholeExtentCallbackType

template<typename TOutputImage >
using itk::VTKImageImport< TOutputImage >::WholeExtentCallbackType = int * (*)(void *)

These are function pointer types for the pipeline connection callbacks.

Definition at line 88 of file itkVTKImageImport.h.

Constructor & Destructor Documentation

◆ VTKImageImport()

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

◆ ~VTKImageImport()

template<typename TOutputImage >
itk::VTKImageImport< TOutputImage >::~VTKImageImport ( )
overrideprotecteddefault

Member Function Documentation

◆ GenerateData()

template<typename TOutputImage >
void itk::VTKImageImport< TOutputImage >::GenerateData ( )
overrideprotectedvirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling DynamicThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter can be threaded, it should NOT provide a GenerateData() method but should provide a DynamicThreadedGenerateData() instead.

See also
ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateOutputInformation()

template<typename TOutputImage >
void itk::VTKImageImport< TOutputImage >::GenerateOutputInformation ( )
overrideprotectedvirtual

Generate the information describing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented from itk::ProcessObject.

◆ GetBufferPointerCallback()

template<typename TOutputImage >
virtual BufferPointerCallbackType itk::VTKImageImport< TOutputImage >::GetBufferPointerCallback ( ) const
virtual

What to do when receiving BufferPointer().

◆ GetCallbackUserData()

template<typename TOutputImage >
virtual void* itk::VTKImageImport< TOutputImage >::GetCallbackUserData ( ) const
virtual

Specify callback data.

◆ GetDataExtentCallback()

template<typename TOutputImage >
virtual DataExtentCallbackType itk::VTKImageImport< TOutputImage >::GetDataExtentCallback ( ) const
virtual

What to do when receiving DataExtent().

◆ GetDirectionCallback()

template<typename TOutputImage >
virtual DirectionCallbackType itk::VTKImageImport< TOutputImage >::GetDirectionCallback ( ) const
virtual

What to do when receiving SetDirection().

◆ GetFloatOriginCallback()

template<typename TOutputImage >
virtual FloatOriginCallbackType itk::VTKImageImport< TOutputImage >::GetFloatOriginCallback ( ) const
virtual

What to do when receiving SetOrigin().

◆ GetFloatSpacingCallback()

template<typename TOutputImage >
virtual FloatSpacingCallbackType itk::VTKImageImport< TOutputImage >::GetFloatSpacingCallback ( ) const
virtual

What to do when receiving SetSpacing().

◆ GetNumberOfComponentsCallback()

template<typename TOutputImage >
virtual NumberOfComponentsCallbackType itk::VTKImageImport< TOutputImage >::GetNumberOfComponentsCallback ( ) const
virtual

What to do when receiving SetNumberOfComponents().

◆ GetOriginCallback()

template<typename TOutputImage >
virtual OriginCallbackType itk::VTKImageImport< TOutputImage >::GetOriginCallback ( ) const
virtual

What to do when receiving SetOrigin().

◆ GetPipelineModifiedCallback()

template<typename TOutputImage >
virtual PipelineModifiedCallbackType itk::VTKImageImport< TOutputImage >::GetPipelineModifiedCallback ( ) const
virtual

What to do when receiving PipelineModified().

◆ GetPropagateUpdateExtentCallback()

template<typename TOutputImage >
virtual PropagateUpdateExtentCallbackType itk::VTKImageImport< TOutputImage >::GetPropagateUpdateExtentCallback ( ) const
virtual

What to do when receiving PropagateUpdateExtent().

◆ GetScalarTypeCallback()

template<typename TOutputImage >
virtual ScalarTypeCallbackType itk::VTKImageImport< TOutputImage >::GetScalarTypeCallback ( ) const
virtual

What to do when receiving UpdateInformation().

◆ GetSpacingCallback()

template<typename TOutputImage >
virtual SpacingCallbackType itk::VTKImageImport< TOutputImage >::GetSpacingCallback ( ) const
virtual

What to do when receiving SetSpacing().

◆ GetUpdateDataCallback()

template<typename TOutputImage >
virtual UpdateDataCallbackType itk::VTKImageImport< TOutputImage >::GetUpdateDataCallback ( ) const
virtual

What to do when receiving UpdateData().

◆ GetUpdateInformationCallback()

template<typename TOutputImage >
virtual UpdateInformationCallbackType itk::VTKImageImport< TOutputImage >::GetUpdateInformationCallback ( ) const
virtual

What to do when receiving UpdateInformation().

◆ GetWholeExtentCallback()

template<typename TOutputImage >
virtual WholeExtentCallbackType itk::VTKImageImport< TOutputImage >::GetWholeExtentCallback ( ) const
virtual

What to do when receiving SetWholeExtent().

◆ itkOverrideGetNameOfClassMacro()

template<typename TOutputImage >
itk::VTKImageImport< TOutputImage >::itkOverrideGetNameOfClassMacro ( VTKImageImport< TOutputImage >  )

Run-time type information (and related methods).

◆ itkSetMacro2()

template<typename TOutputImage >
itk::VTKImageImport< TOutputImage >::itkSetMacro2 ( CallbackUserData  ,
void *   
)

Specify callback data.

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

template<typename TOutputImage >
void itk::VTKImageImport< TOutputImage >::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::ImageSource< TOutputImage >.

◆ PropagateRequestedRegion()

template<typename TOutputImage >
void itk::VTKImageImport< TOutputImage >::PropagateRequestedRegion ( DataObject output)
overrideprotectedvirtual

Send the requested region information back up the pipeline (to the filters that precede this one).

Reimplemented from itk::ProcessObject.

◆ SetBufferPointerCallback()

template<typename TOutputImage >
virtual void itk::VTKImageImport< TOutputImage >::SetBufferPointerCallback ( BufferPointerCallbackType  _arg)
virtual

What to do when receiving BufferPointer().

◆ SetDataExtentCallback()

template<typename TOutputImage >
virtual void itk::VTKImageImport< TOutputImage >::SetDataExtentCallback ( DataExtentCallbackType  _arg)
virtual

What to do when receiving DataExtent().

◆ SetDirectionCallback()

template<typename TOutputImage >
virtual void itk::VTKImageImport< TOutputImage >::SetDirectionCallback ( DirectionCallbackType  _arg)
virtual

What to do when receiving SetDirection().

◆ SetFloatOriginCallback()

template<typename TOutputImage >
virtual void itk::VTKImageImport< TOutputImage >::SetFloatOriginCallback ( FloatOriginCallbackType  _arg)
virtual

What to do when receiving SetOrigin().

◆ SetFloatSpacingCallback()

template<typename TOutputImage >
virtual void itk::VTKImageImport< TOutputImage >::SetFloatSpacingCallback ( FloatSpacingCallbackType  _arg)
virtual

What to do when receiving SetSpacing().

◆ SetNumberOfComponentsCallback()

template<typename TOutputImage >
virtual void itk::VTKImageImport< TOutputImage >::SetNumberOfComponentsCallback ( NumberOfComponentsCallbackType  _arg)
virtual

What to do when receiving SetNumberOfComponents().

◆ SetOriginCallback() [1/2]

template<typename TOutputImage >
void itk::VTKImageImport< TOutputImage >::SetOriginCallback ( FloatOriginCallbackType  f)
inline

What to do when receiving SetOrigin().

Definition at line 138 of file itkVTKImageImport.h.

◆ SetOriginCallback() [2/2]

template<typename TOutputImage >
virtual void itk::VTKImageImport< TOutputImage >::SetOriginCallback ( OriginCallbackType  _arg)
virtual

What to do when receiving SetOrigin().

◆ SetPipelineModifiedCallback()

template<typename TOutputImage >
virtual void itk::VTKImageImport< TOutputImage >::SetPipelineModifiedCallback ( PipelineModifiedCallbackType  _arg)
virtual

What to do when receiving PipelineModified().

◆ SetPropagateUpdateExtentCallback()

template<typename TOutputImage >
virtual void itk::VTKImageImport< TOutputImage >::SetPropagateUpdateExtentCallback ( PropagateUpdateExtentCallbackType  _arg)
virtual

What to do when receiving PropagateUpdateExtent().

◆ SetScalarTypeCallback()

template<typename TOutputImage >
virtual void itk::VTKImageImport< TOutputImage >::SetScalarTypeCallback ( ScalarTypeCallbackType  _arg)
virtual

What to do when receiving UpdateInformation().

◆ SetSpacingCallback() [1/2]

template<typename TOutputImage >
void itk::VTKImageImport< TOutputImage >::SetSpacingCallback ( FloatSpacingCallbackType  f)
inline

What to do when receiving SetSpacing().

Definition at line 126 of file itkVTKImageImport.h.

◆ SetSpacingCallback() [2/2]

template<typename TOutputImage >
virtual void itk::VTKImageImport< TOutputImage >::SetSpacingCallback ( SpacingCallbackType  _arg)
virtual

What to do when receiving SetSpacing().

◆ SetUpdateDataCallback()

template<typename TOutputImage >
virtual void itk::VTKImageImport< TOutputImage >::SetUpdateDataCallback ( UpdateDataCallbackType  _arg)
virtual

What to do when receiving UpdateData().

◆ SetUpdateInformationCallback()

template<typename TOutputImage >
virtual void itk::VTKImageImport< TOutputImage >::SetUpdateInformationCallback ( UpdateInformationCallbackType  _arg)
virtual

What to do when receiving UpdateInformation().

◆ SetWholeExtentCallback()

template<typename TOutputImage >
virtual void itk::VTKImageImport< TOutputImage >::SetWholeExtentCallback ( WholeExtentCallbackType  _arg)
virtual

What to do when receiving SetWholeExtent().

◆ UpdateOutputInformation()

template<typename TOutputImage >
void itk::VTKImageImport< TOutputImage >::UpdateOutputInformation ( )
overrideprotectedvirtual

Update the information describing the output data.

This method traverses up the pipeline gathering modified time information. On the way back down the pipeline, this method calls GenerateOutputInformation() to set any necessary information about the output data objects. For instance, a filter that shrinks an image will need to provide an implementation for GenerateOutputInformation() that changes the spacing of the pixels. Such filters should call their superclass' implementation of GenerateOutputInformation prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented from itk::ProcessObject.

Member Data Documentation

◆ m_BufferPointerCallback

template<typename TOutputImage >
BufferPointerCallbackType itk::VTKImageImport< TOutputImage >::m_BufferPointerCallback { nullptr }
private

Definition at line 217 of file itkVTKImageImport.h.

◆ m_CallbackUserData

template<typename TOutputImage >
void* itk::VTKImageImport< TOutputImage >::m_CallbackUserData { nullptr }
private

Definition at line 203 of file itkVTKImageImport.h.

◆ m_DataExtentCallback

template<typename TOutputImage >
DataExtentCallbackType itk::VTKImageImport< TOutputImage >::m_DataExtentCallback { nullptr }
private

Definition at line 216 of file itkVTKImageImport.h.

◆ m_DirectionCallback

template<typename TOutputImage >
DirectionCallbackType itk::VTKImageImport< TOutputImage >::m_DirectionCallback { nullptr }
private

Definition at line 211 of file itkVTKImageImport.h.

◆ m_FloatOriginCallback

template<typename TOutputImage >
FloatOriginCallbackType itk::VTKImageImport< TOutputImage >::m_FloatOriginCallback { nullptr }
private

Definition at line 210 of file itkVTKImageImport.h.

◆ m_FloatSpacingCallback

template<typename TOutputImage >
FloatSpacingCallbackType itk::VTKImageImport< TOutputImage >::m_FloatSpacingCallback { nullptr }
private

Definition at line 208 of file itkVTKImageImport.h.

◆ m_NumberOfComponentsCallback

template<typename TOutputImage >
NumberOfComponentsCallbackType itk::VTKImageImport< TOutputImage >::m_NumberOfComponentsCallback { nullptr }
private

Definition at line 213 of file itkVTKImageImport.h.

◆ m_OriginCallback

template<typename TOutputImage >
OriginCallbackType itk::VTKImageImport< TOutputImage >::m_OriginCallback { nullptr }
private

Definition at line 209 of file itkVTKImageImport.h.

◆ m_PipelineModifiedCallback

template<typename TOutputImage >
PipelineModifiedCallbackType itk::VTKImageImport< TOutputImage >::m_PipelineModifiedCallback { nullptr }
private

Definition at line 205 of file itkVTKImageImport.h.

◆ m_PropagateUpdateExtentCallback

template<typename TOutputImage >
PropagateUpdateExtentCallbackType itk::VTKImageImport< TOutputImage >::m_PropagateUpdateExtentCallback { nullptr }
private

Definition at line 214 of file itkVTKImageImport.h.

◆ m_ScalarTypeCallback

template<typename TOutputImage >
ScalarTypeCallbackType itk::VTKImageImport< TOutputImage >::m_ScalarTypeCallback { nullptr }
private

Definition at line 212 of file itkVTKImageImport.h.

◆ m_ScalarTypeName

template<typename TOutputImage >
std::string itk::VTKImageImport< TOutputImage >::m_ScalarTypeName {}
private

Definition at line 219 of file itkVTKImageImport.h.

◆ m_SpacingCallback

template<typename TOutputImage >
SpacingCallbackType itk::VTKImageImport< TOutputImage >::m_SpacingCallback { nullptr }
private

Definition at line 207 of file itkVTKImageImport.h.

◆ m_UpdateDataCallback

template<typename TOutputImage >
UpdateDataCallbackType itk::VTKImageImport< TOutputImage >::m_UpdateDataCallback { nullptr }
private

Definition at line 215 of file itkVTKImageImport.h.

◆ m_UpdateInformationCallback

template<typename TOutputImage >
UpdateInformationCallbackType itk::VTKImageImport< TOutputImage >::m_UpdateInformationCallback { nullptr }
private

Definition at line 204 of file itkVTKImageImport.h.

◆ m_WholeExtentCallback

template<typename TOutputImage >
WholeExtentCallbackType itk::VTKImageImport< TOutputImage >::m_WholeExtentCallback { nullptr }
private

Definition at line 206 of file itkVTKImageImport.h.

◆ OutputImageDimension

template<typename TOutputImage >
constexpr unsigned int itk::VTKImageImport< TOutputImage >::OutputImageDimension = OutputImageType::ImageDimension
staticconstexpr

The output image dimension.

Definition at line 82 of file itkVTKImageImport.h.


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