IDSpeakIPL  v1.8.0
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:
42 
50 
62  GammaCorrector(const GammaCorrector& other);
63 
76 
85  GammaCorrector(GammaCorrector&& other) noexcept;
86 
95  GammaCorrector& operator=(GammaCorrector&& other) noexcept;
96 
106  void SetGammaCorrectionValue(float gammaValue);
107 
116 
125 
134 
144  PEAK_IPL_NO_DISCARD bool IsPixelFormatSupported(PixelFormatName pixelFormatName) const;
145 
155  void ProcessInPlace(Image& image) const;
156 
167  PEAK_IPL_NO_DISCARD Image Process(const Image& inputImage) const;
168 
169 private:
170  PEAK_IPL_GAMMA_CORRECTOR_HANDLE m_backendHandle{};
171 };
172 
174 {
176 }
177 
179 {
180  if (m_backendHandle)
181  {
183  }
184 }
185 
187 {
188  *this = std::move(other);
189 }
190 
192 {
193 
194 
195  if (other.m_backendHandle)
196  {
198  }
199 
200  m_backendHandle = other.m_backendHandle;
201 }
202 
204 {
205  if (this != &other)
206  {
207  if (m_backendHandle)
208  {
210  }
211 
212  if (other.m_backendHandle)
213  {
215  [&] { return PEAK_IPL_C_ABI_PREFIX PEAK_IPL_GammaCorrector_Acquire(other.m_backendHandle); });
216  }
217  }
218 
219  m_backendHandle = other.m_backendHandle;
220 
221  return *this;
222 }
223 
225 {
226  if (this != &other)
227  {
229  m_backendHandle = other.m_backendHandle;
230  other.m_backendHandle = nullptr;
231  }
232 
233  return *this;
234 }
235 
236 inline void GammaCorrector::SetGammaCorrectionValue(float gammaValue)
237 {
240  m_backendHandle, reinterpret_cast<float*>(&gammaValue));
241  });
242 }
243 
245 {
246  float gammaValue;
247 
250  m_backendHandle, reinterpret_cast<float*>(&gammaValue));
251  });
252 
253  return gammaValue;
254 }
255 
257 {
258  float gammaMin;
259 
262  m_backendHandle, reinterpret_cast<float*>(&gammaMin));
263  });
264 
265  return gammaMin;
266 }
267 
269 {
270  float gammaMax;
271 
274  m_backendHandle, reinterpret_cast<float*>(&gammaMax));
275  });
276 
277  return gammaMax;
278 }
279 
280 inline bool GammaCorrector::IsPixelFormatSupported(PixelFormatName pixelFormatName) const
281 {
282  PEAK_IPL_BOOL8 isPixelFormatSupported = 0;
283 
286  static_cast<PEAK_IPL_PIXEL_FORMAT>(pixelFormatName),
287  reinterpret_cast<PEAK_IPL_BOOL8*>(&isPixelFormatSupported));
288  });
289 
290  return isPixelFormatSupported > 0;
291 }
292 
293 inline void GammaCorrector::ProcessInPlace(Image& image) const
294 {
297  m_backendHandle, ImageBackendAccessor::BackendHandle(image));
298  });
299 }
300 
301 inline Image GammaCorrector::Process(const Image& inputImage) const
302 {
303  PEAK_IPL_IMAGE_HANDLE outputImageHandle = nullptr;
306  m_backendHandle, ImageBackendAccessor::BackendHandle(inputImage), &outputImageHandle);
307  });
308 
309  return ImageBackendAccessor::CreateImage(outputImageHandle);
310 }
311 
312 } /* namespace ipl */
313 } /* namespace peak */
#define PEAK_IPL_NO_DISCARD
Definition: peak_ipl_backend.h:26
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:350
The "peak::ipl" namespace contains the whole image processing library.
Definition: peak_ipl_binning.hpp:22
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:182
void ProcessInPlace(Image &image) const
Corrects the gammas of the given image in place that is, it will change the input image...
Definition: peak_ipl_gamma_corrector.hpp:293
Stores the pixel format, width and height of an image and the pointer to the image buffer...
Definition: peak_ipl_image.hpp:39
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.
PEAK_IPL_C_API PEAK_IPL_GammaCorrector_Acquire(PEAK_IPL_GAMMA_CORRECTOR_HANDLE gammaCorrectorHandle)
Increase the reference count of a gamma corrector object.
GammaCorrector & operator=(const GammaCorrector &other)
Copy assigment for GammaCorrector instance.
Definition: peak_ipl_gamma_corrector.hpp:203
PEAK_IPL_NO_DISCARD bool IsPixelFormatSupported(PixelFormatName pixelFormatName) const
Returns whether the gamma corrector supports the given pixel format.
Definition: peak_ipl_gamma_corrector.hpp:280
~GammaCorrector()
Destructor for the GammaCorrector instance.
Definition: peak_ipl_gamma_corrector.hpp:178
struct PEAK_IPL_IMAGE * PEAK_IPL_IMAGE_HANDLE
Definition: peak_ipl_backend.h:354
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.
PEAK_IPL_NO_DISCARD float GammaCorrectionMax() const
Returns the maximum value of the gamma correction.
Definition: peak_ipl_gamma_corrector.hpp:268
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:41
void SetGammaCorrectionValue(float gammaValue)
Sets the values of the gamma correction.
Definition: peak_ipl_gamma_corrector.hpp:236
PEAK_IPL_NO_DISCARD Image Process(const Image &inputImage) const
Corrects the gammas of the given image.
Definition: peak_ipl_gamma_corrector.hpp:301
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.
PEAK_IPL_NO_DISCARD float GammaCorrectionValue() const
Returns the value of the gamma correction.
Definition: peak_ipl_gamma_corrector.hpp:244
PEAK_IPL_NO_DISCARD float GammaCorrectionMin() const
Returns the minimum value of the gamma correction.
Definition: peak_ipl_gamma_corrector.hpp:256
GammaCorrector()
Constructor for a new GammaCorrector instance.
Definition: peak_ipl_gamma_corrector.hpp:173