VTK  9.0.1
vtkImageThreshold.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkImageThreshold.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 =========================================================================*/
24 #ifndef vtkImageThreshold_h
25 #define vtkImageThreshold_h
26 
27 #include "vtkImagingCoreModule.h" // For export macro
29 
30 class VTKIMAGINGCORE_EXPORT vtkImageThreshold : public vtkThreadedImageAlgorithm
31 {
32 public:
33  static vtkImageThreshold* New();
35  void PrintSelf(ostream& os, vtkIndent indent) override;
36 
40  void ThresholdByUpper(double thresh);
41 
45  void ThresholdByLower(double thresh);
46 
50  void ThresholdBetween(double lower, double upper);
51 
53 
56  vtkSetMacro(ReplaceIn, vtkTypeBool);
57  vtkGetMacro(ReplaceIn, vtkTypeBool);
58  vtkBooleanMacro(ReplaceIn, vtkTypeBool);
60 
62 
65  void SetInValue(double val);
66  vtkGetMacro(InValue, double);
68 
70 
73  vtkSetMacro(ReplaceOut, vtkTypeBool);
74  vtkGetMacro(ReplaceOut, vtkTypeBool);
75  vtkBooleanMacro(ReplaceOut, vtkTypeBool);
77 
79 
82  void SetOutValue(double val);
83  vtkGetMacro(OutValue, double);
85 
87 
90  vtkGetMacro(UpperThreshold, double);
91  vtkGetMacro(LowerThreshold, double);
93 
95 
98  vtkSetMacro(OutputScalarType, int);
99  vtkGetMacro(OutputScalarType, int);
100  void SetOutputScalarTypeToDouble() { this->SetOutputScalarType(VTK_DOUBLE); }
101  void SetOutputScalarTypeToFloat() { this->SetOutputScalarType(VTK_FLOAT); }
102  void SetOutputScalarTypeToLong() { this->SetOutputScalarType(VTK_LONG); }
103  void SetOutputScalarTypeToUnsignedLong() { this->SetOutputScalarType(VTK_UNSIGNED_LONG); }
104  void SetOutputScalarTypeToInt() { this->SetOutputScalarType(VTK_INT); }
105  void SetOutputScalarTypeToUnsignedInt() { this->SetOutputScalarType(VTK_UNSIGNED_INT); }
106  void SetOutputScalarTypeToShort() { this->SetOutputScalarType(VTK_SHORT); }
107  void SetOutputScalarTypeToUnsignedShort() { this->SetOutputScalarType(VTK_UNSIGNED_SHORT); }
108  void SetOutputScalarTypeToChar() { this->SetOutputScalarType(VTK_CHAR); }
109  void SetOutputScalarTypeToSignedChar() { this->SetOutputScalarType(VTK_SIGNED_CHAR); }
110  void SetOutputScalarTypeToUnsignedChar() { this->SetOutputScalarType(VTK_UNSIGNED_CHAR); }
112 
113 protected:
115  ~vtkImageThreshold() override {}
116 
120  double InValue;
122  double OutValue;
123 
125 
127 
128  void ThreadedRequestData(vtkInformation* request, vtkInformationVector** inputVector,
129  vtkInformationVector* outputVector, vtkImageData*** inData, vtkImageData** outData,
130  int extent[6], int id) override;
131 
132 private:
133  vtkImageThreshold(const vtkImageThreshold&) = delete;
134  void operator=(const vtkImageThreshold&) = delete;
135 };
136 
137 #endif
vtkThreadedImageAlgorithm::ThreadedRequestData
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,...
vtkImageThreshold::~vtkImageThreshold
~vtkImageThreshold() override
Definition: vtkImageThreshold.h:115
VTK_UNSIGNED_INT
#define VTK_UNSIGNED_INT
Definition: vtkType.h:49
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:35
VTK_UNSIGNED_SHORT
#define VTK_UNSIGNED_SHORT
Definition: vtkType.h:47
vtkImageThreshold::SetOutputScalarTypeToInt
void SetOutputScalarTypeToInt()
Definition: vtkImageThreshold.h:104
vtkThreadedImageAlgorithm
Generic filter that has one input.
Definition: vtkThreadedImageAlgorithm.h:37
vtkImageThreshold::ReplaceOut
vtkTypeBool ReplaceOut
Definition: vtkImageThreshold.h:121
vtkImageThreshold::InValue
double InValue
Definition: vtkImageThreshold.h:120
vtkImageThreshold::SetOutputScalarTypeToSignedChar
void SetOutputScalarTypeToSignedChar()
Definition: vtkImageThreshold.h:109
vtkImageThreshold::ReplaceIn
vtkTypeBool ReplaceIn
Definition: vtkImageThreshold.h:119
vtkThreadedImageAlgorithm.h
vtkImageAlgorithm::RequestInformation
virtual int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Subclasses can reimplement this method to collect information from their inputs and set information f...
vtkThreadedImageAlgorithm::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
VTK_CHAR
#define VTK_CHAR
Definition: vtkType.h:43
vtkImageThreshold::SetOutputScalarTypeToUnsignedInt
void SetOutputScalarTypeToUnsignedInt()
Definition: vtkImageThreshold.h:105
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:41
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
VTK_FLOAT
#define VTK_FLOAT
Definition: vtkType.h:52
VTK_DOUBLE
#define VTK_DOUBLE
Definition: vtkType.h:53
VTK_UNSIGNED_CHAR
#define VTK_UNSIGNED_CHAR
Definition: vtkType.h:45
VTK_LONG
#define VTK_LONG
Definition: vtkType.h:50
vtkImageThreshold::SetOutputScalarTypeToDouble
void SetOutputScalarTypeToDouble()
Definition: vtkImageThreshold.h:100
vtkImageThreshold::SetOutputScalarTypeToLong
void SetOutputScalarTypeToLong()
Definition: vtkImageThreshold.h:102
vtkImageThreshold::UpperThreshold
double UpperThreshold
Definition: vtkImageThreshold.h:117
VTK_UNSIGNED_LONG
#define VTK_UNSIGNED_LONG
Definition: vtkType.h:51
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:73
vtkAlgorithm::New
static vtkAlgorithm * New()
vtkImageThreshold
Flexible threshold.
Definition: vtkImageThreshold.h:30
VTK_SHORT
#define VTK_SHORT
Definition: vtkType.h:46
vtkImageThreshold::SetOutputScalarTypeToFloat
void SetOutputScalarTypeToFloat()
Definition: vtkImageThreshold.h:101
vtkImageThreshold::LowerThreshold
double LowerThreshold
Definition: vtkImageThreshold.h:118
vtkImageThreshold::OutputScalarType
int OutputScalarType
Definition: vtkImageThreshold.h:124
VTK_SIGNED_CHAR
#define VTK_SIGNED_CHAR
Definition: vtkType.h:44
vtkImageThreshold::SetOutputScalarTypeToUnsignedShort
void SetOutputScalarTypeToUnsignedShort()
Definition: vtkImageThreshold.h:107
vtkX3D::extent
@ extent
Definition: vtkX3D.h:351
VTK_INT
#define VTK_INT
Definition: vtkType.h:48
vtkImageThreshold::SetOutputScalarTypeToShort
void SetOutputScalarTypeToShort()
Definition: vtkImageThreshold.h:106
vtkImageThreshold::SetOutputScalarTypeToChar
void SetOutputScalarTypeToChar()
Definition: vtkImageThreshold.h:108
vtkImageThreshold::SetOutputScalarTypeToUnsignedLong
void SetOutputScalarTypeToUnsignedLong()
Definition: vtkImageThreshold.h:103
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkImageThreshold::SetOutputScalarTypeToUnsignedChar
void SetOutputScalarTypeToUnsignedChar()
Definition: vtkImageThreshold.h:110
vtkImageThreshold::OutValue
double OutValue
Definition: vtkImageThreshold.h:122