1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkPythonAlgorithm
* @brief algorithm that can be implemented in Python
*
* vtkPythonAlgorithm is an algorithm that calls a Python object to do the actual
* work.
* It defers the following methods to Python:
* - ProcessRequest()
* - FillInputPortInformation()
* - FillOutputPortInformation()
*
* Python signature of these methods is as follows:
* - ProcessRequest(self, vtkself, request, inInfo, outInfo) : vtkself is the vtk object, inInfo is
* a tuple of information objects
* - FillInputPortInformation(self, vtkself, port, info)
* - FillOutputPortInformation(self, vtkself, port, info)
* - Initialize(self, vtkself)
*
* In addition, it calls an Initialize() method when setting the Python
* object, which allows the initialization of number of input and output
* ports etc.
*
* @sa
* vtkProgrammableFilter
*/
#ifndef vtkPythonAlgorithm_h
#define vtkPythonAlgorithm_h
#if !defined(__VTK_WRAP__) || defined(__VTK_WRAP_HIERARCHY__) || defined(__VTK_WRAP_PYTHON__)
#include "vtkPython.h" // Must be first
#include "vtkAlgorithm.h"
#include "vtkFiltersPythonModule.h" // For export macro
VTK_ABI_NAMESPACE_BEGIN
class vtkSmartPyObject;
class VTKFILTERSPYTHON_EXPORT vtkPythonAlgorithm : public vtkAlgorithm
{
public:
static vtkPythonAlgorithm* New();
vtkTypeMacro(vtkPythonAlgorithm, vtkAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent) override;
/**
* Specify the Python object to use to operate on the data. A reference will
* be taken on the object. This will also invoke Initialize() on the Python
* object, which is commonly used to set the number of input and output
* ports as well as perform tasks commonly performed in the constructor
* of C++ algorithm subclass.
*/
void SetPythonObject(PyObject* obj);
/**
* Set the number of input ports used by the algorithm.
* This is made public so that it can be called from Python.
*/
void SetNumberOfInputPorts(int n) override;
/**
* Set the number of output ports provided by the algorithm.
* This is made public so that it can be called from Python.
*/
void SetNumberOfOutputPorts(int n) override;
protected:
vtkPythonAlgorithm();
~vtkPythonAlgorithm() override;
vtkTypeBool ProcessRequest(
vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
int FillInputPortInformation(int port, vtkInformation* info) override;
int FillOutputPortInformation(int port, vtkInformation* info) override;
private:
vtkPythonAlgorithm(const vtkPythonAlgorithm&) = delete;
void operator=(const vtkPythonAlgorithm&) = delete;
int CheckResult(const char* method, const vtkSmartPyObject& res);
PyObject* Object;
};
VTK_ABI_NAMESPACE_END
#endif
#endif
|
