VTK  9.3.20240329
vtkKMeansStatistics.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-FileCopyrightText: Copyright 2010 Sandia Corporation
3 // SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
103 #ifndef vtkKMeansStatistics_h
104 #define vtkKMeansStatistics_h
105 
106 #include "vtkFiltersStatisticsModule.h" // For export macro
107 #include "vtkStatisticsAlgorithm.h"
108 
109 VTK_ABI_NAMESPACE_BEGIN
110 class vtkIdTypeArray;
111 class vtkIntArray;
112 class vtkDoubleArray;
115 
116 class VTKFILTERSSTATISTICS_EXPORT vtkKMeansStatistics : public vtkStatisticsAlgorithm
117 {
118 public:
120  void PrintSelf(ostream& os, vtkIndent indent) override;
122 
124 
128  vtkGetObjectMacro(DistanceFunctor, vtkKMeansDistanceFunctor);
130 
132 
135  vtkSetMacro(DefaultNumberOfClusters, int);
136  vtkGetMacro(DefaultNumberOfClusters, int);
138 
140 
143  vtkSetStringMacro(KValuesArrayName);
144  vtkGetStringMacro(KValuesArrayName);
146 
148 
152  vtkSetMacro(MaxNumIterations, int);
153  vtkGetMacro(MaxNumIterations, int);
155 
157 
161  vtkSetMacro(Tolerance, double);
162  vtkGetMacro(Tolerance, double);
164 
170 
174  bool SetParameter(const char* parameter, int index, vtkVariant value) override;
175 
177 
187  vtkSetMacro(GhostsToSkip, unsigned char);
188  vtkGetMacro(GhostsToSkip, unsigned char);
190 
191 protected:
194 
196 
201 
205  void Derive(vtkMultiBlockDataSet*) override;
206 
211 
216 
220  void SelectAssessFunctor(vtkTable* inData, vtkDataObject* inMeta, vtkStringArray* rowNames,
221  AssessFunctor*& dfunc) override;
222 
228  virtual void UpdateClusterCenters(vtkTable* newClusterElements, vtkTable* curClusterElements,
229  vtkIdTypeArray* numMembershipChanges, vtkIdTypeArray* numDataElementsInCluster,
230  vtkDoubleArray* error, vtkIdTypeArray* startRunID, vtkIdTypeArray* endRunID,
231  vtkIntArray* computeRun);
232 
239 
247  vtkTable* dataElements, vtkIdTypeArray* numberOfClusters, vtkTable* curClusterElements,
248  vtkTable* newClusterElements, vtkIdTypeArray* startRunID, vtkIdTypeArray* endRunID);
249 
255  virtual void CreateInitialClusterCenters(vtkIdType numToAllocate,
256  vtkIdTypeArray* numberOfClusters, vtkTable* inData, vtkTable* curClusterElements,
257  vtkTable* newClusterElements);
258 
277  double Tolerance;
283 
288 
289  unsigned char GhostsToSkip;
290 
291 private:
292  vtkKMeansStatistics(const vtkKMeansStatistics&) = delete;
293  void operator=(const vtkKMeansStatistics&) = delete;
294 };
295 
296 VTK_ABI_NAMESPACE_END
297 #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:108
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
dynamic, self-adjusting array of int
Definition: vtkIntArray.h:144
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.
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
static vtkKMeansStatistics * New()
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:168
A type representing the union of many types.
Definition: vtkVariant.h:162
@ value
Definition: vtkX3D.h:220
@ parameter
Definition: vtkX3D.h:443
@ index
Definition: vtkX3D.h:246
int vtkIdType
Definition: vtkType.h:315