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

#include <vtkKMeansDistanceFunctorCalculator.h>

Inheritance diagram for vtkKMeansDistanceFunctorCalculator:

Collaboration diagram for vtkKMeansDistanceFunctorCalculator:

Public Types
typedef vtkKMeansDistanceFunctor	Superclass
Public Types inherited from vtkKMeansDistanceFunctor
Public Types inherited from vtkObject

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	operator() (double &, vtkVariantArray , vtkVariantArray )

virtual void	SetDistanceExpression (const char *)
virtual char *	GetDistanceExpression ()

virtual void	SetFunctionParser (vtkFunctionParser *)
virtual vtkFunctionParser *	GetFunctionParser ()
Public Member Functions inherited from vtkKMeansDistanceFunctor
virtual vtkVariantArray *	GetEmptyTuple (vtkIdType dimension)
virtual void	PairwiseUpdate (vtkTable clusterCenters, vtkIdType row, vtkVariantArray data, vtkIdType dataCardinality, vtkIdType totalCardinality)
virtual void	PerturbElement (vtkTable , vtkTable , vtkIdType, vtkIdType, vtkIdType, double)
virtual void *	AllocateElementArray (vtkIdType size)
virtual void	DeallocateElementArray (void *)
virtual vtkAbstractArray *	CreateCoordinateArray ()
virtual void	PackElements (vtkTable curTable, void vElements)
virtual int	GetDataType ()
virtual void	UnPackElements (vtkTable curTable, vtkTable newTable, void vLocalElements, void vGlobalElements, int np)
virtual void	UnPackElements (vtkTable curTable, void vLocalElements, vtkIdType numRows, vtkIdType numCols)
Public Member Functions inherited from vtkObject
virtual void	DebugOn ()
virtual void	DebugOff ()
unsigned char	GetDebug ()
void	SetDebug (unsigned char debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char event, vtkCommand )
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char event, vtkCommand )
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char event, void callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &os)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkKMeansDistanceFunctorCalculator *	New ()
static int	IsTypeOf (const char *type)
static vtkKMeansDistanceFunctorCalculator *	SafeDownCast (vtkObject *o)

Protected Member Functions
	vtkKMeansDistanceFunctorCalculator ()
virtual	~vtkKMeansDistanceFunctorCalculator ()
Protected Member Functions inherited from vtkKMeansDistanceFunctor
	vtkKMeansDistanceFunctor ()
virtual	~vtkKMeansDistanceFunctor ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &os)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
char *	DistanceExpression
int	TupleSize
vtkFunctionParser *	FunctionParser
Protected Attributes inherited from vtkKMeansDistanceFunctor
vtkVariantArray *	EmptyTuple
vtkTable *	CenterUpdates
Protected Attributes inherited from vtkObject
unsigned char	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
int	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

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

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.

Tests:: vtkKMeansDistanceFunctorCalculator (Tests)

Definition at line 31 of file vtkKMeansDistanceFunctorCalculator.h.

Member Typedef Documentation

typedef vtkKMeansDistanceFunctor vtkKMeansDistanceFunctorCalculator::Superclass

Reimplemented from vtkKMeansDistanceFunctor.

Definition at line 35 of file vtkKMeansDistanceFunctorCalculator.h.

Constructor & Destructor Documentation

vtkKMeansDistanceFunctorCalculator::vtkKMeansDistanceFunctorCalculator ( )

protected

virtual vtkKMeansDistanceFunctorCalculator::~vtkKMeansDistanceFunctorCalculator ( )

protectedvirtual

Member Function Documentation

static vtkKMeansDistanceFunctorCalculator* vtkKMeansDistanceFunctorCalculator::New ( )

static

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkKMeansDistanceFunctor.

virtual const char* vtkKMeansDistanceFunctorCalculator::GetClassName ( )

virtual

Reimplemented from vtkKMeansDistanceFunctor.

static int vtkKMeansDistanceFunctorCalculator::IsTypeOf ( const char * name )

static

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkKMeansDistanceFunctor.

virtual int vtkKMeansDistanceFunctorCalculator::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkKMeansDistanceFunctor.

static vtkKMeansDistanceFunctorCalculator* vtkKMeansDistanceFunctorCalculator::SafeDownCast ( vtkObject * o )

static

Reimplemented from vtkKMeansDistanceFunctor.

virtual void vtkKMeansDistanceFunctorCalculator::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkKMeansDistanceFunctor.

virtual void vtkKMeansDistanceFunctorCalculator::operator()	(	double &	,
		vtkVariantArray *	,
		vtkVariantArray *
	)

virtual

Compute the distance from one observation to another, returning the distance in the first argument.

Reimplemented from vtkKMeansDistanceFunctor.

virtual void vtkKMeansDistanceFunctorCalculator::SetDistanceExpression ( const char * )

virtual

Set/get the distance function expression.

virtual char* vtkKMeansDistanceFunctorCalculator::GetDistanceExpression ( )

virtual

Set/get the distance function expression.

virtual void vtkKMeansDistanceFunctorCalculator::SetFunctionParser ( vtkFunctionParser * )

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.

virtual vtkFunctionParser* 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.