VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkImageImport Class Reference

Import data from a C array. More...

#include <vtkImageImport.h>

Inheritance diagram for vtkImageImport:
[legend]
Collaboration diagram for vtkImageImport:
[legend]

Public Types

typedef vtkImageAlgorithm Superclass
 
typedef void(* UpdateInformationCallbackType) (void *)
 These are function pointer types for the pipeline connection callbacks. More...
 
typedef int(* PipelineModifiedCallbackType) (void *)
 These are function pointer types for the pipeline connection callbacks. More...
 
typedef int *(* WholeExtentCallbackType) (void *)
 These are function pointer types for the pipeline connection callbacks. More...
 
typedef double *(* SpacingCallbackType) (void *)
 These are function pointer types for the pipeline connection callbacks. More...
 
typedef double *(* OriginCallbackType) (void *)
 These are function pointer types for the pipeline connection callbacks. More...
 
typedef double *(* DirectionCallbackType) (void *)
 These are function pointer types for the pipeline connection callbacks. More...
 
typedef const char *(* ScalarTypeCallbackType) (void *)
 These are function pointer types for the pipeline connection callbacks. More...
 
typedef int(* NumberOfComponentsCallbackType) (void *)
 These are function pointer types for the pipeline connection callbacks. More...
 
typedef void(* PropagateUpdateExtentCallbackType) (void *, int *)
 These are function pointer types for the pipeline connection callbacks. More...
 
typedef void(* UpdateDataCallbackType) (void *)
 These are function pointer types for the pipeline connection callbacks. More...
 
typedef int *(* DataExtentCallbackType) (void *)
 These are function pointer types for the pipeline connection callbacks. More...
 
typedef void *(* BufferPointerCallbackType) (void *)
 These are function pointer types for the pipeline connection callbacks. More...
 
- Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkImageImportNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void CopyImportVoidPointer (void *ptr, vtkIdType size)
 Import data and make an internal copy of it. More...
 
void SetImportVoidPointer (void *ptr, int save)
 Set the pointer from which the image data is imported. More...
 
int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 Propagates the update extent through the callback if it is set. More...
 
int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime) override
 Override vtkAlgorithm. More...
 
void SetImportVoidPointer (void *ptr)
 Set the pointer from which the image data is imported. More...
 
void * GetImportVoidPointer ()
 Set the pointer from which the image data is imported. More...
 
virtual void SetDataScalarType (int)
 Set/Get the data type of pixels in the imported data. More...
 
void SetDataScalarTypeToDouble ()
 Set/Get the data type of pixels in the imported data. More...
 
void SetDataScalarTypeToFloat ()
 Set/Get the data type of pixels in the imported data. More...
 
void SetDataScalarTypeToInt ()
 Set/Get the data type of pixels in the imported data. More...
 
void SetDataScalarTypeToShort ()
 Set/Get the data type of pixels in the imported data. More...
 
void SetDataScalarTypeToUnsignedShort ()
 Set/Get the data type of pixels in the imported data. More...
 
void SetDataScalarTypeToUnsignedChar ()
 Set/Get the data type of pixels in the imported data. More...
 
virtual int GetDataScalarType ()
 Set/Get the data type of pixels in the imported data. More...
 
const char * GetDataScalarTypeAsString ()
 Set/Get the data type of pixels in the imported data. More...
 
virtual void SetNumberOfScalarComponents (int)
 Set/Get the number of scalar components, for RGB images this must be 3. More...
 
virtual int GetNumberOfScalarComponents ()
 Set/Get the number of scalar components, for RGB images this must be 3. More...
 
virtual void SetDataExtent (int, int, int, int, int, int)
 Get/Set the extent of the data buffer. More...
 
virtual void SetDataExtent (int[6])
 Get/Set the extent of the data buffer. More...
 
virtual intGetDataExtent ()
 Get/Set the extent of the data buffer. More...
 
virtual void GetDataExtent (int &, int &, int &, int &, int &, int &)
 Get/Set the extent of the data buffer. More...
 
virtual void GetDataExtent (int[6])
 Get/Set the extent of the data buffer. More...
 
void SetDataExtentToWholeExtent ()
 Get/Set the extent of the data buffer. More...
 
virtual void SetDataSpacing (double, double, double)
 Set/Get the spacing (typically in mm) between image voxels. More...
 
virtual void SetDataSpacing (double[3])
 Set/Get the spacing (typically in mm) between image voxels. More...
 
virtual doubleGetDataSpacing ()
 Set/Get the spacing (typically in mm) between image voxels. More...
 
virtual void GetDataSpacing (double &, double &, double &)
 Set/Get the spacing (typically in mm) between image voxels. More...
 
virtual void GetDataSpacing (double[3])
 Set/Get the spacing (typically in mm) between image voxels. More...
 
virtual void SetDataOrigin (double, double, double)
 Set/Get the origin of the data, i.e. More...
 
