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.vtkGradientFilter Class Reference

vtkGradientFilter - A general filter for gradient estimation. More...

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

List of all members.

Public Member Functions

 vtkGradientFilter (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkGradientFilter ()
 Undocumented Block.
virtual void ComputeVorticityOff ()
 Set the resultant array to be vorticity/curl of the input array. The input array must have 3 components.
virtual void ComputeVorticityOn ()
 Set the resultant array to be vorticity/curl of the input array. The input array must have 3 components.
virtual void FasterApproximationOff ()
 When this flag is on (default is off), the gradient filter will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster). The error contains some smoothing of the output data and some possible errors on the boundary. This parameter has no effect when performing the gradient of cell data. This only applies if the input grid is a vtkUnstructuredGrid or a vtkPolyData.
virtual void FasterApproximationOn ()
 When this flag is on (default is off), the gradient filter will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster). The error contains some smoothing of the output data and some possible errors on the boundary. This parameter has no effect when performing the gradient of cell data. This only applies if the input grid is a vtkUnstructuredGrid or a vtkPolyData.
virtual int GetComputeVorticity ()
 Set the resultant array to be vorticity/curl of the input array. The input array must have 3 components.
virtual int GetFasterApproximation ()
 When this flag is on (default is off), the gradient filter will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster). The error contains some smoothing of the output data and some possible errors on the boundary. This parameter has no effect when performing the gradient of cell data. This only applies if the input grid is a vtkUnstructuredGrid or a vtkPolyData.
virtual string GetResultArrayName ()
 Get/Set the name of the resulting array to create. If NULL (the default) then the output array will be named "Gradients".
override int IsA (string type)
 Undocumented Block.
new vtkGradientFilter NewInstance ()
 Undocumented Block.
virtual void SetComputeVorticity (int _arg)
 Set the resultant array to be vorticity/curl of the input array. The input array must have 3 components.
virtual void SetFasterApproximation (int _arg)
 When this flag is on (default is off), the gradient filter will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster). The error contains some smoothing of the output data and some possible errors on the boundary. This parameter has no effect when performing the gradient of cell data. This only applies if the input grid is a vtkUnstructuredGrid or a vtkPolyData.
virtual void SetInputScalars (int fieldAssociation, string name)
 These are basically a convenience method that calls SetInputArrayToProcess to set the array used as the input scalars. The fieldAssociation comes from the vtkDataObject::FieldAssocations enum. The fieldAttributeType comes from the vtkDataSetAttributes::AttributeTypes enum.
virtual void SetInputScalars (int fieldAssociation, int fieldAttributeType)
 These are basically a convenience method that calls SetInputArrayToProcess to set the array used as the input scalars. The fieldAssociation comes from the vtkDataObject::FieldAssocations enum. The fieldAttributeType comes from the vtkDataSetAttributes::AttributeTypes enum.
virtual void SetResultArrayName (string _arg)
 Get/Set the name of the resulting array to create. If NULL (the default) then the output array will be named "Gradients".

Static Public Member Functions

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

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "17vtkGradientFilter"
 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 vtkGradientFilter_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkGradientFilter_ComputeVorticityOff_01 (HandleRef pThis)
static internal void vtkGradientFilter_ComputeVorticityOn_02 (HandleRef pThis)
static internal void vtkGradientFilter_FasterApproximationOff_03 (HandleRef pThis)
static internal void vtkGradientFilter_FasterApproximationOn_04 (HandleRef pThis)
static internal int vtkGradientFilter_GetComputeVorticity_05 (HandleRef pThis)
static internal int vtkGradientFilter_GetFasterApproximation_06 (HandleRef pThis)
static internal IntPtr vtkGradientFilter_GetResultArrayName_07 (HandleRef pThis)
static internal int vtkGradientFilter_IsA_08 (HandleRef pThis, string type)
static internal int vtkGradientFilter_IsTypeOf_09 (string type)
static internal IntPtr vtkGradientFilter_NewInstance_11 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkGradientFilter_SafeDownCast_12 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkGradientFilter_SetComputeVorticity_13 (HandleRef pThis, int _arg)
static internal void vtkGradientFilter_SetFasterApproximation_14 (HandleRef pThis, int _arg)
static internal void vtkGradientFilter_SetInputScalars_15 (HandleRef pThis, int fieldAssociation, string name)
static internal void vtkGradientFilter_SetInputScalars_16 (HandleRef pThis, int fieldAssociation, int fieldAttributeType)
static internal void vtkGradientFilter_SetResultArrayName_17 (HandleRef pThis, string _arg)

Static Private Member Functions

static vtkGradientFilter ()
 Automatically generated type registration mechanics.

Detailed Description

vtkGradientFilter - A general filter for gradient estimation.

