VTK  9.5.20251012
vtkmProbe.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-FileCopyrightText: Copyright (c) Kitware, Inc.
3// SPDX-FileCopyrightText: Copyright 2012 Sandia Corporation.
4// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
33#ifndef vtkmProbe_h
34#define vtkmProbe_h
35
36#include <string> // for std::string
37
38#include "vtkAcceleratorsVTKmFiltersModule.h" //required for export
39#include "vtkDataSetAlgorithm.h"
40#include "vtkmAlgorithm.h" // For vtkmAlgorithm
41#include "vtkmlib/vtkmInitializer.h" // Need for initializing viskores
42
43#ifndef __VTK_WRAP__
44#define vtkDataSetAlgorithm vtkmAlgorithm<vtkDataSetAlgorithm>
45#endif
46
47VTK_ABI_NAMESPACE_BEGIN
48class VTKACCELERATORSVTKMFILTERS_EXPORT vtkmProbe : public vtkDataSetAlgorithm
49{
50public:
52#ifndef __VTK_WRAP__
53#undef vtkDataSetAlgorithm
54#endif
55 void PrintSelf(ostream& os, vtkIndent indent) override;
56 static vtkmProbe* New();
57
59
68
70
78
80
84 vtkSetMacro(PassCellArrays, vtkTypeBool);
85 vtkBooleanMacro(PassCellArrays, vtkTypeBool);
86 vtkGetMacro(PassCellArrays, vtkTypeBool);
89
93 vtkSetMacro(PassPointArrays, vtkTypeBool);
94 vtkBooleanMacro(PassPointArrays, vtkTypeBool);
95 vtkGetMacro(PassPointArrays, vtkTypeBool);
97
99
103 vtkSetMacro(PassFieldArrays, vtkTypeBool);
104 vtkBooleanMacro(PassFieldArrays, vtkTypeBool);
105 vtkGetMacro(PassFieldArrays, vtkTypeBool);
107
109
114 vtkSetMacro(ValidPointMaskArrayName, std::string);
115 vtkGetMacro(ValidPointMaskArrayName, std::string);
117
119
124 vtkSetMacro(ValidCellMaskArrayName, std::string);
125 vtkGetMacro(ValidCellMaskArrayName, std::string);
127
128protected:
130 ~vtkmProbe() override = default;
131
137
139
141
143
149
150private:
151 vtkmProbe(const vtkmProbe&) = delete;
152 void operator=(const vtkmProbe&) = delete;
153 vtkmInitializer Initializer;
154};
155
156VTK_ABI_NAMESPACE_END
157#endif // vtkmProbe_h
Proxy object to connect input/output ports.
general representation of visualization data
Superclass for algorithms that produce output of the same type as input.
abstract class to specify dataset behavior
Definition vtkDataSet.h:166
a simple class to control print indentation
Definition vtkIndent.h:108
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Sample data at specified point locations.
Definition vtkmProbe.h:49
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int RequestUpdateExtent(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when each filter in the pipeline decides what portion of its inp...
vtkTypeBool PassPointArrays
Definition vtkmProbe.h:133
~vtkmProbe() override=default
void SetSourceConnection(vtkAlgorithmOutput *algOutput)
Specify the data set that will be probed at the input points.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when a request asks the algorithm to do its work.
vtkDataObject * GetSource()
Specify the data set that will be probed at the input points.
std::string ValidCellMaskArrayName
Definition vtkmProbe.h:136
static vtkmProbe * New()
vtkTypeBool PassFieldArrays
Definition vtkmProbe.h:134
std::string ValidPointMaskArrayName
Definition vtkmProbe.h:135
void PassAttributeData(vtkDataSet *input, vtkDataObject *source, vtkDataSet *output)
Call at the end of RequestData() to pass attribute dat a respecting the PassCellArrays,...
vtkTypeBool PassCellArrays
Definition vtkmProbe.h:132
void SetSourceData(vtkDataObject *source)
Specify the data set that will be probed at the input points.
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when a request asks for Information.
int vtkTypeBool
Definition vtkABI.h:64
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)