VTK  9.0.1
vtkImageShiftScale.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkImageShiftScale.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 =========================================================================*/
25 #ifndef vtkImageShiftScale_h
26 #define vtkImageShiftScale_h
27 
28 #include "vtkImagingCoreModule.h" // For export macro
30 
31 class VTKIMAGINGCORE_EXPORT vtkImageShiftScale : public vtkThreadedImageAlgorithm
32 {
33 public:
34  static vtkImageShiftScale* New();
36  void PrintSelf(ostream& os, vtkIndent indent) override;
37 
39 
42  vtkSetMacro(Shift, double);
43  vtkGetMacro(Shift, double);
45 
47 
50  vtkSetMacro(Scale, double);
51  vtkGetMacro(Scale, double);
53 
55 
59  vtkSetMacro(OutputScalarType, int);
60  vtkGetMacro(OutputScalarType, int);
61  void SetOutputScalarTypeToDouble() { this->SetOutputScalarType(VTK_DOUBLE); }
62  void SetOutputScalarTypeToFloat() { this->SetOutputScalarType(VTK_FLOAT); }
63  void SetOutputScalarTypeToLong() { this->SetOutputScalarType(VTK_LONG); }
64  void SetOutputScalarTypeToUnsignedLong() { this->SetOutputScalarType(VTK_UNSIGNED_LONG); }
65  void SetOutputScalarTypeToInt() { this->SetOutputScalarType(VTK_INT); }
66  void SetOutputScalarTypeToUnsignedInt() { this->SetOutputScalarType(VTK_UNSIGNED_INT); }
67  void SetOutputScalarTypeToShort() { this->SetOutputScalarType(VTK_SHORT); }
68  void SetOutputScalarTypeToUnsignedShort() { this->SetOutputScalarType(VTK_UNSIGNED_SHORT); }
69  void SetOutputScalarTypeToChar() { this->SetOutputScalarType(VTK_CHAR); }
70  void SetOutputScalarTypeToUnsignedChar() { this->SetOutputScalarType(VTK_UNSIGNED_CHAR); }
72 
74 
82  vtkSetMacro(ClampOverflow, vtkTypeBool);
83  vtkGetMacro(ClampOverflow, vtkTypeBool);
84  vtkBooleanMacro(ClampOverflow, vtkTypeBool);
86 
87 protected:
89  ~vtkImageShiftScale() override;
90 
91  double Shift;
92  double Scale;
95 
97 
99  vtkImageData*** inData, vtkImageData** outData, int outExt[6], int threadId) override;
100 
101 private:
102  vtkImageShiftScale(const vtkImageShiftScale&) = delete;
103  void operator=(const vtkImageShiftScale&) = delete;
104 };
105 
106 #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,...
vtkImageShiftScale::SetOutputScalarTypeToInt
void SetOutputScalarTypeToInt()
Definition: vtkImageShiftScale.h:65
vtkImageShiftScale::SetOutputScalarTypeToFloat
void SetOutputScalarTypeToFloat()
Definition: vtkImageShiftScale.h:62
VTK_UNSIGNED_INT
#define VTK_UNSIGNED_INT
Definition: vtkType.h:49
vtkImageShiftScale::SetOutputScalarTypeToUnsignedShort
void SetOutputScalarTypeToUnsignedShort()
Definition: vtkImageShiftScale.h:68
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:35
VTK_UNSIGNED_SHORT
#define VTK_UNSIGNED_SHORT
Definition: vtkType.h:47
vtkThreadedImageAlgorithm
Generic filter that has one input.
Definition: vtkThreadedImageAlgorithm.h:37
vtkImageShiftScale::SetOutputScalarTypeToShort
void SetOutputScalarTypeToShort()
Definition: vtkImageShiftScale.h:67
vtkThreadedImageAlgorithm.h
vtkImageShiftScale::SetOutputScalarTypeToUnsignedLong
void SetOutputScalarTypeToUnsignedLong()
Definition: vtkImageShiftScale.h:64
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...
vtkImageShiftScale::SetOutputScalarTypeToChar
void SetOutputScalarTypeToChar()
Definition: vtkImageShiftScale.h:69
vtkImageShiftScale::Shift
double Shift
Definition: vtkImageShiftScale.h:91
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
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:41
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkImageShiftScale
shift and scale an input image
Definition: vtkImageShiftScale.h:31
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
vtkImageShiftScale::SetOutputScalarTypeToUnsignedChar
void SetOutputScalarTypeToUnsignedChar()
Definition: vtkImageShiftScale.h:70
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()
vtkImageShiftScale::OutputScalarType
int OutputScalarType
Definition: vtkImageShiftScale.h:93
vtkImageShiftScale::Scale
double Scale
Definition: vtkImageShiftScale.h:92
VTK_SHORT
#define VTK_SHORT
Definition: vtkType.h:46
vtkImageShiftScale::SetOutputScalarTypeToLong
void SetOutputScalarTypeToLong()
Definition: vtkImageShiftScale.h:63
vtkImageShiftScale::SetOutputScalarTypeToUnsignedInt
void SetOutputScalarTypeToUnsignedInt()
Definition: vtkImageShiftScale.h:66
vtkImageShiftScale::ClampOverflow
vtkTypeBool ClampOverflow
Definition: vtkImageShiftScale.h:94
VTK_INT
#define VTK_INT
Definition: vtkType.h:48
vtkImageShiftScale::SetOutputScalarTypeToDouble
void SetOutputScalarTypeToDouble()
Definition: vtkImageShiftScale.h:61
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69