virtual void SetDataOrigin (double[3])
 Set/Get the origin of the data, i.e. More...
 
virtual doubleGetDataOrigin ()
 Set/Get the origin of the data, i.e. More...
 
virtual void GetDataOrigin (double &, double &, double &)
 Set/Get the origin of the data, i.e. More...
 
virtual void GetDataOrigin (double[3])
 Set/Get the origin of the data, i.e. More...
 
virtual void SetDataDirection (double data[])
 Set/Get the direction of the data, i.e. More...
 
virtual doubleGetDataDirection ()
 Set/Get the direction of the data, i.e. More...
 
virtual void GetDataDirection (double data[9])
 Set/Get the direction of the data, i.e. More...
 
virtual void SetWholeExtent (int, int, int, int, int, int)
 Get/Set the whole extent of the image. More...
 
virtual void SetWholeExtent (int[6])
 Get/Set the whole extent of the image. More...
 
virtual intGetWholeExtent ()
 Get/Set the whole extent of the image. More...
 
virtual void GetWholeExtent (int &, int &, int &, int &, int &, int &)
 Get/Set the whole extent of the image. More...
 
virtual void GetWholeExtent (int[6])
 Get/Set the whole extent of the image. More...
 
virtual void SetScalarArrayName (const char *)
 Set/get the scalar array name for this data set. More...
 
virtual char * GetScalarArrayName ()
 Set/get the scalar array name for this data set. More...
 
virtual void SetUpdateInformationCallback (UpdateInformationCallbackType)
 Set/Get the callback for propagating UpdateInformation calls to a third-party pipeline. More...
 
virtual UpdateInformationCallbackType GetUpdateInformationCallback ()
 Set/Get the callback for propagating UpdateInformation calls to a third-party pipeline. More...
 
virtual void SetPipelineModifiedCallback (PipelineModifiedCallbackType)
 Set/Get the callback for checking whether the third-party pipeline has been modified since the last invocation of the callback. More...
 
virtual PipelineModifiedCallbackType GetPipelineModifiedCallback ()
 Set/Get the callback for checking whether the third-party pipeline has been modified since the last invocation of the callback. More...
 
virtual void SetWholeExtentCallback (WholeExtentCallbackType)
 Set/Get the callback for getting the whole extent of the input image from a third-party pipeline. More...
 
virtual WholeExtentCallbackType GetWholeExtentCallback ()
 Set/Get the callback for getting the whole extent of the input image from a third-party pipeline. More...
 
virtual void SetSpacingCallback (SpacingCallbackType)
 Set/Get the callback for getting the spacing of the input image from a third-party pipeline. More...
 
virtual SpacingCallbackType GetSpacingCallback ()
 Set/Get the callback for getting the spacing of the input image from a third-party pipeline. More...
 
virtual void SetOriginCallback (OriginCallbackType)
 Set/Get the callback for getting the origin of the input image from a third-party pipeline. More...
 
virtual OriginCallbackType GetOriginCallback ()
 Set/Get the callback for getting the origin of the input image from a third-party pipeline. More...
 
virtual void SetDirectionCallback (DirectionCallbackType)
 Set/Get the callback for getting the direction of the input image from a third-party pipeline. More...
 
virtual DirectionCallbackType GetDirectionCallback ()
 Set/Get the callback for getting the direction of the input image from a third-party pipeline. More...
 
virtual void SetScalarTypeCallback (ScalarTypeCallbackType)
 Set/Get the callback for getting the scalar value type of the input image from a third-party pipeline. More...
 
virtual ScalarTypeCallbackType GetScalarTypeCallback ()
 Set/Get the callback for getting the scalar value type of the input image from a third-party pipeline. More...
 
virtual void SetNumberOfComponentsCallback (NumberOfComponentsCallbackType)
 Set/Get the callback for getting the number of components of the input image from a third-party pipeline. More...
 
virtual NumberOfComponentsCallbackType GetNumberOfComponentsCallback ()
 Set/Get the callback for getting the number of components of the input image from a third-party pipeline. More...
 
virtual void SetPropagateUpdateExtentCallback (PropagateUpdateExtentCallbackType)
 Set/Get the callback for propagating the pipeline update extent to a third-party pipeline. More...
 
virtual PropagateUpdateExtentCallbackType GetPropagateUpdateExtentCallback ()
 Set/Get the callback for propagating the pipeline update extent to a third-party pipeline. More...
 
virtual void SetUpdateDataCallback (UpdateDataCallbackType)
 Set/Get the callback for propagating UpdateData calls to a third-party pipeline. More...
 
virtual UpdateDataCallbackType GetUpdateDataCallback ()
 Set/Get the callback for propagating UpdateData calls to a third-party pipeline. More...
 
virtual void SetDataExtentCallback (DataExtentCallbackType)
 Set/Get the callback for getting the data extent of the input image from a third-party pipeline. More...
 
