VTK  9.2.6
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
36class VTKIMAGINGCORE_EXPORT vtkImageMask : public vtkThreadedImageAlgorithm
37{
38public:
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
81
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
105protected:
107 ~vtkImageMask() override;
108
112 double MaskAlpha;
113
115
117 vtkInformationVector* outputVector, vtkImageData*** inData, vtkImageData** outData,
118 int outExt[6], int threadId) override;
119
120private:
121 vtkImageMask(const vtkImageMask&) = delete;
122 void operator=(const vtkImageMask&) = delete;
123};
124
125#endif
general representation of visualization data
void SetInputData(vtkDataObject *)
Assign a data object as input.
topologically and geometrically regular array of data
Combines a mask and an image.
int MaskedOutputValueLength
~vtkImageMask() override
vtkTypeBool NotMask
double * GetMaskedOutputValue()
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int GetMaskedOutputValueLength()
static vtkImageMask * New()
void SetImageInputData(vtkImageData *in)
Set the input to be masked.
double * MaskedOutputValue
void SetMaskInputData(vtkImageData *in)
Set the mask to be used.
virtual void SetInput2Data(vtkDataObject *in)
virtual void SetInput1Data(vtkDataObject *in)
Set the two inputs to this filter.
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)
void SetMaskedOutputValue(double v1, double v2, double v3)
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)
a simple class to control print indentation
Definition vtkIndent.h:34
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Generic filter that has one input.
int vtkTypeBool
Definition vtkABI.h:69