VTK
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 =========================================================================*/
27 #ifndef vtkImageThreshold_h
28 #define vtkImageThreshold_h
29 
30 
31 #include "vtkImagingCoreModule.h" // For export macro
33 
34 class VTKIMAGINGCORE_EXPORT vtkImageThreshold : public vtkThreadedImageAlgorithm
35 {
36 public:
37  static vtkImageThreshold *New();
39  void PrintSelf(ostream& os, vtkIndent indent) override;
40 
44  void ThresholdByUpper(double thresh);
45 
49  void ThresholdByLower(double thresh);
50 
54  void ThresholdBetween(double lower, double upper);
55 
57 
60  vtkSetMacro(ReplaceIn, vtkTypeBool);
61  vtkGetMacro(ReplaceIn, vtkTypeBool);
62  vtkBooleanMacro(ReplaceIn, vtkTypeBool);
64 
66 
69  void SetInValue(double val);
70  vtkGetMacro(InValue, double);
72 
74 
77  vtkSetMacro(ReplaceOut, vtkTypeBool);
78  vtkGetMacro(ReplaceOut, vtkTypeBool);
79  vtkBooleanMacro(ReplaceOut, vtkTypeBool);
81 
83 
86  void SetOutValue(double val);
87  vtkGetMacro(OutValue, double);
89 
91 
94  vtkGetMacro(UpperThreshold, double);
95  vtkGetMacro(LowerThreshold, double);
97 
99 
102  vtkSetMacro(OutputScalarType, int);
103  vtkGetMacro(OutputScalarType, int);
105  {this->SetOutputScalarType(VTK_DOUBLE);}
107  {this->SetOutputScalarType(VTK_FLOAT);}
109  {this->SetOutputScalarType(VTK_LONG);}
111  {this->SetOutputScalarType(VTK_UNSIGNED_LONG);};
113  {this->SetOutputScalarType(VTK_INT);}
115  {this->SetOutputScalarType(VTK_UNSIGNED_INT);}
117  {this->SetOutputScalarType(VTK_SHORT);}
119  {this->SetOutputScalarType(VTK_UNSIGNED_SHORT);}
121  {this->SetOutputScalarType(VTK_CHAR);}
123  {this->SetOutputScalarType(VTK_SIGNED_CHAR);}
125  {this->SetOutputScalarType(VTK_UNSIGNED_CHAR);}
127 
128 protected:
130  ~vtkImageThreshold() override {}
131 
135  double InValue;
137  double OutValue;
138 
140 
142 
143  void ThreadedRequestData(vtkInformation *request,
144  vtkInformationVector **inputVector,
145  vtkInformationVector *outputVector,
146  vtkImageData ***inData, vtkImageData **outData,
147  int extent[6], int id) override;
148 
149 private:
150  vtkImageThreshold(const vtkImageThreshold&) = delete;
151  void operator=(const vtkImageThreshold&) = delete;
152 };
153 
154 #endif
155 
156 
157 
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:130
VTK_UNSIGNED_INT
#define VTK_UNSIGNED_INT
Definition: vtkType.h:55
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:41
VTK_UNSIGNED_SHORT
#define VTK_UNSIGNED_SHORT
Definition: vtkType.h:53
vtkImageThreshold::SetOutputScalarTypeToInt
void SetOutputScalarTypeToInt()
Definition: vtkImageThreshold.h:112
vtkThreadedImageAlgorithm
Generic filter that has one input.
Definition: vtkThreadedImageAlgorithm.h:43
vtkImageThreshold::ReplaceOut
vtkTypeBool ReplaceOut
Definition: vtkImageThreshold.h:136
vtkImageThreshold::InValue
double InValue
Definition: vtkImageThreshold.h:135
vtkImageThreshold::SetOutputScalarTypeToSignedChar
void SetOutputScalarTypeToSignedChar()
Definition: vtkImageThreshold.h:122
vtkImageThreshold::ReplaceIn
vtkTypeBool ReplaceIn
Definition: vtkImageThreshold.h:134
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:49
vtkImageThreshold::SetOutputScalarTypeToUnsignedInt
void SetOutputScalarTypeToUnsignedInt()
Definition: vtkImageThreshold.h:114
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:45
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
VTK_FLOAT
#define VTK_FLOAT
Definition: vtkType.h:58
VTK_DOUBLE
#define VTK_DOUBLE
Definition: vtkType.h:59
VTK_UNSIGNED_CHAR
#define VTK_UNSIGNED_CHAR
Definition: vtkType.h:51
VTK_LONG
#define VTK_LONG
Definition: vtkType.h:56
vtkImageThreshold::SetOutputScalarTypeToDouble
void SetOutputScalarTypeToDouble()
Definition: vtkImageThreshold.h:104
vtkImageThreshold::SetOutputScalarTypeToLong
void SetOutputScalarTypeToLong()
Definition: vtkImageThreshold.h:108
vtkImageThreshold::UpperThreshold
double UpperThreshold
Definition: vtkImageThreshold.h:132
VTK_UNSIGNED_LONG
#define VTK_UNSIGNED_LONG
Definition: vtkType.h:57
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
vtkAlgorithm::New
static vtkAlgorithm * New()
vtkImageThreshold
Flexible threshold.
Definition: vtkImageThreshold.h:34
VTK_SHORT
#define VTK_SHORT
Definition: vtkType.h:52
vtkImageThreshold::SetOutputScalarTypeToFloat
void SetOutputScalarTypeToFloat()
Definition: vtkImageThreshold.h:106
vtkImageThreshold::LowerThreshold
double LowerThreshold
Definition: vtkImageThreshold.h:133
vtkImageThreshold::OutputScalarType
int OutputScalarType
Definition: vtkImageThreshold.h:139
VTK_SIGNED_CHAR
#define VTK_SIGNED_CHAR
Definition: vtkType.h:50
vtkImageThreshold::SetOutputScalarTypeToUnsignedShort
void SetOutputScalarTypeToUnsignedShort()
Definition: vtkImageThreshold.h:118
vtkX3D::extent
Definition: vtkX3D.h:345
VTK_INT
#define VTK_INT
Definition: vtkType.h:54
vtkImageThreshold::SetOutputScalarTypeToShort
void SetOutputScalarTypeToShort()
Definition: vtkImageThreshold.h:116
vtkImageThreshold::SetOutputScalarTypeToChar
void SetOutputScalarTypeToChar()
Definition: vtkImageThreshold.h:120
vtkImageThreshold::SetOutputScalarTypeToUnsignedLong
void SetOutputScalarTypeToUnsignedLong()
Definition: vtkImageThreshold.h:110
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkImageThreshold::SetOutputScalarTypeToUnsignedChar
void SetOutputScalarTypeToUnsignedChar()
Definition: vtkImageThreshold.h:124
vtkImageThreshold::OutValue
double OutValue
Definition: vtkImageThreshold.h:137