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

A class for KMeans clustering. More...

#include <vtkKMeansStatistics.h>

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

Public Types

typedef vtkStatisticsAlgorithm Superclass
 
- Public Types inherited from vtkStatisticsAlgorithm
enum  InputPorts { INPUT_DATA = 0, LEARN_PARAMETERS = 1, INPUT_MODEL = 2 }
 enumeration values to specify input port types More...
 
enum  OutputIndices { OUTPUT_DATA = 0, OUTPUT_MODEL = 1, OUTPUT_TEST = 2 }
 enumeration values to specify output port types More...
 
typedef vtkTableAlgorithm Superclass
 
- Public Types inherited from vtkTableAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkKMeansStatisticsNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Aggregate (vtkDataObjectCollection *, vtkMultiBlockDataSet *) override
 Given a collection of models, calculate aggregate model NB: not implemented. More...
 
bool SetParameter (const char *parameter, int index, vtkVariant value) override
 A convenience method for setting properties by name. More...
 
virtual void SetDistanceFunctor (vtkKMeansDistanceFunctor *)
 Set the DistanceFunctor. More...
 
virtual vtkKMeansDistanceFunctorGetDistanceFunctor ()
 Set the DistanceFunctor. More...
 
virtual void SetDefaultNumberOfClusters (int)
 Set/get the DefaultNumberOfClusters, used when no initial cluster coordinates are specified. More...
 
virtual int GetDefaultNumberOfClusters ()
 Set/get the DefaultNumberOfClusters, used when no initial cluster coordinates are specified. More...
 
virtual void SetKValuesArrayName (const char *)
 Set/get the KValuesArrayName. More...
 
virtual char * GetKValuesArrayName ()
 Set/get the KValuesArrayName. More...
 
virtual void SetMaxNumIterations (int)
 Set/get the MaxNumIterations used to terminate iterations on cluster center coordinates when the relative tolerance can not be met. More...
 
virtual int GetMaxNumIterations ()
 Set/get the MaxNumIterations used to terminate iterations on cluster center coordinates when the relative tolerance can not be met. More...
 
virtual void SetTolerance (double)
 Set/get the relative Tolerance used to terminate iterations on cluster center coordinates. More...
 
virtual double GetTolerance ()
 Set/get the relative Tolerance used to terminate iterations on cluster center coordinates. More...
 
- Public Member Functions inherited from vtkStatisticsAlgorithm
vtkStatisticsAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetLearnOptionParameterConnection (vtkAlgorithmOutput *params)
 A convenience method for setting learn input parameters (if one is expected or allowed). More...
 
virtual void SetLearnOptionParameters (vtkDataObject *params)
 A convenience method for setting learn input parameters (if one is expected or allowed). More...
 
virtual void SetInputModelConnection (vtkAlgorithmOutput *model)
 A convenience method for setting the input model connection (if one is expected or allowed). More...
 
virtual void SetInputModel (vtkDataObject *model)
 A convenience method for setting the input model (if one is expected or allowed). More...
 
virtual void SetColumnStatus (const char *namCol, int status)
 Add or remove a column from the current analysis request. More...
 
virtual void ResetAllColumnStates ()
 Set the the status of each and every column in the current request to OFF (0). More...
 
virtual int RequestSelectedColumns ()
 Use the current column status values to produce a new request for statistics to be produced when RequestData() is called. More...
 
virtual void ResetRequests ()
 Empty the list of current requests. More...
 
virtual vtkIdType GetNumberOfRequests ()
 Return the number of requests. More...
 
virtual vtkIdType GetNumberOfColumnsForRequest (vtkIdType request)
 Return the number of columns for a given request. More...
 
virtual const char * GetColumnForRequest (vtkIdType r, vtkIdType c)
 Provide the name of the c-th column for the r-th request. More...
 
virtual int GetColumnForRequest (vtkIdType r, vtkIdType c, vtkStdString &columnName)
 
