vtkImageImport Class Reference
#include <vtkImageImport.h>
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 39 of file vtkImageImport.h.
Member Typedef Documentation
| typedef void(* vtkImageImport::UpdateInformationCallbackType)(void *) |
These are function pointer types for the pipeline connection callbacks. See further documentation on each individual callback.
| typedef int(* vtkImageImport::PipelineModifiedCallbackType)(void *) |
These are function pointer types for the pipeline connection callbacks. See further documentation on each individual callback.
| typedef int*(* vtkImageImport::WholeExtentCallbackType)(void *) |
These are function pointer types for the pipeline connection callbacks. See further documentation on each individual callback.
| typedef double*(* vtkImageImport::SpacingCallbackType)(void *) |
These are function pointer types for the pipeline connection callbacks. See further documentation on each individual callback.
| typedef double*(* vtkImageImport::OriginCallbackType)(void *) |
These are function pointer types for the pipeline connection callbacks. See further documentation on each individual callback.
| typedef const char*(* vtkImageImport::ScalarTypeCallbackType)(void *) |
These are function pointer types for the pipeline connection callbacks. See further documentation on each individual callback.
| typedef int(* vtkImageImport::NumberOfComponentsCallbackType)(void *) |
These are function pointer types for the pipeline connection callbacks. See further documentation on each individual callback.
| typedef void(* vtkImageImport::PropagateUpdateExtentCallbackType)(void *, int *) |
These are function pointer types for the pipeline connection callbacks. See further documentation on each individual callback.
| typedef void(* vtkImageImport::UpdateDataCallbackType)(void *) |
These are function pointer types for the pipeline connection callbacks. See further documentation on each individual callback.
| typedef int*(* vtkImageImport::DataExtentCallbackType)(void *) |
These are function pointer types for the pipeline connection callbacks. See further documentation on each individual callback.
| typedef void*(* vtkImageImport::BufferPointerCallbackType)(void *) |
These are function pointer types for the pipeline connection callbacks. See further documentation on each individual callback.
Constructor & Destructor Documentation
| vtkImageImport::vtkImageImport | ( | ) | [protected] |
| vtkImageImport::~vtkImageImport | ( | ) | [protected] |
Member Function Documentation
| static vtkImageImport* vtkImageImport::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkAlgorithm.
| virtual const char* vtkImageImport::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkImageAlgorithm.
| static int vtkImageImport::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type 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.
| virtual int 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 | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkImageAlgorithm.
| void vtkImageImport::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
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, | |
| int | 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 57 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 71 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 72 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 73 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 74 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 75 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 77 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 80 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 98 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::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.
| virtual int vtkImageImport::RequestUpdateExtent | ( | vtkInformation * | request, | |
| vtkInformationVector ** | inputVector, | |||
| vtkInformationVector * | outputVector | |||
| ) | [virtual] |
Propagates the update extent through the callback if it is set.
Reimplemented from vtkImageAlgorithm.
| 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::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
| virtual int vtkImageImport::RequestInformation | ( | vtkInformation * | , | |
| vtkInformationVector ** | , | |||
| vtkInformationVector * | ||||
| ) | [protected, virtual] |
Reimplemented from vtkImageAlgorithm.
| virtual void vtkImageImport::ExecuteData | ( | vtkDataObject * | output | ) | [protected, virtual] |
This method is the old style execute method
Reimplemented from vtkImageAlgorithm.
Member Data Documentation
void* vtkImageImport::ImportVoidPointer [protected] |
Definition at line 276 of file vtkImageImport.h.
int vtkImageImport::SaveUserArray [protected] |
Definition at line 277 of file vtkImageImport.h.
int vtkImageImport::NumberOfScalarComponents [protected] |
Definition at line 279 of file vtkImageImport.h.
int vtkImageImport::DataScalarType [protected] |
Definition at line 280 of file vtkImageImport.h.
int vtkImageImport::WholeExtent[6] [protected] |
Definition at line 282 of file vtkImageImport.h.
int vtkImageImport::DataExtent[6] [protected] |
Definition at line 283 of file vtkImageImport.h.
double vtkImageImport::DataSpacing[3] [protected] |
Definition at line 284 of file vtkImageImport.h.
double vtkImageImport::DataOrigin[3] [protected] |
Definition at line 285 of file vtkImageImport.h.
char* vtkImageImport::ScalarArrayName [protected] |
Definition at line 287 of file vtkImageImport.h.
void* vtkImageImport::CallbackUserData [protected] |
Definition at line 288 of file vtkImageImport.h.
Definition at line 291 of file vtkImageImport.h.
Definition at line 292 of file vtkImageImport.h.
Definition at line 293 of file vtkImageImport.h.
SpacingCallbackType vtkImageImport::SpacingCallback [protected] |
Definition at line 294 of file vtkImageImport.h.
OriginCallbackType vtkImageImport::OriginCallback [protected] |
Definition at line 295 of file vtkImageImport.h.
Definition at line 296 of file vtkImageImport.h.
Definition at line 297 of file vtkImageImport.h.
Definition at line 298 of file vtkImageImport.h.
Definition at line 299 of file vtkImageImport.h.
Definition at line 300 of file vtkImageImport.h.
Definition at line 301 of file vtkImageImport.h.
The documentation for this class was generated from the following file:
- dox/Imaging/vtkImageImport.h