virtual DataExtentCallbackType GetDataExtentCallback ()
 Set/Get the callback for getting the data extent of the input image from a third-party pipeline. More...
 
virtual void SetBufferPointerCallback (BufferPointerCallbackType)
 Set/Get the callback for getting a pointer to the data buffer of an image from a third-party pipeline. More...
 
virtual BufferPointerCallbackType GetBufferPointerCallback ()
 Set/Get the callback for getting a pointer to the data buffer of an image from a third-party pipeline. More...
 
virtual void SetCallbackUserData (void *)
 Set/Get the user data which will be passed as the first argument to all of the third-party pipeline callbacks. More...
 
virtual void * GetCallbackUserData ()
 Set/Get the user data which will be passed as the first argument to all of the third-party pipeline callbacks. More...
 
int InvokePipelineModifiedCallbacks ()
 Invoke the appropriate callbacks. More...
 
void InvokeUpdateInformationCallbacks ()
 Invoke the appropriate callbacks. More...
 
void InvokeExecuteInformationCallbacks ()
 Invoke the appropriate callbacks. More...
 
void InvokeExecuteDataCallbacks ()
 Invoke the appropriate callbacks. More...
 
void LegacyCheckWholeExtent ()
 Invoke the appropriate callbacks. More...
 
- Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithmNewInstance () const
 
int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Process a request from the executive. More...
 
vtkImageDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkImageDataGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
virtual void SetOutput (vtkDataObject *d)
 Get the output data object for a port on this algorithm. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
vtkDataObjectGetInput (int port)
 Get a data object for one of the input port connections. More...
 
vtkDataObjectGetInput ()
 Get a data object for one of the input port connections. More...
 
vtkImageDataGetImageDataInput (int port)
 Get a data object for one of the input port connections. More...
 
virtual void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
virtual void AddInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual int Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual int Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkImageImportNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageImportSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageAlgorithm
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImageImport ()
 
 ~vtkImageImport () override
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Subclasses can reimplement this method to collect information from their inputs and set information for their outputs. More...
 
void ExecuteDataWithInformation (vtkDataObject *d, vtkInformation *outInfo) override
 This is a convenience method that is implemented in many subclasses instead of RequestData. More...
 
- Protected Member Functions inherited from vtkImageAlgorithm
 vtkImageAlgorithm ()
 
 ~vtkImageAlgorithm () override
 
virtual void CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 Convenience method to copy the scalar type and number of components from the input data to the output data. More...
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 This is called in response to a REQUEST_DATA request from the executive. More...
 
virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
 Copy the other point and cell data. More...
 
virtual void ExecuteData (vtkDataObject *output)
 This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers. More...
 
virtual void Execute ()
 This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers. More...
 
virtual void AllocateOutputData (vtkImageData *out, vtkInformation *outInfo, int *uExtent)
 Allocate the output data. More...
 
virtual vtkImageDataAllocateOutputData (vtkDataObject *out, vtkInformation *outInfo)
 Allocate the output data. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 These method should be reimplemented by subclasses that have more than a single input or single output. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 These method should be reimplemented by subclasses that have more than a single input or single output. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

void * ImportVoidPointer
 
int SaveUserArray
 
int NumberOfScalarComponents
 
int DataScalarType
 
int WholeExtent [6]
 
int DataExtent [6]
 
double DataSpacing [3]
 
double DataOrigin [3]
 
double DataDirection [9]
 
char * ScalarArrayName
 
void * CallbackUserData
 
UpdateInformationCallbackType UpdateInformationCallback
 
PipelineModifiedCallbackType PipelineModifiedCallback
 
WholeExtentCallbackType WholeExtentCallback
 
SpacingCallbackType SpacingCallback
 
OriginCallbackType OriginCallback
 
DirectionCallbackType DirectionCallback
 
ScalarTypeCallbackType ScalarTypeCallback
 
NumberOfComponentsCallbackType NumberOfComponentsCallback
 
PropagateUpdateExtentCallbackType PropagateUpdateExtentCallback
 
UpdateDataCallbackType UpdateDataCallback
 
DataExtentCallbackType DataExtentCallback
 
BufferPointerCallbackType BufferPointerCallback
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Import data from a C array.

vtkImageImport provides methods needed to import image data from a source independent of VTK, such as a simple C array or a third-party pipeline. Note that the VTK convention is for the image voxel index (0,0,0) to be the lower-left corner of the image, while most 2D image formats use the upper-left corner. You can use vtkImageFlip to correct the orientation after the image has been loaded into VTK. Note that is also possible to import the raw data from a Python string instead of from a C array. The array applies on scalar point data only, not on cell data.

See also
vtkImageExport
Tests:
vtkImageImport (Tests)

Definition at line 41 of file vtkImageImport.h.

