VTK
vtkMaskPoints.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkMaskPoints.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 =========================================================================*/
37 #ifndef vtkMaskPoints_h
38 #define vtkMaskPoints_h
39 
40 #include "vtkFiltersCoreModule.h" // For export macro
41 #include "vtkPolyDataAlgorithm.h"
42 
43 class VTKFILTERSCORE_EXPORT vtkMaskPoints : public vtkPolyDataAlgorithm
44 {
45 public:
46  static vtkMaskPoints *New();
48  void PrintSelf(ostream& os, vtkIndent indent) override;
49 
51 
54  vtkSetClampMacro(OnRatio,int,1,VTK_INT_MAX);
55  vtkGetMacro(OnRatio,int);
57 
59 
63  vtkSetClampMacro(MaximumNumberOfPoints,vtkIdType,0,VTK_ID_MAX);
64  vtkGetMacro(MaximumNumberOfPoints,vtkIdType);
66 
68 
71  vtkSetClampMacro(Offset,vtkIdType,0,VTK_ID_MAX);
72  vtkGetMacro(Offset,vtkIdType);
74 
76 
79  vtkSetMacro(RandomMode,vtkTypeBool);
80  vtkGetMacro(RandomMode,vtkTypeBool);
81  vtkBooleanMacro(RandomMode,vtkTypeBool);
83 
85 
106  vtkSetClampMacro(RandomModeType, int, 0, 2);
107  vtkGetMacro(RandomModeType, int);
109 
111 
124  vtkSetMacro(ProportionalMaximumNumberOfPoints, vtkTypeBool);
125  vtkGetMacro(ProportionalMaximumNumberOfPoints, vtkTypeBool);
126  vtkBooleanMacro(ProportionalMaximumNumberOfPoints, vtkTypeBool);
128 
130 
135  vtkSetMacro(GenerateVertices,vtkTypeBool);
136  vtkGetMacro(GenerateVertices,vtkTypeBool);
137  vtkBooleanMacro(GenerateVertices,vtkTypeBool);
139 
141 
146  vtkSetMacro(SingleVertexPerCell,vtkTypeBool);
147  vtkGetMacro(SingleVertexPerCell,vtkTypeBool);
148  vtkBooleanMacro(SingleVertexPerCell,vtkTypeBool);
150 
152 
157  vtkSetMacro(OutputPointsPrecision,int);
158  vtkGetMacro(OutputPointsPrecision,int);
160 
161 protected:
162  vtkMaskPoints();
163  ~vtkMaskPoints() override {}
164 
166  vtkInformationVector *) override;
167  int FillInputPortInformation(int port, vtkInformation *info) override;
168 
169  int OnRatio; // every OnRatio point is on; all others are off.
170  vtkIdType Offset; // offset (or starting point id)
171  int RandomMode; // turn on/off randomization
173  vtkTypeBool GenerateVertices; //generate polydata verts
175  int RandomModeType; // choose the random sampling mode
178 
179  virtual void InternalScatter(unsigned long*, unsigned long *, int, int) {}
180  virtual void InternalGather(unsigned long*, unsigned long*, int, int) {}
181  virtual int InternalGetNumberOfProcesses() { return 1; };
182  virtual int InternalGetLocalProcessId() { return 0; };
183  virtual void InternalBarrier() {}
184  unsigned long GetLocalSampleSize(vtkIdType, int);
185 
186 private:
187  vtkMaskPoints(const vtkMaskPoints&) = delete;
188  void operator=(const vtkMaskPoints&) = delete;
189 };
190 
191 #endif
VTK_INT_MAX
#define VTK_INT_MAX
Definition: vtkType.h:159
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:41
vtkMaskPoints::InternalGather
virtual void InternalGather(unsigned long *, unsigned long *, int, int)
Definition: vtkMaskPoints.h:180
vtkMaskPoints::OutputPointsPrecision
int OutputPointsPrecision
Definition: vtkMaskPoints.h:177
vtkMaskPoints::MaximumNumberOfPoints
vtkIdType MaximumNumberOfPoints
Definition: vtkMaskPoints.h:172
vtkMaskPoints::InternalBarrier
virtual void InternalBarrier()
Definition: vtkMaskPoints.h:183
vtkPolyDataAlgorithm::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkMaskPoints::RandomMode
int RandomMode
Definition: vtkMaskPoints.h:171
vtkMaskPoints::ProportionalMaximumNumberOfPoints
vtkTypeBool ProportionalMaximumNumberOfPoints
Definition: vtkMaskPoints.h:176
vtkPolyDataAlgorithm.h
vtkX3D::port
Definition: vtkX3D.h:447
vtkMaskPoints::GenerateVertices
vtkTypeBool GenerateVertices
Definition: vtkMaskPoints.h:173
vtkPolyDataAlgorithm::RequestData
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
This is called by the superclass.
vtkMaskPoints::SingleVertexPerCell
vtkTypeBool SingleVertexPerCell
Definition: vtkMaskPoints.h:174
vtkMaskPoints::InternalGetNumberOfProcesses
virtual int InternalGetNumberOfProcesses()
Definition: vtkMaskPoints.h:181
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkMaskPoints::~vtkMaskPoints
~vtkMaskPoints() override
Definition: vtkMaskPoints.h:163
vtkPolyDataAlgorithm::FillInputPortInformation
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
vtkMaskPoints
selectively filter points
Definition: vtkMaskPoints.h:43
vtkMaskPoints::InternalScatter
virtual void InternalScatter(unsigned long *, unsigned long *, int, int)
Definition: vtkMaskPoints.h:179
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
vtkX3D::info
Definition: vtkX3D.h:376
VTK_ID_MAX
#define VTK_ID_MAX
Definition: vtkType.h:351
vtkMaskPoints::Offset
vtkIdType Offset
Definition: vtkMaskPoints.h:170
vtkMaskPoints::InternalGetLocalProcessId
virtual int InternalGetLocalProcessId()
Definition: vtkMaskPoints.h:182
vtkMaskPoints::OnRatio
int OnRatio
Definition: vtkMaskPoints.h:169
vtkMaskPoints::RandomModeType
int RandomModeType
Definition: vtkMaskPoints.h:175
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkPolyDataAlgorithm::New
static vtkPolyDataAlgorithm * New()
vtkPolyDataAlgorithm
Superclass for algorithms that produce only polydata as output.
Definition: vtkPolyDataAlgorithm.h:44