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 =========================================================================*/
74 #ifndef vtkImageBlend_h
75 #define vtkImageBlend_h
76 
77 
78 #include "vtkImagingCoreModule.h" // For export macro
80 
82 
83 #define VTK_IMAGE_BLEND_MODE_NORMAL 0
84 #define VTK_IMAGE_BLEND_MODE_COMPOUND 1
85 
86 class VTKIMAGINGCORE_EXPORT vtkImageBlend : public vtkThreadedImageAlgorithm
87 {
88 public:
89  static vtkImageBlend *New();
91  void PrintSelf(ostream& os, vtkIndent indent) override;
92 
99  virtual void ReplaceNthInputConnection(int idx, vtkAlgorithmOutput* input);
100 
102 
107  void SetInputData(int num, vtkDataObject *input);
108  void SetInputData(vtkDataObject *input) { this->SetInputData(0, input); };
110 
112 
117  vtkDataObject *GetInput(int num);
118  vtkDataObject *GetInput() { return this->GetInput(0); };
120 
126  int GetNumberOfInputs() { return this->GetNumberOfInputConnections(0); };
127 
129 
133  void SetOpacity(int idx, double opacity);
134  double GetOpacity(int idx);
136 
141  void SetStencilConnection(vtkAlgorithmOutput *algOutput);
142 
144 
147  void SetStencilData(vtkImageStencilData *stencil);
148  vtkImageStencilData *GetStencil();
150 
152 
155  vtkSetClampMacro(BlendMode,int,
158  vtkGetMacro(BlendMode,int);
160  {this->SetBlendMode(VTK_IMAGE_BLEND_MODE_NORMAL);};
162  {this->SetBlendMode(VTK_IMAGE_BLEND_MODE_COMPOUND);};
163  const char *GetBlendModeAsString(void);
165 
167 
171  vtkSetMacro(CompoundThreshold,double);
172  vtkGetMacro(CompoundThreshold,double);
174 
175 protected:
176  vtkImageBlend();
177  ~vtkImageBlend() override;
178 
181  vtkInformationVector *) override;
182 
183  void InternalComputeInputUpdateExtent(int inExt[6], int outExt[6],
184  int inWExtent[6]);
185 
186  void ThreadedRequestData (vtkInformation* request,
187  vtkInformationVector** inputVector,
188  vtkInformationVector* outputVector,
189  vtkImageData ***inData, vtkImageData **outData,
190  int ext[6], int id) override;
191 
192  // see vtkAlgorithm for docs.
193  int FillInputPortInformation(int, vtkInformation*) override;
194 
195  // see vtkAlgorithm for docs.
196  int RequestData(vtkInformation* request,
197  vtkInformationVector** inputVector,
198  vtkInformationVector* outputVector) override;
199 
200  double *Opacity;
205 
206 private:
207  vtkImageBlend(const vtkImageBlend&) = delete;
208  void operator=(const vtkImageBlend&) = delete;
209 };
210 
212 
216 {
217  switch (this->BlendMode)
218  {
220  return "Normal";
222  return "Compound";
223  default:
224  return "Unknown Blend Mode";
225  }
226 }
228 
229 
230 #endif
231 
232 
233 
234 
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:204
vtkImageBlend::BlendMode
int BlendMode
Definition: vtkImageBlend.h:202
vtkImageBlend::SetInputData
void SetInputData(vtkDataObject *input)
Definition: vtkImageBlend.h:108
vtkImageBlend::SetBlendModeToCompound
void SetBlendModeToCompound()
Definition: vtkImageBlend.h:161
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:35
vtkImageBlend::GetBlendModeAsString
const char * GetBlendModeAsString(void)
Get the blending mode as a descriptive string.
Definition: vtkImageBlend.h:215
VTK_IMAGE_BLEND_MODE_NORMAL
#define VTK_IMAGE_BLEND_MODE_NORMAL
Definition: vtkImageBlend.h:83
VTK_IMAGE_BLEND_MODE_COMPOUND
#define VTK_IMAGE_BLEND_MODE_COMPOUND
Definition: vtkImageBlend.h:84
vtkThreadedImageAlgorithm
Generic filter that has one input.
Definition: vtkThreadedImageAlgorithm.h:37
vtkImageBlend
blend images together using alpha or opacity
Definition: vtkImageBlend.h:86
vtkImageBlend::OpacityArrayLength
int OpacityArrayLength
Definition: vtkImageBlend.h:201
vtkImageAlgorithm::GetInput
vtkDataObject * GetInput()
Definition: vtkImageAlgorithm.h:78
vtkThreadedImageAlgorithm.h
vtkImageBlend::SetBlendModeToNormal
void SetBlendModeToNormal()
Definition: vtkImageBlend.h:159
vtkImageBlend::Opacity
double * Opacity
Definition: vtkImageBlend.h:200
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:39
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:80
vtkImageBlend::GetInput
vtkDataObject * GetInput()
Definition: vtkImageBlend.h:118
vtkAlgorithm::New
static vtkAlgorithm * New()
vtkAlgorithmOutput
Proxy object to connect input/output ports.
Definition: vtkAlgorithmOutput.h:36
vtkImageStencilData
efficient description of an image stencil
Definition: vtkImageStencilData.h:34
vtkImageBlend::GetNumberOfInputs
int GetNumberOfInputs()
Get the number of inputs to this filter.
Definition: vtkImageBlend.h:126
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:58
vtkImageBlend::CompoundThreshold
double CompoundThreshold
Definition: vtkImageBlend.h:203
vtkThreadedImageAlgorithm::RequestData
int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
This is called by the superclass.