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=========================================================================*/
33#ifndef vtkImageMask_h
34#define vtkImageMask_h
35
36#include "vtkImagingCoreModule.h" // For export macro
38
39class VTKIMAGINGCORE_EXPORT vtkImageMask : public vtkThreadedImageAlgorithm
40{
41public:
42 static vtkImageMask* New();
44 void PrintSelf(ostream& os, vtkIndent indent) override;
45
49 void SetMaskedOutputValue(int num, double* v);
50 void SetMaskedOutputValue(double v) { this->SetMaskedOutputValue(1, &v); }
51 void SetMaskedOutputValue(double v1, double v2)
52 {
53 double v[2];
54 v[0] = v1;
55 v[1] = v2;
56 this->SetMaskedOutputValue(2, v);
57 }
58 void SetMaskedOutputValue(double v1, double v2, double v3)
59 {
60 double v[3];
61 v[0] = v1;
62 v[1] = v2;
63 v[2] = v3;
64 this->SetMaskedOutputValue(3, v);
65 }
66 double* GetMaskedOutputValue() { return this->MaskedOutputValue; }
67 int GetMaskedOutputValueLength() { return this->MaskedOutputValueLength; }
68
70
76 vtkSetClampMacro(MaskAlpha, double, 0.0, 1.0);
77 vtkGetMacro(MaskAlpha, double);
79
84
89
91
97 vtkSetMacro(NotMask, vtkTypeBool);
98 vtkGetMacro(NotMask, vtkTypeBool);
99 vtkBooleanMacro(NotMask, vtkTypeBool);
101
105 virtual void SetInput1Data(vtkDataObject* in) { this->SetInputData(0, in); }
106 virtual void SetInput2Data(vtkDataObject* in) { this->SetInputData(1, in); }
107
108protected:
110 ~vtkImageMask() override;
111
115 double MaskAlpha;
116
118
120 vtkInformationVector* outputVector, vtkImageData*** inData, vtkImageData** outData,
121 int outExt[6], int threadId) override;
122
123private:
124 vtkImageMask(const vtkImageMask&) = delete;
125 void operator=(const vtkImageMask&) = delete;
126};
127
128#endif
general representation of visualization data
Definition: vtkDataObject.h:66
void SetInputData(vtkDataObject *)
Assign a data object as input.
topologically and geometrically regular array of data
Definition: vtkImageData.h:54
Combines a mask and an image.
Definition: vtkImageMask.h:40
int MaskedOutputValueLength
Definition: vtkImageMask.h:113
double MaskAlpha
Definition: vtkImageMask.h:115
~vtkImageMask() override
vtkTypeBool NotMask
Definition: vtkImageMask.h:114
double * GetMaskedOutputValue()
Definition: vtkImageMask.h:66
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int GetMaskedOutputValueLength()
Definition: vtkImageMask.h:67
static vtkImageMask * New()
void SetImageInputData(vtkImageData *in)
Set the input to be masked.
double * MaskedOutputValue
Definition: vtkImageMask.h:112
void SetMaskInputData(vtkImageData *in)
Set the mask to be used.
virtual void SetInput2Data(vtkDataObject *in)
Definition: vtkImageMask.h:106
virtual void SetInput1Data(vtkDataObject *in)
Set the two inputs to this filter.
Definition: vtkImageMask.h:105
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:51
void SetMaskedOutputValue(double v1, double v2, double v3)
Definition: vtkImageMask.h:58
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:50
a simple class to control print indentation
Definition: vtkIndent.h:40
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Generic filter that has one input.
int vtkTypeBool
Definition: vtkABI.h:69