Member Typedef Documentation

Definition at line 45 of file vtkImageImport.h.

typedef void(* vtkImageImport::UpdateInformationCallbackType) (void *)

These are function pointer types for the pipeline connection callbacks.

See further documentation on each individual callback.

Definition at line 184 of file vtkImageImport.h.

typedef int(* vtkImageImport::PipelineModifiedCallbackType) (void *)

These are function pointer types for the pipeline connection callbacks.

See further documentation on each individual callback.

Definition at line 185 of file vtkImageImport.h.

typedef int*(* vtkImageImport::WholeExtentCallbackType) (void *)

These are function pointer types for the pipeline connection callbacks.

See further documentation on each individual callback.

Definition at line 186 of file vtkImageImport.h.

typedef double*(* vtkImageImport::SpacingCallbackType) (void *)

These are function pointer types for the pipeline connection callbacks.

See further documentation on each individual callback.

Definition at line 187 of file vtkImageImport.h.

typedef double*(* vtkImageImport::OriginCallbackType) (void *)

These are function pointer types for the pipeline connection callbacks.

See further documentation on each individual callback.

Definition at line 188 of file vtkImageImport.h.

typedef double*(* vtkImageImport::DirectionCallbackType) (void *)

These are function pointer types for the pipeline connection callbacks.

See further documentation on each individual callback.

Definition at line 189 of file vtkImageImport.h.

typedef const char*(* vtkImageImport::ScalarTypeCallbackType) (void *)

These are function pointer types for the pipeline connection callbacks.

See further documentation on each individual callback.

Definition at line 190 of file vtkImageImport.h.

typedef int(* vtkImageImport::NumberOfComponentsCallbackType) (void *)

These are function pointer types for the pipeline connection callbacks.

See further documentation on each individual callback.

Definition at line 191 of file vtkImageImport.h.

typedef void(* vtkImageImport::PropagateUpdateExtentCallbackType) (void *, int *)

These are function pointer types for the pipeline connection callbacks.

See further documentation on each individual callback.

Definition at line 192 of file vtkImageImport.h.

typedef void(* vtkImageImport::UpdateDataCallbackType) (void *)

These are function pointer types for the pipeline connection callbacks.

See further documentation on each individual callback.

Definition at line 193 of file vtkImageImport.h.

typedef int*(* vtkImageImport::DataExtentCallbackType) (void *)

These are function pointer types for the pipeline connection callbacks.

See further documentation on each individual callback.

Definition at line 194 of file vtkImageImport.h.

typedef void*(* vtkImageImport::BufferPointerCallbackType) (void *)

These are function pointer types for the pipeline connection callbacks.

See further documentation on each individual callback.

Definition at line 195 of file vtkImageImport.h.

Constructor & Destructor Documentation

vtkImageImport::vtkImageImport ( )
protected
vtkImageImport::~vtkImageImport ( )
overrideprotected

Member Function Documentation

static vtkImageImport* vtkImageImport::New ( )
static
static vtkTypeBool vtkImageImport::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkImageImport::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageAlgorithm.

static vtkImageImport* vtkImageImport::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkImageImport::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImageAlgorithm.

vtkImageImport* vtkImageImport::NewInstance ( ) const
void vtkImageImport::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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

void vtkImageImport::CopyImportVoidPointer ( void *  ptr,
vtkIdType  size 
)

Import data and make an internal copy of it.

If you do not want VTK to copy the data, then use SetImportVoidPointer instead (do not use both). Give the size of the data array in bytes.

void vtkImageImport::SetImportVoidPointer ( void *  ptr)

Set the pointer from which the image data is imported.

VTK will not make its own copy of the data, it will access the data directly from the supplied array. VTK will not attempt to delete the data nor modify the data.

void* vtkImageImport::GetImportVoidPointer ( )
inline

Set the pointer from which the image data is imported.

VTK will not make its own copy of the data, it will access the data directly from the supplied array. VTK will not attempt to delete the data nor modify the data.

Definition at line 63 of file vtkImageImport.h.

void vtkImageImport::SetImportVoidPointer ( void *  ptr,
int  save 
)

Set the pointer from which the image data is imported.

Set save to 1 (the default) unless you want VTK to delete the array via C++ delete when the vtkImageImport object is deallocated. VTK will not make its own copy of the data, it will access the data directly from the supplied array.

virtual void vtkImageImport::SetDataScalarType ( int  )
virtual

Set/Get the data type of pixels in the imported data.

This is used as the scalar type of the Output. Default: Short.

void vtkImageImport::SetDataScalarTypeToDouble ( )
inline

Set/Get the data type of pixels in the imported data.

This is used as the scalar type of the Output. Default: Short.

Definition at line 81 of file vtkImageImport.h.

void vtkImageImport::SetDataScalarTypeToFloat ( )
inline

Set/Get the data type of pixels in the imported data.

