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

vtkGridTransform - a nonlinear warp transformation More...

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

List of all members.

Public Member Functions

 vtkGridTransform (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkGridTransform ()
 *Undocumented Block
virtual vtkImageData GetDisplacementGrid ()
 Set/Get the grid transform (the grid transform must have three components for displacement in x, y, and z respectively). The vtkGridTransform class will never modify the data.
virtual double GetDisplacementScale ()
 Set scale factor to be applied to the displacements. This is used primarily for grids which contain integer data types. Default: 1.
virtual double GetDisplacementShift ()
 Set a shift to be applied to the displacements. The shift is applied after the scale, i.e. x = scale*y + shift. Default: 0.
virtual int GetInterpolationMode ()
 Set interpolation mode for sampling the grid. Higher-order interpolation allows you to use a sparser grid. Default: Linear.
string GetInterpolationModeAsString ()
 Internal functions for calculating the transformation.
override uint GetMTime ()
 Get the MTime.
override int IsA (string type)
 *Undocumented Block
override vtkAbstractTransform MakeTransform ()
 Make another transform of the same type.
new vtkGridTransform NewInstance ()
 *Undocumented Block
virtual void SetDisplacementGrid (vtkImageData arg0)
 Set/Get the grid transform (the grid transform must have three components for displacement in x, y, and z respectively). The vtkGridTransform class will never modify the data.
virtual void SetDisplacementScale (double _arg)
 Set scale factor to be applied to the displacements. This is used primarily for grids which contain integer data types. Default: 1.
virtual void SetDisplacementShift (double _arg)
 Set a shift to be applied to the displacements. The shift is applied after the scale, i.e. x = scale*y + shift. Default: 0.
void SetInterpolationMode (int mode)
 Set interpolation mode for sampling the grid. Higher-order interpolation allows you to use a sparser grid. Default: Linear.
void SetInterpolationModeToCubic ()
 Set interpolation mode for sampling the grid. Higher-order interpolation allows you to use a sparser grid. Default: Linear.
void SetInterpolationModeToLinear ()
 Set interpolation mode for sampling the grid. Higher-order interpolation allows you to use a sparser grid. Default: Linear.
void SetInterpolationModeToNearestNeighbor ()
 Set interpolation mode for sampling the grid. Higher-order interpolation allows you to use a sparser grid. Default: Linear.
- Public Member Functions inherited from Kitware.VTK.vtkWarpTransform
 vtkWarpTransform (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
virtual int GetInverseFlag ()
 Get the inverse flag of the transformation. This flag is set to zero when the transformation is first created, and is flipped each time Inverse() is called.
virtual int GetInverseIterations ()
 Set the maximum number of iterations for the inverse transformation. The default is 500, but usually only 2 to 5 iterations are used. The inversion method is fairly robust, and it should converge for nearly all smooth transformations that do not fold back on themselves.
virtual double GetInverseTolerance ()
 Set the tolerance for inverse transformation. The default is 0.001.
override void InternalTransformPoint (IntPtr arg0, IntPtr arg1)
 This will calculate the transformation without calling Update. Meant for use only within other VTK classes.
override void Inverse ()
 Invert the transformation. Warp transformations are usually inverted using an iterative technique such as Newton's method. The inverse transform is usually around five or six times as computationally expensive as the forward transform.
virtual void SetInverseIterations (int _arg)
 Set the maximum number of iterations for the inverse transformation. The default is 500, but usually only 2 to 5 iterations are used. The inversion method is fairly robust, and it should converge for nearly all smooth transformations that do not fold back on themselves.
virtual void SetInverseTolerance (double _arg)
 Set the tolerance for inverse transformation. The default is 0.001.
void TemplateTransformInverse (IntPtr arg0, IntPtr arg1)
 Do not use these methods. They exists only as a work-around for internal templated functions (I really didn't want to make the Forward/Inverse methods public, is there a decent work around for this sort of thing?)
void TemplateTransformPoint (IntPtr arg0, IntPtr arg1)
 Do not use these methods. They exists only as a work-around for internal templated functions (I really didn't want to make the Forward/Inverse methods public, is there a decent work around for this sort of thing?)
- Public Member Functions inherited from Kitware.VTK.vtkAbstractTransform
 vtkAbstractTransform (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
virtual int CircuitCheck (vtkAbstractTransform transform)
 Check for self-reference. Will return true if concatenating with the specified transform, setting it to be our inverse, or setting it to be our input will create a circular reference. CircuitCheck is automatically called by SetInput(), SetInverse(), and Concatenate(vtkXTransform *). Avoid using this function, it is experimental.
void DeepCopy (vtkAbstractTransform arg0)
 Copy this transform from another of the same type.
vtkAbstractTransform GetInverse ()
 Get the inverse of this transform. If you modify this transform, the returned inverse transform will automatically update. If you want the inverse of a vtkTransform, you might want to use GetLinearInverse() instead which will type cast the result from vtkAbstractTransform to vtkLinearTransform.
void SetInverse (vtkAbstractTransform transform)
 Set a transformation that this transform will be the inverse of. This transform will automatically update to agree with the inverse transform that you set.
double[] TransformDoubleNormalAtPoint (IntPtr point, IntPtr normal)
 Apply the transformation to a double-precision normal at the specified vertex. If the transformation is a vtkLinearTransform, you can use TransformDoubleNormal() instead.
double[] TransformDoublePoint (double x, double y, double z)
 Apply the transformation to a double-precision (x,y,z) coordinate. Use this if you are programming in Python, tcl or Java.
double[] TransformDoublePoint (IntPtr point)
 Apply the transformation to a double-precision (x,y,z) coordinate. Use this if you are programming in Python, tcl or Java.
double[] TransformDoubleVectorAtPoint (IntPtr point, IntPtr vector)
 Apply the transformation to a double-precision vector at the specified vertex. If the transformation is a vtkLinearTransform, you can use TransformDoubleVector() instead.
float[] TransformFloatNormalAtPoint (IntPtr point, IntPtr normal)
 Apply the transformation to a single-precision normal at the specified vertex. If the transformation is a vtkLinearTransform, you can use TransformFloatNormal() instead.
float[] TransformFloatPoint (float x, float y, float z)
 Apply the transformation to an (x,y,z) coordinate. Use this if you are programming in Python, tcl or Java.
float[] TransformFloatPoint (IntPtr point)
 Apply the transformation to an (x,y,z) coordinate. Use this if you are programming in Python, tcl or Java.
float[] TransformFloatVectorAtPoint (IntPtr point, IntPtr vector)
 Apply the transformation to a single-precision vector at the specified vertex. If the transformation is a vtkLinearTransform, you can use TransformFloatVector() instead.
void TransformNormalAtPoint (IntPtr point, IntPtr arg1, IntPtr arg2)
 Apply the transformation to a normal at the specified vertex. If the transformation is a vtkLinearTransform, you can use TransformNormal() instead.
double[] TransformNormalAtPoint (IntPtr point, IntPtr normal)
 Apply the transformation to a normal at the specified vertex. If the transformation is a vtkLinearTransform, you can use TransformNormal() instead.
void TransformPoint (IntPtr arg0, IntPtr arg1)
 Apply the transformation to a coordinate. You can use the same array to store both the input and output point.
double[] TransformPoint (double x, double y, double z)
 Apply the transformation to a double-precision coordinate. Use this if you are programming in Python, tcl or Java.
double[] TransformPoint (IntPtr point)
 Apply the transformation to a double-precision coordinate. Use this if you are programming in Python, tcl or Java.
virtual void TransformPoints (vtkPoints inPts, vtkPoints outPts)
 Apply the transformation to a series of points, and append the results to outPts.
virtual void TransformPointsNormalsVectors (vtkPoints inPts, vtkPoints outPts, vtkDataArray inNms, vtkDataArray outNms, vtkDataArray inVrs, vtkDataArray outVrs)
 Apply the transformation to a combination of points, normals and vectors.
void TransformVectorAtPoint (IntPtr point, IntPtr arg1, IntPtr arg2)
 Apply the transformation to a vector at the specified vertex. If the transformation is a vtkLinearTransform, you can use TransformVector() instead.
double[] TransformVectorAtPoint (IntPtr point, IntPtr vector)
 Apply the transformation to a vector at the specified vertex. If the transformation is a vtkLinearTransform, you can use TransformVector() instead.
void Update ()
 Update the transform to account for any changes which have been made. You do not have to call this method yourself, it is called automatically whenever the transform needs an update.
- Public Member Functions inherited from Kitware.VTK.vtkObject
 vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void DebugOff ()
 Turn debugging output off.
virtual void DebugOn ()
 Turn debugging output on.
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
byte GetDebug ()
 Get the value of the debug flag.
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void Modified ()
 Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on.
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string.
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events.
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
- Public Member Functions inherited from Kitware.VTK.vtkObjectBase
 vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void Register (vtkObjectBase o)
 Increase the reference count (mark as used by another object).
virtual void FastDelete ()
 Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string GetClassName ()
 Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions

static new vtkGridTransform New ()
 *Undocumented Block
static new int IsTypeOf (string type)
 *Undocumented Block
static new vtkGridTransform SafeDownCast (vtkObjectBase o)
 *Undocumented Block

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkGridTransform"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkWarpTransform
- Public Attributes inherited from Kitware.VTK.vtkAbstractTransform
- Public Attributes inherited from Kitware.VTK.vtkObject
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

static new readonly string MRClassNameKey = "16vtkGridTransform"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkWarpTransform
- Static Public Attributes inherited from Kitware.VTK.vtkAbstractTransform
- Static Public Attributes inherited from Kitware.VTK.vtkObject
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

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.

Static Private Member Functions

static vtkGridTransform ()
 Automatically generated type registration mechanics.

Detailed Description

vtkGridTransform - a nonlinear warp transformation

Description vtkGridTransform describes a nonlinear warp transformation as a set of displacement vectors sampled along a uniform 3D grid. Caveats The inverse grid transform is calculated using an iterative method, and is several times more expensive than the forward transform.

vtkThinPlateSplineTransform vtkGeneralTransform vtkTransformToGrid


Constructor & Destructor Documentation

static Kitware.VTK.vtkGridTransform.vtkGridTransform ( )
staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkGridTransform.vtkGridTransform ( )

*Undocumented Block


Member Function Documentation

override void Kitware.VTK.vtkGridTransform.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.vtkWarpTransform.

virtual vtkImageData Kitware.VTK.vtkGridTransform.GetDisplacementGrid ( )
virtual

Set/Get the grid transform (the grid transform must have three components for displacement in x, y, and z respectively). The vtkGridTransform class will never modify the data.

Here is the call graph for this function:

virtual double Kitware.VTK.vtkGridTransform.GetDisplacementScale ( )
virtual

Set scale factor to be applied to the displacements. This is used primarily for grids which contain integer data types. Default: 1.

virtual double Kitware.VTK.vtkGridTransform.GetDisplacementShift ( )
virtual

Set a shift to be applied to the displacements. The shift is applied after the scale, i.e. x = scale*y + shift. Default: 0.

virtual int Kitware.VTK.vtkGridTransform.GetInterpolationMode ( )
virtual

Set interpolation mode for sampling the grid. Higher-order interpolation allows you to use a sparser grid. Default: Linear.

string Kitware.VTK.vtkGridTransform.GetInterpolationModeAsString ( )

Internal functions for calculating the transformation.

override uint Kitware.VTK.vtkGridTransform.GetMTime ( )
virtual

Get the MTime.

Reimplemented from Kitware.VTK.vtkAbstractTransform.

override int Kitware.VTK.vtkGridTransform.IsA ( string  type)
virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkWarpTransform.

static new int Kitware.VTK.vtkGridTransform.IsTypeOf ( string  type)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkWarpTransform.

override vtkAbstractTransform Kitware.VTK.vtkGridTransform.MakeTransform ( )
virtual

Make another transform of the same type.

Reimplemented from Kitware.VTK.vtkAbstractTransform.

static new vtkGridTransform Kitware.VTK.vtkGridTransform.New ( )
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkObject.

new vtkGridTransform Kitware.VTK.vtkGridTransform.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkWarpTransform.

static new vtkGridTransform Kitware.VTK.vtkGridTransform.SafeDownCast ( vtkObjectBase  o)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkWarpTransform.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkGridTransform.SetDisplacementGrid ( vtkImageData  arg0)
virtual

Set/Get the grid transform (the grid transform must have three components for displacement in x, y, and z respectively). The vtkGridTransform class will never modify the data.

virtual void Kitware.VTK.vtkGridTransform.SetDisplacementScale ( double  _arg)
virtual

Set scale factor to be applied to the displacements. This is used primarily for grids which contain integer data types. Default: 1.

virtual void Kitware.VTK.vtkGridTransform.SetDisplacementShift ( double  _arg)
virtual

Set a shift to be applied to the displacements. The shift is applied after the scale, i.e. x = scale*y + shift. Default: 0.

void Kitware.VTK.vtkGridTransform.SetInterpolationMode ( int  mode)

Set interpolation mode for sampling the grid. Higher-order interpolation allows you to use a sparser grid. Default: Linear.

void Kitware.VTK.vtkGridTransform.SetInterpolationModeToCubic ( )

Set interpolation mode for sampling the grid. Higher-order interpolation allows you to use a sparser grid. Default: Linear.

void Kitware.VTK.vtkGridTransform.SetInterpolationModeToLinear ( )

Set interpolation mode for sampling the grid. Higher-order interpolation allows you to use a sparser grid. Default: Linear.

void Kitware.VTK.vtkGridTransform.SetInterpolationModeToNearestNeighbor ( )

Set interpolation mode for sampling the grid. Higher-order interpolation allows you to use a sparser grid. Default: Linear.


Member Data Documentation

new readonly string Kitware.VTK.vtkGridTransform.MRClassNameKey = "16vtkGridTransform"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkWarpTransform.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkWarpTransform.


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