VTK  9.2.6
vtkKMeansStatistics.h
Go to the documentation of this file.
1/*=========================================================================
2
3Program: Visualization Toolkit
4Module: vtkKMeansStatistics.h
5
6Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7All rights reserved.
8See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10This software is distributed WITHOUT ANY WARRANTY; without even
11the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
15/*-------------------------------------------------------------------------
16 Copyright 2010 Sandia Corporation.
17 Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
18 the U.S. Government retains certain rights in this software.
19 -------------------------------------------------------------------------*/
97#ifndef vtkKMeansStatistics_h
98#define vtkKMeansStatistics_h
99
100#include "vtkFiltersStatisticsModule.h" // For export macro
102
103class vtkIdTypeArray;
104class vtkIntArray;
105class vtkDoubleArray;
108
109class VTKFILTERSSTATISTICS_EXPORT vtkKMeansStatistics : public vtkStatisticsAlgorithm
110{
111public:
113 void PrintSelf(ostream& os, vtkIndent indent) override;
115
117
121 vtkGetObjectMacro(DistanceFunctor, vtkKMeansDistanceFunctor);
123
125
128 vtkSetMacro(DefaultNumberOfClusters, int);
129 vtkGetMacro(DefaultNumberOfClusters, int);
131
133
136 vtkSetStringMacro(KValuesArrayName);
137 vtkGetStringMacro(KValuesArrayName);
139
141
145 vtkSetMacro(MaxNumIterations, int);
146 vtkGetMacro(MaxNumIterations, int);
148
150
154 vtkSetMacro(Tolerance, double);
155 vtkGetMacro(Tolerance, double);
157
163
167 bool SetParameter(const char* parameter, int index, vtkVariant value) override;
168
170
180 vtkSetMacro(GhostsToSkip, unsigned char);
181 vtkGetMacro(GhostsToSkip, unsigned char);
183
184protected:
187
189
194
199
204
208 void Test(vtkTable*, vtkMultiBlockDataSet*, vtkTable*) override { return; }
209
214 AssessFunctor*& dfunc) override;
215
221 virtual void UpdateClusterCenters(vtkTable* newClusterElements, vtkTable* curClusterElements,
222 vtkIdTypeArray* numMembershipChanges, vtkIdTypeArray* numDataElementsInCluster,
223 vtkDoubleArray* error, vtkIdTypeArray* startRunID, vtkIdTypeArray* endRunID,
224 vtkIntArray* computeRun);
225
232
240 vtkTable* dataElements, vtkIdTypeArray* numberOfClusters, vtkTable* curClusterElements,
241 vtkTable* newClusterElements, vtkIdTypeArray* startRunID, vtkIdTypeArray* endRunID);
242
248 virtual void CreateInitialClusterCenters(vtkIdType numToAllocate,
249 vtkIdTypeArray* numberOfClusters, vtkTable* inData, vtkTable* curClusterElements,
250 vtkTable* newClusterElements);
251
270 double Tolerance;
276
281
282 unsigned char GhostsToSkip;
283
284private:
286 void operator=(const vtkKMeansStatistics&) = delete;
287};
288
289#endif
maintain an unordered list of data objects
general representation of visualization data
dynamic, self-adjusting array of double
dynamic, self-adjusting array of vtkIdType
a simple class to control print indentation
Definition vtkIndent.h:34
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
dynamic, self-adjusting array of int
Definition vtkIntArray.h:40
measure distance from k-means cluster centers
A class for KMeans clustering.
int MaxNumIterations
This is the maximum number of iterations allowed if the new cluster centers have not yet converged.
void SelectAssessFunctor(vtkTable *inData, vtkDataObject *inMeta, vtkStringArray *rowNames, AssessFunctor *&dfunc) override
Provide the appropriate assessment functor.
static vtkKMeansStatistics * New()
void Aggregate(vtkDataObjectCollection *, vtkMultiBlockDataSet *) override
Given a collection of models, calculate aggregate model NB: not implemented.
virtual void UpdateClusterCenters(vtkTable *newClusterElements, vtkTable *curClusterElements, vtkIdTypeArray *numMembershipChanges, vtkIdTypeArray *numDataElementsInCluster, vtkDoubleArray *error, vtkIdTypeArray *startRunID, vtkIdTypeArray *endRunID, vtkIntArray *computeRun)
Subroutine to update new cluster centers from the old centers.
char * KValuesArrayName
This is the name of the column that specifies the number of clusters in each run.
vtkIdType NumberOfGhosts
Number of ghosts in input data.
void Learn(vtkTable *, vtkTable *, vtkMultiBlockDataSet *) override
Execute the calculations required by the Learn option.
vtkKMeansDistanceFunctor * DistanceFunctor
This is the Distance functor.
bool SetParameter(const char *parameter, int index, vtkVariant value) override
A convenience method for setting properties by name.
virtual vtkIdType GetTotalNumberOfObservations(vtkIdType numObservations)
Subroutine to get the total number of observations.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int DefaultNumberOfClusters
This is the default number of clusters used when the user does not provide initial cluster centers.
void Derive(vtkMultiBlockDataSet *) override
Execute the calculations required by the Derive option.
void Assess(vtkTable *, vtkMultiBlockDataSet *, vtkTable *) override
Execute the calculations required by the Assess option.
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_PAR...
virtual void CreateInitialClusterCenters(vtkIdType numToAllocate, vtkIdTypeArray *numberOfClusters, vtkTable *inData, vtkTable *curClusterElements, vtkTable *newClusterElements)
Subroutine to initialize cluster centerss if not provided by the user.
~vtkKMeansStatistics() override
double Tolerance
This is the percentage of data elements that swap cluster IDs.
void Test(vtkTable *, vtkMultiBlockDataSet *, vtkTable *) override
Execute the calculations required by the Test option.
virtual void SetDistanceFunctor(vtkKMeansDistanceFunctor *)
Set the DistanceFunctor.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
Composite dataset that organizes datasets into blocks.
A base class for a functor that assesses data.
Base class for statistics algorithms.
a vtkAbstractArray subclass for strings
A table, which contains similar-typed columns of data.
Definition vtkTable.h:68
A atomic type representing the union of many types.
Definition vtkVariant.h:64
int vtkIdType
Definition vtkType.h:332