This is used as the scalar type of the Output. Default: Short.

Definition at line 82 of file vtkImageImport.h.

void vtkImageImport::SetDataScalarTypeToInt ( )
inline

Set/Get the data type of pixels in the imported data.

This is used as the scalar type of the Output. Default: Short.

Definition at line 83 of file vtkImageImport.h.

void vtkImageImport::SetDataScalarTypeToShort ( )
inline

Set/Get the data type of pixels in the imported data.

This is used as the scalar type of the Output. Default: Short.

Definition at line 84 of file vtkImageImport.h.

void vtkImageImport::SetDataScalarTypeToUnsignedShort ( )
inline

Set/Get the data type of pixels in the imported data.

This is used as the scalar type of the Output. Default: Short.

Definition at line 85 of file vtkImageImport.h.

void vtkImageImport::SetDataScalarTypeToUnsignedChar ( )
inline

Set/Get the data type of pixels in the imported data.

This is used as the scalar type of the Output. Default: Short.

Definition at line 87 of file vtkImageImport.h.

virtual int vtkImageImport::GetDataScalarType ( )
virtual

Set/Get the data type of pixels in the imported data.

This is used as the scalar type of the Output. Default: Short.

const char* vtkImageImport::GetDataScalarTypeAsString ( )
inline

Set/Get the data type of pixels in the imported data.

This is used as the scalar type of the Output. Default: Short.

Definition at line 90 of file vtkImageImport.h.

virtual void vtkImageImport::SetNumberOfScalarComponents ( int  )
virtual

Set/Get the number of scalar components, for RGB images this must be 3.

Default: 1.

virtual int vtkImageImport::GetNumberOfScalarComponents ( )
virtual

Set/Get the number of scalar components, for RGB images this must be 3.

Default: 1.

virtual void vtkImageImport::SetDataExtent ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
)
virtual

Get/Set the extent of the data buffer.

The dimensions of your data must be equal to (extent[1]-extent[0]+1) * (extent[3]-extent[2]+1) * (extent[5]-DataExtent[4]+1). For example, for a 2D image use (0,width-1, 0,height-1, 0,0).

virtual void vtkImageImport::SetDataExtent ( int  [6])
virtual

Get/Set the extent of the data buffer.

The dimensions of your data must be equal to (extent[1]-extent[0]+1) * (extent[3]-extent[2]+1) * (extent[5]-DataExtent[4]+1). For example, for a 2D image use (0,width-1, 0,height-1, 0,0).

virtual int* vtkImageImport::GetDataExtent ( )
virtual

Get/Set the extent of the data buffer.

The dimensions of your data must be equal to (extent[1]-extent[0]+1) * (extent[3]-extent[2]+1) * (extent[5]-DataExtent[4]+1). For example, for a 2D image use (0,width-1, 0,height-1, 0,0).

virtual void vtkImageImport::GetDataExtent ( int ,
int ,
int ,
int ,
int ,
int  
)
virtual

Get/Set the extent of the data buffer.

The dimensions of your data must be equal to (extent[1]-extent[0]+1) * (extent[3]-extent[2]+1) * (extent[5]-DataExtent[4]+1). For example, for a 2D image use (0,width-1, 0,height-1, 0,0).

virtual void vtkImageImport::GetDataExtent ( int  [6])
virtual

Get/Set the extent of the data buffer.

The dimensions of your data must be equal to (extent[1]-extent[0]+1) * (extent[3]-extent[2]+1) * (extent[5]-DataExtent[4]+1). For example, for a 2D image use (0,width-1, 0,height-1, 0,0).

void vtkImageImport::SetDataExtentToWholeExtent ( )
inline

Get/Set the extent of the data buffer.

The dimensions of your data must be equal to (extent[1]-extent[0]+1) * (extent[3]-extent[2]+1) * (extent[5]-DataExtent[4]+1). For example, for a 2D image use (0,width-1, 0,height-1, 0,0).

Definition at line 112 of file vtkImageImport.h.

virtual void vtkImageImport::SetDataSpacing ( double  ,
double  ,
double   
)
virtual

Set/Get the spacing (typically in mm) between image voxels.

Default: (1.0, 1.0, 1.0).

virtual void vtkImageImport::SetDataSpacing ( double  [3])
virtual

Set/Get the spacing (typically in mm) between image voxels.

Default: (1.0, 1.0, 1.0).

virtual double* vtkImageImport::GetDataSpacing ( )
virtual

Set/Get the spacing (typically in mm) between image voxels.

Default: (1.0, 1.0, 1.0).

virtual void vtkImageImport::GetDataSpacing ( double ,
double ,
double  
)
virtual

Set/Get the spacing (typically in mm) between image voxels.

Default: (1.0, 1.0, 1.0).

virtual void vtkImageImport::GetDataSpacing ( double  [3])
virtual

