ITK  5.0.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Static Private Member Functions | Private Attributes | List of all members
itk::VTKImageExportBase Class Referenceabstract

#include <itkVTKImageExportBase.h>

+ Inheritance diagram for itk::VTKImageExportBase:
+ Collaboration diagram for itk::VTKImageExportBase:

Detailed Description

Superclass for VTKImageExport instantiations.

VTKImageExportBase provides the functions that serve as callbacks given to vtkImageImport to connect the end of an ITK pipeline to the beginning of a VTK pipeline.

See Also

Definition at line 37 of file itkVTKImageExportBase.h.


class  CallbackTypeProxy

Public Types

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

BufferPointerCallbackType GetBufferPointerCallback () const
void * GetCallbackUserData ()
DataExtentCallbackType GetDataExtentCallback () const
virtual const char * GetNameOfClass () const
NumberOfComponentsCallbackType GetNumberOfComponentsCallback () const
CallbackTypeProxy GetOriginCallback () const
PipelineModifiedCallbackType GetPipelineModifiedCallback () const
PropagateUpdateExtentCallbackType GetPropagateUpdateExtentCallback () const
ScalarTypeCallbackType GetScalarTypeCallback () const
CallbackTypeProxy GetSpacingCallback () const
UpdateDataCallbackType GetUpdateDataCallback () const
UpdateInformationCallbackType GetUpdateInformationCallback () const
WholeExtentCallbackType GetWholeExtentCallback () 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 ()
MultiThreaderTypeGetMultiThreader () const
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
DataObjectPointerArraySizeType GetNumberOfInputs () const
DataObjectPointerArraySizeType GetNumberOfOutputs () const
GetNumberOfValidRequiredInputs () const
NameArray GetOutputNames () const
DataObjectPointerArray GetOutputs ()
virtual const float & GetProgress () const
NameArray GetRequiredInputNames () const
bool HasInput (const DataObjectIdentifierType &key) const
bool HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
virtual void PrepareOutputs ()
virtual void PropagateRequestedRegion (DataObject *output)
virtual void ResetPipeline ()
virtual void SetAbortGenerateData (bool _arg)
void SetMultiThreader (MultiThreaderType *threader)
virtual void 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
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) 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 noexceptoverride
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
virtual void SetObjectName (std::string _arg)
virtual const std::string & GetObjectName () const
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
virtual int GetReferenceCount () const
 itkCloneMacro (Self)
void Print (std::ostream &os, Indent indent=0) const

Protected Types

using DataObjectPointer = DataObject::Pointer

Protected Member Functions

virtual void * BufferPointerCallback ()=0
virtual int * DataExtentCallback ()=0
virtual float * FloatOriginCallback ()=0
virtual float * FloatSpacingCallback ()=0
virtual int NumberOfComponentsCallback ()=0
virtual double * OriginCallback ()=0
virtual int PipelineModifiedCallback ()
void PrintSelf (std::ostream &os, Indent indent) const override
virtual void PropagateUpdateExtentCallback (int *)=0
virtual const char * ScalarTypeCallback ()=0
virtual double * SpacingCallback ()=0
virtual void UpdateDataCallback ()
virtual void UpdateInformationCallback ()
 VTKImageExportBase ()
virtual int * WholeExtentCallback ()=0
 ~VTKImageExportBase () override=default
- 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
GetNumberOfRequiredInputs () const
virtual const
GetNumberOfRequiredOutputs () const
bool IsIndexedInputName (const DataObjectIdentifierType &) const
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
bool IsRequiredInputName (const DataObjectIdentifierType &) const
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
virtual void PopBackInput ()
virtual void PopFrontInput ()
 ProcessObject ()
virtual void PropagateResetPipeline ()
virtual void PushBackInput (const DataObject *input)
virtual void PushFrontInput (const DataObject *input)
virtual void ReleaseInputs ()
virtual void RemoveInput (const DataObjectIdentifierType &key)
virtual void RemoveInput (DataObjectPointerArraySizeType)
virtual void RemoveOutput (const DataObjectIdentifierType &key)
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void RestoreInputReleaseDataFlags ()
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void SetPrimaryInput (DataObject *input)
virtual void SetPrimaryOutput (DataObject *output)
void SetRequiredInputNames (const NameArray &)
virtual void VerifyInputInformation () ITKv5_CONST
virtual void VerifyPreconditions () ITKv5_CONST
 ~ProcessObject () override
