VTK
vtkImageBlend.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkImageBlend.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 =========================================================================*/
77 #ifndef vtkImageBlend_h
78 #define vtkImageBlend_h
79 
80 
81 #include "vtkImagingCoreModule.h" // For export macro
83 
85 
86 #define VTK_IMAGE_BLEND_MODE_NORMAL 0
87 #define VTK_IMAGE_BLEND_MODE_COMPOUND 1
88 
89 class VTKIMAGINGCORE_EXPORT vtkImageBlend : public vtkThreadedImageAlgorithm
90 {
91 public:
92  static vtkImageBlend *New();
94  void PrintSelf(ostream& os, vtkIndent indent) override;
95 
102  virtual void ReplaceNthInputConnection(int idx, vtkAlgorithmOutput* input);
103 
105 
110  void SetInputData(int num, vtkDataObject *input);
111  void SetInputData(vtkDataObject *input) { this->SetInputData(0, input); };
113 
115 
120  vtkDataObject *GetInput(int num);
121  vtkDataObject *GetInput() { return this->GetInput(0); };
123 
129  int GetNumberOfInputs() { return this->GetNumberOfInputConnections(0); };
130 
132 
136  void SetOpacity(int idx, double opacity);
137  double GetOpacity(int idx);
139 
144  void SetStencilConnection(vtkAlgorithmOutput *algOutput);
145 
147 
150  void SetStencilData(vtkImageStencilData *stencil);
151  vtkImageStencilData *GetStencil();
153 
155 
158  vtkSetClampMacro(BlendMode,int,
161  vtkGetMacro(BlendMode,int);
163  {this->SetBlendMode(VTK_IMAGE_BLEND_MODE_NORMAL);};
165  {this->SetBlendMode(VTK_IMAGE_BLEND_MODE_COMPOUND);};
166  const char *GetBlendModeAsString(void);
168 
170 
174  vtkSetMacro(CompoundThreshold,double);
175  vtkGetMacro(CompoundThreshold,double);
177 
178 protected:
179  vtkImageBlend();
180  ~vtkImageBlend() override;
181 
184  vtkInformationVector *) override;
185 
186  void InternalComputeInputUpdateExtent(int inExt[6], int outExt[6],
187  int inWExtent[6]);
188 
189  void ThreadedRequestData (vtkInformation* request,
190  vtkInformationVector** inputVector,
191  vtkInformationVector* outputVector,
192  vtkImageData ***inData, vtkImageData **outData,
193  int ext[6], int id) override;
194 
195  // see vtkAlgorithm for docs.
196  int FillInputPortInformation(int, vtkInformation*) override;
197 
198  // see vtkAlgorithm for docs.
199  int RequestData(vtkInformation* request,
200  vtkInformationVector** inputVector,
201  vtkInformationVector* outputVector) override;
202 
203  double *Opacity;
208 
209 private:
210  vtkImageBlend(const vtkImageBlend&) = delete;
211  void operator=(const vtkImageBlend&) = delete;
212 };
213 
215 
219 {
220  switch (this->BlendMode)
221  {
223  return "Normal";
225  return "Compound";
226  default:
227  return "Unknown Blend Mode";
228  }
229 }
231 
232 
233 #endif
234 
235 
236 
237 
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,...
vtkImageBlend::DataWasPassed
int DataWasPassed
Definition: vtkImageBlend.h:207
vtkImageBlend::BlendMode
int BlendMode
Definition: vtkImageBlend.h:205
vtkImageBlend::SetInputData
void SetInputData(vtkDataObject *input)
Definition: vtkImageBlend.h:111
vtkImageBlend::SetBlendModeToCompound
void SetBlendModeToCompound()
Definition: vtkImageBlend.h:164
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:41
vtkImageBlend::GetBlendModeAsString
const char * GetBlendModeAsString(void)
Get the blending mode as a descriptive string.
Definition: vtkImageBlend.h:218
VTK_IMAGE_BLEND_MODE_NORMAL
#define VTK_IMAGE_BLEND_MODE_NORMAL
Definition: vtkImageBlend.h:86
VTK_IMAGE_BLEND_MODE_COMPOUND
#define VTK_IMAGE_BLEND_MODE_COMPOUND
Definition: vtkImageBlend.h:87
vtkThreadedImageAlgorithm
Generic filter that has one input.
Definition: vtkThreadedImageAlgorithm.h:43
vtkImageBlend
blend images together using alpha or opacity
Definition: vtkImageBlend.h:89
vtkImageBlend::OpacityArrayLength
int OpacityArrayLength
Definition: vtkImageBlend.h:204
vtkImageAlgorithm::GetInput
vtkDataObject * GetInput()
Definition: vtkImageAlgorithm.h:81
vtkThreadedImageAlgorithm.h
vtkImageBlend::SetBlendModeToNormal
void SetBlendModeToNormal()
Definition: vtkImageBlend.h:162
vtkImageBlend::Opacity
double * Opacity
Definition: vtkImageBlend.h:203
vtkImageAlgorithm::SetInputData
void SetInputData(vtkDataObject *)
Assign a data object as input.
vtkImageAlgorithm::RequestUpdateExtent
virtual int RequestUpdateExtent(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Subclasses can reimplement this method to translate the update extent requests from each output port ...
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
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
vtkImageBlend::GetInput
vtkDataObject * GetInput()
Definition: vtkImageBlend.h:121
vtkAlgorithm::New
static vtkAlgorithm * New()
vtkAlgorithmOutput
Proxy object to connect input/output ports.
Definition: vtkAlgorithmOutput.h:39
vtkImageStencilData
efficient description of an image stencil
Definition: vtkImageStencilData.h:37
vtkImageBlend::GetNumberOfInputs
int GetNumberOfInputs()
Get the number of inputs to this filter.
Definition: vtkImageBlend.h:129
vtkAlgorithm::GetNumberOfInputConnections
int GetNumberOfInputConnections(int port)
Get the number of inputs currently connected to a port.
vtkImageAlgorithm::FillInputPortInformation
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:64
vtkImageBlend::CompoundThreshold
double CompoundThreshold
Definition: vtkImageBlend.h:206
vtkThreadedImageAlgorithm::RequestData
int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
This is called by the superclass.