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

vtkKMeansDistanceFunctor - measure distance from k-means cluster centers More...

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

List of all members.

Public Member Functions

 vtkKMeansDistanceFunctor (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkKMeansDistanceFunctor ()
 Undocumented Block.
virtual IntPtr AllocateElementArray (int size)
 Allocate an array large enough to hold size coordinates and return a void pointer to this array. This is used by vtkPKMeansStatistics to send (receive) cluster center coordinates to (from) other processes.
virtual vtkAbstractArray CreateCoordinateArray ()
 Return a vtkAbstractArray capable of holding cluster center coordinates. This is used by vtkPKMeansStatistics to hold cluster center coordinates sent to (received from) other processes.
virtual void DeallocateElementArray (IntPtr arg0)
 Free an array allocated with AllocateElementArray.
virtual int GetDataType ()
 Return the data type used to store cluster center coordinates.
virtual vtkVariantArray GetEmptyTuple (int dimension)
 Return an empty tuple. These values are used as cluster center coordinates when no initial cluster centers are specified.
override int IsA (string type)
 Undocumented Block.
new vtkKMeansDistanceFunctor NewInstance ()
 Undocumented Block.
virtual void PackElements (vtkTable curTable, IntPtr vElements)
 Pack the cluster center coordinates in vElements into columns of curTable. This code may assume that the columns in curTable are all of the type returned by GetNewVTKArray().
virtual void PairwiseUpdate (vtkTable clusterCenters, int row, vtkVariantArray data, int dataCardinality, int totalCardinality)
 This is called once per observation per run per iteration in order to assign the observation to its nearest cluster center after the distance functor has been evaluated for all the cluster centers.
virtual void PerturbElement (vtkTable arg0, vtkTable arg1, int arg2, int arg3, int arg4, double arg5)
 When a cluster center (1) has no observations that are closer to it than other cluster centers or (2) has exactly the same coordinates as another cluster center, its coordinates should be perturbed. This function should perform that perturbation.
virtual void UnPackElements (vtkTable curTable, vtkTable newTable, IntPtr vLocalElements, IntPtr vGlobalElements, int np)
 Unpack the cluster center coordinates in vElements into columns of curTable. This code may assume that the columns in curTable are all of the type returned by GetNewVTKArray().
virtual void UnPackElements (vtkTable curTable, IntPtr vLocalElements, int numRows, int numCols)
 Unpack the cluster center coordinates in vElements into columns of curTable. This code may assume that the columns in curTable are all of the type returned by GetNewVTKArray().

Static Public Member Functions

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

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "24vtkKMeansDistanceFunctor"
 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 vtkKMeansDistanceFunctor_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkKMeansDistanceFunctor_AllocateElementArray_01 (HandleRef pThis, int size)
static internal IntPtr vtkKMeansDistanceFunctor_CreateCoordinateArray_02 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkKMeansDistanceFunctor_DeallocateElementArray_03 (HandleRef pThis, IntPtr arg0)
static internal int vtkKMeansDistanceFunctor_GetDataType_04 (HandleRef pThis)
static internal IntPtr vtkKMeansDistanceFunctor_GetEmptyTuple_05 (HandleRef pThis, int dimension, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkKMeansDistanceFunctor_IsA_06 (HandleRef pThis, string type)
static internal int vtkKMeansDistanceFunctor_IsTypeOf_07 (string type)
static internal IntPtr vtkKMeansDistanceFunctor_NewInstance_09 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkKMeansDistanceFunctor_PackElements_10 (HandleRef pThis, HandleRef curTable, IntPtr vElements)
static internal void vtkKMeansDistanceFunctor_PairwiseUpdate_11 (HandleRef pThis, HandleRef clusterCenters, int row, HandleRef data, int dataCardinality, int totalCardinality)
static internal void vtkKMeansDistanceFunctor_PerturbElement_12 (HandleRef pThis, HandleRef arg0, HandleRef arg1, int arg2, int arg3, int arg4, double arg5)
static internal IntPtr vtkKMeansDistanceFunctor_SafeDownCast_13 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkKMeansDistanceFunctor_UnPackElements_14 (HandleRef pThis, HandleRef curTable, HandleRef newTable, IntPtr vLocalElements, IntPtr vGlobalElements, int np)
static internal void vtkKMeansDistanceFunctor_UnPackElements_15 (HandleRef pThis, HandleRef curTable, IntPtr vLocalElements, int numRows, int numCols)

Static Private Member Functions

static vtkKMeansDistanceFunctor ()
 Automatically generated type registration mechanics.

Detailed Description

vtkKMeansDistanceFunctor - measure distance from k-means cluster centers

Description This is an abstract class (with a default concrete subclass) that implements algorithms used by the vtkKMeansStatistics filter that rely on a distance metric. If you wish to use a non-Euclidean distance metric (this could include working with strings that do not have a Euclidean distance metric, implementing k-mediods, or trying distance metrics in norms other than L2), you should subclass vtkKMeansDistanceFunctor.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

virtual IntPtr Kitware.VTK.vtkKMeansDistanceFunctor.AllocateElementArray ( int  size) [virtual]

Allocate an array large enough to hold size coordinates and return a void pointer to this array. This is used by vtkPKMeansStatistics to send (receive) cluster center coordinates to (from) other processes.

Return a vtkAbstractArray capable of holding cluster center coordinates. This is used by vtkPKMeansStatistics to hold cluster center coordinates sent to (received from) other processes.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkKMeansDistanceFunctor.DeallocateElementArray ( IntPtr  arg0) [virtual]

Free an array allocated with AllocateElementArray.

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

Reimplemented in Kitware.VTK.vtkKMeansDistanceFunctorCalculator.

Return the data type used to store cluster center coordinates.

Return an empty tuple. These values are used as cluster center coordinates when no initial cluster centers are specified.

Here is the call graph for this function:

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkKMeansDistanceFunctorCalculator.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkKMeansDistanceFunctorCalculator.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkKMeansDistanceFunctorCalculator.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkKMeansDistanceFunctorCalculator.

virtual void Kitware.VTK.vtkKMeansDistanceFunctor.PackElements ( vtkTable  curTable,
IntPtr  vElements 
) [virtual]

Pack the cluster center coordinates in vElements into columns of curTable. This code may assume that the columns in curTable are all of the type returned by GetNewVTKArray().

virtual void Kitware.VTK.vtkKMeansDistanceFunctor.PairwiseUpdate ( vtkTable  clusterCenters,
int  row,
vtkVariantArray  data,
int  dataCardinality,
int  totalCardinality 
) [virtual]

This is called once per observation per run per iteration in order to assign the observation to its nearest cluster center after the distance functor has been evaluated for all the cluster centers.

The distance functor is responsible for incrementally updating the cluster centers to account for the assignment.

virtual void Kitware.VTK.vtkKMeansDistanceFunctor.PerturbElement ( vtkTable  arg0,
vtkTable  arg1,
int  arg2,
int  arg3,
int  arg4,
double  arg5 
) [virtual]

When a cluster center (1) has no observations that are closer to it than other cluster centers or (2) has exactly the same coordinates as another cluster center, its coordinates should be perturbed. This function should perform that perturbation.

Since perturbation relies on a distance metric, this function is the responsibility of the distance functor.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkKMeansDistanceFunctorCalculator.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkKMeansDistanceFunctor.UnPackElements ( vtkTable  curTable,
vtkTable  newTable,
IntPtr  vLocalElements,
IntPtr  vGlobalElements,
int  np 
) [virtual]

Unpack the cluster center coordinates in vElements into columns of curTable. This code may assume that the columns in curTable are all of the type returned by GetNewVTKArray().

virtual void Kitware.VTK.vtkKMeansDistanceFunctor.UnPackElements ( vtkTable  curTable,
IntPtr  vLocalElements,
int  numRows,
int  numCols 
) [virtual]

Unpack the cluster center coordinates in vElements into columns of curTable. This code may assume that the columns in curTable are all of the type returned by GetNewVTKArray().

static internal IntPtr Kitware.VTK.vtkKMeansDistanceFunctor.vtkKMeansDistanceFunctor_AllocateElementArray_01 ( HandleRef  pThis,
int  size 
) [private]
static internal IntPtr Kitware.VTK.vtkKMeansDistanceFunctor.vtkKMeansDistanceFunctor_CreateCoordinateArray_02 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkKMeansDistanceFunctor.vtkKMeansDistanceFunctor_DeallocateElementArray_03 ( HandleRef  pThis,
IntPtr  arg0 
) [private]
static internal int Kitware.VTK.vtkKMeansDistanceFunctor.vtkKMeansDistanceFunctor_GetDataType_04 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkKMeansDistanceFunctor.vtkKMeansDistanceFunctor_GetEmptyTuple_05 ( HandleRef  pThis,
int  dimension,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkKMeansDistanceFunctor.vtkKMeansDistanceFunctor_IsA_06 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkKMeansDistanceFunctor.vtkKMeansDistanceFunctor_IsTypeOf_07 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkKMeansDistanceFunctor.vtkKMeansDistanceFunctor_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkKMeansDistanceFunctor.vtkKMeansDistanceFunctor_NewInstance_09 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkKMeansDistanceFunctor.vtkKMeansDistanceFunctor_PackElements_10 ( HandleRef  pThis,
HandleRef  curTable,
IntPtr  vElements 
) [private]
static internal void Kitware.VTK.vtkKMeansDistanceFunctor.vtkKMeansDistanceFunctor_PairwiseUpdate_11 ( HandleRef  pThis,
HandleRef  clusterCenters,
int  row,
HandleRef  data,
int  dataCardinality,
int  totalCardinality 
) [private]
static internal void Kitware.VTK.vtkKMeansDistanceFunctor.vtkKMeansDistanceFunctor_PerturbElement_12 ( HandleRef  pThis,
HandleRef  arg0,
HandleRef  arg1,
int  arg2,
int  arg3,
int  arg4,
double  arg5 
) [private]
static internal IntPtr Kitware.VTK.vtkKMeansDistanceFunctor.vtkKMeansDistanceFunctor_SafeDownCast_13 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkKMeansDistanceFunctor.vtkKMeansDistanceFunctor_UnPackElements_14 ( HandleRef  pThis,
HandleRef  curTable,
HandleRef  newTable,
IntPtr  vLocalElements,
IntPtr  vGlobalElements,
int  np 
) [private]
static internal void Kitware.VTK.vtkKMeansDistanceFunctor.vtkKMeansDistanceFunctor_UnPackElements_15 ( HandleRef  pThis,
HandleRef  curTable,
IntPtr  vLocalElements,
int  numRows,
int  numCols 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkKMeansDistanceFunctor.MRClassNameKey = "24vtkKMeansDistanceFunctor" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkKMeansDistanceFunctorCalculator.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkKMeansDistanceFunctorCalculator.


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