void AddColumn (const char *namCol)
 Convenience method to create a request with a single column name namCol in a single call; this is the preferred method to select columns, ensuring selection consistency (a single column per request). More...
 
void AddColumnPair (const char *namColX, const char *namColY)
 Convenience method to create a request with a single column name pair (namColX, namColY) in a single call; this is the preferred method to select columns pairs, ensuring selection consistency (a pair of columns per request). More...
 
virtual void SetLearnOption (bool)
 Set/Get the Learn operation. More...
 
virtual bool GetLearnOption ()
 Set/Get the Learn operation. More...
 
virtual void SetDeriveOption (bool)
 Set/Get the Derive operation. More...
 
virtual bool GetDeriveOption ()
 Set/Get the Derive operation. More...
 
virtual void SetAssessOption (bool)
 Set/Get the Assess operation. More...
 
virtual bool GetAssessOption ()
 Set/Get the Assess operation. More...
 
virtual void SetTestOption (bool)
 Set/Get the Test operation. More...
 
virtual bool GetTestOption ()
 Set/Get the Test operation. More...
 
virtual void SetNumberOfPrimaryTables (vtkIdType)
 Set/Get the number of tables in the primary model. More...
 
virtual vtkIdType GetNumberOfPrimaryTables ()
 Set/Get the number of tables in the primary model. More...
 
virtual void SetAssessNames (vtkStringArray *)
 Set/get assessment names. More...
 
virtual vtkStringArrayGetAssessNames ()
 Set/get assessment names. More...
 
- Public Member Functions inherited from vtkTableAlgorithm
vtkTableAlgorithmNewInstance () const
 
int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkTableGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkTableGetOutput (int index)
 
void SetInputData (vtkDataObject *obj)
 Assign a data object as input. More...
 
void SetInputData (int index, vtkDataObject *obj)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual int Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual int Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (int)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual int GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void SetProgress (double)
 Set/Get the execution progress of a process object. More...
 
virtual double GetProgress ()
 Set/Get the execution progress of a process object. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. 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...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- 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...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkKMeansStatisticsSafeDownCast (vtkObjectBase *o)
 
static vtkKMeansStatisticsNew ()
 
- Static Public Member Functions inherited from vtkStatisticsAlgorithm
static int IsTypeOf (const char *type)
 
static vtkStatisticsAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkTableAlgorithm
static vtkTableAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkTableAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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
 
 vtkKMeansStatistics ()
 
 ~vtkKMeansStatistics () override
 
void Learn (vtkTable *, vtkTable *, vtkMultiBlockDataSet *) override
 Execute the calculations required by the Learn option. More...
 
void Derive (vtkMultiBlockDataSet *) override
 Execute the calculations required by the Derive option. More...
 
void Assess (vtkTable *, vtkMultiBlockDataSet *, vtkTable *) override
 Execute the calculations required by the Assess option. More...
 
void Test (vtkTable *, vtkMultiBlockDataSet *, vtkTable *) override
 Execute the calculations required by the Test option. More...
 
void SelectAssessFunctor (vtkTable *inData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc) override
 Provide the appropriate assessment functor. More...
 
virtual void UpdateClusterCenters (vtkTable *newClusterElements, vtkTable *curClusterElements, vtkIdTypeArray *numMembershipChanges, vtkIdTypeArray *numElementsInCluster, vtkDoubleArray *error, vtkIdTypeArray *startRunID, vtkIdTypeArray *endRunID, vtkIntArray *computeRun)
 Subroutine to update new cluster centers from the old centers. More...
 
virtual vtkIdType GetTotalNumberOfObservations (vtkIdType numObservations)
 Subroutine to get the total number of observations. More...
 
int InitializeDataAndClusterCenters (vtkTable *inParameters, vtkTable *inData, vtkTable *dataElements, vtkIdTypeArray *numberOfClusters, vtkTable *curClusterElements, vtkTable *newClusterElements, vtkIdTypeArray *startRunID, vtkIdTypeArray *endRunID)
 Subroutine to initialize the cluster centers using those provided by the user in input port LEARN_PARAMETERS. More...
 
