VTK
vtkPeriodicFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPeriodicFiler.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 =========================================================================*/
15 
35 #ifndef vtkPeriodicFilter_h
36 #define vtkPeriodicFilter_h
37 
38 #include "vtkFiltersParallelModule.h" // For export macro
40 
41 #include <set> // For block selection
42 #include <vector> // For pieces number
43 
48 
49 #define VTK_ITERATION_MODE_DIRECT_NB 0 // Generate a user-provided number of periods
50 #define VTK_ITERATION_MODE_MAX 1 // Generate a maximum of periods, i.e. a full period.
51 
52 class VTKFILTERSPARALLEL_EXPORT vtkPeriodicFilter : public vtkMultiBlockDataSetAlgorithm
53 {
54 public:
56  void PrintSelf(ostream& os, vtkIndent indent);
57 
59 
64  vtkSetClampMacro(IterationMode, int,
67  vtkGetMacro(IterationMode, int);
69  { this->SetIterationMode(VTK_ITERATION_MODE_DIRECT_NB); }
71  { this->SetIterationMode(VTK_ITERATION_MODE_MAX); }
73 
75 
79  vtkSetMacro(NumberOfPeriods, int);
80  vtkGetMacro(NumberOfPeriods, int);
82 
91  virtual void AddIndex(unsigned int index);
92 
96  virtual void RemoveIndex(unsigned int index);
97 
101  virtual void RemoveAllIndices();
102 
103 protected:
106 
107  // see algorithm for more info
109 
113 
118  vtkCompositeDataSet* output,
119  vtkCompositeDataSet* input) = 0;
120 
125  vtkCompositeDataSet* output,
126  int nbPeriod) = 0;
127 
128  std::vector<int> PeriodNumbers; // Periods numbers by leaf
130 
131 private:
132  vtkPeriodicFilter(const vtkPeriodicFilter&) VTK_DELETE_FUNCTION;
133  void operator=(const vtkPeriodicFilter&) VTK_DELETE_FUNCTION;
134 
135  int IterationMode;
136  int NumberOfPeriods; // User provided number of periods
137 
138  std::set<vtkIdType> Indices; // Selected indices
139 };
140 
141 #endif
vtkPeriodicFilter::SetPeriodNumber
virtual void SetPeriodNumber(vtkCompositeDataIterator *loc, vtkCompositeDataSet *output, int nbPeriod)=0
Manually set the number of period on a specific leaf.
vtkPeriodicFilter::PeriodNumbers
std::vector< int > PeriodNumbers
Definition: vtkPeriodicFilter.h:128
vtkMultiPieceDataSet
composite dataset to encapsulates pieces of dataset.
Definition: vtkMultiPieceDataSet.h:44
vtkPeriodicFilter::AddIndex
virtual void AddIndex(unsigned int index)
Select the periodic pieces indices.
vtkPeriodicFilter::~vtkPeriodicFilter
~vtkPeriodicFilter()
vtkPeriodicFilter
A filter to produce mapped periodic multiblock dataset from a single block.
Definition: vtkPeriodicFilter.h:53
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:42
vtkPeriodicFilter::RemoveAllIndices
virtual void RemoveAllIndices()
Clear selected indices tree.
vtkCompositeDataSet
abstract superclass for composite (multi-block or AMR) datasets
Definition: vtkCompositeDataSet.h:52
vtkPeriodicFilter::RequestData
virtual int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called by the superclass.
vtkX3D::port
@ port
Definition: vtkX3D.h:447
VTK_ITERATION_MODE_DIRECT_NB
#define VTK_ITERATION_MODE_DIRECT_NB
Definition: vtkPeriodicFilter.h:49
vtkPeriodicFilter::FillInputPortInformation
virtual int FillInputPortInformation(int port, vtkInformation *info)
Fill the input port information objects for this algorithm.
vtkCompositeDataIterator
superclass for composite data iterators
Definition: vtkCompositeDataIterator.h:39
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkPeriodicFilter::SetIterationModeToMax
void SetIterationModeToMax()
Definition: vtkPeriodicFilter.h:70
vtkPeriodicFilter::SetIterationModeToDirectNb
void SetIterationModeToDirectNb()
Definition: vtkPeriodicFilter.h:68
vtkMultiBlockDataSetAlgorithm.h
vtkPeriodicFilter::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
vtkPeriodicFilter::CreatePeriodicDataSet
virtual void CreatePeriodicDataSet(vtkCompositeDataIterator *loc, vtkCompositeDataSet *output, vtkCompositeDataSet *input)=0
Create a periodic data, leaf of the tree.
vtkPeriodicFilter::vtkPeriodicFilter
vtkPeriodicFilter()
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkSetMacro
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkX3D::info
@ info
Definition: vtkX3D.h:376
vtkPeriodicFilter::RemoveIndex
virtual void RemoveIndex(unsigned int index)
Remove an index from selected indices tress.
VTK_ITERATION_MODE_MAX
#define VTK_ITERATION_MODE_MAX
Definition: vtkPeriodicFilter.h:50
vtkDataObjectTreeIterator
superclass for composite data iterators
Definition: vtkDataObjectTreeIterator.h:43
vtkPeriodicFilter::ReducePeriodNumbers
bool ReducePeriodNumbers
Definition: vtkPeriodicFilter.h:129
vtkX3D::index
@ index
Definition: vtkX3D.h:246
vtkMultiBlockDataSetAlgorithm
Superclass for algorithms that produce only vtkMultiBlockDataSet as output.
Definition: vtkMultiBlockDataSetAlgorithm.h:33