VTK  9.1.0
vtkImageStencil.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkImageStencil.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=========================================================================*/
62#ifndef vtkImageStencil_h
63#define vtkImageStencil_h
64
65#include "vtkImagingStencilModule.h" // For export macro
67
69
70class VTKIMAGINGSTENCIL_EXPORT vtkImageStencil : public vtkThreadedImageAlgorithm
71{
72public:
75 void PrintSelf(ostream& os, vtkIndent indent) override;
76
78
83 virtual void SetStencilData(vtkImageStencilData* stencil);
86
91 {
92 this->SetInputConnection(2, outputPort);
93 }
94
96
99 vtkSetMacro(ReverseStencil, vtkTypeBool);
100 vtkBooleanMacro(ReverseStencil, vtkTypeBool);
101 vtkGetMacro(ReverseStencil, vtkTypeBool);
103
105
113
115
118 void SetBackgroundValue(double val) { this->SetBackgroundColor(val, val, val, val); }
119 double GetBackgroundValue() { return this->BackgroundColor[0]; }
121
123
127 vtkSetVector4Macro(BackgroundColor, double);
128 vtkGetVector4Macro(BackgroundColor, double);
130
131protected:
134
136 vtkInformationVector* outputVector, vtkImageData*** inData, vtkImageData** outData,
137 int extent[6], int id) override;
138
140 double BackgroundColor[4];
141
143
144private:
145 vtkImageStencil(const vtkImageStencil&) = delete;
146 void operator=(const vtkImageStencil&) = delete;
147};
148
149#endif
Proxy object to connect input/output ports.
virtual void SetInputConnection(int port, vtkAlgorithmOutput *input)
Set the connection for the given input port index.
topologically and geometrically regular array of data
Definition: vtkImageData.h:157
efficient description of an image stencil
combine images via a cookie-cutter operation
virtual void SetStencilData(vtkImageStencilData *stencil)
Specify the stencil to use.
static vtkImageStencil * New()
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void SetBackgroundInputData(vtkImageData *input)
Set the second input.
vtkTypeBool ReverseStencil
vtkImageData * GetBackgroundInput()
Set the second input.
double GetBackgroundValue()
Set the default output value to use when the second input is not set.
~vtkImageStencil() override
void SetBackgroundValue(double val)
Set the default output value to use when the second input is not set.
int FillInputPortInformation(int, vtkInformation *) override
These method should be reimplemented by subclasses that have more than a single input or single outpu...
void SetStencilConnection(vtkAlgorithmOutput *outputPort)
Specify the stencil to use.
vtkImageStencilData * GetStencil()
Specify the stencil to use.
void ThreadedRequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int extent[6], int id) override
If the subclass does not define an Execute method, then the task will be broken up,...
a simple class to control print indentation
Definition: vtkIndent.h:113
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Generic filter that has one input.
@ extent
Definition: vtkX3D.h:351
int vtkTypeBool
Definition: vtkABI.h:69