vtkKMeansStatistics.h

Go to the documentation of this file.

/*=========================================================================
 
Program:   Visualization Toolkit
Module:    vtkKMeansStatistics.h
 
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
/*-------------------------------------------------------------------------
  Copyright 2010 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
  -------------------------------------------------------------------------*/
#ifndef vtkKMeansStatistics_h
#define vtkKMeansStatistics_h
 
#include "vtkFiltersStatisticsModule.h" // For export macro
#include "vtkStatisticsAlgorithm.h"
 
class vtkIdTypeArray;
class vtkIntArray;
class vtkDoubleArray;
class vtkKMeansDistanceFunctor;
class vtkMultiBlockDataSet;
 
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);
 
  void Aggregate(vtkDataObjectCollection*, vtkMultiBlockDataSet*) override { return; }
 
  bool SetParameter(const char* parameter, int index, vtkVariant value) override;
 
protected:
  vtkKMeansStatistics();
  ~vtkKMeansStatistics() override;
 
  void Learn(vtkTable*, vtkTable*, vtkMultiBlockDataSet*) override;
 
  void Derive(vtkMultiBlockDataSet*) override;
 
  void Assess(vtkTable*, vtkMultiBlockDataSet*, vtkTable*) override;
 
  void Test(vtkTable*, vtkMultiBlockDataSet*, vtkTable*) override { return; }
 
  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;
};
 
#endif