vtkConnectedPointsFilter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkConnectedPointsFilter_h
#define vtkConnectedPointsFilter_h
 
#include "vtkFiltersPointsModule.h" // For export macro
#include "vtkPolyDataAlgorithm.h"
 
// Make these consistent with the other connectivity filters
#define VTK_EXTRACT_POINT_SEEDED_REGIONS 1
#define VTK_EXTRACT_SPECIFIED_REGIONS 3
#define VTK_EXTRACT_LARGEST_REGION 4
#define VTK_EXTRACT_ALL_REGIONS 5
#define VTK_EXTRACT_CLOSEST_POINT_REGION 6
 
VTK_ABI_NAMESPACE_BEGIN
class vtkAbstractPointLocator;
class vtkDataArray;
class vtkFloatArray;
class vtkIdList;
class vtkIdTypeArray;
class vtkIntArray;
 
class VTKFILTERSPOINTS_EXPORT vtkConnectedPointsFilter : public vtkPolyDataAlgorithm
{
public:
  vtkTypeMacro(vtkConnectedPointsFilter, vtkPolyDataAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkConnectedPointsFilter* New();


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


  vtkSetClampMacro(
    ExtractionMode, int, VTK_EXTRACT_POINT_SEEDED_REGIONS, VTK_EXTRACT_CLOSEST_POINT_REGION);
  vtkGetMacro(ExtractionMode, int);
  void SetExtractionModeToPointSeededRegions()
  {
    this->SetExtractionMode(VTK_EXTRACT_POINT_SEEDED_REGIONS);
  }
  void SetExtractionModeToLargestRegion() { this->SetExtractionMode(VTK_EXTRACT_LARGEST_REGION); }
  void SetExtractionModeToSpecifiedRegions()
  {
    this->SetExtractionMode(VTK_EXTRACT_SPECIFIED_REGIONS);
  }
  void SetExtractionModeToClosestPointRegion()
  {
    this->SetExtractionMode(VTK_EXTRACT_CLOSEST_POINT_REGION);
  }
  void SetExtractionModeToAllRegions() { this->SetExtractionMode(VTK_EXTRACT_ALL_REGIONS); }
  const char* GetExtractionModeAsString();


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

  void InitializeSeedList();

  void AddSeed(vtkIdType id);

  void DeleteSeed(vtkIdType id);

  void InitializeSpecifiedRegionList();

  void AddSpecifiedRegion(vtkIdType id);

  void DeleteSpecifiedRegion(vtkIdType id);


  vtkSetMacro(AlignedNormals, int);
  vtkGetMacro(AlignedNormals, int);
  vtkBooleanMacro(AlignedNormals, int);


  vtkSetClampMacro(NormalAngle, double, 0.0001, 90.0);
  vtkGetMacro(NormalAngle, double);


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


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

  int GetNumberOfExtractedRegions();


  void SetLocator(vtkAbstractPointLocator* locator);
  vtkGetObjectMacro(Locator, vtkAbstractPointLocator);
 
protected:
  vtkConnectedPointsFilter();
  ~vtkConnectedPointsFilter() override;
 
  // Usual data generation method
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int FillInputPortInformation(int port, vtkInformation* info) override;
 
  // The radius defines the proximal neighborhood of points
  double Radius;
 
  // indicate how to extract regions
  int ExtractionMode;
 
  // id's of points used to seed regions
  vtkIdList* Seeds;
 
  // regions specified for extraction
  vtkIdList* SpecifiedRegionIds;
 
  // Seed with a closest point
  double ClosestPoint[3];
 
  // Segment based on nearly aligned normals
  int AlignedNormals;
  double NormalAngle;
  double NormalThreshold;
 
  // Support segmentation based on scalar connectivity
  int ScalarConnectivity;
  double ScalarRange[2];
 
  // accelerate searching
  vtkAbstractPointLocator* Locator;
 
  // Wave propagation used to segment points
  void TraverseAndMark(
    vtkPoints* inPts, vtkDataArray* inScalars, float* normals, vtkIdType* labels);
 
private:
  // used to support algorithm execution
  vtkIdType CurrentRegionNumber;
  vtkIdTypeArray* RegionLabels;
  vtkIdType NumPointsInRegion;
  vtkIdTypeArray* RegionSizes;
  vtkIdList* NeighborPointIds; // avoid repetitive new/delete
  vtkIdList* Wave;
  vtkIdList* Wave2;
 
  vtkConnectedPointsFilter(const vtkConnectedPointsFilter&) = delete;
  void operator=(const vtkConnectedPointsFilter&) = delete;
};

inline const char* vtkConnectedPointsFilter::GetExtractionModeAsString()
{
  if (this->ExtractionMode == VTK_EXTRACT_POINT_SEEDED_REGIONS)
  {
    return "ExtractPointSeededRegions";
  }
  else if (this->ExtractionMode == VTK_EXTRACT_SPECIFIED_REGIONS)
  {
    return "ExtractSpecifiedRegions";
  }
  else if (this->ExtractionMode == VTK_EXTRACT_ALL_REGIONS)
  {
    return "ExtractAllRegions";
  }
  else if (this->ExtractionMode == VTK_EXTRACT_CLOSEST_POINT_REGION)
  {
    return "ExtractClosestPointRegion";
  }
  else
  {
    return "ExtractLargestRegion";
  }
}
 
VTK_ABI_NAMESPACE_END
#endif