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