Description Estimates the gradient of a field in a data set. The gradient calculation is dependent on the input dataset type. The created gradient array is of the same type as the array it is calculated from (e.g. point data or cell data) as well as data type (e.g. float, double). At the boundary the gradient is not central differencing. The output array has 3*number of components of the input data array. The ordering for the output tuple will be {du/dx, du/dy, du/dz, dv/dx, dv/dy, dv/dz, dw/dx, dw/dy, dw/dz} for an input array {u, v, w}.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

Set the resultant array to be vorticity/curl of the input array. The input array must have 3 components.

Set the resultant array to be vorticity/curl of the input array. The input array must have 3 components.

override void Kitware.VTK.vtkGradientFilter.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.vtkDataSetAlgorithm.

When this flag is on (default is off), the gradient filter will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster). The error contains some smoothing of the output data and some possible errors on the boundary. This parameter has no effect when performing the gradient of cell data. This only applies if the input grid is a vtkUnstructuredGrid or a vtkPolyData.

When this flag is on (default is off), the gradient filter will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster). The error contains some smoothing of the output data and some possible errors on the boundary. This parameter has no effect when performing the gradient of cell data. This only applies if the input grid is a vtkUnstructuredGrid or a vtkPolyData.

Set the resultant array to be vorticity/curl of the input array. The input array must have 3 components.

When this flag is on (default is off), the gradient filter will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster). The error contains some smoothing of the output data and some possible errors on the boundary. This parameter has no effect when performing the gradient of cell data. This only applies if the input grid is a vtkUnstructuredGrid or a vtkPolyData.

Get/Set the name of the resulting array to create. If NULL (the default) then the output array will be named "Gradients".

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkGradientFilter.SetComputeVorticity ( int  _arg) [virtual]

Set the resultant array to be vorticity/curl of the input array. The input array must have 3 components.

virtual void Kitware.VTK.vtkGradientFilter.SetFasterApproximation ( int  _arg) [virtual]

When this flag is on (default is off), the gradient filter will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster). The error contains some smoothing of the output data and some possible errors on the boundary. This parameter has no effect when performing the gradient of cell data. This only applies if the input grid is a vtkUnstructuredGrid or a vtkPolyData.

virtual void Kitware.VTK.vtkGradientFilter.SetInputScalars ( int  fieldAssociation,
string  name 
) [virtual]

These are basically a convenience method that calls SetInputArrayToProcess to set the array used as the input scalars. The fieldAssociation comes from the vtkDataObject::FieldAssocations enum. The fieldAttributeType comes from the vtkDataSetAttributes::AttributeTypes enum.

virtual void Kitware.VTK.vtkGradientFilter.SetInputScalars ( int  fieldAssociation,
int  fieldAttributeType 
) [virtual]

These are basically a convenience method that calls SetInputArrayToProcess to set the array used as the input scalars. The fieldAssociation comes from the vtkDataObject::FieldAssocations enum. The fieldAttributeType comes from the vtkDataSetAttributes::AttributeTypes enum.

virtual void Kitware.VTK.vtkGradientFilter.SetResultArrayName ( string  _arg) [virtual]

Get/Set the name of the resulting array to create. If NULL (the default) then the output array will be named "Gradients".

static internal void Kitware.VTK.vtkGradientFilter.vtkGradientFilter_ComputeVorticityOff_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkGradientFilter.vtkGradientFilter_ComputeVorticityOn_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkGradientFilter.vtkGradientFilter_FasterApproximationOff_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkGradientFilter.vtkGradientFilter_FasterApproximationOn_04 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkGradientFilter.vtkGradientFilter_GetComputeVorticity_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkGradientFilter.vtkGradientFilter_GetFasterApproximation_06 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkGradientFilter.vtkGradientFilter_GetResultArrayName_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkGradientFilter.vtkGradientFilter_IsA_08 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkGradientFilter.vtkGradientFilter_IsTypeOf_09 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkGradientFilter.vtkGradientFilter_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkGradientFilter.vtkGradientFilter_NewInstance_11 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkGradientFilter.vtkGradientFilter_SafeDownCast_12 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkGradientFilter.vtkGradientFilter_SetComputeVorticity_13 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkGradientFilter.vtkGradientFilter_SetFasterApproximation_14 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkGradientFilter.vtkGradientFilter_SetInputScalars_15 ( HandleRef  pThis,
int  fieldAssociation,
string  name 
) [private]
static internal void Kitware.VTK.vtkGradientFilter.vtkGradientFilter_SetInputScalars_16 ( HandleRef  pThis,
int  fieldAssociation,
int  fieldAttributeType 
) [private]
static internal void Kitware.VTK.vtkGradientFilter.vtkGradientFilter_SetResultArrayName_17 ( HandleRef  pThis,
string  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkGradientFilter.MRClassNameKey = "17vtkGradientFilter" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.


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