DataObjectGetInput (DataObjectPointerArraySizeType idx)
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryInput ()
const DataObjectGetPrimaryInput () const
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
virtual const char * GetPrimaryInputName () const
DataObjectGetOutput (const DataObjectIdentifierType &key)
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
virtual const char * GetPrimaryOutputName () const
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryOutput ()
const DataObjectGetPrimaryOutput () const
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
 ~Object () override
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 LightObject ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual ~LightObject ()

Static Private Member Functions

static void * BufferPointerCallbackFunction (void *)
static int * DataExtentCallbackFunction (void *)
static float * FloatOriginCallbackFunction (void *)
static float * FloatSpacingCallbackFunction (void *)
static int NumberOfComponentsCallbackFunction (void *)
static double * OriginCallbackFunction (void *)
static int PipelineModifiedCallbackFunction (void *)
static void PropagateUpdateExtentCallbackFunction (void *, int *)
static const char * ScalarTypeCallbackFunction (void *)
static double * SpacingCallbackFunction (void *)
static void UpdateDataCallbackFunction (void *)
static void UpdateInformationCallbackFunction (void *)
static int * WholeExtentCallbackFunction (void *)

Private Attributes

ModifiedTimeType m_LastPipelineMTime

Additional Inherited Members

- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
static void GlobalWarningDisplayOff ()
static void GlobalWarningDisplayOn ()
static Pointer New ()
static void SetGlobalWarningDisplay (bool flag)
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
static Pointer New ()
- Protected 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

The function pointer type expected for a callback.

Definition at line 65 of file itkVTKImageExportBase.h.

Definition at line 46 of file itkVTKImageExportBase.h.

The function pointer type expected for a callback.

Definition at line 64 of file itkVTKImageExportBase.h.

Definition at line 127 of file itkVTKImageExportBase.h.

Compatibility for VTK older than 4.4.

Definition at line 70 of file itkVTKImageExportBase.h.

Compatibility for VTK older than 4.4.

Definition at line 69 of file itkVTKImageExportBase.h.

The function pointer type expected for a callback.

Definition at line 61 of file itkVTKImageExportBase.h.

using itk::VTKImageExportBase::OriginCallbackType = double *(*)(void *)

The function pointer type expected for a callback.

Definition at line 59 of file itkVTKImageExportBase.h.

The function pointer type expected for a callback.

Definition at line 56 of file itkVTKImageExportBase.h.

Definition at line 45 of file itkVTKImageExportBase.h.

The function pointer type expected for a callback.

Definition at line 62 of file itkVTKImageExportBase.h.

using itk::VTKImageExportBase::ScalarTypeCallbackType = const char *(*)(void *)

The function pointer type expected for a callback.

Definition at line 60 of file itkVTKImageExportBase.h.

Standard class type aliases.

Definition at line 43 of file itkVTKImageExportBase.h.

using itk::VTKImageExportBase::SpacingCallbackType = double *(*)(void *)

The function pointer type expected for a callback.

Definition at line 58 of file itkVTKImageExportBase.h.

Definition at line 44 of file itkVTKImageExportBase.h.

The function pointer type expected for a callback.

Definition at line 63 of file itkVTKImageExportBase.h.

The function pointer type expected for a callback.

Definition at line 55 of file itkVTKImageExportBase.h.

The function pointer type expected for a callback.

Definition at line 57 of file itkVTKImageExportBase.h.

Constructor & Destructor Documentation

itk::VTKImageExportBase::VTKImageExportBase ( )
itk::VTKImageExportBase::~VTKImageExportBase ( )

Member Function Documentation