virtual void CreateInitialClusterCenters (vtkIdType numToAllocate, vtkIdTypeArray *numberOfClusters, vtkTable *inData, vtkTable *curClusterElements, vtkTable *newClusterElements)
 Subroutine to initialize cluster centerss if not provided by the user. More...
 
- Protected Member Functions inherited from vtkStatisticsAlgorithm
 vtkStatisticsAlgorithm ()
 
 ~vtkStatisticsAlgorithm () override
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
void Assess (vtkTable *, vtkMultiBlockDataSet *, vtkTable *, int)
 A convenience implementation for generic assessment with variable number of variables. More...
 
- Protected Member Functions inherited from vtkTableAlgorithm
 vtkTableAlgorithm ()
 
 ~vtkTableAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int DefaultNumberOfClusters
 This is the default number of clusters used when the user does not provide initial cluster centers. More...
 
char * KValuesArrayName
 This is the name of the column that specifies the number of clusters in each run. More...
 
int MaxNumIterations
 This is the maximum number of iterations allowed if the new cluster centers have not yet converged. More...
 
double Tolerance
 This is the percentage of data elements that swap cluster IDs. More...
 
vtkKMeansDistanceFunctorDistanceFunctor
 This is the Distance functor. More...
 
- Protected Attributes inherited from vtkStatisticsAlgorithm
vtkIdType NumberOfPrimaryTables
 
bool LearnOption
 
bool DeriveOption
 
bool AssessOption
 
bool TestOption
 
vtkStringArrayAssessNames
 
vtkStatisticsAlgorithmPrivateInternals
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

A class for KMeans clustering.

This class takes as input an optional vtkTable on port LEARN_PARAMETERS specifying initial set(s) of cluster values of the following form:

          K     | Col1            |  ...    | ColN
     -----------+-----------------+---------+---------------
          M     |clustCoord(1, 1) |  ...    | clustCoord(1, N)
          M     |clustCoord(2, 1) |  ...    | clustCoord(2, N)
          .     |       .         |   .     |        .
          .     |       .         |   .     |        .
          .     |       .         |   .     |        .
          M     |clustCoord(M, 1) |  ...    | clustCoord(M, N)
          L     |clustCoord(1, 1) |  ...    | clustCoord(1, N)
          L     |clustCoord(2, 1) |  ...    | clustCoord(2, N)
          .     |       .         |   .     |        .
          .     |       .         |   .     |        .
          .     |       .         |   .     |        .
          L     |clustCoord(L, 1) |  ...    | clustCoord(L, N)

Because the desired value of K is often not known in advance and the results of the algorithm are dependent on the initial cluster centers, we provide a mechanism for the user to test multiple runs or sets of cluster centers within a single call to the Learn phase. The first column of the table identifies the number of clusters K in the particular run (the entries in this column should be of type vtkIdType), while the remaining columns are a subset of the columns contained in the table on port INPUT_DATA. We require that all user specified clusters be of the same dimension N and consequently, that the LEARN_PARAMETERS table have N+1 columns. Due to this restriction, only one request can be processed for each call to the Learn phase and subsequent requests are silently ignored. Note that, if the first column of the LEARN_PARAMETERS table is not of type vtkIdType, then the table will be ignored and a single run will be performed using the first DefaultNumberOfClusters input data observations as initial cluster centers.

When the user does not supply an initial set of clusters, then the first DefaultNumberOfClusters input data observations are used as initial cluster centers and a single run is performed.

This class provides the following functionalities, depending on the operation in which it is executed:

The code can handle a wide variety of data types as it operates on vtkAbstractArrays and is not limited to vtkDataArrays. A default distance functor that computes the sum of the squares of the Euclidean distance between two objects is provided (vtkKMeansDistanceFunctor). The default distance functor can be overridden to use alternative distance metrics.

