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 =========================================================================*/
30 #ifndef vtkImageMask_h
31 #define vtkImageMask_h
32 
33 
34 #include "vtkImagingCoreModule.h" // For export macro
36 
37 class VTKIMAGINGCORE_EXPORT vtkImageMask : public vtkThreadedImageAlgorithm
38 {
39 public:
40  static vtkImageMask *New();
42  void PrintSelf(ostream& os, vtkIndent indent) override;
43 
47  void SetMaskedOutputValue(int num, double *v);
48  void SetMaskedOutputValue(double v) {this->SetMaskedOutputValue(1, &v);}
49  void SetMaskedOutputValue(double v1, double v2)
50  {double v[2]; v[0]=v1; v[1]=v2; this->SetMaskedOutputValue(2, v);}
51  void SetMaskedOutputValue(double v1, double v2, double v3)
52  {double v[3]; v[0]=v1; v[1]=v2; v[2]=v3; this->SetMaskedOutputValue(3, v);}
53  double *GetMaskedOutputValue() {return this->MaskedOutputValue;}
54  int GetMaskedOutputValueLength() {return this->MaskedOutputValueLength;}
55 
57 
63  vtkSetClampMacro ( MaskAlpha, double, 0.0, 1.0 );
64  vtkGetMacro ( MaskAlpha, double );
66 
70  void SetImageInputData(vtkImageData *in);
71 
75  void SetMaskInputData(vtkImageData *in);
76 
78 
84  vtkSetMacro(NotMask,vtkTypeBool);
85  vtkGetMacro(NotMask,vtkTypeBool);
86  vtkBooleanMacro(NotMask, vtkTypeBool);
88 
92  virtual void SetInput1Data(vtkDataObject *in) { this->SetInputData(0,in); }
93  virtual void SetInput2Data(vtkDataObject *in) { this->SetInputData(1,in); }
94 
95 protected:
96  vtkImageMask();
97  ~vtkImageMask() override;
98 
102  double MaskAlpha;
103 
106  vtkInformationVector *) override;
107 
108 
109  void ThreadedRequestData(vtkInformation *request,
110  vtkInformationVector **inputVector,
111  vtkInformationVector *outputVector,
112  vtkImageData ***inData,
113  vtkImageData **outData,
114  int extent[6], int threadId) override;
115 
116 private:
117  vtkImageMask(const vtkImageMask&) = delete;
118  void operator=(const vtkImageMask&) = delete;
119 };
120 
121 #endif
122 
123 
124 
double * GetMaskedOutputValue()
Definition: vtkImageMask.h:53
void SetMaskedOutputValue(double v1, double v2, double v3)
Definition: vtkImageMask.h:51
Store vtkAlgorithm input/output information.
double * MaskedOutputValue
Definition: vtkImageMask.h:99
double MaskAlpha
Definition: vtkImageMask.h:102
void SetMaskedOutputValue(double v1, double v2)
Definition: vtkImageMask.h:49
virtual void SetInput1Data(vtkDataObject *in)
Set the two inputs to this filter.
Definition: vtkImageMask.h:92
void SetInputData(vtkDataObject *)
Assign a data object as input.
Combines a mask and an image.
Definition: vtkImageMask.h:37
int MaskedOutputValueLength
Definition: vtkImageMask.h:100
int GetMaskedOutputValueLength()
Definition: vtkImageMask.h:54
int vtkTypeBool
Definition: vtkABI.h:69
Generic filter that has one input.
void SetMaskedOutputValue(double v)
Definition: vtkImageMask.h:48
a simple class to control print indentation
Definition: vtkIndent.h:33
topologically and geometrically regular array of data
Definition: vtkImageData.h:39
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:101
virtual void SetInput2Data(vtkDataObject *in)
Definition: vtkImageMask.h:93
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,...
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:58