Set/Get the spacing (typically in mm) between image voxels.

Default: (1.0, 1.0, 1.0).

virtual void vtkImageImport::SetDataOrigin ( double  ,
double  ,
double   
)
virtual

Set/Get the origin of the data, i.e.

the coordinates (usually in mm) of voxel (0,0,0). Default: (0.0, 0.0, 0.0).

virtual void vtkImageImport::SetDataOrigin ( double  [3])
virtual

Set/Get the origin of the data, i.e.

the coordinates (usually in mm) of voxel (0,0,0). Default: (0.0, 0.0, 0.0).

virtual double* vtkImageImport::GetDataOrigin ( )
virtual

Set/Get the origin of the data, i.e.

the coordinates (usually in mm) of voxel (0,0,0). Default: (0.0, 0.0, 0.0).

virtual void vtkImageImport::GetDataOrigin ( double ,
double ,
double  
)
virtual

Set/Get the origin of the data, i.e.

the coordinates (usually in mm) of voxel (0,0,0). Default: (0.0, 0.0, 0.0).

virtual void vtkImageImport::GetDataOrigin ( double  [3])
virtual

Set/Get the origin of the data, i.e.

the coordinates (usually in mm) of voxel (0,0,0). Default: (0.0, 0.0, 0.0).

virtual void vtkImageImport::SetDataDirection ( double  data[])
virtual

Set/Get the direction of the data, i.e.

the 3x3 matrix to rotate the coordinates from index space (ijk) to physical space (xyz). Default: Identity Matrix (1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 1.0)

virtual double* vtkImageImport::GetDataDirection ( )
virtual

Set/Get the direction of the data, i.e.

the 3x3 matrix to rotate the coordinates from index space (ijk) to physical space (xyz). Default: Identity Matrix (1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 1.0)

virtual void vtkImageImport::GetDataDirection ( double  data[9])
virtual

Set/Get the direction of the data, i.e.

the 3x3 matrix to rotate the coordinates from index space (ijk) to physical space (xyz). Default: Identity Matrix (1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 1.0)

virtual void vtkImageImport::SetWholeExtent ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
)
virtual

Get/Set the whole extent of the image.

This is the largest possible extent. Set the DataExtent to the extent of the image in the buffer pointed to by the ImportVoidPointer.

virtual void vtkImageImport::SetWholeExtent ( int  [6])
virtual

Get/Set the whole extent of the image.

This is the largest possible extent. Set the DataExtent to the extent of the image in the buffer pointed to by the ImportVoidPointer.

virtual int* vtkImageImport::GetWholeExtent ( )
virtual

Get/Set the whole extent of the image.

This is the largest possible extent. Set the DataExtent to the extent of the image in the buffer pointed to by the ImportVoidPointer.

virtual void vtkImageImport::GetWholeExtent ( int ,
int ,
int ,
int ,
int ,
int  
)
virtual

Get/Set the whole extent of the image.

This is the largest possible extent. Set the DataExtent to the extent of the image in the buffer pointed to by the ImportVoidPointer.

virtual void vtkImageImport::GetWholeExtent ( int  [6])
virtual

Get/Set the whole extent of the image.

This is the largest possible extent. Set the DataExtent to the extent of the image in the buffer pointed to by the ImportVoidPointer.

int vtkImageImport::RequestUpdateExtent ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overridevirtual

Propagates the update extent through the callback if it is set.

Reimplemented from vtkImageAlgorithm.

int vtkImageImport::ComputePipelineMTime ( vtkInformation request,
vtkInformationVector **  inInfoVec,
vtkInformationVector outInfoVec,
int  requestFromOutputPort,
vtkMTimeType mtime 
)
overridevirtual

Override vtkAlgorithm.

Reimplemented from vtkAlgorithm.

virtual void vtkImageImport::SetScalarArrayName ( const char *  )
virtual

Set/get the scalar array name for this data set.

Initial value is "scalars".

virtual char* vtkImageImport::GetScalarArrayName ( )
virtual

Set/get the scalar array name for this data set.

Initial value is "scalars".

virtual void vtkImageImport::SetUpdateInformationCallback ( UpdateInformationCallbackType  )
virtual

Set/Get the callback for propagating UpdateInformation calls to a third-party pipeline.

The callback should make sure that the third-party pipeline information is up to date.

virtual UpdateInformationCallbackType vtkImageImport::GetUpdateInformationCallback ( )
virtual

Set/Get the callback for propagating UpdateInformation calls to a third-party pipeline.

The callback should make sure that the third-party pipeline information is up to date.

virtual void vtkImageImport::SetPipelineModifiedCallback ( PipelineModifiedCallbackType  )
virtual

Set/Get the callback for checking whether the third-party pipeline has been modified since the last invocation of the callback.

The callback should return 1 for modified, and 0 for not modified. The first call should always return modified.

