VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkKMeansDistanceFunctor Class Reference

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

#include <vtkKMeansDistanceFunctor.h>

Inheritance diagram for vtkKMeansDistanceFunctor:
[legend]
Collaboration diagram for vtkKMeansDistanceFunctor:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkKMeansDistanceFunctorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkVariantArrayGetEmptyTuple (vtkIdType dimension)
 Return an empty tuple. More...
 
virtual void operator() (double &, vtkVariantArray *, vtkVariantArray *)
 Compute the distance from one observation to another, returning the distance in the first argument. More...
 
virtual void PairwiseUpdate (vtkTable *clusterCenters, vtkIdType row, vtkVariantArray *data, vtkIdType dataCardinality, vtkIdType 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. More...
 
virtual void PerturbElement (vtkTable *, vtkTable *, vtkIdType, vtkIdType, vtkIdType, double)
 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. More...
 
virtual void * AllocateElementArray (vtkIdType size)
 Allocate an array large enough to hold size coordinates and return a void pointer to this array. More...
 
virtual void DeallocateElementArray (void *)
 Free an array allocated with AllocateElementArray. More...
 
virtual vtkAbstractArrayCreateCoordinateArray ()
 Return a vtkAbstractArray capable of holding cluster center coordinates. More...
 
virtual void PackElements (vtkTable *curTable, void *vElements)
 Pack the cluster center coordinates in vElements into columns of curTable. More...
 
virtual void UnPackElements (vtkTable *curTable, vtkTable *newTable, void *vLocalElements, void *vGlobalElements, int np)
 Unpack the cluster center coordinates in vElements into columns of curTable. More...
 
virtual void UnPackElements (vtkTable *curTable, void *vLocalElements, vtkIdType numRows, vtkIdType numCols)
 
virtual int GetDataType ()
 Return the data type used to store cluster center coordinates. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkKMeansDistanceFunctorNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkKMeansDistanceFunctorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkKMeansDistanceFunctor ()
 
 ~vtkKMeansDistanceFunctor () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkVariantArrayEmptyTuple
 
vtkTableCenterUpdates
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

measure distance from k-means cluster centers

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.

Definition at line 23 of file vtkKMeansDistanceFunctor.h.

Member Typedef Documentation

◆ Superclass

Definition at line 27 of file vtkKMeansDistanceFunctor.h.

Constructor & Destructor Documentation

◆ vtkKMeansDistanceFunctor()

vtkKMeansDistanceFunctor::vtkKMeansDistanceFunctor ( )
protected

◆ ~vtkKMeansDistanceFunctor()

vtkKMeansDistanceFunctor::~vtkKMeansDistanceFunctor ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkKMeansDistanceFunctor* vtkKMeansDistanceFunctor::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkKMeansDistanceFunctor::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkKMeansDistanceFunctor::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 vtkObjectBase.

Reimplemented in vtkKMeansDistanceFunctorCalculator.

◆ SafeDownCast()

static vtkKMeansDistanceFunctor* vtkKMeansDistanceFunctor::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkKMeansDistanceFunctor::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkKMeansDistanceFunctor* vtkKMeansDistanceFunctor::NewInstance ( ) const

◆ PrintSelf()

void vtkKMeansDistanceFunctor::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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 vtkObject.

Reimplemented in vtkKMeansDistanceFunctorCalculator.

◆ GetEmptyTuple()

virtual vtkVariantArray* vtkKMeansDistanceFunctor::GetEmptyTuple ( vtkIdType  dimension)
virtual

Return an empty tuple.

These values are used as cluster center coordinates when no initial cluster centers are specified.

◆ operator()()

virtual void vtkKMeansDistanceFunctor::operator() ( double &  ,
vtkVariantArray ,
vtkVariantArray  
)
virtual

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

Reimplemented in vtkKMeansDistanceFunctorCalculator.

◆ PairwiseUpdate()

virtual void vtkKMeansDistanceFunctor::PairwiseUpdate ( vtkTable clusterCenters,
vtkIdType  row,
vtkVariantArray data,
vtkIdType  dataCardinality,
vtkIdType  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.

◆ PerturbElement()

virtual void vtkKMeansDistanceFunctor::PerturbElement ( vtkTable ,
vtkTable ,
vtkIdType  ,
vtkIdType  ,
vtkIdType  ,
double   
)
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.

◆ AllocateElementArray()

virtual void* vtkKMeansDistanceFunctor::AllocateElementArray ( vtkIdType  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.

◆ DeallocateElementArray()

virtual void vtkKMeansDistanceFunctor::DeallocateElementArray ( void *  )
virtual

Free an array allocated with AllocateElementArray.

◆ CreateCoordinateArray()

virtual vtkAbstractArray* vtkKMeansDistanceFunctor::CreateCoordinateArray ( )
virtual

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.

◆ PackElements()

virtual void vtkKMeansDistanceFunctor::PackElements ( vtkTable curTable,
void *  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().

◆ UnPackElements() [1/2]

virtual void vtkKMeansDistanceFunctor::UnPackElements ( vtkTable curTable,
vtkTable newTable,
void *  vLocalElements,
void *  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().

◆ UnPackElements() [2/2]

virtual void vtkKMeansDistanceFunctor::UnPackElements ( vtkTable curTable,
void *  vLocalElements,
vtkIdType  numRows,
vtkIdType  numCols 
)
virtual

◆ GetDataType()

virtual int vtkKMeansDistanceFunctor::GetDataType ( )
virtual

Return the data type used to store cluster center coordinates.

Member Data Documentation

◆ EmptyTuple

vtkVariantArray* vtkKMeansDistanceFunctor::EmptyTuple
protected

Definition at line 110 of file vtkKMeansDistanceFunctor.h.

◆ CenterUpdates

vtkTable* vtkKMeansDistanceFunctor::CenterUpdates
protected

Definition at line 112 of file vtkKMeansDistanceFunctor.h.


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