A generic filter that can reduce any type of dataset using any reduction algorithm. More...
#include <vtkReductionFilter.h>
Detailed Description
A generic filter that can reduce any type of dataset using any reduction algorithm.
A generic filter that can reduce any type of dataset using any reduction algorithm. Actual reduction is performed by running the PreGatherHelper and PostGatherHelper algorithms. The PreGatherHelper runs on each node in parallel. Next the intermediate results are gathered to the root node. Then the root node then runs the PostGatherHelper algorithm to produce a single result. The PostGatherHelper must be an algorithm that takes multiple input connections and produces a single reduced output.
In addition to doing reduction the PassThrough variable lets you choose to pass through the results of any one node instead of aggregating all of them together.
Definition at line 39 of file vtkReductionFilter.h.
Member Enumeration Documentation
Definition at line 87 of file vtkReductionFilter.h.
Constructor & Destructor Documentation
| vtkReductionFilter::vtkReductionFilter | ( | ) | [protected] |
| vtkReductionFilter::~vtkReductionFilter | ( | ) | [protected] |
Member Function Documentation
| static vtkReductionFilter* vtkReductionFilter::New | ( | ) | [static] |
Reimplemented from vtkDataObjectAlgorithm.
| virtual const char* vtkReductionFilter::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkDataObjectAlgorithm.
| static int vtkReductionFilter::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkDataObjectAlgorithm.
| virtual int vtkReductionFilter::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkDataObjectAlgorithm.
| static vtkReductionFilter* vtkReductionFilter::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkDataObjectAlgorithm.
| void vtkReductionFilter::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkDataObjectAlgorithm.
| void vtkReductionFilter::SetPreGatherHelper | ( | vtkAlgorithm * | ) |
Get/Set the pre-reduction helper. Pre-Reduction helper is an algorithm that runs on each node's data before it is sent to the root.
| void vtkReductionFilter::SetPreGatherHelperName | ( | const char * | ) |
Get/Set the pre-reduction helper. Pre-Reduction helper is an algorithm that runs on each node's data before it is sent to the root.
| virtual vtkAlgorithm* vtkReductionFilter::GetPreGatherHelper | ( | ) | [virtual] |
Get/Set the pre-reduction helper. Pre-Reduction helper is an algorithm that runs on each node's data before it is sent to the root.
| void vtkReductionFilter::SetPostGatherHelper | ( | vtkAlgorithm * | ) |
Get/Set the reduction helper. Reduction helper is an algorithm with multiple input connections, that produces a single output as the reduced output. This is run on the root node to produce a result from the gathered results of each node.
| void vtkReductionFilter::SetPostGatherHelperName | ( | const char * | ) |
Get/Set the reduction helper. Reduction helper is an algorithm with multiple input connections, that produces a single output as the reduced output. This is run on the root node to produce a result from the gathered results of each node.
| virtual vtkAlgorithm* vtkReductionFilter::GetPostGatherHelper | ( | ) | [virtual] |
Get/Set the reduction helper. Reduction helper is an algorithm with multiple input connections, that produces a single output as the reduced output. This is run on the root node to produce a result from the gathered results of each node.
| void vtkReductionFilter::SetController | ( | vtkMultiProcessController * | ) |
Get/Set the MPI controller used for gathering.
| virtual void vtkReductionFilter::SetPassThrough | ( | int | ) | [virtual] |
Get/Set the PassThrough flag which (when set to a nonnegative number N) tells the filter to produce results that come from node N only. The data from that node still runs through the PreReduction and PostGatherHelper algorithms.
| virtual int vtkReductionFilter::GetPassThrough | ( | ) | [virtual] |
Get/Set the PassThrough flag which (when set to a nonnegative number N) tells the filter to produce results that come from node N only. The data from that node still runs through the PreReduction and PostGatherHelper algorithms.
| virtual void vtkReductionFilter::SetGenerateProcessIds | ( | int | ) | [virtual] |
When set, a new array vtkOriginalProcessIds will be added to the output of the the pre-gather helper (or input, if no pre-gather helper is set). The values in the array indicate the process id. Note that the array is added only if the number of processes is > 1.
| virtual int vtkReductionFilter::GetGenerateProcessIds | ( | ) | [virtual] |
When set, a new array vtkOriginalProcessIds will be added to the output of the the pre-gather helper (or input, if no pre-gather helper is set). The values in the array indicate the process id. Note that the array is added only if the number of processes is > 1.
| virtual int vtkReductionFilter::FillInputPortInformation | ( | int | port, |
| vtkInformation * | info | ||
| ) | [protected, virtual] |
Reimplemented from vtkDataObjectAlgorithm.
| virtual int vtkReductionFilter::RequestDataObject | ( | vtkInformation * | request, |
| vtkInformationVector ** | inputVector, | ||
| vtkInformationVector * | outputVector | ||
| ) | [protected, virtual] |
Reimplemented from vtkDataObjectAlgorithm.
| virtual int vtkReductionFilter::RequestData | ( | vtkInformation * | request, |
| vtkInformationVector ** | inputVector, | ||
| vtkInformationVector * | outputVector | ||
| ) | [protected, virtual] |
Reimplemented from vtkDataObjectAlgorithm.
| void vtkReductionFilter::Reduce | ( | vtkDataObject * | input, |
| vtkDataObject * | output | ||
| ) | [protected] |
| vtkDataObject* vtkReductionFilter::PreProcess | ( | vtkDataObject * | input | ) | [protected] |
| void vtkReductionFilter::PostProcess | ( | vtkDataObject * | output, |
| vtkSmartPointer< vtkDataObject > | inputs[], | ||
| unsigned int | num_inputs | ||
| ) | [protected] |
| void vtkReductionFilter::Send | ( | int | receiver, |
| vtkDataObject * | |||
| ) | [protected] |
| vtkDataObject* vtkReductionFilter::Receive | ( | int | receiver, |
| int | dataobjectType | ||
| ) | [protected] |
Member Data Documentation
vtkAlgorithm* vtkReductionFilter::PreGatherHelper [protected] |
Definition at line 115 of file vtkReductionFilter.h.
vtkAlgorithm* vtkReductionFilter::PostGatherHelper [protected] |
Definition at line 116 of file vtkReductionFilter.h.
vtkMultiProcessController* vtkReductionFilter::Controller [protected] |
Definition at line 117 of file vtkReductionFilter.h.
int vtkReductionFilter::PassThrough [protected] |
Definition at line 118 of file vtkReductionFilter.h.
int vtkReductionFilter::GenerateProcessIds [protected] |
Definition at line 119 of file vtkReductionFilter.h.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/VTKExtensions/vtkReductionFilter.h
