vtkKMeansDistanceFunctorCalculator - measure distance from k-means cluster centers using a user-specified expression More...

Inheritance diagram for Kitware.VTK.vtkKMeansDistanceFunctorCalculator:

[legend]

Collaboration diagram for Kitware.VTK.vtkKMeansDistanceFunctorCalculator:

[legend]

List of all members.

Public Member Functions
	vtkKMeansDistanceFunctorCalculator (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkKMeansDistanceFunctorCalculator ()
	*Undocumented Block
virtual string	GetDistanceExpression ()
	Set/get the distance function expression.
virtual vtkFunctionParser	GetFunctionParser ()
	Set/get the string containing an expression which evaluates to the distance metric used for k-means computation. The scalar variables "x0", "x1", ... "xn" and "y0", "y1", ..., "yn" refer to the coordinates involved in the computation.
override int	IsA (string type)
	*Undocumented Block
new vtkKMeansDistanceFunctorCalculator	NewInstance ()
	*Undocumented Block
virtual void	SetDistanceExpression (string _arg)
	Set/get the distance function expression.
virtual void	SetFunctionParser (vtkFunctionParser arg0)
	Set/get the string containing an expression which evaluates to the distance metric used for k-means computation. The scalar variables "x0", "x1", ... "xn" and "y0", "y1", ..., "yn" refer to the coordinates involved in the computation.
Public Member Functions inherited from Kitware.VTK.vtkKMeansDistanceFunctor
	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.
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().
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 vtkKMeansDistanceFunctorCalculator	New ()
	*Undocumented Block
static new int	IsTypeOf (string type)
	*Undocumented Block
static new vtkKMeansDistanceFunctorCalculator	SafeDownCast (vtkObjectBase o)
	*Undocumented Block

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

Detailed Description

vtkKMeansDistanceFunctorCalculator - measure distance from k-means cluster centers using a user-specified expression

Description This is a subclass of the default k-means distance functor that allows the user to specify a distance function as a string. The provided expression is evaluated whenever the parenthesis operator is invoked but this is much slower than the default distance calculation.

User-specified distance expressions should be written in terms of two vector variables named "x" and "y". The length of the vectors will be determined by the k-means request and all columns of interest in the request must contain values that may be converted to a floating point representation. (Strings and vtkObject pointers are not allowed.) An example distance expression is "sqrt( (x0-y0)^2 + (x1-y1)^2 )" which computes Euclidian distance in a plane defined by the first 2 coordinates of the vectors specified.

Constructor & Destructor Documentation

static Kitware.VTK.vtkKMeansDistanceFunctorCalculator.vtkKMeansDistanceFunctorCalculator ( )

staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkKMeansDistanceFunctorCalculator.vtkKMeansDistanceFunctorCalculator ( )

*Undocumented Block

Member Function Documentation

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

virtual string Kitware.VTK.vtkKMeansDistanceFunctorCalculator.GetDistanceExpression ( )

virtual

Set/get the distance function expression.

virtual vtkFunctionParser Kitware.VTK.vtkKMeansDistanceFunctorCalculator.GetFunctionParser ( )

virtual

Set/get the string containing an expression which evaluates to the distance metric used for k-means computation. The scalar variables "x0", "x1", ... "xn" and "y0", "y1", ..., "yn" refer to the coordinates involved in the computation.

Here is the call graph for this function:

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

virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkKMeansDistanceFunctor.

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

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkKMeansDistanceFunctor.

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

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkKMeansDistanceFunctor.

new vtkKMeansDistanceFunctorCalculator Kitware.VTK.vtkKMeansDistanceFunctorCalculator.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkKMeansDistanceFunctor.

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

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkKMeansDistanceFunctor.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkKMeansDistanceFunctorCalculator.SetDistanceExpression ( string _arg )

virtual

Set/get the distance function expression.

virtual void Kitware.VTK.vtkKMeansDistanceFunctorCalculator.SetFunctionParser ( vtkFunctionParser arg0 )

virtual

Set/get the string containing an expression which evaluates to the distance metric used for k-means computation. The scalar variables "x0", "x1", ... "xn" and "y0", "y1", ..., "yn" refer to the coordinates involved in the computation.