IDS peak IPL v1.17.1
Loading...
Searching...
No Matches
peak_ipl_lut.hpp
Go to the documentation of this file.
1
10
11#pragma once
12
18
23
24namespace peak
25{
26namespace ipl
27{
28
29class Image;
30
50class Lut final
51{
52public:
56 enum class Channel
57 {
59 Red = 0,
61 Green = 1,
63 Blue = 2,
65 All = 3
66 };
67
72 enum class Selector
73 {
82 };
83
146
153 Lut();
154
161 ~Lut();
162
173 Lut(const Lut& other);
174
185 Lut& operator=(const Lut& other);
186
195 Lut(Lut&& other) noexcept;
196
205 Lut& operator=(Lut&& other) noexcept;
206
218 PEAK_IPL_NO_DISCARD uint32_t LutValue(Selector selector, Channel channel, uint32_t index) const;
219
232 void SetLutValue(Selector selector, Channel channel, uint32_t index, uint32_t value);
233
246 PEAK_IPL_NO_DISCARD std::vector<uint32_t> AllLutValues(Selector selector, Channel channel) const;
247
259 void SetAllLutValues(Selector selector, Channel channel, const std::vector<uint32_t>& values);
260
269 void SetLutPreset(Selector selector, Preset preset);
270
281
293 void ProcessInPlace(Image& image) const;
294
307 PEAK_IPL_NO_DISCARD Image Process(const Image& inputImage) const;
308
309private:
310 PEAK_IPL_LUT_HANDLE m_backendHandle{};
311};
312
313inline Lut::Lut()
314{
316}
317
318inline Lut::~Lut()
319{
320 if (m_backendHandle)
321 {
322 (void)PEAK_IPL_C_ABI_PREFIX PEAK_IPL_Lut_Destruct(m_backendHandle);
323 }
324}
325
326inline Lut::Lut(Lut&& other) noexcept
327{
328 *this = std::move(other);
329}
330
331inline Lut::Lut(const Lut& other)
332{
333 if (other.m_backendHandle)
334 {
335 ExecuteAndMapReturnCodes([&] { return PEAK_IPL_C_ABI_PREFIX PEAK_IPL_Lut_Acquire(other.m_backendHandle); });
336 }
337
338 m_backendHandle = other.m_backendHandle;
339}
340
341inline Lut& Lut::operator=(const Lut& other)
342{
343 if (this != &other)
344 {
345 if (m_backendHandle)
346 {
347 (void)PEAK_IPL_C_ABI_PREFIX PEAK_IPL_Lut_Destruct(m_backendHandle);
348 }
349
350 if (other.m_backendHandle)
351 {
353 [&] { return PEAK_IPL_C_ABI_PREFIX PEAK_IPL_Lut_Acquire(other.m_backendHandle); });
354 }
355 }
356
357 m_backendHandle = other.m_backendHandle;
358
359 return *this;
360}
361
362inline Lut& Lut::operator=(Lut&& other) noexcept
363{
364 if (this != &other)
365 {
366 if (m_backendHandle != nullptr)
367 {
368 (void)PEAK_IPL_C_ABI_PREFIX PEAK_IPL_Lut_Destruct(m_backendHandle);
369 }
370 m_backendHandle = other.m_backendHandle;
371 other.m_backendHandle = nullptr;
372 }
373
374 return *this;
375}
376
377inline uint32_t Lut::LutValue(Selector selector, Channel channel, uint32_t index) const
378{
379 uint32_t value = 0;
380
383 m_backendHandle, static_cast<PEAK_IPL_LUT_SELECTOR>(selector), static_cast<PEAK_IPL_LUT_CHANNEL>(channel), index, &value);
384 });
385
386 return value;
387}
388
389inline void Lut::SetLutValue(Selector selector, Channel channel, uint32_t index, uint32_t value)
390{
392 return PEAK_IPL_C_ABI_PREFIX PEAK_IPL_Lut_SetLutValue(m_backendHandle,
393 static_cast<PEAK_IPL_LUT_SELECTOR>(selector), static_cast<PEAK_IPL_LUT_CHANNEL>(channel), index, value);
394 });
395}
396
397inline std::vector<uint32_t> Lut::AllLutValues(Selector selector, Channel channel) const
398{
399 size_t numLutValues = 0;
400
403 static_cast<PEAK_IPL_LUT_SELECTOR>(selector), static_cast<PEAK_IPL_LUT_CHANNEL>(channel), nullptr, &numLutValues);
404 });
405
406 std::vector<uint32_t> vector(numLutValues);
407
410 static_cast<PEAK_IPL_LUT_SELECTOR>(selector), static_cast<PEAK_IPL_LUT_CHANNEL>(channel),
411 reinterpret_cast<uint32_t*>(vector.data()), &numLutValues);
412 });
413
414 return vector;
415}
416
417inline void Lut::SetAllLutValues(Selector selector, Channel channel, const std::vector<uint32_t>& vector)
418{
421 static_cast<PEAK_IPL_LUT_SELECTOR>(selector), static_cast<PEAK_IPL_LUT_CHANNEL>(channel),
422 reinterpret_cast<const uint32_t*>(vector.data()), vector.size());
423 });
424}
425
426inline void Lut::SetLutPreset(Selector selector, Preset preset)
427{
430 m_backendHandle, static_cast<PEAK_IPL_LUT_SELECTOR>(selector), static_cast<PEAK_IPL_LUT_PRESET>(preset));
431 });
432}
433
434inline bool Lut::IsPixelFormatSupported(PixelFormatName pixelFormatName) const
435{
436 PEAK_IPL_BOOL8 isPixelFormatSupported = 0;
437
440 static_cast<PEAK_IPL_PIXEL_FORMAT>(pixelFormatName),
441 reinterpret_cast<PEAK_IPL_BOOL8*>(&isPixelFormatSupported));
442 });
443
444 return isPixelFormatSupported > 0;
445}
446
447inline void Lut::ProcessInPlace(Image& image) const
448{
451 m_backendHandle, ImageBackendAccessor::BackendHandle(image));
452 });
453}
454
455inline Image Lut::Process(const Image& inputImage) const
456{
457 PEAK_IPL_IMAGE_HANDLE outputImageHandle = nullptr;
460 m_backendHandle, ImageBackendAccessor::BackendHandle(inputImage), &outputImageHandle);
461 });
462
463 return ImageBackendAccessor::CreateImage(outputImageHandle);
464}
465
466} /* namespace ipl */
467} /* namespace peak */
Stores the pixel format, width and height of an image and the pointer to the image buffer.
Definition peak_ipl_image.hpp:47
Applies a LUT to the input image data.
Definition peak_ipl_lut.hpp:51
void ProcessInPlace(Image &image) const
Applies the LUT to the given image in place that is, it will change the input image.
Definition peak_ipl_lut.hpp:447
void SetLutValue(Selector selector, Channel channel, uint32_t index, uint32_t value)
Sets a single LUT value for a given selector and channel at an indexed position.
Definition peak_ipl_lut.hpp:389
bool IsPixelFormatSupported(PixelFormatName pixelFormatName) const
Returns whether the LUT supports the given pixel format.
Definition peak_ipl_lut.hpp:434
uint32_t LutValue(Selector selector, Channel channel, uint32_t index) const
Reads a single LUT value for a given selector and channel at an indexed position.
Definition peak_ipl_lut.hpp:377
Channel
Channel parameter to select the channel where the operation is applied.
Definition peak_ipl_lut.hpp:57
@ Blue
Definition peak_ipl_lut.hpp:63
@ All
Definition peak_ipl_lut.hpp:65
@ Green
Definition peak_ipl_lut.hpp:61
@ Red
Definition peak_ipl_lut.hpp:59
void SetLutPreset(Selector selector, Preset preset)
Applies the given preset (identity, inverse, ...) to the specified LUT.
Definition peak_ipl_lut.hpp:426
Image Process(const Image &inputImage) const
Applies the LUT to the given image.
Definition peak_ipl_lut.hpp:455
~Lut()
Destructor for the LUT instance.
Definition peak_ipl_lut.hpp:318
std::vector< uint32_t > AllLutValues(Selector selector, Channel channel) const
Reads all LUT values for a given selector and channel at once.
Definition peak_ipl_lut.hpp:397
void SetAllLutValues(Selector selector, Channel channel, const std::vector< uint32_t > &values)
Sets all LUT values for a given selector and channel at once.
Definition peak_ipl_lut.hpp:417
Selector
Selector parameter to select to which LUT the operation is applied (8/10/12/16 bit LUT)....
Definition peak_ipl_lut.hpp:73
@ Lut_10Bit
Definition peak_ipl_lut.hpp:77
@ Lut_16Bit
Definition peak_ipl_lut.hpp:81
@ Lut_8Bit
Definition peak_ipl_lut.hpp:75
@ Lut_12Bit
Definition peak_ipl_lut.hpp:79
Preset
Preset Selects a predefined LUT.
Definition peak_ipl_lut.hpp:88
@ Jet
Definition peak_ipl_lut.hpp:104
@ Hot
Definition peak_ipl_lut.hpp:110
@ Rainbow
Definition peak_ipl_lut.hpp:116
@ DigitalBlack25Percent
Definition peak_ipl_lut.hpp:139
@ OnlyRed
Definition peak_ipl_lut.hpp:121
@ Binarize
Definition peak_ipl_lut.hpp:144
@ DigitalGain2
Definition peak_ipl_lut.hpp:135
@ OnlyBlue
Definition peak_ipl_lut.hpp:131
@ Inverse
Definition peak_ipl_lut.hpp:98
@ Identity
Definition peak_ipl_lut.hpp:93
@ OnlyGreen
Definition peak_ipl_lut.hpp:126
Lut & operator=(const Lut &other)
Copy assigment for LUT instance.
Definition peak_ipl_lut.hpp:341
Lut()
Constructor for a new LUT instance.
Definition peak_ipl_lut.hpp:313
PixelFormatName
Enum holding the possible pixel format names.
Definition peak_ipl_simple_types.hpp:43
The "peak::ipl" namespace contains the whole image processing library.
void ExecuteAndMapReturnCodes(const CallableType &callableObject)
Definition peak_ipl_exception.hpp:282
#define PEAK_IPL_NO_DISCARD
Definition peak_ipl_attribute_defines.h:25
PEAK_IPL_C_API PEAK_IPL_Lut_GetAllLutValues(PEAK_IPL_LUT_HANDLE lutHandle, PEAK_IPL_LUT_SELECTOR lutSelector, PEAK_IPL_LUT_CHANNEL channel, uint32_t *values, size_t *sizeValues)
Returns all lut values at once in an array.
PEAK_IPL_C_API PEAK_IPL_Lut_SetLutPreset(PEAK_IPL_LUT_HANDLE lutHandle, PEAK_IPL_LUT_SELECTOR lutSelector, PEAK_IPL_LUT_PRESET preset)
Sets the lut to a preset (identity, inverse, ...)
int32_t PEAK_IPL_LUT_PRESET
Definition peak_ipl_backend.h:352
PEAK_IPL_C_API PEAK_IPL_Lut_SetLutValue(PEAK_IPL_LUT_HANDLE lutHandle, PEAK_IPL_LUT_SELECTOR lutSelector, PEAK_IPL_LUT_CHANNEL channel, uint32_t index, uint32_t value)
Sets a value in the lut.
int32_t PEAK_IPL_LUT_SELECTOR
Definition peak_ipl_backend.h:336
PEAK_IPL_C_API PEAK_IPL_Lut_Destruct(PEAK_IPL_LUT_HANDLE lutHandle)
Destroys the lut associated with the given handle.
PEAK_IPL_C_API PEAK_IPL_Lut_GetLutValue(PEAK_IPL_LUT_HANDLE lutHandle, PEAK_IPL_LUT_SELECTOR lutSelector, PEAK_IPL_LUT_CHANNEL channel, uint32_t index, uint32_t *value)
Returns a lut value at the indexed position.
PEAK_IPL_C_API PEAK_IPL_Lut_Acquire(PEAK_IPL_LUT_HANDLE lutHandle)
Increase the reference count of a lut object.
PEAK_IPL_C_API PEAK_IPL_Lut_Process(PEAK_IPL_LUT_HANDLE lutHandle, PEAK_IPL_IMAGE_HANDLE imageHandle, PEAK_IPL_IMAGE_HANDLE *outputImageHandle)
Applies the lut to the given image.
struct PEAK_IPL_IMAGE * PEAK_IPL_IMAGE_HANDLE
Definition peak_ipl_backend.h:405
struct PEAK_IPL_LUT * PEAK_IPL_LUT_HANDLE
Definition peak_ipl_backend.h:429
PEAK_IPL_C_API PEAK_IPL_Lut_SetAllLutValues(PEAK_IPL_LUT_HANDLE lutHandle, PEAK_IPL_LUT_SELECTOR lutSelector, PEAK_IPL_LUT_CHANNEL channel, const uint32_t *values, size_t sizeValues)
Sets all lut values at once over an array.
PEAK_IPL_C_API PEAK_IPL_Lut_IsPixelFormatSupported(PEAK_IPL_LUT_HANDLE lutHandle, PEAK_IPL_PIXEL_FORMAT pixelFormat, PEAK_IPL_BOOL8 *isPixelFormatSupported)
Asks the given lut whether it supports the given pixel format.
PEAK_IPL_C_API PEAK_IPL_Lut_Construct(PEAK_IPL_LUT_HANDLE *lutHandle)
Creates a lut.
int8_t PEAK_IPL_BOOL8
Definition peak_ipl_backend.h:26
PEAK_IPL_C_API PEAK_IPL_Lut_ProcessInPlace(PEAK_IPL_LUT_HANDLE lutHandle, PEAK_IPL_IMAGE_HANDLE imageHandle)
Applies lut to the given image inplace.
int32_t PEAK_IPL_LUT_CHANNEL
Definition peak_ipl_backend.h:327
int32_t PEAK_IPL_PIXEL_FORMAT
Definition peak_ipl_backend.h:173
#define PEAK_IPL_C_ABI_PREFIX
Definition peak_ipl_dll_defines.h:16