Thanks:
Thanks to Janine Bennett, David Thompson, and Philippe Pebay of Sandia National Laboratories for implementing this class. Updated by Philippe Pebay, Kitware SAS 2012
Examples:
vtkKMeansStatistics (Examples)
Tests:
vtkKMeansStatistics (Tests)

Definition at line 114 of file vtkKMeansStatistics.h.

Member Typedef Documentation

Definition at line 117 of file vtkKMeansStatistics.h.

Constructor & Destructor Documentation

vtkKMeansStatistics::vtkKMeansStatistics ( )
protected
vtkKMeansStatistics::~vtkKMeansStatistics ( )
overrideprotected

Member Function Documentation

static int vtkKMeansStatistics::IsTypeOf ( const char *  type)
static
virtual int vtkKMeansStatistics::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 vtkStatisticsAlgorithm.

Reimplemented in vtkPKMeansStatistics.

static vtkKMeansStatistics* vtkKMeansStatistics::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkKMeansStatistics::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkStatisticsAlgorithm.

Reimplemented in vtkPKMeansStatistics.

vtkKMeansStatistics* vtkKMeansStatistics::NewInstance ( ) const
void vtkKMeansStatistics::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 vtkTableAlgorithm.

static vtkKMeansStatistics* vtkKMeansStatistics::New ( )
static
virtual void vtkKMeansStatistics::SetDistanceFunctor ( vtkKMeansDistanceFunctor )
virtual

Set the DistanceFunctor.

virtual vtkKMeansDistanceFunctor* vtkKMeansStatistics::GetDistanceFunctor ( )
virtual

Set the DistanceFunctor.

virtual void vtkKMeansStatistics::SetDefaultNumberOfClusters ( int  )
virtual

Set/get the DefaultNumberOfClusters, used when no initial cluster coordinates are specified.

virtual int vtkKMeansStatistics::GetDefaultNumberOfClusters ( )
virtual

Set/get the DefaultNumberOfClusters, used when no initial cluster coordinates are specified.

virtual void vtkKMeansStatistics::SetKValuesArrayName ( const char *  )
virtual

Set/get the KValuesArrayName.

virtual char* vtkKMeansStatistics::GetKValuesArrayName ( )
virtual

Set/get the KValuesArrayName.

virtual void vtkKMeansStatistics::SetMaxNumIterations ( int  )
virtual

Set/get the MaxNumIterations used to terminate iterations on cluster center coordinates when the relative tolerance can not be met.

virtual int vtkKMeansStatistics::GetMaxNumIterations ( )
virtual

Set/get the MaxNumIterations used to terminate iterations on cluster center coordinates when the relative tolerance can not be met.

virtual void vtkKMeansStatistics::SetTolerance ( double  )
virtual

Set/get the relative Tolerance used to terminate iterations on cluster center coordinates.

virtual double vtkKMeansStatistics::GetTolerance ( )
virtual

Set/get the relative Tolerance used to terminate iterations on cluster center coordinates.

void vtkKMeansStatistics::Aggregate ( vtkDataObjectCollection ,
vtkMultiBlockDataSet  
)
inlineoverridevirtual

Given a collection of models, calculate aggregate model NB: not implemented.

Implements vtkStatisticsAlgorithm.

Definition at line 167 of file vtkKMeansStatistics.h.

bool vtkKMeansStatistics::SetParameter ( const char *  parameter,
int  index,
vtkVariant  value 
)
overridevirtual

A convenience method for setting properties by name.

Reimplemented from vtkStatisticsAlgorithm.

void vtkKMeansStatistics::Learn ( vtkTable ,
vtkTable ,
vtkMultiBlockDataSet  
)
overrideprotectedvirtual

Execute the calculations required by the Learn option.

Implements vtkStatisticsAlgorithm.

void vtkKMeansStatistics::Derive ( vtkMultiBlockDataSet )
overrideprotectedvirtual

Execute the calculations required by the Derive option.

Implements vtkStatisticsAlgorithm.

