vtkConnectivityFilter.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 vtkConnectivityFilter_h
#define vtkConnectivityFilter_h
 
#include "vtkFiltersCoreModule.h" // For export macro
#include "vtkPointSetAlgorithm.h"
 
#include "vtkNew.h" // for member
 
#define VTK_EXTRACT_POINT_SEEDED_REGIONS 1
#define VTK_EXTRACT_CELL_SEEDED_REGIONS 2
#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 vtkDataArray;
class vtkDataSet;
class vtkFloatArray;
class vtkIdList;
class vtkIdTypeArray;
class vtkIntArray;
class vtkPolyData;
 
class VTKFILTERSCORE_EXPORT vtkConnectivityFilter : public vtkPointSetAlgorithm
{
public:
  vtkTypeMacro(vtkConnectivityFilter, vtkPointSetAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkConnectivityFilter* New();


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


  vtkSetVector2Macro(ScalarRange, double);
  vtkGetVector2Macro(ScalarRange, 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 SetExtractionModeToCellSeededRegions()
  {
    this->SetExtractionMode(VTK_EXTRACT_CELL_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();

  void InitializeSeedList();

  void AddSeed(vtkIdType id);

  void DeleteSeed(vtkIdType id);

  void InitializeSpecifiedRegionList();

  void AddSpecifiedRegion(int id);

  void DeleteSpecifiedRegion(int id);


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

  int GetNumberOfExtractedRegions();


  vtkSetMacro(ColorRegions, vtkTypeBool);
  vtkGetMacro(ColorRegions, vtkTypeBool);
  vtkBooleanMacro(ColorRegions, vtkTypeBool);

  enum RegionIdAssignment
  {
    UNSPECIFIED,
    CELL_COUNT_DESCENDING,
    CELL_COUNT_ASCENDING
  };


  vtkSetMacro(RegionIdAssignmentMode, int);
  vtkGetMacro(RegionIdAssignmentMode, int);


  vtkSetMacro(OutputPointsPrecision, int);
  vtkGetMacro(OutputPointsPrecision, int);


  vtkSetMacro(CompressArrays, bool);
  vtkGetMacro(CompressArrays, bool);
  vtkBooleanMacro(CompressArrays, bool);
 
protected:
  vtkConnectivityFilter();
  ~vtkConnectivityFilter() override;


  vtkTypeBool ProcessRequest(
    vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestDataObject(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  // Requires a vtkDataSet
  int FillInputPortInformation(int port, vtkInformation* info) override;
  // Outputs a vtkDataSet
  int FillOutputPortInformation(int vtkNotUsed(port), vtkInformation* info) override;

  void AddRegionsIds(vtkDataSet* output, vtkDataArray* pointArray, vtkDataArray* cellArray);
 
  // boolean turns on/off scalar gen for separate regions
  vtkTypeBool ColorRegions = 0;
  // how to extract regions
  int ExtractionMode = VTK_EXTRACT_LARGEST_REGION;
  int OutputPointsPrecision = vtkAlgorithm::DEFAULT_PRECISION;
  // id's of points or cells used to seed regions
  vtkIdList* Seeds = nullptr;
  // regions specified for extraction
  vtkIdList* SpecifiedRegionIds = nullptr;
  // size (in cells) of each region extracted
  vtkIdTypeArray* RegionSizes = nullptr;
 
  double ClosestPoint[3] = { 0, 0, 0 };
 
  vtkTypeBool ScalarConnectivity = 0;
  double ScalarRange[2] = { 0, 1 };
 
  int RegionIdAssignmentMode = UNSPECIFIED;

  void TraverseAndMark(vtkDataSet* input);
 
  void OrderRegionIds(vtkIdTypeArray* pointRegionIds, vtkIdTypeArray* cellRegionIds);

  vtkSmartPointer<vtkDataArray> CompressWithImplicit(vtkDataArray* array);
 
private:
  // used to support algorithm execution
  vtkNew<vtkFloatArray> CellScalars;
  vtkNew<vtkIdList> NeighborCellPointIds;
  vtkIdType* Visited = nullptr;
  vtkIdType* PointMap = nullptr;
  vtkNew<vtkIdTypeArray> NewScalars;
  vtkNew<vtkIdTypeArray> NewCellScalars;
  vtkIdType RegionNumber = 0;
  vtkIdType PointNumber = 0;
  vtkIdType NumCellsInRegion = 0;
  vtkDataArray* InScalars = nullptr;
  vtkIdList* Wave = nullptr;
  vtkIdList* Wave2 = nullptr;
  vtkIdList* PointIds = nullptr;
  vtkIdList* CellIds = nullptr;
  bool CompressArrays = true;
 
  vtkConnectivityFilter(const vtkConnectivityFilter&) = delete;
  void operator=(const vtkConnectivityFilter&) = delete;
};

inline const char* vtkConnectivityFilter::GetExtractionModeAsString()
{
  if (this->ExtractionMode == VTK_EXTRACT_POINT_SEEDED_REGIONS)
  {
    return "ExtractPointSeededRegions";
  }
  else if (this->ExtractionMode == VTK_EXTRACT_CELL_SEEDED_REGIONS)
  {
    return "ExtractCellSeededRegions";
  }
  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