VTK  9.2.6
vtkImageMathematics.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkImageMathematics.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=========================================================================*/
37#ifndef vtkImageMathematics_h
38#define vtkImageMathematics_h
39
40// Operation options.
41#define VTK_ADD 0
42#define VTK_SUBTRACT 1
43#define VTK_MULTIPLY 2
44#define VTK_DIVIDE 3
45#define VTK_INVERT 4
46#define VTK_SIN 5
47#define VTK_COS 6
48#define VTK_EXP 7
49#define VTK_LOG 8
50#define VTK_ABS 9
51#define VTK_SQR 10
52#define VTK_SQRT 11
53#define VTK_MIN 12
54#define VTK_MAX 13
55#define VTK_ATAN 14
56#define VTK_ATAN2 15
57#define VTK_MULTIPLYBYK 16
58#define VTK_ADDC 17
59#define VTK_CONJUGATE 18
60#define VTK_COMPLEX_MULTIPLY 19
61#define VTK_REPLACECBYK 20
62
63#include "vtkImagingMathModule.h" // For export macro
65
66class VTKIMAGINGMATH_EXPORT vtkImageMathematics : public vtkThreadedImageAlgorithm
67{
68public:
71 void PrintSelf(ostream& os, vtkIndent indent) override;
72
74
77 vtkSetMacro(Operation, int);
78 vtkGetMacro(Operation, int);
80
85 void SetOperationToAdd() { this->SetOperation(VTK_ADD); }
86
91 void SetOperationToSubtract() { this->SetOperation(VTK_SUBTRACT); }
92
97 void SetOperationToMultiply() { this->SetOperation(VTK_MULTIPLY); }
98
103 void SetOperationToDivide() { this->SetOperation(VTK_DIVIDE); }
104
105 void SetOperationToConjugate() { this->SetOperation(VTK_CONJUGATE); }
106
108
113 void SetOperationToInvert() { this->SetOperation(VTK_INVERT); }
114
119 void SetOperationToSin() { this->SetOperation(VTK_SIN); }
120
125 void SetOperationToCos() { this->SetOperation(VTK_COS); }
126
131 void SetOperationToExp() { this->SetOperation(VTK_EXP); }
132
137 void SetOperationToLog() { this->SetOperation(VTK_LOG); }
138
143 void SetOperationToAbsoluteValue() { this->SetOperation(VTK_ABS); }
144
149 void SetOperationToSquare() { this->SetOperation(VTK_SQR); }
150
155 void SetOperationToSquareRoot() { this->SetOperation(VTK_SQRT); }
156
161 void SetOperationToMin() { this->SetOperation(VTK_MIN); }
162
167 void SetOperationToMax() { this->SetOperation(VTK_MAX); }
168
173 void SetOperationToATAN() { this->SetOperation(VTK_ATAN); }
174
175 void SetOperationToATAN2() { this->SetOperation(VTK_ATAN2); }
176
181 void SetOperationToMultiplyByK() { this->SetOperation(VTK_MULTIPLYBYK); }
182
187 void SetOperationToAddConstant() { this->SetOperation(VTK_ADDC); }
188
193 void SetOperationToReplaceCByK() { this->SetOperation(VTK_REPLACECBYK); }
194
196
199 vtkSetMacro(ConstantK, double);
200 vtkGetMacro(ConstantK, double);
202
204
207 vtkSetMacro(ConstantC, double);
208 vtkGetMacro(ConstantC, double);
210
212
215 vtkSetMacro(DivideByZeroToC, vtkTypeBool);
216 vtkGetMacro(DivideByZeroToC, vtkTypeBool);
217 vtkBooleanMacro(DivideByZeroToC, vtkTypeBool);
219
221
225 virtual void SetInput1Data(vtkDataObject* in) { this->SetInputData(0, in); }
226 virtual void SetInput2Data(vtkDataObject* in) { this->AddInputData(0, in); }
227 virtual void SetInputConnection(int idx, vtkAlgorithmOutput* input) override;
228 virtual void SetInputConnection(vtkAlgorithmOutput* input) override
229 {
230 this->SetInputConnection(0, input);
231 }
233
240 virtual void ReplaceNthInputConnection(int idx, vtkAlgorithmOutput* input);
241
243
248 void SetInputData(int idx, vtkDataObject* input);
249 void SetInputData(vtkDataObject* input) { this->SetInputData(0, input); }
251
253
259 vtkDataObject* GetInput() { return this->GetInput(0); }
261
268
269protected:
271 ~vtkImageMathematics() override = default;
272
274 double ConstantK;
275 double ConstantC;
277
279
281 vtkInformationVector* outputVector, vtkImageData*** inData, vtkImageData** outData,
282 int outExt[6], int threadId) override;
283
284 int FillInputPortInformation(int port, vtkInformation* info) override;
285
286private:
288 void operator=(const vtkImageMathematics&) = delete;
289};
290
291#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
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
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.
virtual void SetInputConnection(vtkAlgorithmOutput *input) override
Set the inputs to this filter.
vtkDataObject * GetInput(int idx)
Get one input 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...
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.
virtual void SetInputConnection(int idx, vtkAlgorithmOutput *input) override
Set the inputs to this filter.
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...
void SetOperationToAbsoluteValue()
Set each pixel in the output image to the absolute value of the corresponding pixel in Input1.
static vtkImageMathematics * New()
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...
vtkDataObject * GetInput()
Get one input to this filter.
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:49
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Generic filter that has one input.
int vtkTypeBool
Definition vtkABI.h:69
#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