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

vtkProbeFilter - sample data values at specified point locations More...

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

List of all members.

Public Member Functions

 vtkProbeFilter (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkProbeFilter ()
 Undocumented Block.
vtkDataObject GetSource ()
 Specify the point locations used to probe input. Any geometry can be used. Old style. Do not use unless for backwards compatibility.
virtual int GetSpatialMatch ()
 This flag is used only when a piece is requested to update. By default the flag is off. Because no spatial correspondence between input pieces and source pieces is known, all of the source has to be requested no matter what piece of the output is requested. When there is a spatial correspondence, the user/application can set this flag. This hint allows the breakup of the probe operation to be much more efficient. When piece m of n is requested for update by the user, then only n of m needs to be requested of the source.
virtual string GetValidPointMaskArrayName ()
 Returns the name of the char array added to the output with values 1 for valid points and 0 for invalid points. Set to "vtkValidPointMask" by default.
virtual vtkIdTypeArray GetValidPoints ()
 Get the list of point ids in the output that contain attribute data interpolated from the source.
override int IsA (string type)
 Undocumented Block.
new vtkProbeFilter NewInstance ()
 Undocumented Block.
void SetSource (vtkDataObject source)
 Specify the point locations used to probe input. Any geometry can be used. Old style. Do not use unless for backwards compatibility.
void SetSourceConnection (vtkAlgorithmOutput algOutput)
 Specify the point locations used to probe input. Any geometry can be used. New style. Equivalent to SetInputConnection(1, algOutput).
virtual void SetSpatialMatch (int _arg)
 This flag is used only when a piece is requested to update. By default the flag is off. Because no spatial correspondence between input pieces and source pieces is known, all of the source has to be requested no matter what piece of the output is requested. When there is a spatial correspondence, the user/application can set this flag. This hint allows the breakup of the probe operation to be much more efficient. When piece m of n is requested for update by the user, then only n of m needs to be requested of the source.
virtual void SetValidPointMaskArrayName (string _arg)
 Returns the name of the char array added to the output with values 1 for valid points and 0 for invalid points. Set to "vtkValidPointMask" by default.
virtual void SpatialMatchOff ()
 This flag is used only when a piece is requested to update. By default the flag is off. Because no spatial correspondence between input pieces and source pieces is known, all of the source has to be requested no matter what piece of the output is requested. When there is a spatial correspondence, the user/application can set this flag. This hint allows the breakup of the probe operation to be much more efficient. When piece m of n is requested for update by the user, then only n of m needs to be requested of the source.
virtual void SpatialMatchOn ()
 This flag is used only when a piece is requested to update. By default the flag is off. Because no spatial correspondence between input pieces and source pieces is known, all of the source has to be requested no matter what piece of the output is requested. When there is a spatial correspondence, the user/application can set this flag. This hint allows the breakup of the probe operation to be much more efficient. When piece m of n is requested for update by the user, then only n of m needs to be requested of the source.

Static Public Member Functions

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

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "14vtkProbeFilter"
 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 vtkProbeFilter_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkProbeFilter_GetSource_01 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkProbeFilter_GetSpatialMatch_02 (HandleRef pThis)
static internal IntPtr vtkProbeFilter_GetValidPointMaskArrayName_03 (HandleRef pThis)
static internal IntPtr vtkProbeFilter_GetValidPoints_04 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkProbeFilter_IsA_05 (HandleRef pThis, string type)
static internal int vtkProbeFilter_IsTypeOf_06 (string type)
static internal IntPtr vtkProbeFilter_NewInstance_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkProbeFilter_SafeDownCast_09 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkProbeFilter_SetSource_10 (HandleRef pThis, HandleRef source)
static internal void vtkProbeFilter_SetSourceConnection_11 (HandleRef pThis, HandleRef algOutput)
static internal void vtkProbeFilter_SetSpatialMatch_12 (HandleRef pThis, int _arg)
static internal void vtkProbeFilter_SetValidPointMaskArrayName_13 (HandleRef pThis, string _arg)
static internal void vtkProbeFilter_SpatialMatchOff_14 (HandleRef pThis)
static internal void vtkProbeFilter_SpatialMatchOn_15 (HandleRef pThis)

Static Private Member Functions

static vtkProbeFilter ()
 Automatically generated type registration mechanics.

Detailed Description

vtkProbeFilter - sample data values at specified point locations

Description vtkProbeFilter is a filter that computes point attributes (e.g., scalars, vectors, etc.) at specified point positions. The filter has two inputs: the Input and Source. The Input geometric structure is passed through the filter. The point attributes are computed at the Input point positions by interpolating into the source data. For example, we can compute data values on a plane (plane specified as Input) from a volume (Source). The cell data of the source data is copied to the output based on in which source cell each input point is. If an array of the same name exists both in source's point and cell data, only the one from the point data is probed.

This filter can be used to resample data, or convert one dataset form into another. For example, an unstructured grid (vtkUnstructuredGrid) can be probed with a volume (three-dimensional vtkImageData), and then volume rendering techniques can be used to visualize the results. Another example: a line or curve can be used to probe data to produce x-y plots along that line or curve.


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

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

Reimplemented in Kitware.VTK.vtkCompositeDataProbeFilter, and Kitware.VTK.vtkPProbeFilter.

Specify the point locations used to probe input. Any geometry can be used. Old style. Do not use unless for backwards compatibility.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkProbeFilter.GetSpatialMatch ( ) [virtual]

This flag is used only when a piece is requested to update. By default the flag is off. Because no spatial correspondence between input pieces and source pieces is known, all of the source has to be requested no matter what piece of the output is requested. When there is a spatial correspondence, the user/application can set this flag. This hint allows the breakup of the probe operation to be much more efficient. When piece m of n is requested for update by the user, then only n of m needs to be requested of the source.

Returns the name of the char array added to the output with values 1 for valid points and 0 for invalid points. Set to "vtkValidPointMask" by default.

Get the list of point ids in the output that contain attribute data interpolated from the source.

Here is the call graph for this function:

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

Reimplemented in Kitware.VTK.vtkCompositeDataProbeFilter, and Kitware.VTK.vtkPProbeFilter.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

Reimplemented in Kitware.VTK.vtkCompositeDataProbeFilter, and Kitware.VTK.vtkPProbeFilter.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

Reimplemented in Kitware.VTK.vtkCompositeDataProbeFilter, and Kitware.VTK.vtkPProbeFilter.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

Reimplemented in Kitware.VTK.vtkCompositeDataProbeFilter, and Kitware.VTK.vtkPProbeFilter.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

Reimplemented in Kitware.VTK.vtkCompositeDataProbeFilter, and Kitware.VTK.vtkPProbeFilter.

Here is the call graph for this function:

Specify the point locations used to probe input. Any geometry can be used. Old style. Do not use unless for backwards compatibility.

Specify the point locations used to probe input. Any geometry can be used. New style. Equivalent to SetInputConnection(1, algOutput).

virtual void Kitware.VTK.vtkProbeFilter.SetSpatialMatch ( int  _arg) [virtual]

This flag is used only when a piece is requested to update. By default the flag is off. Because no spatial correspondence between input pieces and source pieces is known, all of the source has to be requested no matter what piece of the output is requested. When there is a spatial correspondence, the user/application can set this flag. This hint allows the breakup of the probe operation to be much more efficient. When piece m of n is requested for update by the user, then only n of m needs to be requested of the source.

virtual void Kitware.VTK.vtkProbeFilter.SetValidPointMaskArrayName ( string  _arg) [virtual]

Returns the name of the char array added to the output with values 1 for valid points and 0 for invalid points. Set to "vtkValidPointMask" by default.

virtual void Kitware.VTK.vtkProbeFilter.SpatialMatchOff ( ) [virtual]

This flag is used only when a piece is requested to update. By default the flag is off. Because no spatial correspondence between input pieces and source pieces is known, all of the source has to be requested no matter what piece of the output is requested. When there is a spatial correspondence, the user/application can set this flag. This hint allows the breakup of the probe operation to be much more efficient. When piece m of n is requested for update by the user, then only n of m needs to be requested of the source.

virtual void Kitware.VTK.vtkProbeFilter.SpatialMatchOn ( ) [virtual]

This flag is used only when a piece is requested to update. By default the flag is off. Because no spatial correspondence between input pieces and source pieces is known, all of the source has to be requested no matter what piece of the output is requested. When there is a spatial correspondence, the user/application can set this flag. This hint allows the breakup of the probe operation to be much more efficient. When piece m of n is requested for update by the user, then only n of m needs to be requested of the source.

static internal IntPtr Kitware.VTK.vtkProbeFilter.vtkProbeFilter_GetSource_01 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkProbeFilter.vtkProbeFilter_GetSpatialMatch_02 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkProbeFilter.vtkProbeFilter_GetValidPointMaskArrayName_03 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkProbeFilter.vtkProbeFilter_GetValidPoints_04 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkProbeFilter.vtkProbeFilter_IsA_05 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkProbeFilter.vtkProbeFilter_IsTypeOf_06 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkProbeFilter.vtkProbeFilter_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkProbeFilter.vtkProbeFilter_NewInstance_08 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkProbeFilter.vtkProbeFilter_SafeDownCast_09 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkProbeFilter.vtkProbeFilter_SetSource_10 ( HandleRef  pThis,
HandleRef  source 
) [private]
static internal void Kitware.VTK.vtkProbeFilter.vtkProbeFilter_SetSourceConnection_11 ( HandleRef  pThis,
HandleRef  algOutput 
) [private]
static internal void Kitware.VTK.vtkProbeFilter.vtkProbeFilter_SetSpatialMatch_12 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkProbeFilter.vtkProbeFilter_SetValidPointMaskArrayName_13 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkProbeFilter.vtkProbeFilter_SpatialMatchOff_14 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkProbeFilter.vtkProbeFilter_SpatialMatchOn_15 ( HandleRef  pThis) [private]

Member Data Documentation

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

Reimplemented in Kitware.VTK.vtkCompositeDataProbeFilter, and Kitware.VTK.vtkPProbeFilter.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

Reimplemented in Kitware.VTK.vtkCompositeDataProbeFilter, and Kitware.VTK.vtkPProbeFilter.


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