VTK  9.2.5
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 =========================================================================*/
52 #ifndef vtkImageMask_h
53 #define vtkImageMask_h
54 
55 #include "vtkImagingCoreModule.h" // For export macro
57 
58 class VTKIMAGINGCORE_EXPORT vtkImageMask : public vtkThreadedImageAlgorithm
59 {
60 public:
61  static vtkImageMask* New();
63  void PrintSelf(ostream& os, vtkIndent indent) override;
64 
68  void SetMaskedOutputValue(int num, double* v);
69  void SetMaskedOutputValue(double v) { this->SetMaskedOutputValue(1, &v); }
70  void SetMaskedOutputValue(double v1, double v2)
71  {
72  double v[2];
73  v[0] = v1;
74  v[1] = v2;
75  this->SetMaskedOutputValue(2, v);
76  }
77  void SetMaskedOutputValue(double v1, double v2, double v3)
78  {
79  double v[3];
80  v[0] = v1;
81  v[1] = v2;
82  v[2] = v3;
83  this->SetMaskedOutputValue(3, v);
84  }
85  double* GetMaskedOutputValue() { return this->MaskedOutputValue; }
86  int GetMaskedOutputValueLength() { return this->MaskedOutputValueLength; }
87 
89 
95  vtkSetClampMacro(MaskAlpha, double, 0.0, 1.0);
96  vtkGetMacro(MaskAlpha, double);
98 
103 
108 
110 
116  vtkSetMacro(NotMask, vtkTypeBool);
117  vtkGetMacro(NotMask, vtkTypeBool);
118  vtkBooleanMacro(NotMask, vtkTypeBool);
120 
124  virtual void SetInput1Data(vtkDataObject* in) { this->SetInputData(0, in); }
125  virtual void SetInput2Data(vtkDataObject* in) { this->SetInputData(1, in); }
126 
127 protected:
129  ~vtkImageMask() override;
130 
134  double MaskAlpha;
135 
137 
139  vtkInformationVector* outputVector, vtkImageData*** inData, vtkImageData** outData,
140  int outExt[6], int threadId) override;
141 
142 private:
143  vtkImageMask(const vtkImageMask&) = delete;
144  void operator=(const vtkImageMask&) = delete;
145 };
146 
147 #endif
general representation of visualization data
void SetInputData(vtkDataObject *)
Assign a data object as input.
topologically and geometrically regular array of data
Definition: vtkImageData.h:163
Combines a mask and an image.
Definition: vtkImageMask.h:59
int MaskedOutputValueLength
Definition: vtkImageMask.h:132
double MaskAlpha
Definition: vtkImageMask.h:134
~vtkImageMask() override
vtkTypeBool NotMask
Definition: vtkImageMask.h:133
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int GetMaskedOutputValueLength()
Definition: vtkImageMask.h:86
static vtkImageMask * New()
double * GetMaskedOutputValue()
Definition: vtkImageMask.h:85
void SetImageInputData(vtkImageData *in)
Set the input to be masked.
double * MaskedOutputValue
Definition: vtkImageMask.h:131
void SetMaskInputData(vtkImageData *in)
Set the mask to be used.
virtual void SetInput2Data(vtkDataObject *in)
Definition: vtkImageMask.h:125
virtual void SetInput1Data(vtkDataObject *in)
Set the two inputs to this filter.
Definition: vtkImageMask.h:124
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Subclasses can reimplement this method to collect information from their inputs and set information f...
void SetMaskedOutputValue(double v1, double v2)
Definition: vtkImageMask.h:70
void SetMaskedOutputValue(double v1, double v2, double v3)
Definition: vtkImageMask.h:77
void SetMaskedOutputValue(int num, double *v)
SetGet the value of the output pixel replaced by mask.
void ThreadedRequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int outExt[6], int threadId) override
If the subclass does not define an Execute method, then the task will be broken up,...
void SetMaskedOutputValue(double v)
Definition: vtkImageMask.h:69
a simple class to control print indentation
Definition: vtkIndent.h:119
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Generic filter that has one input.
int vtkTypeBool
Definition: vtkABI.h:69