VTK
vtkImageMask.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkImageMask.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 =========================================================================*/
33 #ifndef vtkImageMask_h
34 #define vtkImageMask_h
35 
36 
37 #include "vtkImagingCoreModule.h" // For export macro
39 
40 class VTKIMAGINGCORE_EXPORT vtkImageMask : public vtkThreadedImageAlgorithm
41 {
42 public:
43  static vtkImageMask *New();
45  void PrintSelf(ostream& os, vtkIndent indent) override;
46 
50  void SetMaskedOutputValue(int num, double *v);
51  void SetMaskedOutputValue(double v) {this->SetMaskedOutputValue(1, &v);}
52  void SetMaskedOutputValue(double v1, double v2)
53  {double v[2]; v[0]=v1; v[1]=v2; this->SetMaskedOutputValue(2, v);}
54  void SetMaskedOutputValue(double v1, double v2, double v3)
55  {double v[3]; v[0]=v1; v[1]=v2; v[2]=v3; this->SetMaskedOutputValue(3, v);}
56  double *GetMaskedOutputValue() {return this->MaskedOutputValue;}
57  int GetMaskedOutputValueLength() {return this->MaskedOutputValueLength;}
58 
60 
66  vtkSetClampMacro ( MaskAlpha, double, 0.0, 1.0 );
67  vtkGetMacro ( MaskAlpha, double );
69 
73  void SetImageInputData(vtkImageData *in);
74 
78  void SetMaskInputData(vtkImageData *in);
79 
81 
87  vtkSetMacro(NotMask,vtkTypeBool);
88  vtkGetMacro(NotMask,vtkTypeBool);
89  vtkBooleanMacro(NotMask, vtkTypeBool);
91 
95  virtual void SetInput1Data(vtkDataObject *in) { this->SetInputData(0,in); }
96  virtual void SetInput2Data(vtkDataObject *in) { this->SetInputData(1,in); }
97 
98 protected:
99  vtkImageMask();
100  ~vtkImageMask() override;
101 
105  double MaskAlpha;
106 
109  vtkInformationVector *) override;
110 
111 
112  void ThreadedRequestData(vtkInformation *request,
113  vtkInformationVector **inputVector,
114  vtkInformationVector *outputVector,
115  vtkImageData ***inData,
116  vtkImageData **outData,
117  int extent[6], int threadId) override;
118 
119 private:
120  vtkImageMask(const vtkImageMask&) = delete;
121  void operator=(const vtkImageMask&) = delete;
122 };
123 
124 #endif
125 
126 
127 
double * GetMaskedOutputValue()
Definition: vtkImageMask.h:56
void SetMaskedOutputValue(double v1, double v2, double v3)
Definition: vtkImageMask.h:54
Store vtkAlgorithm input/output information.
double * MaskedOutputValue
Definition: vtkImageMask.h:102
double MaskAlpha
Definition: vtkImageMask.h:105
void SetMaskedOutputValue(double v1, double v2)
Definition: vtkImageMask.h:52
virtual void SetInput1Data(vtkDataObject *in)
Set the two inputs to this filter.
Definition: vtkImageMask.h:95
void SetInputData(vtkDataObject *)
Assign a data object as input.
Combines a mask and an image.
Definition: vtkImageMask.h:40
int MaskedOutputValueLength
Definition: vtkImageMask.h:103
int GetMaskedOutputValueLength()
Definition: vtkImageMask.h:57
int vtkTypeBool
Definition: vtkABI.h:69
Generic filter that has one input.
void SetMaskedOutputValue(double v)
Definition: vtkImageMask.h:51
a simple class to control print indentation
Definition: vtkIndent.h:39
topologically and geometrically regular array of data
Definition: vtkImageData.h:45
virtual int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Subclasses can reimplement this method to collect information from their inputs and set information f...
vtkTypeBool NotMask
Definition: vtkImageMask.h:104
virtual void SetInput2Data(vtkDataObject *in)
Definition: vtkImageMask.h:96
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.
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.
general representation of visualization data
Definition: vtkDataObject.h:64