ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkImageExport Class Reference

vtkImageExport - Export VTK images to third-party systems. More...

Inheritance diagram for Kitware.VTK.vtkImageExport:
[legend]
Collaboration diagram for Kitware.VTK.vtkImageExport:
[legend]

List of all members.

Public Member Functions

 vtkImageExport (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkImageExport ()
 Undocumented Block.
delegate IntPtr BufferPointerCallbackType (IntPtr arg0)
 Get the user data that should be passed to the callback functions.
delegate IntPtr DataExtentCallbackType (IntPtr arg0)
 Get the user data that should be passed to the callback functions.
delegate int NumberOfComponentsCallbackType (IntPtr arg0)
 Get the user data that should be passed to the callback functions.
delegate IntPtr OriginCallbackType (IntPtr arg0)
 Get the user data that should be passed to the callback functions.
delegate int PipelineModifiedCallbackType (IntPtr arg0)
 Get the user data that should be passed to the callback functions.
delegate void PropagateUpdateExtentCallbackType (IntPtr arg0, IntPtr arg1)
 Get the user data that should be passed to the callback functions.
delegate IntPtr ScalarTypeCallbackType (IntPtr arg0)
 Get the user data that should be passed to the callback functions.
delegate IntPtr SpacingCallbackType (IntPtr arg0)
 Get the user data that should be passed to the callback functions.
delegate void UpdateDataCallbackType (IntPtr arg0)
 Get the user data that should be passed to the callback functions.
delegate void UpdateInformationCallbackType (IntPtr arg0)
 Get the user data that should be passed to the callback functions.
delegate IntPtr WholeExtentCallbackType (IntPtr arg0)
 Get the user data that should be passed to the callback functions.
void Export ()
 The main interface: update the pipeline and export the image to the memory pointed to by SetExportVoidPointer(). You can also specify a void pointer when you call Export().
virtual void Export (IntPtr arg0)
 The main interface: update the pipeline and export the image to the memory pointed to by SetExportVoidPointer(). You can also specify a void pointer when you call Export().
BufferPointerCallbackType GetBufferPointerCallback ()
 Get the user data that should be passed to the callback functions.
IntPtr GetCallbackUserData ()
 Get the user data that should be passed to the callback functions.
void GetDataDimensions (IntPtr ptr)
 Get the (x,y,z) index dimensions of the data. Please note that C arrays are indexed in decreasing order, i.e. array[z][y][x].
int[] GetDataDimensions ()
 Get the (x,y,z) index dimensions of the data. Please note that C arrays are indexed in decreasing order, i.e. array[z][y][x].
int[] GetDataExtent ()
 Get miscellaneous additional information about the data.
void GetDataExtent (IntPtr ptr)
 Get miscellaneous additional information about the data.
DataExtentCallbackType GetDataExtentCallback ()
 Get the user data that should be passed to the callback functions.
int GetDataMemorySize ()
 Get the number of bytes required for the output C array.
int GetDataNumberOfScalarComponents ()
 Get the number of scalar components of the data. Please note that when you index into a C array, the scalar component index comes last, i.e. array[z][y][x][c].
double[] GetDataOrigin ()
 Get miscellaneous additional information about the data.
void GetDataOrigin (IntPtr ptr)
 Get miscellaneous additional information about the data.
int GetDataScalarType ()
 Get the scalar type of the data. The scalar type of the C array must match the scalar type of the data.
string GetDataScalarTypeAsString ()
 Get the scalar type of the data. The scalar type of the C array must match the scalar type of the data.
double[] GetDataSpacing ()
 Get miscellaneous additional information about the data.
void GetDataSpacing (IntPtr ptr)
 Get miscellaneous additional information about the data.
IntPtr GetExportVoidPointer ()
 Set the void pointer of the C array to export the data to. From python, you can specify a pointer to a string that is large enough to hold the data.
virtual int GetImageLowerLeft ()
 Set/Get whether the data goes to the exported memory starting in the lower left corner or upper left corner. Default: On. When this flag is Off, the image will be flipped vertically before it is exported. WARNING: this flag is used only with the Export() method, it is ignored by GetPointerToData().
new vtkImageData GetInput ()
 Get miscellaneous additional information about the data.
NumberOfComponentsCallbackType GetNumberOfComponentsCallback ()
 Get the user data that should be passed to the callback functions.
OriginCallbackType GetOriginCallback ()
 Get the user data that should be passed to the callback functions.
NumberOfComponentsCallbackType GetPipelineModifiedCallback ()
 Get the user data that should be passed to the callback functions.
IntPtr GetPointerToData ()
 An alternative to Export(): Use with caution. Update the pipeline and return a pointer to the image memory. The pointer is only valid until the next time that the pipeline is updated. WARNING: This method ignores the ImageLowerLeft flag.
PropagateUpdateExtentCallbackType GetPropagateUpdateExtentCallback ()
 Get the user data that should be passed to the callback functions.
ScalarTypeCallbackType GetScalarTypeCallback ()
 Get the user data that should be passed to the callback functions.
OriginCallbackType GetSpacingCallback ()
 Get the user data that should be passed to the callback functions.
UpdateDataCallbackType GetUpdateDataCallback ()
 Get the user data that should be passed to the callback functions.
UpdateDataCallbackType GetUpdateInformationCallback ()
 Get the user data that should be passed to the callback functions.
DataExtentCallbackType GetWholeExtentCallback ()
 Get the user data that should be passed to the callback functions.
virtual void ImageLowerLeftOff ()
 Set/Get whether the data goes to the exported memory starting in the lower left corner or upper left corner. Default: On. When this flag is Off, the image will be flipped vertically before it is exported. WARNING: this flag is used only with the Export() method, it is ignored by GetPointerToData().
virtual void ImageLowerLeftOn ()
 Set/Get whether the data goes to the exported memory starting in the lower left corner or upper left corner. Default: On. When this flag is Off, the image will be flipped vertically before it is exported. WARNING: this flag is used only with the Export() method, it is ignored by GetPointerToData().
override int IsA (string type)
 Undocumented Block.
new vtkImageExport NewInstance ()
 Undocumented Block.
void SetExportVoidPointer (IntPtr arg0)
 Set the void pointer of the C array to export the data to. From python, you can specify a pointer to a string that is large enough to hold the data.
virtual void SetImageLowerLeft (int _arg)
 Set/Get whether the data goes to the exported memory starting in the lower left corner or upper left corner. Default: On. When this flag is Off, the image will be flipped vertically before it is exported. WARNING: this flag is used only with the Export() method, it is ignored by GetPointerToData().

Static Public Member Functions

static new vtkImageExport New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkImageExport SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkImageExport"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "14vtkImageExport"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkImageExport_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkImageExport_Export_01 (HandleRef pThis)
static internal void vtkImageExport_Export_02 (HandleRef pThis, IntPtr arg0)
static internal
BufferPointerCallbackType 
vtkImageExport_GetBufferPointerCallback_03 (HandleRef pThis)
static internal IntPtr vtkImageExport_GetCallbackUserData_04 (HandleRef pThis)
static internal void vtkImageExport_GetDataDimensions_05 (HandleRef pThis, IntPtr ptr)
static internal IntPtr vtkImageExport_GetDataDimensions_06 (HandleRef pThis)
static internal IntPtr vtkImageExport_GetDataExtent_07 (HandleRef pThis)
static internal void vtkImageExport_GetDataExtent_08 (HandleRef pThis, IntPtr ptr)
static internal
DataExtentCallbackType 
vtkImageExport_GetDataExtentCallback_09 (HandleRef pThis)
static internal int vtkImageExport_GetDataMemorySize_10 (HandleRef pThis)
static internal int vtkImageExport_GetDataNumberOfScalarComponents_11 (HandleRef pThis)
static internal IntPtr vtkImageExport_GetDataOrigin_12 (HandleRef pThis)
static internal void vtkImageExport_GetDataOrigin_13 (HandleRef pThis, IntPtr ptr)
static internal int vtkImageExport_GetDataScalarType_14 (HandleRef pThis)
static internal IntPtr vtkImageExport_GetDataScalarTypeAsString_15 (HandleRef pThis)
static internal IntPtr vtkImageExport_GetDataSpacing_16 (HandleRef pThis)
static internal void vtkImageExport_GetDataSpacing_17 (HandleRef pThis, IntPtr ptr)
static internal IntPtr vtkImageExport_GetExportVoidPointer_18 (HandleRef pThis)
static internal int vtkImageExport_GetImageLowerLeft_19 (HandleRef pThis)
static internal IntPtr vtkImageExport_GetInput_20 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal
NumberOfComponentsCallbackType 
vtkImageExport_GetNumberOfComponentsCallback_21 (HandleRef pThis)
static internal OriginCallbackType vtkImageExport_GetOriginCallback_22 (HandleRef pThis)
static internal
NumberOfComponentsCallbackType 
vtkImageExport_GetPipelineModifiedCallback_23 (HandleRef pThis)
static internal IntPtr vtkImageExport_GetPointerToData_24 (HandleRef pThis)
static internal
PropagateUpdateExtentCallbackType 
vtkImageExport_GetPropagateUpdateExtentCallback_25 (HandleRef pThis)
static internal
ScalarTypeCallbackType 
vtkImageExport_GetScalarTypeCallback_26 (HandleRef pThis)
static internal OriginCallbackType vtkImageExport_GetSpacingCallback_27 (HandleRef pThis)
static internal
UpdateDataCallbackType 
vtkImageExport_GetUpdateDataCallback_28 (HandleRef pThis)
static internal
UpdateDataCallbackType 
vtkImageExport_GetUpdateInformationCallback_29 (HandleRef pThis)
static internal
DataExtentCallbackType 
vtkImageExport_GetWholeExtentCallback_30 (HandleRef pThis)
static internal void vtkImageExport_ImageLowerLeftOff_31 (HandleRef pThis)
static internal void vtkImageExport_ImageLowerLeftOn_32 (HandleRef pThis)
static internal int vtkImageExport_IsA_33 (HandleRef pThis, string type)
static internal int vtkImageExport_IsTypeOf_34 (string type)
static internal IntPtr vtkImageExport_NewInstance_36 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkImageExport_SafeDownCast_37 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkImageExport_SetExportVoidPointer_38 (HandleRef pThis, IntPtr arg0)
static internal void vtkImageExport_SetImageLowerLeft_39 (HandleRef pThis, int _arg)

Static Private Member Functions

static vtkImageExport ()
 Automatically generated type registration mechanics.

Detailed Description

vtkImageExport - Export VTK images to third-party systems.

Description vtkImageExport provides a way of exporting image data at the end of a pipeline to a third-party system or to a simple C array. Applications can use this to get direct access to the image data in memory. A callback interface is provided to allow connection of the VTK pipeline to a third-party pipeline. This interface conforms to the interface of vtkImageImport. In Python it is possible to use this class to write the image data into a python string that has been pre-allocated to be the correct size.

vtkImageImport


Constructor & Destructor Documentation

static Kitware.VTK.vtkImageExport.vtkImageExport ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkImageExport.vtkImageExport ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

delegate IntPtr Kitware.VTK.vtkImageExport.BufferPointerCallbackType ( IntPtr  arg0)

Get the user data that should be passed to the callback functions.

delegate IntPtr Kitware.VTK.vtkImageExport.DataExtentCallbackType ( IntPtr  arg0)

Get the user data that should be passed to the callback functions.

override void Kitware.VTK.vtkImageExport.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

The main interface: update the pipeline and export the image to the memory pointed to by SetExportVoidPointer(). You can also specify a void pointer when you call Export().

virtual void Kitware.VTK.vtkImageExport.Export ( IntPtr  arg0) [virtual]

The main interface: update the pipeline and export the image to the memory pointed to by SetExportVoidPointer(). You can also specify a void pointer when you call Export().

Get the user data that should be passed to the callback functions.

Get the user data that should be passed to the callback functions.

Get the (x,y,z) index dimensions of the data. Please note that C arrays are indexed in decreasing order, i.e. array[z][y][x].

Get the (x,y,z) index dimensions of the data. Please note that C arrays are indexed in decreasing order, i.e. array[z][y][x].

Get miscellaneous additional information about the data.

Get miscellaneous additional information about the data.

Get the user data that should be passed to the callback functions.

Get the number of bytes required for the output C array.

Get the number of scalar components of the data. Please note that when you index into a C array, the scalar component index comes last, i.e. array[z][y][x][c].

Get miscellaneous additional information about the data.

Get miscellaneous additional information about the data.

Get the scalar type of the data. The scalar type of the C array must match the scalar type of the data.

Get the scalar type of the data. The scalar type of the C array must match the scalar type of the data.

Get miscellaneous additional information about the data.

Get miscellaneous additional information about the data.

Set the void pointer of the C array to export the data to. From python, you can specify a pointer to a string that is large enough to hold the data.

Set/Get whether the data goes to the exported memory starting in the lower left corner or upper left corner. Default: On. When this flag is Off, the image will be flipped vertically before it is exported. WARNING: this flag is used only with the Export() method, it is ignored by GetPointerToData().

Get miscellaneous additional information about the data.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

Here is the call graph for this function:

Get the user data that should be passed to the callback functions.

Get the user data that should be passed to the callback functions.

Get the user data that should be passed to the callback functions.

An alternative to Export(): Use with caution. Update the pipeline and return a pointer to the image memory. The pointer is only valid until the next time that the pipeline is updated. WARNING: This method ignores the ImageLowerLeft flag.

Get the user data that should be passed to the callback functions.

Get the user data that should be passed to the callback functions.

Get the user data that should be passed to the callback functions.

Get the user data that should be passed to the callback functions.

Get the user data that should be passed to the callback functions.

Get the user data that should be passed to the callback functions.

Set/Get whether the data goes to the exported memory starting in the lower left corner or upper left corner. Default: On. When this flag is Off, the image will be flipped vertically before it is exported. WARNING: this flag is used only with the Export() method, it is ignored by GetPointerToData().

virtual void Kitware.VTK.vtkImageExport.ImageLowerLeftOn ( ) [virtual]

Set/Get whether the data goes to the exported memory starting in the lower left corner or upper left corner. Default: On. When this flag is Off, the image will be flipped vertically before it is exported. WARNING: this flag is used only with the Export() method, it is ignored by GetPointerToData().

override int Kitware.VTK.vtkImageExport.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

static new int Kitware.VTK.vtkImageExport.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

Get the user data that should be passed to the callback functions.

delegate IntPtr Kitware.VTK.vtkImageExport.OriginCallbackType ( IntPtr  arg0)

Get the user data that should be passed to the callback functions.

Get the user data that should be passed to the callback functions.

delegate void Kitware.VTK.vtkImageExport.PropagateUpdateExtentCallbackType ( IntPtr  arg0,
IntPtr  arg1 
)

Get the user data that should be passed to the callback functions.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

Here is the call graph for this function:

delegate IntPtr Kitware.VTK.vtkImageExport.ScalarTypeCallbackType ( IntPtr  arg0)

Get the user data that should be passed to the callback functions.

Set the void pointer of the C array to export the data to. From python, you can specify a pointer to a string that is large enough to hold the data.

virtual void Kitware.VTK.vtkImageExport.SetImageLowerLeft ( int  _arg) [virtual]

Set/Get whether the data goes to the exported memory starting in the lower left corner or upper left corner. Default: On. When this flag is Off, the image will be flipped vertically before it is exported. WARNING: this flag is used only with the Export() method, it is ignored by GetPointerToData().

delegate IntPtr Kitware.VTK.vtkImageExport.SpacingCallbackType ( IntPtr  arg0)

Get the user data that should be passed to the callback functions.

delegate void Kitware.VTK.vtkImageExport.UpdateDataCallbackType ( IntPtr  arg0)

Get the user data that should be passed to the callback functions.

Get the user data that should be passed to the callback functions.

static internal void Kitware.VTK.vtkImageExport.vtkImageExport_Export_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageExport.vtkImageExport_Export_02 ( HandleRef  pThis,
IntPtr  arg0 
) [private]
static internal IntPtr Kitware.VTK.vtkImageExport.vtkImageExport_GetCallbackUserData_04 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageExport.vtkImageExport_GetDataDimensions_05 ( HandleRef  pThis,
IntPtr  ptr 
) [private]
static internal IntPtr Kitware.VTK.vtkImageExport.vtkImageExport_GetDataDimensions_06 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkImageExport.vtkImageExport_GetDataExtent_07 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageExport.vtkImageExport_GetDataExtent_08 ( HandleRef  pThis,
IntPtr  ptr 
) [private]
static internal int Kitware.VTK.vtkImageExport.vtkImageExport_GetDataMemorySize_10 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkImageExport.vtkImageExport_GetDataNumberOfScalarComponents_11 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkImageExport.vtkImageExport_GetDataOrigin_12 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageExport.vtkImageExport_GetDataOrigin_13 ( HandleRef  pThis,
IntPtr  ptr 
) [private]
static internal int Kitware.VTK.vtkImageExport.vtkImageExport_GetDataScalarType_14 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkImageExport.vtkImageExport_GetDataScalarTypeAsString_15 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkImageExport.vtkImageExport_GetDataSpacing_16 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageExport.vtkImageExport_GetDataSpacing_17 ( HandleRef  pThis,
IntPtr  ptr 
) [private]
static internal IntPtr Kitware.VTK.vtkImageExport.vtkImageExport_GetExportVoidPointer_18 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkImageExport.vtkImageExport_GetImageLowerLeft_19 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkImageExport.vtkImageExport_GetInput_20 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkImageExport.vtkImageExport_GetPointerToData_24 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageExport.vtkImageExport_ImageLowerLeftOff_31 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkImageExport.vtkImageExport_ImageLowerLeftOn_32 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkImageExport.vtkImageExport_IsA_33 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkImageExport.vtkImageExport_IsTypeOf_34 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkImageExport.vtkImageExport_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkImageExport.vtkImageExport_NewInstance_36 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkImageExport.vtkImageExport_SafeDownCast_37 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkImageExport.vtkImageExport_SetExportVoidPointer_38 ( HandleRef  pThis,
IntPtr  arg0 
) [private]
static internal void Kitware.VTK.vtkImageExport.vtkImageExport_SetImageLowerLeft_39 ( HandleRef  pThis,
int  _arg 
) [private]
delegate IntPtr Kitware.VTK.vtkImageExport.WholeExtentCallbackType ( IntPtr  arg0)

Get the user data that should be passed to the callback functions.


Member Data Documentation

new readonly string Kitware.VTK.vtkImageExport.MRClassNameKey = "14vtkImageExport" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

new const string Kitware.VTK.vtkImageExport.MRFullTypeName = "Kitware.VTK.vtkImageExport"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.


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