IDS peak IPL  v1.3.2
peak_ipl_gamma_corrector.hpp
Go to the documentation of this file.
1 
11 #pragma once
12 
18 
22 namespace peak
23 {
24 namespace ipl
25 {
26 
27 class Image;
28 
32 class GammaCorrector final
33 {
34 public:
37  GammaCorrector(const GammaCorrector& other) = delete;
38  GammaCorrector& operator=(const GammaCorrector& other) = delete;
41 
51  void SetGammaCorrectionValue(float gammaValue);
52 
60  float GammaCorrectionValue() const;
61 
69  float GammaCorrectionMin() const;
70 
78  float GammaCorrectionMax() const;
79 
89  bool IsPixelFormatSupported(PixelFormatName pixelFormatName) const;
90 
100  void ProcessInPlace(Image& image) const;
101 
112  Image Process(const Image& inputImage) const;
113 
114 private:
115  PEAK_IPL_GAMMA_CORRECTOR_HANDLE m_backendHandle{};
116 };
117 
119 {
121 }
122 
124 {
126 }
127 
129 {
130  *this = std::move(other);
131 }
132 
134 {
135  if (this != &other)
136  {
138  m_backendHandle = other.m_backendHandle;
139  other.m_backendHandle = nullptr;
140  }
141 
142  return *this;
143 }
144 
145 inline void GammaCorrector::SetGammaCorrectionValue(float gammaValue)
146 {
149  m_backendHandle, reinterpret_cast<float*>(&gammaValue));
150  });
151 }
152 
154 {
155  float gammaValue;
156 
159  m_backendHandle, reinterpret_cast<float*>(&gammaValue));
160  });
161 
162  return gammaValue;
163 }
164 
166 {
167  float gammaMin;
168 
171  m_backendHandle, reinterpret_cast<float*>(&gammaMin));
172  });
173 
174  return gammaMin;
175 }
176 
178 {
179  float gammaMax;
180 
183  m_backendHandle, reinterpret_cast<float*>(&gammaMax));
184  });
185 
186  return gammaMax;
187 }
188 
189 inline bool GammaCorrector::IsPixelFormatSupported(PixelFormatName pixelFormatName) const
190 {
191  PEAK_IPL_BOOL8 isPixelFormatSupported = 0;
192 
195  static_cast<PEAK_IPL_PIXEL_FORMAT>(pixelFormatName),
196  reinterpret_cast<PEAK_IPL_BOOL8*>(&isPixelFormatSupported));
197  });
198 
199  return isPixelFormatSupported > 0;
200 }
201 
202 inline void GammaCorrector::ProcessInPlace(Image& image) const
203 {
206  m_backendHandle, ImageBackendAccessor::BackendHandle(image));
207  });
208 }
209 
210 inline Image GammaCorrector::Process(const Image& inputImage) const
211 {
212  PEAK_IPL_IMAGE_HANDLE outputImageHandle = nullptr;
215  m_backendHandle, ImageBackendAccessor::BackendHandle(inputImage), &outputImageHandle);
216  });
217 
218  return ImageBackendAccessor::CreateImage(outputImageHandle);
219 }
220 
221 } /* namespace ipl */
222 } /* namespace peak */
PEAK_IPL_C_API PEAK_IPL_GammaCorrector_SetGammaCorrectionValue(PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, float *gammaValue)
Sets the value of the gamma correction.
#define PEAK_IPL_C_ABI_PREFIX
Definition: peak_ipl_dll_defines.h:16
PixelFormatName
Enum holding the possible pixel format names.
Definition: peak_ipl_simple_types.hpp:38
struct PEAK_IPL_GAMMA_CORRECTOR * PEAK_IPL_GAMMA_CORRECTOR_HANDLE
Definition: peak_ipl_backend.h:223
The "peak::ipl" namespace contains the whole image processing library.
Definition: peak_ipl_color_corrector.hpp:30
PEAK_IPL_C_API PEAK_IPL_GammaCorrector_Construct(PEAK_IPL_GAMMA_CORRECTOR_HANDLE *gammaCorrectorHandle)
Creates a gamma corrector.
PEAK_IPL_C_API PEAK_IPL_GammaCorrector_ProcessInPlace(PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, PEAK_IPL_IMAGE_HANDLE imageHandle)
Corrects the gammas of the given image.
Applies gamma correction to the data.
Definition: peak_ipl_gamma_corrector.hpp:32
void ExecuteAndMapReturnCodes(const CallableType &callableObject)
Definition: peak_ipl_exception.hpp:128
void ProcessInPlace(Image &image) const
Corrects the gammas of the given image in place i.e. it will change the input image.
Definition: peak_ipl_gamma_corrector.hpp:202
Stores the pixel format, width and height of an image and the pointer to the image buffer...
Definition: peak_ipl_image.hpp:37
PEAK_IPL_C_API PEAK_IPL_GammaCorrector_Destruct(PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle)
Destroys the gamma corrector associated with the given handle.
PEAK_IPL_C_API PEAK_IPL_GammaCorrector_GetIsPixelFormatSupported(PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, PEAK_IPL_PIXEL_FORMAT pixelFormat, PEAK_IPL_BOOL8 *isPixelFormatSupported)
Asks the given gamma corrector whether it supports the given pixel format.
bool IsPixelFormatSupported(PixelFormatName pixelFormatName) const
Returns whether the gamma corrector supports the given pixel format.
Definition: peak_ipl_gamma_corrector.hpp:189
~GammaCorrector()
Definition: peak_ipl_gamma_corrector.hpp:123
struct PEAK_IPL_IMAGE * PEAK_IPL_IMAGE_HANDLE
Definition: peak_ipl_backend.h:227
GammaCorrector & operator=(const GammaCorrector &other)=delete
PEAK_IPL_C_API PEAK_IPL_GammaCorrector_GetGammaCorrectionMin(PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, float *gammaMin)
Returns the minimum gamma corrector value which can be set.
float GammaCorrectionMax() const
Returns the maximum value of the gamma correction.
Definition: peak_ipl_gamma_corrector.hpp:177
PEAK_IPL_C_API PEAK_IPL_GammaCorrector_GetGammaCorrectionMax(PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, float *gammaMax)
Returns the maximum gamma corrector value which can be set.
int8_t PEAK_IPL_BOOL8
Definition: peak_ipl_backend.h:25
void SetGammaCorrectionValue(float gammaValue)
Sets the values of the gamma correction.
Definition: peak_ipl_gamma_corrector.hpp:145
Image Process(const Image &inputImage) const
Corrects the gammas of the given image.
Definition: peak_ipl_gamma_corrector.hpp:210
PEAK_IPL_C_API PEAK_IPL_GammaCorrector_Process(PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle)
Corrects the gammas of the given image.
PEAK_IPL_C_API PEAK_IPL_GammaCorrector_GetGammaCorrectionValue(PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle, float *gammaValue)
Returns the gamma corrector value.
float GammaCorrectionValue() const
Returns the value of the gamma correction.
Definition: peak_ipl_gamma_corrector.hpp:153
float GammaCorrectionMin() const
Returns the minimum value of the gamma correction.
Definition: peak_ipl_gamma_corrector.hpp:165
GammaCorrector()
Definition: peak_ipl_gamma_corrector.hpp:118