VTK  9.3.0
vtkImageMathematics.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
25 #ifndef vtkImageMathematics_h
26 #define vtkImageMathematics_h
27 
28 // Operation options.
29 #define VTK_ADD 0
30 #define VTK_SUBTRACT 1
31 #define VTK_MULTIPLY 2
32 #define VTK_DIVIDE 3
33 #define VTK_INVERT 4
34 #define VTK_SIN 5
35 #define VTK_COS 6
36 #define VTK_EXP 7
37 #define VTK_LOG 8
38 #define VTK_ABS 9
39 #define VTK_SQR 10
40 #define VTK_SQRT 11
41 #define VTK_MIN 12
42 #define VTK_MAX 13
43 #define VTK_ATAN 14
44 #define VTK_ATAN2 15
45 #define VTK_MULTIPLYBYK 16
46 #define VTK_ADDC 17
47 #define VTK_CONJUGATE 18
48 #define VTK_COMPLEX_MULTIPLY 19
49 #define VTK_REPLACECBYK 20
50 
51 #include "vtkImagingMathModule.h" // For export macro
53 
54 VTK_ABI_NAMESPACE_BEGIN
55 class VTKIMAGINGMATH_EXPORT vtkImageMathematics : public vtkThreadedImageAlgorithm
56 {
57 public:
60  void PrintSelf(ostream& os, vtkIndent indent) override;
61 
63 
66  vtkSetMacro(Operation, int);
67  vtkGetMacro(Operation, int);
69 
74  void SetOperationToAdd() { this->SetOperation(VTK_ADD); }
75 
80  void SetOperationToSubtract() { this->SetOperation(VTK_SUBTRACT); }
81 
86  void SetOperationToMultiply() { this->SetOperation(VTK_MULTIPLY); }
87 
92  void SetOperationToDivide() { this->SetOperation(VTK_DIVIDE); }
93 
94  void SetOperationToConjugate() { this->SetOperation(VTK_CONJUGATE); }
95 
96  void SetOperationToComplexMultiply() { this->SetOperation(VTK_COMPLEX_MULTIPLY); }
97 
102  void SetOperationToInvert() { this->SetOperation(VTK_INVERT); }
103 
108  void SetOperationToSin() { this->SetOperation(VTK_SIN); }
109 
114  void SetOperationToCos() { this->SetOperation(VTK_COS); }
115 
120  void SetOperationToExp() { this->SetOperation(VTK_EXP); }
121 
126  void SetOperationToLog() { this->SetOperation(VTK_LOG); }
127 
132  void SetOperationToAbsoluteValue() { this->SetOperation(VTK_ABS); }
133 
138  void SetOperationToSquare() { this->SetOperation(VTK_SQR); }
139 
144  void SetOperationToSquareRoot() { this->SetOperation(VTK_SQRT); }
145 
150  void SetOperationToMin() { this->SetOperation(VTK_MIN); }
151 
156  void SetOperationToMax() { this->SetOperation(VTK_MAX); }
157 
162  void SetOperationToATAN() { this->SetOperation(VTK_ATAN); }
163 
164  void SetOperationToATAN2() { this->SetOperation(VTK_ATAN2); }
165 
170  void SetOperationToMultiplyByK() { this->SetOperation(VTK_MULTIPLYBYK); }
171 
176  void SetOperationToAddConstant() { this->SetOperation(VTK_ADDC); }
177 
182  void SetOperationToReplaceCByK() { this->SetOperation(VTK_REPLACECBYK); }
183 
185 
188  vtkSetMacro(ConstantK, double);
189  vtkGetMacro(ConstantK, double);
191 
193 
196  vtkSetMacro(ConstantC, double);
197  vtkGetMacro(ConstantC, double);
199 
201 
204  vtkSetMacro(DivideByZeroToC, vtkTypeBool);
205  vtkGetMacro(DivideByZeroToC, vtkTypeBool);
206  vtkBooleanMacro(DivideByZeroToC, vtkTypeBool);
208 
210 
214  virtual void SetInput1Data(vtkDataObject* in) { this->SetInputData(0, in); }
215  virtual void SetInput2Data(vtkDataObject* in) { this->AddInputData(0, in); }
216  void SetInputConnection(int idx, vtkAlgorithmOutput* input) override;
218  {
219  this->SetInputConnection(0, input);
220  }
222 
229  virtual void ReplaceNthInputConnection(int idx, vtkAlgorithmOutput* input);
230 
232 
237  void SetInputData(int idx, vtkDataObject* input);
238  void SetInputData(vtkDataObject* input) { this->SetInputData(0, input); }
240 
242 
248  vtkDataObject* GetInput() { return this->GetInput(0); }
250 
257 
258 protected:
260  ~vtkImageMathematics() override = default;
261 
263  double ConstantK;
264  double ConstantC;
266 
268 
270  vtkInformationVector* outputVector, vtkImageData*** inData, vtkImageData** outData,
271  int outExt[6], int threadId) override;
272 
274 
275 private:
276  vtkImageMathematics(const vtkImageMathematics&) = delete;
277  void operator=(const vtkImageMathematics&) = delete;
278 };
279 
280 VTK_ABI_NAMESPACE_END
281 #endif
Proxy object to connect input/output ports.
virtual void SetInputConnection(int port, vtkAlgorithmOutput *input)
Set the connection for the given input port index.
int GetNumberOfInputConnections(int port)
Get the number of inputs currently connected to a port.
general representation of visualization data
Definition: vtkDataObject.h:64
void SetInputData(vtkDataObject *)
Assign a data object as input.
virtual void AddInputData(vtkDataObject *)
Assign a data object as input.
topologically and geometrically regular array of data
Definition: vtkImageData.h:52
Add, subtract, multiply, divide, invert, sin, cos, exp, log.
void SetOperationToMultiply()
Set each pixel in the output image to the product of the corresponding pixels in Input1 and Input2.
void SetOperationToATAN()
Set each pixel in the output image to the arctangent of the corresponding pixel in Input1.
void SetInputConnection(int idx, vtkAlgorithmOutput *input) override
Set the inputs to this filter.
virtual void SetInput1Data(vtkDataObject *in)
Set the inputs to this filter.
void SetOperationToMultiplyByK()
Set each pixel in the output image to the product of ConstantK with the corresponding pixel in Input1...
void ThreadedRequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int outExt[6], int threadId) override
If the subclass does not define an Execute method, then the task will be broken up,...
~vtkImageMathematics() override=default
void SetOperationToSquareRoot()
Set each pixel in the output image to the square root of the corresponding pixel in Input1.
void SetOperationToMin()
Set each pixel in the output image to the minimum of the corresponding pixels in Input1 and Input2.
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Subclasses can reimplement this method to collect information from their inputs and set information f...
void SetInputConnection(vtkAlgorithmOutput *input) override
Set the inputs to this filter.
virtual void ReplaceNthInputConnection(int idx, vtkAlgorithmOutput *input)
Replace one of the input connections with a new input.
void SetInputData(vtkDataObject *input)
Assign a data object as input.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void SetInput2Data(vtkDataObject *in)
Set the inputs to this filter.
void SetOperationToDivide()
Set each pixel in the output image to the quotient of the corresponding pixels in Input1 and Input2 (...
void SetOperationToExp()
Set each pixel in the output image to the exponential of the corresponding pixel in Input1.
void SetInputData(int idx, vtkDataObject *input)
Assign a data object as input.
void SetOperationToSubtract()
Set each pixel in the output image to the difference of the corresponding pixels in Input1 and Input2...
void SetOperationToLog()
Set each pixel in the output image to the log of the corresponding pixel in Input1.
void SetOperationToMax()
Set each pixel in the output image to the maximum of the corresponding pixels in Input1 and Input2.
void SetOperationToAdd()
Set each pixel in the output image to the sum of the corresponding pixels in Input1 and Input2.
int FillInputPortInformation(int port, vtkInformation *info) override
These method should be reimplemented by subclasses that have more than a single input or single outpu...
int GetNumberOfInputs()
Get the number of inputs to this filter.
void SetOperationToReplaceCByK()
Find every pixel in Input1 that equals ConstantC and set the corresponding pixels in the Output to Co...
void SetOperationToSin()
Set each pixel in the output image to the sine of the corresponding pixel in Input1.
void SetOperationToAddConstant()
Set each pixel in the output image to the product of ConstantC with the corresponding pixel in Input1...
vtkDataObject * GetInput(int idx)
Get one input to this filter.
vtkDataObject * GetInput()
Get one input to this filter.
static vtkImageMathematics * New()
void SetOperationToAbsoluteValue()
Set each pixel in the output image to the absolute value of the corresponding pixel in Input1.
void SetOperationToSquare()
Set each pixel in the output image to the square of the corresponding pixel in Input1.
void SetOperationToInvert()
Set each pixel in the output image to 1 over the corresponding pixel in Input1 and Input2 (output = 1...
void SetOperationToCos()
Set each pixel in the output image to the cosine of the corresponding pixel in Input1.
a simple class to control print indentation
Definition: vtkIndent.h:38
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Generic filter that has one input.
@ info
Definition: vtkX3D.h:376
@ port
Definition: vtkX3D.h:447
int vtkTypeBool
Definition: vtkABI.h:64
#define VTK_SQRT
#define VTK_MULTIPLYBYK
#define VTK_LOG
#define VTK_ATAN
#define VTK_ATAN2
#define VTK_INVERT
#define VTK_SUBTRACT
#define VTK_EXP
#define VTK_MIN
#define VTK_MULTIPLY
#define VTK_COMPLEX_MULTIPLY
#define VTK_SIN
#define VTK_ABS
#define VTK_COS
#define VTK_ADD
#define VTK_SQR
#define VTK_MAX
#define VTK_REPLACECBYK
#define VTK_ADDC
#define VTK_CONJUGATE
#define VTK_DIVIDE