virtual PipelineModifiedCallbackType vtkImageImport::GetPipelineModifiedCallback ( )
virtual

Set/Get the callback for checking whether the third-party pipeline has been modified since the last invocation of the callback.

The callback should return 1 for modified, and 0 for not modified. The first call should always return modified.

virtual void vtkImageImport::SetWholeExtentCallback ( WholeExtentCallbackType  )
virtual

Set/Get the callback for getting the whole extent of the input image from a third-party pipeline.

The callback should return a vector of six integers describing the extent of the whole image (x1 x2 y1 y2 z1 z2).

virtual WholeExtentCallbackType vtkImageImport::GetWholeExtentCallback ( )
virtual

Set/Get the callback for getting the whole extent of the input image from a third-party pipeline.

The callback should return a vector of six integers describing the extent of the whole image (x1 x2 y1 y2 z1 z2).

virtual void vtkImageImport::SetSpacingCallback ( SpacingCallbackType  )
virtual

Set/Get the callback for getting the spacing of the input image from a third-party pipeline.

The callback should return a vector of three double values describing the spacing (dx dy dz).

virtual SpacingCallbackType vtkImageImport::GetSpacingCallback ( )
virtual

Set/Get the callback for getting the spacing of the input image from a third-party pipeline.

The callback should return a vector of three double values describing the spacing (dx dy dz).

virtual void vtkImageImport::SetOriginCallback ( OriginCallbackType  )
virtual

Set/Get the callback for getting the origin of the input image from a third-party pipeline.

The callback should return a vector of three double values describing the origin (x0 y0 z0).

virtual OriginCallbackType vtkImageImport::GetOriginCallback ( )
virtual

Set/Get the callback for getting the origin of the input image from a third-party pipeline.

The callback should return a vector of three double values describing the origin (x0 y0 z0).

virtual void vtkImageImport::SetDirectionCallback ( DirectionCallbackType  )
virtual

Set/Get the callback for getting the direction of the input image from a third-party pipeline.

The callback should return a vector of nine double values describing the rotation from ijk to xyz.

virtual DirectionCallbackType vtkImageImport::GetDirectionCallback ( )
virtual

Set/Get the callback for getting the direction of the input image from a third-party pipeline.

The callback should return a vector of nine double values describing the rotation from ijk to xyz.

virtual void vtkImageImport::SetScalarTypeCallback ( ScalarTypeCallbackType  )
virtual

Set/Get the callback for getting the scalar value type of the input image from a third-party pipeline.

The callback should return a string with the name of the type.

virtual ScalarTypeCallbackType vtkImageImport::GetScalarTypeCallback ( )
virtual

Set/Get the callback for getting the scalar value type of the input image from a third-party pipeline.

The callback should return a string with the name of the type.

virtual void vtkImageImport::SetNumberOfComponentsCallback ( NumberOfComponentsCallbackType  )
virtual

Set/Get the callback for getting the number of components of the input image from a third-party pipeline.

The callback should return an integer with the number of components.

virtual NumberOfComponentsCallbackType vtkImageImport::GetNumberOfComponentsCallback ( )
virtual

Set/Get the callback for getting the number of components of the input image from a third-party pipeline.

The callback should return an integer with the number of components.

virtual void vtkImageImport::SetPropagateUpdateExtentCallback ( PropagateUpdateExtentCallbackType  )
virtual

Set/Get the callback for propagating the pipeline update extent to a third-party pipeline.

The callback should take a vector of six integers describing the extent. This should cause the third-party pipeline to provide data which contains at least this extent after the next UpdateData callback.

virtual PropagateUpdateExtentCallbackType vtkImageImport::GetPropagateUpdateExtentCallback ( )
virtual

Set/Get the callback for propagating the pipeline update extent to a third-party pipeline.

The callback should take a vector of six integers describing the extent. This should cause the third-party pipeline to provide data which contains at least this extent after the next UpdateData callback.

virtual void vtkImageImport::SetUpdateDataCallback ( UpdateDataCallbackType  )
virtual

Set/Get the callback for propagating UpdateData calls to a third-party pipeline.

The callback should make sure the third-party pipeline is up to date.

virtual UpdateDataCallbackType vtkImageImport::GetUpdateDataCallback ( )
virtual

Set/Get the callback for propagating UpdateData calls to a third-party pipeline.

The callback should make sure the third-party pipeline is up to date.

virtual void vtkImageImport::SetDataExtentCallback ( DataExtentCallbackType  )
virtual

Set/Get the callback for getting the data extent of the input image from a third-party pipeline.

The callback should return a vector of six integers describing the extent of the buffered portion of the image (x1 x2 y1 y2 z1 z2). The buffer location should be set with the BufferPointerCallback.

virtual DataExtentCallbackType vtkImageImport::GetDataExtentCallback ( )
virtual

Set/Get the callback for getting the data extent of the input image from a third-party pipeline.

