VTK  9.0.1
vtkConnectivityFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkConnectivityFilter.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
57 #ifndef vtkConnectivityFilter_h
58 #define vtkConnectivityFilter_h
59 
60 #include "vtkFiltersCoreModule.h" // For export macro
61 #include "vtkPointSetAlgorithm.h"
62 
63 #define VTK_EXTRACT_POINT_SEEDED_REGIONS 1
64 #define VTK_EXTRACT_CELL_SEEDED_REGIONS 2
65 #define VTK_EXTRACT_SPECIFIED_REGIONS 3
66 #define VTK_EXTRACT_LARGEST_REGION 4
67 #define VTK_EXTRACT_ALL_REGIONS 5
68 #define VTK_EXTRACT_CLOSEST_POINT_REGION 6
69 
70 class vtkDataArray;
71 class vtkDataSet;
72 class vtkFloatArray;
73 class vtkIdList;
74 class vtkIdTypeArray;
75 class vtkIntArray;
76 class vtkPolyData;
77 
78 class VTKFILTERSCORE_EXPORT vtkConnectivityFilter : public vtkPointSetAlgorithm
79 {
80 public:
82  void PrintSelf(ostream& os, vtkIndent indent) override;
83 
87  static vtkConnectivityFilter* New();
88 
90 
95  vtkSetMacro(ScalarConnectivity, vtkTypeBool);
96  vtkGetMacro(ScalarConnectivity, vtkTypeBool);
97  vtkBooleanMacro(ScalarConnectivity, vtkTypeBool);
99 
101 
104  vtkSetVector2Macro(ScalarRange, double);
105  vtkGetVector2Macro(ScalarRange, double);
107 
109 
112  vtkSetClampMacro(
114  vtkGetMacro(ExtractionMode, int);
116  {
117  this->SetExtractionMode(VTK_EXTRACT_POINT_SEEDED_REGIONS);
118  }
120  {
121  this->SetExtractionMode(VTK_EXTRACT_CELL_SEEDED_REGIONS);
122  }
125  {
126  this->SetExtractionMode(VTK_EXTRACT_SPECIFIED_REGIONS);
127  }
129  {
130  this->SetExtractionMode(VTK_EXTRACT_CLOSEST_POINT_REGION);
131  }
132  void SetExtractionModeToAllRegions() { this->SetExtractionMode(VTK_EXTRACT_ALL_REGIONS); }
133  const char* GetExtractionModeAsString();
135 
139  void InitializeSeedList();
140 
144  void AddSeed(vtkIdType id);
145 
149  void DeleteSeed(vtkIdType id);
150 
154  void InitializeSpecifiedRegionList();
155 
159  void AddSpecifiedRegion(int id);
160 
164  void DeleteSpecifiedRegion(int id);
165 
167 
171  vtkSetVector3Macro(ClosestPoint, double);
172  vtkGetVectorMacro(ClosestPoint, double, 3);
174 
178  int GetNumberOfExtractedRegions();
179 
181 
184  vtkSetMacro(ColorRegions, vtkTypeBool);
185  vtkGetMacro(ColorRegions, vtkTypeBool);
186  vtkBooleanMacro(ColorRegions, vtkTypeBool);
188 
194  {
197  CELL_COUNT_ASCENDING
198  };
199 
201 
205  vtkSetMacro(RegionIdAssignmentMode, int);
206  vtkGetMacro(RegionIdAssignmentMode, int);
207 
209 
214  vtkSetMacro(OutputPointsPrecision, int);
215  vtkGetMacro(OutputPointsPrecision, int);
217 
218 protected:
220  ~vtkConnectivityFilter() override;
221 
224 
225  // Usual data generation method
226  int RequestDataObject(vtkInformation* request, vtkInformationVector** inputVector,
227  vtkInformationVector* outputVector) override;
229  int FillInputPortInformation(int port, vtkInformation* info) override;
230  int FillOutputPortInformation(int vtkNotUsed(port), vtkInformation* info) override;
231 
232  vtkTypeBool ColorRegions; // boolean turns on/off scalar gen for separate regions
233  int ExtractionMode; // how to extract regions
235  vtkIdList* Seeds; // id's of points or cells used to seed regions
236  vtkIdList* SpecifiedRegionIds; // regions specified for extraction
237  vtkIdTypeArray* RegionSizes; // size (in cells) of each region extracted
238 
239  double ClosestPoint[3];
240 
242  double ScalarRange[2];
243 
245 
246  void TraverseAndMark(vtkDataSet* input);
247 
248  void OrderRegionIds(vtkIdTypeArray* pointRegionIds, vtkIdTypeArray* cellRegionIds);
249 
250 private:
251  // used to support algorithm execution
252  vtkFloatArray* CellScalars;
253  vtkIdList* NeighborCellPointIds;
254  vtkIdType* Visited;
255  vtkIdType* PointMap;
256  vtkIdTypeArray* NewScalars;
257  vtkIdTypeArray* NewCellScalars;
258  vtkIdType RegionNumber;
259  vtkIdType PointNumber;
260  vtkIdType NumCellsInRegion;
261  vtkDataArray* InScalars;
262  vtkIdList* Wave;
263  vtkIdList* Wave2;
264  vtkIdList* PointIds;
265  vtkIdList* CellIds;
266 
267 private:
269  void operator=(const vtkConnectivityFilter&) = delete;
270 };
271 
273 
277 {
279  {
280  return "ExtractPointSeededRegions";
281  }
283  {
284  return "ExtractCellSeededRegions";
285  }
287  {
288  return "ExtractSpecifiedRegions";
289  }
290  else if (this->ExtractionMode == VTK_EXTRACT_ALL_REGIONS)
291  {
292  return "ExtractAllRegions";
293  }
295  {
296  return "ExtractClosestPointRegion";
297  }
298  else
299  {
300  return "ExtractLargestRegion";
301  }
302 }
304 
305 #endif
vtkConnectivityFilter::GetExtractionModeAsString
const char * GetExtractionModeAsString()
Return the method of extraction as a string.
Definition: vtkConnectivityFilter.h:276
vtkConnectivityFilter::RegionSizes
vtkIdTypeArray * RegionSizes
Definition: vtkConnectivityFilter.h:237
vtkConnectivityFilter::SpecifiedRegionIds
vtkIdList * SpecifiedRegionIds
Definition: vtkConnectivityFilter.h:236
vtkPointSetAlgorithm
Superclass for algorithms that produce output of the same type as input.
Definition: vtkPointSetAlgorithm.h:43
vtkIdType
int vtkIdType
Definition: vtkType.h:338
vtkFloatArray
dynamic, self-adjusting array of float
Definition: vtkFloatArray.h:35
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:35
vtkConnectivityFilter
extract data based on geometric connectivity
Definition: vtkConnectivityFilter.h:78
VTK_EXTRACT_LARGEST_REGION
#define VTK_EXTRACT_LARGEST_REGION
Definition: vtkConnectivityFilter.h:66
vtkPointSetAlgorithm.h
vtkConnectivityFilter::SetExtractionModeToCellSeededRegions
void SetExtractionModeToCellSeededRegions()
Definition: vtkConnectivityFilter.h:119
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:49
VTK_EXTRACT_SPECIFIED_REGIONS
#define VTK_EXTRACT_SPECIFIED_REGIONS
Definition: vtkConnectivityFilter.h:65
vtkConnectivityFilter::ScalarConnectivity
vtkTypeBool ScalarConnectivity
Definition: vtkConnectivityFilter.h:241
vtkConnectivityFilter::ColorRegions
vtkTypeBool ColorRegions
Definition: vtkConnectivityFilter.h:232
vtkConnectivityFilter::UNSPECIFIED
@ UNSPECIFIED
Definition: vtkConnectivityFilter.h:195
vtkConnectivityFilter::ExtractionMode
int ExtractionMode
Definition: vtkConnectivityFilter.h:233
vtkPointSetAlgorithm::ProcessRequest
vtkTypeBool ProcessRequest(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
see vtkAlgorithm for details
vtkX3D::port
@ port
Definition: vtkX3D.h:453
vtkConnectivityFilter::OutputPointsPrecision
int OutputPointsPrecision
Definition: vtkConnectivityFilter.h:234
vtkPointSetAlgorithm::RequestData
virtual int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called by the superclass.
Definition: vtkPointSetAlgorithm.h:131
VTK_EXTRACT_CLOSEST_POINT_REGION
#define VTK_EXTRACT_CLOSEST_POINT_REGION
Definition: vtkConnectivityFilter.h:68
vtkPointSetAlgorithm::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkConnectivityFilter::RegionIdAssignment
RegionIdAssignment
Enumeration of the various ways to assign RegionIds when the ColorRegions option is on.
Definition: vtkConnectivityFilter.h:193
vtkPointSetAlgorithm::FillOutputPortInformation
int FillOutputPortInformation(int port, vtkInformation *info) override
Fill the output port information objects for this algorithm.
VTK_EXTRACT_CELL_SEEDED_REGIONS
#define VTK_EXTRACT_CELL_SEEDED_REGIONS
Definition: vtkConnectivityFilter.h:64
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkIntArray
dynamic, self-adjusting array of int
Definition: vtkIntArray.h:39
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:30
vtkConnectivityFilter::CELL_COUNT_DESCENDING
@ CELL_COUNT_DESCENDING
Definition: vtkConnectivityFilter.h:196
vtkConnectivityFilter::RegionIdAssignmentMode
int RegionIdAssignmentMode
Definition: vtkConnectivityFilter.h:244
vtkConnectivityFilter::SetExtractionModeToSpecifiedRegions
void SetExtractionModeToSpecifiedRegions()
Definition: vtkConnectivityFilter.h:124
VTK_EXTRACT_POINT_SEEDED_REGIONS
#define VTK_EXTRACT_POINT_SEEDED_REGIONS
Definition: vtkConnectivityFilter.h:63
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:56
vtkConnectivityFilter::Seeds
vtkIdList * Seeds
Definition: vtkConnectivityFilter.h:235
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:73
vtkPointSetAlgorithm::FillInputPortInformation
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
vtkX3D::info
@ info
Definition: vtkX3D.h:382
vtkIdTypeArray
dynamic, self-adjusting array of vtkIdType
Definition: vtkIdTypeArray.h:35
vtkConnectivityFilter::SetExtractionModeToAllRegions
void SetExtractionModeToAllRegions()
Definition: vtkConnectivityFilter.h:132
vtkConnectivityFilter::SetExtractionModeToClosestPointRegion
void SetExtractionModeToClosestPointRegion()
Definition: vtkConnectivityFilter.h:128
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:84
VTK_EXTRACT_ALL_REGIONS
#define VTK_EXTRACT_ALL_REGIONS
Definition: vtkConnectivityFilter.h:67
vtkConnectivityFilter::SetExtractionModeToLargestRegion
void SetExtractionModeToLargestRegion()
Definition: vtkConnectivityFilter.h:123
vtkPointSetAlgorithm::New
static vtkPointSetAlgorithm * New()
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkConnectivityFilter::SetExtractionModeToPointSeededRegions
void SetExtractionModeToPointSeededRegions()
Definition: vtkConnectivityFilter.h:115
vtkPointSetAlgorithm::RequestDataObject
virtual int RequestDataObject(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
This is called by the superclass.