void vtkKMeansStatistics::Assess ( vtkTable ,
vtkMultiBlockDataSet ,
vtkTable  
)
overrideprotectedvirtual

Execute the calculations required by the Assess option.

Implements vtkStatisticsAlgorithm.

void vtkKMeansStatistics::Test ( vtkTable ,
vtkMultiBlockDataSet ,
vtkTable  
)
inlineoverrideprotectedvirtual

Execute the calculations required by the Test option.

Implements vtkStatisticsAlgorithm.

Definition at line 202 of file vtkKMeansStatistics.h.

void vtkKMeansStatistics::SelectAssessFunctor ( vtkTable inData,
vtkDataObject inMeta,
vtkStringArray rowNames,
AssessFunctor *&  dfunc 
)
overrideprotectedvirtual

Provide the appropriate assessment functor.

Implements vtkStatisticsAlgorithm.

virtual void vtkKMeansStatistics::UpdateClusterCenters ( vtkTable newClusterElements,
vtkTable curClusterElements,
vtkIdTypeArray numMembershipChanges,
vtkIdTypeArray numElementsInCluster,
vtkDoubleArray error,
vtkIdTypeArray startRunID,
vtkIdTypeArray endRunID,
vtkIntArray computeRun 
)
protectedvirtual

Subroutine to update new cluster centers from the old centers.

Called from within Learn (and will be overridden by vtkPKMeansStatistics to handle distributed datasets).

Reimplemented in vtkPKMeansStatistics.

virtual vtkIdType vtkKMeansStatistics::GetTotalNumberOfObservations ( vtkIdType  numObservations)
protectedvirtual

Subroutine to get the total number of observations.

Called from within Learn (and will be overridden by vtkPKMeansStatistics to handle distributed datasets).

Reimplemented in vtkPKMeansStatistics.

int vtkKMeansStatistics::InitializeDataAndClusterCenters ( vtkTable inParameters,
vtkTable inData,
vtkTable dataElements,
vtkIdTypeArray numberOfClusters,
vtkTable curClusterElements,
vtkTable newClusterElements,
vtkIdTypeArray startRunID,
vtkIdTypeArray endRunID 
)
protected

Subroutine to initialize the cluster centers using those provided by the user in input port LEARN_PARAMETERS.

If no cluster centers are provided, the subroutine uses the first DefaultNumberOfClusters input data points as initial cluster centers. Called from within Learn.

virtual void vtkKMeansStatistics::CreateInitialClusterCenters ( vtkIdType  numToAllocate,
vtkIdTypeArray numberOfClusters,
vtkTable inData,
vtkTable curClusterElements,
vtkTable newClusterElements 
)
protectedvirtual

Subroutine to initialize cluster centerss if not provided by the user.

Called from within Learn (and will be overridden by vtkPKMeansStatistics to handle distributed datasets).

Reimplemented in vtkPKMeansStatistics.

Member Data Documentation

int vtkKMeansStatistics::DefaultNumberOfClusters
protected

This is the default number of clusters used when the user does not provide initial cluster centers.

Definition at line 265 of file vtkKMeansStatistics.h.

char* vtkKMeansStatistics::KValuesArrayName
protected

This is the name of the column that specifies the number of clusters in each run.

This is only used if the user has not specified initial clusters.

Definition at line 270 of file vtkKMeansStatistics.h.

int vtkKMeansStatistics::MaxNumIterations
protected

This is the maximum number of iterations allowed if the new cluster centers have not yet converged.

Definition at line 274 of file vtkKMeansStatistics.h.

double vtkKMeansStatistics::Tolerance
protected

This is the percentage of data elements that swap cluster IDs.

Definition at line 278 of file vtkKMeansStatistics.h.

vtkKMeansDistanceFunctor* vtkKMeansStatistics::DistanceFunctor
protected

This is the Distance functor.

The default is Euclidean distance, however this can be overridden.

Definition at line 282 of file vtkKMeansStatistics.h.


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