virtual void* itk::VTKImageExportBase::BufferPointerCallback ( )
protectedpure virtual
static void* itk::VTKImageExportBase::BufferPointerCallbackFunction ( void *  )
virtual int* itk::VTKImageExportBase::DataExtentCallback ( )
protectedpure virtual
static int* itk::VTKImageExportBase::DataExtentCallbackFunction ( void *  )
virtual float* itk::VTKImageExportBase::FloatOriginCallback ( )
protectedpure virtual
static float* itk::VTKImageExportBase::FloatOriginCallbackFunction ( void *  )
virtual float* itk::VTKImageExportBase::FloatSpacingCallback ( )
protectedpure virtual
static float* itk::VTKImageExportBase::FloatSpacingCallbackFunction ( void *  )
BufferPointerCallbackType itk::VTKImageExportBase::GetBufferPointerCallback ( ) const
void* itk::VTKImageExportBase::GetCallbackUserData ( )

Returns the user data to set for the vtkImageImport callbacks.

DataExtentCallbackType itk::VTKImageExportBase::GetDataExtentCallback ( ) const
virtual const char* itk::VTKImageExportBase::GetNameOfClass ( ) const

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

Reimplemented in itk::VTKImageExport< TInputImage >.

NumberOfComponentsCallbackType itk::VTKImageExportBase::GetNumberOfComponentsCallback ( ) const
CallbackTypeProxy itk::VTKImageExportBase::GetOriginCallback ( ) const
PipelineModifiedCallbackType itk::VTKImageExportBase::GetPipelineModifiedCallback ( ) const
PropagateUpdateExtentCallbackType itk::VTKImageExportBase::GetPropagateUpdateExtentCallback ( ) const
ScalarTypeCallbackType itk::VTKImageExportBase::GetScalarTypeCallback ( ) const
CallbackTypeProxy itk::VTKImageExportBase::GetSpacingCallback ( ) const
UpdateDataCallbackType itk::VTKImageExportBase::GetUpdateDataCallback ( ) const
UpdateInformationCallbackType itk::VTKImageExportBase::GetUpdateInformationCallback ( ) const

Get a pointer to function to set as a callback in vtkImageImport.

WholeExtentCallbackType itk::VTKImageExportBase::GetWholeExtentCallback ( ) const
virtual int itk::VTKImageExportBase::NumberOfComponentsCallback ( )
protectedpure virtual
static int itk::VTKImageExportBase::NumberOfComponentsCallbackFunction ( void *  )
virtual double* itk::VTKImageExportBase::OriginCallback ( )
protectedpure virtual
static double* itk::VTKImageExportBase::OriginCallbackFunction ( void *  )
virtual int itk::VTKImageExportBase::PipelineModifiedCallback ( )
static int itk::VTKImageExportBase::PipelineModifiedCallbackFunction ( void *  )
void itk::VTKImageExportBase::PrintSelf ( std::ostream &  os,
Indent  indent 
) const

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.

virtual void itk::VTKImageExportBase::PropagateUpdateExtentCallback ( int *  )
protectedpure virtual
static void itk::VTKImageExportBase::PropagateUpdateExtentCallbackFunction ( void *  ,
int *   
virtual const char* itk::VTKImageExportBase::ScalarTypeCallback ( )
protectedpure virtual
static const char* itk::VTKImageExportBase::ScalarTypeCallbackFunction ( void *  )
virtual double* itk::VTKImageExportBase::SpacingCallback ( )
protectedpure virtual
static double* itk::VTKImageExportBase::SpacingCallbackFunction ( void *  )
virtual void itk::VTKImageExportBase::UpdateDataCallback ( )
static void itk::VTKImageExportBase::UpdateDataCallbackFunction ( void *  )
virtual void itk::VTKImageExportBase::UpdateInformationCallback ( )
static void itk::VTKImageExportBase::UpdateInformationCallbackFunction ( void *  )

Actual function sent to VTK as a callback. Casts the user data to a VTKImageExportBase pointer and invokes the corresponding virtual method in that instance.

virtual int* itk::VTKImageExportBase::WholeExtentCallback ( )
protectedpure virtual

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

Implemented in itk::VTKImageExport< TInputImage >.

static int* itk::VTKImageExportBase::WholeExtentCallbackFunction ( void *  )

Member Data Documentation

ModifiedTimeType itk::VTKImageExportBase::m_LastPipelineMTime

PipelineMTime from the last call to PipelineModifiedCallback.

Definition at line 189 of file itkVTKImageExportBase.h.

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