vtkEuclideanClusterExtraction.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkEuclideanClusterExtraction.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See LICENSE file 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.

=========================================================================*/
#ifndef vtkEuclideanClusterExtraction_h
#define vtkEuclideanClusterExtraction_h

#include "vtkFiltersPointsModule.h" // For export macro
#include "vtkPolyDataAlgorithm.h"

#define VTK_EXTRACT_POINT_SEEDED_CLUSTERS 1
#define VTK_EXTRACT_SPECIFIED_CLUSTERS 2
#define VTK_EXTRACT_LARGEST_CLUSTER 3
#define VTK_EXTRACT_ALL_CLUSTERS 4
#define VTK_EXTRACT_CLOSEST_POINT_CLUSTER 5

class vtkDataArray;
class vtkFloatArray;
class vtkIdList;
class vtkIdTypeArray;
class vtkAbstractPointLocator;


class VTKFILTERSPOINTS_EXPORT vtkEuclideanClusterExtraction : public vtkPolyDataAlgorithm
{
public:
  vtkTypeMacro(vtkEuclideanClusterExtraction,vtkPolyDataAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkEuclideanClusterExtraction *New();


  vtkSetClampMacro(Radius,double,0.0,VTK_FLOAT_MAX);
  vtkGetMacro(Radius,double);


  vtkSetMacro(ScalarConnectivity,bool);
  vtkGetMacro(ScalarConnectivity,bool);
  vtkBooleanMacro(ScalarConnectivity,bool);


  vtkSetVector2Macro(ScalarRange,double);
  vtkGetVector2Macro(ScalarRange,double);


  vtkSetClampMacro(ExtractionMode,int,
            VTK_EXTRACT_POINT_SEEDED_CLUSTERS,VTK_EXTRACT_CLOSEST_POINT_CLUSTER);
  vtkGetMacro(ExtractionMode,int);
  void SetExtractionModeToPointSeededClusters()
    {this->SetExtractionMode(VTK_EXTRACT_POINT_SEEDED_CLUSTERS);};
  void SetExtractionModeToLargestCluster()
    {this->SetExtractionMode(VTK_EXTRACT_LARGEST_CLUSTER);};
  void SetExtractionModeToSpecifiedClusters()
    {this->SetExtractionMode(VTK_EXTRACT_SPECIFIED_CLUSTERS);};
  void SetExtractionModeToClosestPointCluster()
    {this->SetExtractionMode(VTK_EXTRACT_CLOSEST_POINT_CLUSTER);};
  void SetExtractionModeToAllClusters()
    {this->SetExtractionMode(VTK_EXTRACT_ALL_CLUSTERS);};
  const char *GetExtractionModeAsString();

  void InitializeSeedList();

  void AddSeed(vtkIdType id);

  void DeleteSeed(vtkIdType id);

  void InitializeSpecifiedClusterList();

  void AddSpecifiedCluster(int id);

  void DeleteSpecifiedCluster(int id);


  vtkSetVector3Macro(ClosestPoint,double);
  vtkGetVectorMacro(ClosestPoint,double,3);

  int GetNumberOfExtractedClusters();


  vtkSetMacro(ColorClusters,bool);
  vtkGetMacro(ColorClusters,bool);
  vtkBooleanMacro(ColorClusters,bool);


  void SetLocator(vtkAbstractPointLocator *locator);
  vtkGetObjectMacro(Locator,vtkAbstractPointLocator);

protected:
  vtkEuclideanClusterExtraction();
  ~vtkEuclideanClusterExtraction() override;

  double Radius; //connection radius
  bool ColorClusters; //boolean turns on/off scalar gen for separate clusters
  int ExtractionMode; //how to extract clusters
  vtkIdList *Seeds; //id's of points or cells used to seed clusters
  vtkIdList *SpecifiedClusterIds; //clusters specified for extraction
  vtkIdTypeArray *ClusterSizes; //size (in cells) of each cluster extracted

  double ClosestPoint[3];

  bool ScalarConnectivity;
  double ScalarRange[2];

  vtkAbstractPointLocator *Locator;

  // Configure the pipeline
  int RequestData(vtkInformation *, vtkInformationVector **,
                          vtkInformationVector *) override;
  int FillInputPortInformation(int port, vtkInformation *info) override;

  // Internal method for propagating connected waves.
  void InsertIntoWave(vtkIdList *wave, vtkIdType ptId);
  void TraverseAndMark(vtkPoints *pts);

private:
  vtkEuclideanClusterExtraction(const vtkEuclideanClusterExtraction&) = delete;
  void operator=(const vtkEuclideanClusterExtraction&) = delete;

  // used to support algorithm execution
  vtkFloatArray *NeighborScalars;
  vtkIdList *NeighborPointIds;
  char *Visited;
  vtkIdType *PointMap;
  vtkIdTypeArray *NewScalars;
  vtkIdType ClusterNumber;
  vtkIdType PointNumber;
  vtkIdType NumPointsInCluster;
  vtkDataArray *InScalars;
  vtkIdList *Wave;
  vtkIdList *Wave2;
  vtkIdList *PointIds;

};


inline const char *vtkEuclideanClusterExtraction::GetExtractionModeAsString(void)
{
  if ( this->ExtractionMode == VTK_EXTRACT_POINT_SEEDED_CLUSTERS )
  {
    return "ExtractPointSeededClusters";
  }
  else if ( this->ExtractionMode == VTK_EXTRACT_SPECIFIED_CLUSTERS )
  {
    return "ExtractSpecifiedClusters";
  }
  else if ( this->ExtractionMode == VTK_EXTRACT_ALL_CLUSTERS )
  {
    return "ExtractAllClusters";
  }
  else if ( this->ExtractionMode == VTK_EXTRACT_CLOSEST_POINT_CLUSTER )
  {
    return "ExtractClosestPointCluster";
  }
  else
  {
    return "ExtractLargestCluster";
  }
}

#endif