VTK  9.1.0
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=========================================================================*/
39#ifndef vtkImageMask_h
40#define vtkImageMask_h
41
42#include "vtkImagingCoreModule.h" // For export macro
44
45class VTKIMAGINGCORE_EXPORT vtkImageMask : public vtkThreadedImageAlgorithm
46{
47public:
48 static vtkImageMask* New();
50 void PrintSelf(ostream& os, vtkIndent indent) override;
51
55 void SetMaskedOutputValue(int num, double* v);
56 void SetMaskedOutputValue(double v) { this->SetMaskedOutputValue(1, &v); }
57 void SetMaskedOutputValue(double v1, double v2)
58 {
59 double v[2];
60 v[0] = v1;
61 v[1] = v2;
62 this->SetMaskedOutputValue(2, v);
63 }
64 void SetMaskedOutputValue(double v1, double v2, double v3)
65 {
66 double v[3];
67 v[0] = v1;
68 v[1] = v2;
69 v[2] = v3;
70 this->SetMaskedOutputValue(3, v);
71 }
72 double* GetMaskedOutputValue() { return this->MaskedOutputValue; }
73 int GetMaskedOutputValueLength() { return this->MaskedOutputValueLength; }
74
76
82 vtkSetClampMacro(MaskAlpha, double, 0.0, 1.0);
83 vtkGetMacro(MaskAlpha, double);
85
90
95
97
103 vtkSetMacro(NotMask, vtkTypeBool);
104 vtkGetMacro(NotMask, vtkTypeBool);
105 vtkBooleanMacro(NotMask, vtkTypeBool);
107
111 virtual void SetInput1Data(vtkDataObject* in) { this->SetInputData(0, in); }
112 virtual void SetInput2Data(vtkDataObject* in) { this->SetInputData(1, in); }
113
114protected:
116 ~vtkImageMask() override;
117
121 double MaskAlpha;
122
124
126 vtkInformationVector* outputVector, vtkImageData*** inData, vtkImageData** outData,
127 int outExt[6], int threadId) override;
128
129private:
130 vtkImageMask(const vtkImageMask&) = delete;
131 void operator=(const vtkImageMask&) = delete;
132};
133
134#endif
general representation of visualization data
Definition: vtkDataObject.h:69
void SetInputData(vtkDataObject *)
Assign a data object as input.
topologically and geometrically regular array of data
Definition: vtkImageData.h:57
Combines a mask and an image.
Definition: vtkImageMask.h:46
int MaskedOutputValueLength
Definition: vtkImageMask.h:119
double MaskAlpha
Definition: vtkImageMask.h:121
~vtkImageMask() override
vtkTypeBool NotMask
Definition: vtkImageMask.h:120
double * GetMaskedOutputValue()
Definition: vtkImageMask.h:72
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int GetMaskedOutputValueLength()
Definition: vtkImageMask.h:73
static vtkImageMask * New()
void SetImageInputData(vtkImageData *in)
Set the input to be masked.
double * MaskedOutputValue
Definition: vtkImageMask.h:118
void SetMaskInputData(vtkImageData *in)
Set the mask to be used.
virtual void SetInput2Data(vtkDataObject *in)
Definition: vtkImageMask.h:112
virtual void SetInput1Data(vtkDataObject *in)
Set the two inputs to this filter.
Definition: vtkImageMask.h:111
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:57
void SetMaskedOutputValue(double v1, double v2, double v3)
Definition: vtkImageMask.h:64
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:56
a simple class to control print indentation
Definition: vtkIndent.h:43
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Generic filter that has one input.
int vtkTypeBool
Definition: vtkABI.h:69