The callback should return a vector of six integers describing the extent of the buffered portion of the image (x1 x2 y1 y2 z1 z2). The buffer location should be set with the BufferPointerCallback.

virtual void vtkImageImport::SetBufferPointerCallback ( BufferPointerCallbackType  )
virtual

Set/Get the callback for getting a pointer to the data buffer of an image from a third-party pipeline.

The callback should return a pointer to the beginning of the buffer. The extent of the buffer should be set with the DataExtentCallback.

virtual BufferPointerCallbackType vtkImageImport::GetBufferPointerCallback ( )
virtual

Set/Get the callback for getting a pointer to the data buffer of an image from a third-party pipeline.

The callback should return a pointer to the beginning of the buffer. The extent of the buffer should be set with the DataExtentCallback.

virtual void vtkImageImport::SetCallbackUserData ( void *  )
virtual

Set/Get the user data which will be passed as the first argument to all of the third-party pipeline callbacks.

virtual void* vtkImageImport::GetCallbackUserData ( )
virtual

Set/Get the user data which will be passed as the first argument to all of the third-party pipeline callbacks.

int vtkImageImport::InvokePipelineModifiedCallbacks ( )

Invoke the appropriate callbacks.

void vtkImageImport::InvokeUpdateInformationCallbacks ( )

Invoke the appropriate callbacks.

void vtkImageImport::InvokeExecuteInformationCallbacks ( )

Invoke the appropriate callbacks.

void vtkImageImport::InvokeExecuteDataCallbacks ( )

Invoke the appropriate callbacks.

void vtkImageImport::LegacyCheckWholeExtent ( )

Invoke the appropriate callbacks.

int vtkImageImport::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.

Reimplemented from vtkImageAlgorithm.

void vtkImageImport::ExecuteDataWithInformation ( vtkDataObject output,
vtkInformation outInfo 
)
overrideprotectedvirtual

This is a convenience method that is implemented in many subclasses instead of RequestData.

It is called by RequestData.

Reimplemented from vtkImageAlgorithm.

Member Data Documentation

void* vtkImageImport::ImportVoidPointer
protected

Definition at line 353 of file vtkImageImport.h.

int vtkImageImport::SaveUserArray
protected

Definition at line 354 of file vtkImageImport.h.

int vtkImageImport::NumberOfScalarComponents
protected

Definition at line 356 of file vtkImageImport.h.

int vtkImageImport::DataScalarType
protected

Definition at line 357 of file vtkImageImport.h.

int vtkImageImport::WholeExtent[6]
protected

Definition at line 359 of file vtkImageImport.h.

int vtkImageImport::DataExtent[6]
protected

Definition at line 360 of file vtkImageImport.h.

double vtkImageImport::DataSpacing[3]
protected

Definition at line 361 of file vtkImageImport.h.

double vtkImageImport::DataOrigin[3]
protected

Definition at line 362 of file vtkImageImport.h.

double vtkImageImport::DataDirection[9]
protected

Definition at line 363 of file vtkImageImport.h.

char* vtkImageImport::ScalarArrayName
protected

Definition at line 365 of file vtkImageImport.h.

void* vtkImageImport::CallbackUserData
protected

Definition at line 366 of file vtkImageImport.h.

UpdateInformationCallbackType vtkImageImport::UpdateInformationCallback
protected

Definition at line 368 of file vtkImageImport.h.

PipelineModifiedCallbackType vtkImageImport::PipelineModifiedCallback
protected

Definition at line 369 of file vtkImageImport.h.

WholeExtentCallbackType vtkImageImport::WholeExtentCallback
protected

Definition at line 370 of file vtkImageImport.h.

SpacingCallbackType vtkImageImport::SpacingCallback
protected

Definition at line 371 of file vtkImageImport.h.

OriginCallbackType vtkImageImport::OriginCallback
protected

Definition at line 372 of file vtkImageImport.h.

DirectionCallbackType vtkImageImport::DirectionCallback
protected

Definition at line 373 of file vtkImageImport.h.

ScalarTypeCallbackType vtkImageImport::ScalarTypeCallback
protected

Definition at line 374 of file vtkImageImport.h.

NumberOfComponentsCallbackType vtkImageImport::NumberOfComponentsCallback
protected

Definition at line 375 of file vtkImageImport.h.

PropagateUpdateExtentCallbackType vtkImageImport::PropagateUpdateExtentCallback
protected

Definition at line 376 of file vtkImageImport.h.

UpdateDataCallbackType vtkImageImport::UpdateDataCallback
protected

Definition at line 377 of file vtkImageImport.h.

DataExtentCallbackType vtkImageImport::DataExtentCallback
protected

Definition at line 378 of file vtkImageImport.h.

BufferPointerCallbackType vtkImageImport::BufferPointerCallback
protected

Definition at line 379 of file vtkImageImport.h.


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