VTK
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 =========================================================================*/
29 #ifndef vtkImageStencil_h
30 #define vtkImageStencil_h
31 
32 #include "vtkImagingStencilModule.h" // For export macro
34 
36 
37 class VTKIMAGINGSTENCIL_EXPORT vtkImageStencil : public vtkThreadedImageAlgorithm
38 {
39 public:
40  static vtkImageStencil *New();
42  void PrintSelf(ostream& os, vtkIndent indent) override;
43 
45 
50  virtual void SetStencilData(vtkImageStencilData *stencil);
51  vtkImageStencilData *GetStencil();
53 
58  {
59  this->SetInputConnection(2, outputPort);
60  }
61 
63 
66  vtkSetMacro(ReverseStencil, vtkTypeBool);
67  vtkBooleanMacro(ReverseStencil, vtkTypeBool);
68  vtkGetMacro(ReverseStencil, vtkTypeBool);
70 
72 
77  virtual void SetBackgroundInputData(vtkImageData *input);
78  vtkImageData *GetBackgroundInput();
80 
82 
85  void SetBackgroundValue(double val) {
86  this->SetBackgroundColor(val,val,val,val); };
87  double GetBackgroundValue() {
88  return this->BackgroundColor[0]; };
90 
92 
96  vtkSetVector4Macro(BackgroundColor, double);
97  vtkGetVector4Macro(BackgroundColor, double);
99 
100 protected:
101  vtkImageStencil();
102  ~vtkImageStencil() override;
103 
104  void ThreadedRequestData(vtkInformation *request,
105  vtkInformationVector **inputVector,
106  vtkInformationVector *outputVector,
107  vtkImageData ***inData, vtkImageData **outData,
108  int extent[6], int id) override;
109 
111  double BackgroundColor[4];
112 
113  int FillInputPortInformation(int, vtkInformation*) override;
114 
115 private:
116  vtkImageStencil(const vtkImageStencil&) = delete;
117  void operator=(const vtkImageStencil&) = delete;
118 };
119 
120 #endif
vtkThreadedImageAlgorithm::ThreadedRequestData
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,...
vtkImageStencil::ReverseStencil
vtkTypeBool ReverseStencil
Definition: vtkImageStencil.h:110
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:41
vtkThreadedImageAlgorithm
Generic filter that has one input.
Definition: vtkThreadedImageAlgorithm.h:43
vtkImageStencil::GetBackgroundValue
double GetBackgroundValue()
Definition: vtkImageStencil.h:87
vtkThreadedImageAlgorithm.h
vtkThreadedImageAlgorithm::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:45
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkImageStencil::SetStencilConnection
void SetStencilConnection(vtkAlgorithmOutput *outputPort)
Specify the stencil to use.
Definition: vtkImageStencil.h:57
vtkAlgorithm::SetInputConnection
virtual void SetInputConnection(int port, vtkAlgorithmOutput *input)
Set the connection for the given input port index.
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
vtkAlgorithm::New
static vtkAlgorithm * New()
vtkImageStencil
combine images via a cookie-cutter operation
Definition: vtkImageStencil.h:37
vtkAlgorithmOutput
Proxy object to connect input/output ports.
Definition: vtkAlgorithmOutput.h:39
vtkImageStencilData
efficient description of an image stencil
Definition: vtkImageStencilData.h:37
vtkX3D::extent
Definition: vtkX3D.h:345
vtkImageStencil::SetBackgroundValue
void SetBackgroundValue(double val)
Set the default output value to use when the second input is not set.
Definition: vtkImageStencil.h:85
vtkImageAlgorithm::FillInputPortInformation
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69