#include <itkVTKImageExport.h>
Inheritance diagram for itk::VTKImageExport< TInputImage >:


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.
Currently VTKImageExport does not support pixel types with multiple components (like RGBPixel).
Definition at line 52 of file itkVTKImageExport.h.
Public Types | |
| typedef void *(* | BufferPointerCallbackType )(void *) |
| typedef SmartPointer< const Self > | ConstPointer |
| typedef int *(* | DataExtentCallbackType )(void *) |
| typedef std::vector< DataObjectPointer > | DataObjectPointerArray |
| typedef float *(* | FloatOriginCallbackType )(void *) |
| typedef TInputImage | InputImageType |
| typedef int(* | NumberOfComponentsCallbackType )(void *) |
| typedef double *(* | OriginCallbackType )(void *) |
| typedef int(* | PipelineModifiedCallbackType )(void *) |
| typedef SmartPointer< Self > | Pointer |
| typedef void(* | PropagateUpdateExtentCallbackType )(void *, int *) |
| typedef const char *(* | ScalarTypeCallbackType )(void *) |
| typedef VTKImageExport | Self |
| typedef double *(* | SpacingCallbackType )(void *) |
| typedef VTKImageExportBase | Superclass |
| typedef void(* | UpdateDataCallbackType )(void *) |
| typedef int *(* | WholeExtentCallbackType )(void *) |
Public Member Functions | |
| virtual void | AbortGenerateDataOff () |
| virtual void | AbortGenerateDataOn () |
| virtual LightObject::Pointer | CreateAnother () const |
| virtual void | DebugOff () const |
| virtual void | DebugOn () const |
| virtual void | Delete () |
| virtual void | EnlargeOutputRequestedRegion (DataObject *) |
| virtual const bool & | GetAbortGenerateData () |
| BufferPointerCallbackType | GetBufferPointerCallback () const |
| void * | GetCallbackUserData () |
| Command * | GetCommand (unsigned long tag) |
| DataExtentCallbackType | GetDataExtentCallback () const |
| bool | GetDebug () const |
| DataObjectPointerArray & | GetInputs () |
| const MetaDataDictionary & | GetMetaDataDictionary (void) const |
| MetaDataDictionary & | GetMetaDataDictionary (void) |
| virtual unsigned long | GetMTime () const |
| MultiThreader * | GetMultiThreader () |
| virtual const char * | GetNameOfClass () const |
| NumberOfComponentsCallbackType | GetNumberOfComponentsCallback () const |
| std::vector< DataObjectPointer >::size_type | GetNumberOfInputs () const |
| std::vector< DataObjectPointer >::size_type | GetNumberOfOutputs () const |
| virtual const int & | GetNumberOfThreads () |
| virtual std::vector< DataObjectPointer >::size_type | GetNumberOfValidRequiredInputs () const |
| CallbackTypeProxy | GetOriginCallback () const |
| Return an array with all the outputs of this process object *This is useful for tracing forward in the pipeline to contruct *graphs etc *DataObjectPointerArray & | GetOutputs () |
| PipelineModifiedCallbackType | GetPipelineModifiedCallback () const |
| virtual const float & | GetProgress () |
| PropagateUpdateExtentCallbackType | GetPropagateUpdateExtentCallback () const |
| virtual int | GetReferenceCount () const |
| virtual const bool & | GetReleaseDataBeforeUpdateFlag () |
| virtual bool | GetReleaseDataFlag () const |
| ScalarTypeCallbackType | GetScalarTypeCallback () const |
| CallbackTypeProxy | GetSpacingCallback () const |
| UpdateDataCallbackType | GetUpdateDataCallback () const |
| Get a pointer to function to set as a callback in vtkImageImport *UpdateInformationCallbackType | GetUpdateInformationCallback () const |
| WholeExtentCallbackType | GetWholeExtentCallback () const |
| bool | HasObserver (const EventObject &event) const |
| void | InvokeEvent (const EventObject &) const |
| void | InvokeEvent (const EventObject &) |
| virtual DataObjectPointer | MakeOutput (unsigned int idx) |
| virtual void | Modified () const |
| virtual void | PrepareOutputs () |
| void | Print (std::ostream &os, Indent indent=0) const |
| virtual void | PropagateRequestedRegion (DataObject *output) |
| virtual void | Register () const |
| virtual void | ReleaseDataBeforeUpdateFlagOff () |
| virtual void | ReleaseDataBeforeUpdateFlagOn () |
| void | ReleaseDataFlagOff () |
| void | ReleaseDataFlagOn () |
| void | RemoveAllObservers () |
| void | RemoveObserver (unsigned long tag) |
| virtual void | ResetPipeline () |
| virtual void | SetAbortGenerateData (bool _arg) |
| void | SetDebug (bool debugFlag) const |
| void | SetInput (const InputImageType *) |
| void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
| Get Set the number of threads to create when executing *virtual void | SetNumberOfThreads (int _arg) |
| virtual void | SetProgress (float _arg) |
| virtual void | SetReferenceCount (int) |
| Turn on off the flags to control whether the bulk data belonging *to the outputs of this ProcessObject are released after being *used by a downstream ProcessObject Default value is off Another *options for controlling memory utilization is the *ReleaseDataBeforeUpdateFlag *virtual void | SetReleaseDataFlag (bool flag) |
| virtual void | UnRegister () const |
| Turn on off the flags to control whether the bulk data belonging *to the outputs of this ProcessObject are released reallocated *during an a user may want *to force the elements of a pipeline to release any bulk data that *is going to be regenerated anyway during an | Update () in order to *control peak memory allocation.Note that this flag is different *from the ReleaseDataFlag.ReleaseDataFlag manages the *deallocation of a ProcessObject's bulk output data once that data *has been consumed by a downstream ProcessObject.The *ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation *of bulk data during a pipeline update to control peak memory *utilization.Default value is on.*/virtual void SetReleaseDataBeforeUpdateFlag(bool _arg) |
| Turn on off the flags to control whether the bulk data belonging *to the outputs of this ProcessObject are released reallocated *during an | Update ().In limited memory scenarios |
| virtual void | Update () |
| virtual void | UpdateLargestPossibleRegion () |
| virtual void | UpdateOutputData (DataObject *output) |
| virtual void | UpdateOutputInformation () |
| void | UpdateProgress (float amount) |
Static Public Member Functions | |
| static void | BreakOnError () |
| static bool | GetGlobalWarningDisplay () |
| static void | GlobalWarningDisplayOff () |
| static void | GlobalWarningDisplayOn () |
| static Pointer | New () |
| This is a global flag that controls whether any warning *or error messages are displayed *static void | SetGlobalWarningDisplay (bool flag) |
Public Attributes | |
| Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon | AddObserver )(const EventObject &event, Command *) const |
| This is a global flag that controls whether any | debug |
| Compatibility for VTK older than *typedef float *(* | FloatSpacingCallbackType )(void *) |
| The function pointer type expected for a callback *typedef void(* | UpdateInformationCallbackType )(void *) |
Protected Types | |
| typedef DataObject::Pointer | DataObjectPointer |
| typedef InputImageType::Pointer | InputImagePointer |
| typedef InputRegionType::IndexType | InputIndexType |
| typedef InputImageType::RegionType | InputRegionType |
| typedef InputRegionType::SizeType | InputSizeType |
Protected Member Functions | |
| virtual void | AddInput (DataObject *input) |
| virtual void | AddOutput (DataObject *output) |
| void * | BufferPointerCallback () |
| virtual void | CacheInputReleaseDataFlags () |
| int * | DataExtentCallback () |
| float * | FloatOriginCallback () |
| float * | FloatSpacingCallback () |
| virtual void | GenerateData () |
| virtual void | GenerateInputRequestedRegion () |
| virtual void | GenerateOutputInformation () |
| virtual void | GenerateOutputRequestedRegion (DataObject *output) |
| const DataObject * | GetInput (unsigned int idx) const |
| Method used internally for getting an input *DataObject * | GetInput (unsigned int idx) |
| InputImageType * | GetInput (void) |
| virtual const unsigned int & | GetNumberOfRequiredInputs () |
| virtual const unsigned int & | GetNumberOfRequiredOutputs () |
| const DataObject * | GetOutput (unsigned int idx) const |
| Method used internally for getting an output *DataObject * | GetOutput (unsigned int idx) |
| itkStaticConstMacro (InputImageDimension, unsigned int, InputImageType::ImageDimension) | |
| int | NumberOfComponentsCallback () |
| double * | OriginCallback () |
| virtual int | PipelineModifiedCallback () |
| virtual void | PopBackInput () |
| virtual void | PopFrontInput () |
| bool | PrintObservers (std::ostream &os, Indent indent) const |
| void | PrintSelf (std::ostream &os, Indent indent) const |
| virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
| virtual void | PropagateResetPipeline () |
| void | PropagateUpdateExtentCallback (int *) |
| Push Pop an input of this process object These methods allow a *filter to model its input vector as a queue or stack These *routines may not be appropriate for all especially *filters with different types of inputs These routines follow *the semantics of STL *virtual void | PushBackInput (const DataObject *input) |
| virtual void | PushFrontInput (const DataObject *input) |
| virtual void | ReleaseInputs () |
| virtual void | RemoveInput (DataObject *input) |
| virtual void | RemoveOutput (DataObject *output) |
| virtual void | RestoreInputReleaseDataFlags () |
| const char * | ScalarTypeCallback () |
| Protected methods for setting inputs *Subclasses make use of them for setting input *virtual void | SetNthInput (unsigned int num, DataObject *input) |
| Protected methods for setting outputs *Subclasses make use of them for getting output *virtual void | SetNthOutput (unsigned int num, DataObject *output) |
| void | SetNumberOfInputs (unsigned int num) |
| void | SetNumberOfOutputs (unsigned int num) |
| virtual void | SetNumberOfRequiredInputs (unsigned int _arg) |
| virtual void | SetNumberOfRequiredOutputs (unsigned int _arg) |
| double * | SpacingCallback () |
| virtual void | UpdateDataCallback () |
| virtual void | UpdateInformationCallback () |
| VTKImageExport () | |
| int * | WholeExtentCallback () |
| ~VTKImageExport () | |
Protected Attributes | |
| Push Pop an input of this process object These methods allow a *filter to model its input vector as a queue or stack These *routines may not be appropriate for all | filters |
| TimeStamp | m_OutputInformationMTime |
| int | m_ReferenceCount |
| SimpleFastMutexLock | m_ReferenceCountLock |
| bool | m_Updating |
| Methods invoked by virtual 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.*/virtual void PrintSelf(std voi | PrintHeader )(std::ostream &os, Indent indent) const |
| These callbacks are image type | specific |
|
|
Definition at line 61 of file itkVTKImageExportBase.h. |
|
|||||
|
Reimplemented from itk::VTKImageExportBase. Definition at line 59 of file itkVTKImageExport.h. |
|
|
Definition at line 60 of file itkVTKImageExportBase.h. |
|
|
Smart Pointer type to a DataObject. Reimplemented from itk::ProcessObject. Definition at line 110 of file itkVTKImageExportBase.h. |
|
|
STL Array of SmartPointers to DataObjects Definition at line 103 of file itkProcessObject.h. |
|
|
Definition at line 66 of file itkVTKImageExportBase.h. |
|
|||||
|
Definition at line 78 of file itkVTKImageExport.h. |
|
|||||
|
The type of the input image. Definition at line 65 of file itkVTKImageExport.h. |
|
|||||
|
Definition at line 81 of file itkVTKImageExport.h. |
|
|||||
|
Definition at line 79 of file itkVTKImageExport.h. |
|
|||||
|
Definition at line 80 of file itkVTKImageExport.h. |
|
|
Definition at line 57 of file itkVTKImageExportBase.h. |
|
|
Definition at line 55 of file itkVTKImageExportBase.h. |
|
|
Definition at line 52 of file itkVTKImageExportBase.h. |
|
|||||
|
Reimplemented from itk::VTKImageExportBase. Definition at line 58 of file itkVTKImageExport.h. |
|
|
Definition at line 58 of file itkVTKImageExportBase.h. |
|
|
Definition at line 56 of file itkVTKImageExportBase.h. |
|
|||||
|
Standard class typedefs. Reimplemented from itk::VTKImageExportBase. Definition at line 56 of file itkVTKImageExport.h. |
|
|
Definition at line 54 of file itkVTKImageExportBase.h. |
|
|||||
|
Reimplemented from itk::VTKImageExportBase. Definition at line 57 of file itkVTKImageExport.h. |
|
|
Definition at line 59 of file itkVTKImageExportBase.h. |
|
|
Definition at line 53 of file itkVTKImageExportBase.h. |
|
|||||||||
|
|
|
|||||||||
|
Definition at line 75 of file itkVTKImageExport.h. |
|
|
|
|
|
Turn on and off the AbortGenerateData flag. |
|
|
|
|
|
|
|
|
This method is called when itkExceptionMacro executes. It allows the debugger to break on error. |
|
|||||||||
|
Implements itk::VTKImageExportBase. |
|
|
Cache the state of any ReleaseDataFlag's on the inputs. While the filter is executing, we need to set the ReleaseDataFlag's on the inputs to false in case the current filter is implemented using a mini-pipeline (which will try to release the inputs). After the filter finishes, we restore the state of the ReleaseDataFlag's before the call to ReleaseInputs(). |
|
|
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::LightObject. |
|
|||||||||
|
Implements itk::VTKImageExportBase. |
|
|
Turn debugging output off. |
|
|
Turn debugging output on. |
|
|
Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting. |
|
|
|||||||||
|
Implements itk::VTKImageExportBase. |
|
|||||||||
|
Implements itk::VTKImageExportBase. |
|
|
|
|
|
Given one output whose requested region has been set, how should the requested regions for the remaining outputs of the process object be set? By default, all the outputs are set to the same requested region. If a filter needs to produce different requested regions for each output, for instance an image processing filter producing several outputs at different resolutions, then that filter may override this method and set the requested regions appropriatedly. Note that a filter producing multiple outputs of different types is required to override this method. The default implementation can only correctly handle multiple outputs of the same type. Reimplemented in itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, itk::watershed::BoundaryResolver< TPixelType, TDimension >, itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >, itk::watershed::Relabeler< TScalarType, TImageDimension >, itk::watershed::Segmenter< TInputImage >, itk::watershed::SegmentTreeGenerator< TScalarType >, itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>, and itk::watershed::SegmentTreeGenerator< ScalarType >. |
|
|
Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways. |
|
|
|
|
|
Returns the user data to set for the vtkImageImport callbacks. |
|
|
Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used. |
|
|
|
|
|
Get the value of the debug flag. |
|
|
|
|
|
|
|
|
||||||||||
|
|
|
|
Return an array with all the inputs of this process object. This is useful for tracing back in the pipeline to construct graphs etc. Definition at line 108 of file itkProcessObject.h. |
|
|
|
|
|
|
|
|
|
Return the multithreader used by this class. Definition at line 281 of file itkProcessObject.h. |
|
|||||||||
|
Run-time type information (and related methods). Reimplemented from itk::VTKImageExportBase. |
|
|
|
|
|
Get the size of the input vector. This is merely the size of the input vector, not the number of inputs that have valid DataObject's assigned. Use GetNumberOfValidRequiredInputs() to determine how many inputs are non-null. Definition at line 115 of file itkProcessObject.h. |
|
|
Definition at line 132 of file itkProcessObject.h. |
|
|
|
|
|
|
|
|
|
|
|
Get the number of valid inputs. This is the number of non-null entries in the input vector in the first NumberOfRequiredInputs slots. This method is used to determine whether the necessary required inputs have been set. Subclasses of ProcessObject may override this implementation if the required inputs are not the first slots in input vector. Reimplemented in itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDeformationField >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >. |
|
|
|
|
|
|
|
|
|
Definition at line 130 of file itkProcessObject.h. |
|
|
|
|
|
Get the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution. |
|
|
|
|
|
Gets the reference count on this object. Definition at line 98 of file itkLightObject.h. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay(). |
|
|
Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay(). |
|
|
Return true if an observer is registered for this event. |
|
|
Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object. |
|
|
Call Execute on all the Commands observing this event id. |
|
||||||||||||||||||||
|
|
|
|
|
|||||||||
|
Method for creation through the object factory. Reimplemented from itk::Object. |
|
|||||||||
|
Implements itk::VTKImageExportBase. |
|
|||||||||
|
Implements itk::VTKImageExportBase. |
|
|
|
|
|
|
|
An opportunity to deallocate a ProcessObject's bulk data storage. Some filters may wish to reuse existing bulk data storage to avoid unnecessary deallocation/allocation sequences. The default implementation calls Initialize() on each output. DataObject::Initialize() frees its bulk data by default. Reimplemented in itk::WatershedImageFilter< TInputImage >. |
|
||||||||||||
|
Cause the object to print itself out. |
|
||||||||||||
|
|
|
||||||||||||||||
|
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::VTKImageExportBase. |
|
||||||||||||
|
|
|
|
Send the requested region information back up the pipeline (to the filters that preceed this one). Reimplemented in itk::VTKImageImport< TOutputImage >. |
|
|
Propagate a call to ResetPipeline() up the pipeline. Called only from DataObject. |
|
||||||||||
|
Implements itk::VTKImageExportBase. |
|
|
|
|
Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject. |
|
|
|
|
|
|
|
|
Definition at line 254 of file itkProcessObject.h. |
|
|
Definition at line 253 of file itkProcessObject.h. |
|
|
|
Remove all observers . |
|
|
|
|
|
Remove the observer with this tag value. |
|
|
|
|
|
Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called. |
|
|
Restore the cached input ReleaseDataFlags. |
|
|||||||||
|
Implements itk::VTKImageExportBase. |
|
|
Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways. |
|
|
Set the value of the debug flag. A non-zero value turns debugging on. |
|
|
Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn(). |
|
||||||||||
|
Set the input image of this image exporter. |
|
|
|
|
||||||||||||
|
||||||||||||
|
|
Called to allocate the input array. Copies old inputs. |
|
|
Called to allocate the output array. Copies old outputs. |
|
|
|
|
|
|
|
|
|
|
|
Set the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution. The ProgressEvent is NOT invoked. |
|
|
Sets the reference count (use with care) Reimplemented from itk::LightObject. |
|
|
|
|
|||||||||
|
Implements itk::VTKImageExportBase. |
|
|
Decrease the reference count (release by another object). Reimplemented from itk::LightObject. |
|
|
|
|
|
|
|
|
|
|
|
Like Update(), but sets the output requested region to the largest possible region for the output. This is the method users should call if they want the entire dataset to be processed. If a user wants to update the same output region as a previous call to Update() or a previous call to UpdateLargestPossibleRegion(), then they should call the method Update(). |
|
|
Actually generate new output Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >. |
|
|
Update the information decribing the output data. This method transverses 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 in itk::watershed::Segmenter< TInputImage >, and itk::VTKImageImport< TOutputImage >. |
|
|
Update the progress of the process object. Sets the Progress ivar to amount and invokes any observers for the ProgressEvent. The parameter amount should be in [0,1] and is the cumulative (not incremental) progress. |
|
|||||||||
|
Implements itk::VTKImageExportBase. |
|
|
|
|
|
Definition at line 94 of file itkObject.h. |
|
|
|
|
|
|
Time when GenerateOutputInformation was last called. Definition at line 428 of file itkProcessObject.h. |
|
|
Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h. |
|
|
Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h. |
|
|
This flag indicates when the pipeline is executing. It prevents infinite recursion when pipelines have loops. Definition at line 425 of file itkProcessObject.h. |
|
|
|
|
|
Definition at line 116 of file itkVTKImageExportBase.h. |
|
|
|
1.4.2 written by Dimitri van Heesch,
© 1997-2000