vtkKMeansStatistics.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2010 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
#ifndef vtkKMeansStatistics_h
#define vtkKMeansStatistics_h

#include "vtkFiltersStatisticsModule.h" // For export macro
#include "vtkStatisticsAlgorithm.h"

VTK_ABI_NAMESPACE_BEGIN
class vtkIdTypeArray;
class vtkIntArray;
class vtkDoubleArray;
class vtkKMeansDistanceFunctor;
class vtkStatisticalModel;

class VTKFILTERSSTATISTICS_EXPORT vtkKMeansStatistics : public vtkStatisticsAlgorithm
{
public:
  vtkTypeMacro(vtkKMeansStatistics, vtkStatisticsAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkKMeansStatistics* New();


  virtual void SetDistanceFunctor(vtkKMeansDistanceFunctor*);
  vtkGetObjectMacro(DistanceFunctor, vtkKMeansDistanceFunctor);


  vtkSetMacro(DefaultNumberOfClusters, int);
  vtkGetMacro(DefaultNumberOfClusters, int);


  vtkSetStringMacro(KValuesArrayName);
  vtkGetStringMacro(KValuesArrayName);


  vtkSetMacro(MaxNumIterations, int);
  vtkGetMacro(MaxNumIterations, int);


  vtkSetMacro(Tolerance, double);
  vtkGetMacro(Tolerance, double);

  bool Aggregate(vtkDataObjectCollection*, vtkStatisticalModel*) override { return false; }

  bool SetParameter(const char* parameter, int index, vtkVariant value) override;

  void AppendAlgorithmParameters(std::string& algorithmParameters) const override;

  std::size_t ConsumeNextAlgorithmParameter(
    vtkStringToken parameterName, const std::string& algorithmParameters) override;

protected:
  vtkKMeansStatistics();
  ~vtkKMeansStatistics() override;

  void Learn(vtkTable*, vtkTable*, vtkStatisticalModel*) override;

  void Derive(vtkStatisticalModel*) override;

  void Assess(vtkTable*, vtkStatisticalModel*, vtkTable*) override;

  void Test(vtkTable*, vtkStatisticalModel*, vtkTable*) override {}

  void SelectAssessFunctor(vtkTable* inData, vtkDataObject* inMeta, vtkStringArray* rowNames,
    AssessFunctor*& dfunc) override;

  virtual void UpdateClusterCenters(vtkTable* newClusterElements, vtkTable* curClusterElements,
    vtkIdTypeArray* numMembershipChanges, vtkIdTypeArray* numDataElementsInCluster,
    vtkDoubleArray* error, vtkIdTypeArray* startRunID, vtkIdTypeArray* endRunID,
    vtkIntArray* computeRun);

  virtual vtkIdType GetTotalNumberOfObservations(vtkIdType numObservations);

  int InitializeDataAndClusterCenters(vtkTable* inParameters, vtkTable* inData,
    vtkTable* dataElements, vtkIdTypeArray* numberOfClusters, vtkTable* curClusterElements,
    vtkTable* newClusterElements, vtkIdTypeArray* startRunID, vtkIdTypeArray* endRunID);

  virtual void CreateInitialClusterCenters(vtkIdType numToAllocate,
    vtkIdTypeArray* numberOfClusters, vtkTable* inData, vtkTable* curClusterElements,
    vtkTable* newClusterElements);

  int DefaultNumberOfClusters;
  char* KValuesArrayName;
  int MaxNumIterations;
  double Tolerance;
  vtkKMeansDistanceFunctor* DistanceFunctor;

private:
  vtkKMeansStatistics(const vtkKMeansStatistics&) = delete;
  void operator=(const vtkKMeansStatistics&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif