vtkFiniteDifferenceGradientEstimator - Use finite differences to estimate gradient. More...

Inheritance diagram for Kitware.VTK.vtkFiniteDifferenceGradientEstimator:

Collaboration diagram for Kitware.VTK.vtkFiniteDifferenceGradientEstimator:

Public Member Functions
	vtkFiniteDifferenceGradientEstimator (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkFiniteDifferenceGradientEstimator ()
	Construct a vtkFiniteDifferenceGradientEstimator with a SampleSpacingInVoxels of 1.
virtual int	GetSampleSpacingInVoxels ()
	Set/Get the spacing between samples for the finite differences method used to compute the normal. This spacing is in voxel units.
override int	IsA (string type)
	*Undocumented Block
new vtkFiniteDifferenceGradientEstimator	NewInstance ()
	*Undocumented Block
virtual void	SetSampleSpacingInVoxels (int _arg)
	Set/Get the spacing between samples for the finite differences method used to compute the normal. This spacing is in voxel units.
Public Member Functions inherited from Kitware.VTK.vtkEncodedGradientEstimator
	vtkEncodedGradientEstimator (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
virtual void	BoundsClipOff ()
	Turn on / off the bounding of the normal computation by the this->Bounds bounding box.
virtual void	BoundsClipOn ()
	Turn on / off the bounding of the normal computation by the this->Bounds bounding box.
virtual void	ComputeGradientMagnitudesOff ()
	If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used. Be careful - if if you a non-constant gradient magnitude transfer function and you turn this on, it may crash.
virtual void	ComputeGradientMagnitudesOn ()
	If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used. Be careful - if if you a non-constant gradient magnitude transfer function and you turn this on, it may crash.
virtual void	CylinderClipOff ()
	If the data in each slice is only contained within a circle circumscribed within the slice, and the slice is square, then don't compute anything outside the circle. This circle through the slices forms a cylinder.
virtual void	CylinderClipOn ()
	If the data in each slice is only contained within a circle circumscribed within the slice, and the slice is square, then don't compute anything outside the circle. This circle through the slices forms a cylinder.
virtual int[]	GetBounds ()
	Set / Get the bounds of the computation (used if this->ComputationBounds is 1.) The bounds are specified xmin, xmax, ymin, ymax, zmin, zmax.
virtual void	GetBounds (IntPtr data)
	Set / Get the bounds of the computation (used if this->ComputationBounds is 1.) The bounds are specified xmin, xmax, ymin, ymax, zmin, zmax.
virtual int	GetBoundsClip ()
	Turn on / off the bounding of the normal computation by the this->Bounds bounding box.
virtual int	GetBoundsClipMaxValue ()
	Turn on / off the bounding of the normal computation by the this->Bounds bounding box.
virtual int	GetBoundsClipMinValue ()
	Turn on / off the bounding of the normal computation by the this->Bounds bounding box.
IntPtr	GetCircleLimits ()
	Get the time required for the last update in seconds or cpu seconds.
virtual int	GetComputeGradientMagnitudes ()
	If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used. Be careful - if if you a non-constant gradient magnitude transfer function and you turn this on, it may crash.
virtual int	GetCylinderClip ()
	If the data in each slice is only contained within a circle circumscribed within the slice, and the slice is square, then don't compute anything outside the circle. This circle through the slices forms a cylinder.
virtual vtkDirectionEncoder	GetDirectionEncoder ()
	Set / Get the direction encoder used to encode normal directions to fit within two bytes.
int	GetEncodedNormalIndex (int xyz_index)
	Get the encoded normal at an x,y,z location in the volume.
int	GetEncodedNormalIndex (int x_index, int y_index, int z_index)
	Get the encoded normal at an x,y,z location in the volume.
IntPtr	GetEncodedNormals ()
	Get the encoded normals.
virtual float	GetGradientMagnitudeBias ()
	Set/Get the scale and bias for the gradient magnitude.
virtual float	GetGradientMagnitudeScale ()
	Set/Get the scale and bias for the gradient magnitude.
IntPtr	GetGradientMagnitudes ()
	Get the gradient magnitudes.
virtual vtkImageData	GetInput ()
	Set/Get the scalar input for which the normals will be calculated.
virtual float[]	GetInputAspect ()
	The time at which the normals were last built.
virtual void	GetInputAspect (IntPtr data)
	The time at which the normals were last built.
virtual int[]	GetInputSize ()
	The time at which the normals were last built.
virtual void	GetInputSize (IntPtr data)
	The time at which the normals were last built.
virtual float	GetLastUpdateTimeInCPUSeconds ()
	Get the time required for the last update in seconds or cpu seconds.
virtual float	GetLastUpdateTimeInSeconds ()
	Get the time required for the last update in seconds or cpu seconds.
virtual int	GetNumberOfThreads ()
	Get/Set the number of threads to create when encoding normals This defaults to the number of available processors on the machine.
virtual int	GetNumberOfThreadsMaxValue ()
	Get/Set the number of threads to create when encoding normals This defaults to the number of available processors on the machine.
virtual int	GetNumberOfThreadsMinValue ()
	Get/Set the number of threads to create when encoding normals This defaults to the number of available processors on the machine.
virtual int	GetUseCylinderClip ()
	Get the time required for the last update in seconds or cpu seconds.
virtual float	GetZeroNormalThreshold ()
	Set / Get the ZeroNormalThreshold - this defines the minimum magnitude of a gradient that is considered sufficient to define a direction. Gradients with magnitudes at or less than this value are given a "zero normal" index. These are handled specially in the shader, and you can set the intensity of light for these zero normals in the gradient shader.
virtual int	GetZeroPad ()
	Assume that the data value outside the volume is zero when computing normals.
virtual int	GetZeroPadMaxValue ()
	Assume that the data value outside the volume is zero when computing normals.
virtual int	GetZeroPadMinValue ()
	Assume that the data value outside the volume is zero when computing normals.
virtual void	SetBounds (int _arg1, int _arg2, int _arg3, int _arg4, int _arg5, int _arg6)
	Set / Get the bounds of the computation (used if this->ComputationBounds is 1.) The bounds are specified xmin, xmax, ymin, ymax, zmin, zmax.
virtual void	SetBounds (IntPtr _arg)
	Set / Get the bounds of the computation (used if this->ComputationBounds is 1.) The bounds are specified xmin, xmax, ymin, ymax, zmin, zmax.
virtual void	SetBoundsClip (int _arg)
	Turn on / off the bounding of the normal computation by the this->Bounds bounding box.
virtual void	SetComputeGradientMagnitudes (int _arg)
	If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used. Be careful - if if you a non-constant gradient magnitude transfer function and you turn this on, it may crash.
virtual void	SetCylinderClip (int _arg)
	If the data in each slice is only contained within a circle circumscribed within the slice, and the slice is square, then don't compute anything outside the circle. This circle through the slices forms a cylinder.
void	SetDirectionEncoder (vtkDirectionEncoder direnc)
	Set / Get the direction encoder used to encode normal directions to fit within two bytes.
virtual void	SetGradientMagnitudeBias (float _arg)
	Set/Get the scale and bias for the gradient magnitude.
virtual void	SetGradientMagnitudeScale (float _arg)
	Set/Get the scale and bias for the gradient magnitude.
virtual void	SetInput (vtkImageData arg0)
	Set/Get the scalar input for which the normals will be calculated.
virtual void	SetNumberOfThreads (int _arg)
	Get/Set the number of threads to create when encoding normals This defaults to the number of available processors on the machine.
void	SetZeroNormalThreshold (float v)
	Set / Get the ZeroNormalThreshold - this defines the minimum magnitude of a gradient that is considered sufficient to define a direction. Gradients with magnitudes at or less than this value are given a "zero normal" index. These are handled specially in the shader, and you can set the intensity of light for these zero normals in the gradient shader.
virtual void	SetZeroPad (int _arg)
	Assume that the data value outside the volume is zero when computing normals.
void	Update ()
	Recompute the encoded normals and gradient magnitudes.
virtual void	ZeroPadOff ()
	Assume that the data value outside the volume is zero when computing normals.
virtual void	ZeroPadOn ()
	Assume that the data value outside the volume is zero when computing normals.
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.
virtual uint	GetMTime ()
	Return this object's modified time.
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 vtkFiniteDifferenceGradientEstimator	New ()
	Construct a vtkFiniteDifferenceGradientEstimator with a SampleSpacingInVoxels of 1.
static new int	IsTypeOf (string type)
	*Undocumented Block
static new vtkFiniteDifferenceGradientEstimator	SafeDownCast (vtkObjectBase o)
	*Undocumented Block

Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkFiniteDifferenceGradientEstimator"
	Automatically generated type registration mechanics.
Public Attributes inherited from Kitware.VTK.vtkEncodedGradientEstimator
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 = "36vtkFiniteDifferenceGradientEstimator"
	Automatically generated type registration mechanics.
Static Public Attributes inherited from Kitware.VTK.vtkEncodedGradientEstimator
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	vtkFiniteDifferenceGradientEstimator ()
	Automatically generated type registration mechanics.

Detailed Description

vtkFiniteDifferenceGradientEstimator - Use finite differences to estimate gradient.

Description vtkFiniteDifferenceGradientEstimator is a concrete subclass of vtkEncodedGradientEstimator that uses a central differences technique to estimate the gradient. The gradient at some sample location (x,y,z) would be estimated by:

 nx = (f(x-dx,y,z) - f(x+dx,y,z)) / 2*dx;
 ny = (f(x,y-dy,z) - f(x,y+dy,z)) / 2*dy;
 nz = (f(x,y,z-dz) - f(x,y,z+dz)) / 2*dz;

This value is normalized to determine a unit direction vector and a magnitude. The normal is computed in voxel space, and dx = dy = dz = SampleSpacingInVoxels. A scaling factor is applied to convert this normal from voxel space to world coordinates.

vtkEncodedGradientEstimator

Constructor & Destructor Documentation

static Kitware.VTK.vtkFiniteDifferenceGradientEstimator.vtkFiniteDifferenceGradientEstimator ( )

staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkFiniteDifferenceGradientEstimator.vtkFiniteDifferenceGradientEstimator ( )

Construct a vtkFiniteDifferenceGradientEstimator with a SampleSpacingInVoxels of 1.

Member Function Documentation

override void Kitware.VTK.vtkFiniteDifferenceGradientEstimator.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.vtkEncodedGradientEstimator.

virtual int Kitware.VTK.vtkFiniteDifferenceGradientEstimator.GetSampleSpacingInVoxels ( )

virtual

Set/Get the spacing between samples for the finite differences method used to compute the normal. This spacing is in voxel units.

override int Kitware.VTK.vtkFiniteDifferenceGradientEstimator.IsA ( string type )

virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkEncodedGradientEstimator.

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

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkEncodedGradientEstimator.

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

static

Construct a vtkFiniteDifferenceGradientEstimator with a SampleSpacingInVoxels of 1.

Reimplemented from Kitware.VTK.vtkObject.

new vtkFiniteDifferenceGradientEstimator Kitware.VTK.vtkFiniteDifferenceGradientEstimator.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkEncodedGradientEstimator.

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

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkEncodedGradientEstimator.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkFiniteDifferenceGradientEstimator.SetSampleSpacingInVoxels ( int _arg )

virtual

Set/Get the spacing between samples for the finite differences method used to compute the normal. This spacing is in voxel units.

Member Data Documentation

new readonly string Kitware.VTK.vtkFiniteDifferenceGradientEstimator.MRClassNameKey = "36vtkFiniteDifferenceGradientEstimator"

static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkEncodedGradientEstimator.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkEncodedGradientEstimator.

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

csharp/vtkFiniteDifferenceGradientEstimator.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation