VTK  9.0.1
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 =========================================================================*/
23 #ifndef vtkImageStencil_h
24 #define vtkImageStencil_h
25 
26 #include "vtkImagingStencilModule.h" // For export macro
28 
30 
31 class VTKIMAGINGSTENCIL_EXPORT vtkImageStencil : public vtkThreadedImageAlgorithm
32 {
33 public:
34  static vtkImageStencil* New();
36  void PrintSelf(ostream& os, vtkIndent indent) override;
37 
39 
44  virtual void SetStencilData(vtkImageStencilData* stencil);
45  vtkImageStencilData* GetStencil();
47 
52  {
53  this->SetInputConnection(2, outputPort);
54  }
55 
57 
60  vtkSetMacro(ReverseStencil, vtkTypeBool);
61  vtkBooleanMacro(ReverseStencil, vtkTypeBool);
62  vtkGetMacro(ReverseStencil, vtkTypeBool);
64 
66 
71  virtual void SetBackgroundInputData(vtkImageData* input);
72  vtkImageData* GetBackgroundInput();
74 
76 
79  void SetBackgroundValue(double val) { this->SetBackgroundColor(val, val, val, val); }
80  double GetBackgroundValue() { return this->BackgroundColor[0]; }
82 
84 
88  vtkSetVector4Macro(BackgroundColor, double);
89  vtkGetVector4Macro(BackgroundColor, double);
91 
92 protected:
94  ~vtkImageStencil() override;
95 
96  void ThreadedRequestData(vtkInformation* request, vtkInformationVector** inputVector,
97  vtkInformationVector* outputVector, vtkImageData*** inData, vtkImageData** outData,
98  int extent[6], int id) override;
99 
101  double BackgroundColor[4];
102 
103  int FillInputPortInformation(int, vtkInformation*) override;
104 
105 private:
106  vtkImageStencil(const vtkImageStencil&) = delete;
107  void operator=(const vtkImageStencil&) = delete;
108 };
109 
110 #endif
Store vtkAlgorithm input/output information.
Proxy object to connect input/output ports.
int vtkTypeBool
Definition: vtkABI.h:69
Generic filter that has one input.
a simple class to control print indentation
Definition: vtkIndent.h:33
efficient description of an image stencil
topologically and geometrically regular array of data
Definition: vtkImageData.h:41
void SetBackgroundValue(double val)
Set the default output value to use when the second input is not set.
virtual void SetInputConnection(int port, vtkAlgorithmOutput *input)
Set the connection for the given input port index.
virtual void ThreadedRequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int extent[6], int threadId)
If the subclass does not define an Execute method, then the task will be broken up, multiple threads will be spawned, and each thread will call this method.
vtkTypeBool ReverseStencil
combine images via a cookie-cutter operation
int FillInputPortInformation(int port, vtkInformation *info) override
These method should be reimplemented by subclasses that have more than a single input or single outpu...
Store zero or more vtkInformation instances.
static vtkAlgorithm * New()
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetStencilConnection(vtkAlgorithmOutput *outputPort)
Specify the stencil to use.
double GetBackgroundValue()
Set the default output value to use when the second input is not set.