#include <peak_icv/pipeline/detail/peak_icv_debayer_module.hpp>

Inheritance diagram for DebayerModule:

[legend]

Public Member Functions
	DebayerModule ()
	Creates an instance of class DebayerModule with default settings.

	~DebayerModule () override

	DebayerModule (const DebayerModule &other)=delete
	Copy constructor for class DebayerModule is deleted.

	DebayerModule (DebayerModule &&other) noexcept

DebayerModule &	operator= (const DebayerModule &other)=delete
	Copy assignment for class DebayerModule is deleted.

DebayerModule &	operator= (DebayerModule &&other) noexcept

void	Serialize (peak::common::serialization::IArchive &archive) const override
	Serializes the object's internal state into the provided archive.

void	Deserialize (const peak::common::serialization::IArchive &archive) override
	Restores the object's state from the provided archive.

void	SetEnabled (bool enabled) override
	Enables or disables the module.

bool	IsEnabled () const override
	Gets whether this module is currently enabled.

const char *	GetType () const override
	Returns the type of the module for serialization purposes.

void	ResetToDefault () override
	Resets all module settings to its default settings.

void	SetChannelLayout (DebayerChannelLayout layout)
	Set the output channel layout for debayered images.

DebayerChannelLayout	GetChannelLayout () const
	Gets the current channel layout setting.

void	SetConversionPolicy (DebayerConversionPolicy policy)
	Set the debayer conversion policy.

DebayerConversionPolicy	GetConversionPolicy () const
	Retrieves the current conversion policy.

void	SetTargetBitDepth (size_t bitDepth)
	Set the target bit depth for processed images.

void	SetProcessingPolicy (ProcessingPolicy policy)
	Set the processing policy.

peak::icv::Image	Process (const peak::icv::Image &input) const
	Converts a Bayer or mono image to a color image, or returns the input image unchanged.

peak::common::Any	Process (const peak::common::Any &input) const override
	Converts a Bayer or mono image to a color image, or returns the input image unchanged.

void	ReleaseBuffers () const
	Frees unused internal buffers.

Detailed Description

Debayer is an image pipeline module that converts Bayer RAW images into standard color formats.

It performs demosaicing on Bayer-pattern RAW images, converting them into full-color images using configurable channel layouts such as RGB, BGR, RGBA, or BGRA. The bit depth of the output is inferred from the input, depending on the selected processing policy.

The module can also be configured to convert Bayer or monochrome images, while passing through other image types unchanged.

Defaults

DebayerChannelLayout::RGB
DebayerConversionPolicy::BayerOnly
Target bit depth = 8
ProcessingPolicy::Fast

Since: ids_peak_icv 1.0

Definition at line 99 of file peak_icv_debayer_module.hpp.

Constructor & Destructor Documentation

◆ DebayerModule() [1/3]

DebayerModule ( )

inline

Creates an instance of class DebayerModule with default settings.

Since: ids_peak_icv 1.0

Definition at line 365 of file peak_icv_debayer_module.hpp.

◆ ~DebayerModule()

~DebayerModule ( )

inlineoverride

Since: ids_peak_icv 1.0

Definition at line 372 of file peak_icv_debayer_module.hpp.

◆ DebayerModule() [2/3]

DebayerModule ( const DebayerModule & other )

delete

Copy constructor for class DebayerModule is deleted.

Note: If you need to copy a module, you can create a new one and copy the parameters via Serialize() and Deserialize().

Since: ids_peak_icv 1.0

◆ DebayerModule() [3/3]

DebayerModule ( DebayerModule && other )

inlinenoexcept

Since: ids_peak_icv 1.0

Definition at line 380 of file peak_icv_debayer_module.hpp.

Member Function Documentation

◆ Deserialize()

void Deserialize ( const peak::common::serialization::IArchive & archive )

inlineoverridevirtual

Restores the object's state from the provided archive.

This function reads and applies all necessary parameters from the given archive to reconstruct the internal state of the object. It ensures that the object is restored to a valid and consistent state.

Parameters

archive The source archive containing the serialized parameters.

Exceptions

CorruptedException	If Archive is malformed, misses keys or the values are invalid
NotSupportedException	If the 'Version' entry indicates an unsupported version.

Note: This function requires that the archive contains all expected fields as produced by a corresponding Serialize() call.

Since: ids_peak_icv 1.0

Implements ISerializable.

Definition at line 411 of file peak_icv_debayer_module.hpp.

◆ GetChannelLayout()

DebayerChannelLayout GetChannelLayout ( ) const

inline

Gets the current channel layout setting.

Returns: The currently configured channel layout.

Since: ids_peak_icv 1.0

Definition at line 448 of file peak_icv_debayer_module.hpp.

◆ GetConversionPolicy()

DebayerConversionPolicy GetConversionPolicy ( ) const

inline

Retrieves the current conversion policy.

Returns: The currently configured DebayerConversionPolicy.

Since: ids_peak_icv 1.0

Definition at line 459 of file peak_icv_debayer_module.hpp.

◆ GetType()

const char * GetType ( ) const

inlineoverridevirtual

Returns the type of the module for serialization purposes.

Returns: A string representing the module's type.

Since: ids_peak_icv 1.0

Implements IModule.

Definition at line 437 of file peak_icv_debayer_module.hpp.

◆ IsEnabled()

bool IsEnabled ( ) const

inlineoverridevirtual

Gets whether this module is currently enabled.

Returns: true if enabled; otherwise false.

Since: ids_peak_icv 1.0

Implements IModule.

Definition at line 432 of file peak_icv_debayer_module.hpp.

◆ operator=() [1/2]

DebayerModule & operator= ( const DebayerModule & other )

delete

Copy assignment for class DebayerModule is deleted.

Note: If you need to copy a module, you can create a new one and copy the parameters via Serialize() and Deserialize().

Since: ids_peak_icv 1.0

◆ operator=() [2/2]

DebayerModule & operator= ( DebayerModule && other )

inlinenoexcept

Since: ids_peak_icv 1.0

Definition at line 389 of file peak_icv_debayer_module.hpp.

◆ Process() [1/2]

peak::common::Any Process ( const peak::common::Any & input ) const

inlineoverridevirtual

Converts a Bayer or mono image to a color image, or returns the input image unchanged.

A demosaicing algorithm is applied according to the configured conversion policy. The input image is returned unchanged if the module is disabled, the policy indicates bypass, or the image format is not eligible for conversion. Otherwise, the Bayer RAW image is converted to the configured output format.

Note: This operation disregards any specified image regions and processes the entire image.

Parameters

input The input image (Bayer, mono, or already color).

Returns: The processed color image or the unmodified input image.

Exceptions

peak::common::InvalidCastException If the input cast to peak::icv::Image failed.

Since: ids_peak_icv 1.0

Implements IModule.

Definition at line 576 of file peak_icv_debayer_module.hpp.

◆ Process() [2/2]

peak::icv::Image Process ( const peak::icv::Image & input ) const

inline

Converts a Bayer or mono image to a color image, or returns the input image unchanged.

A demosaicing algorithm is applied according to the configured conversion policy. The input image is returned unchanged if the module is disabled, the policy indicates bypass, or the image format is not eligible for conversion. Otherwise, the Bayer RAW image is converted to the configured output format.

Note: This operation disregards any specified image regions and processes the entire image.

Parameters

input The input image (Bayer, mono, or already color).

Returns: The processed color image or the unmodified input image.

Since: ids_peak_icv 1.0

Definition at line 571 of file peak_icv_debayer_module.hpp.

◆ ReleaseBuffers()

void ReleaseBuffers ( ) const

inline

Frees unused internal buffers.

This module uses pre-allocated internal buffers to accelerate conversions. When the image size or pixel format changes, new buffers are allocated, which may cause the internal buffer pool to grow over time. This function can be used to release unused buffers and reduce memory usage.

Note: Avoid calling this function too frequently (e.g., after every resize or format change), as it introduces some overhead.

Since: ids_peak_icv 1.0

Definition at line 604 of file peak_icv_debayer_module.hpp.

◆ ResetToDefault()

void ResetToDefault ( )

inlineoverridevirtual

Resets all module settings to its default settings.

Note: The enabled state does not change when calling this function.

Since: ids_peak_icv 1.0

Implements IModule.

Definition at line 421 of file peak_icv_debayer_module.hpp.

◆ Serialize()

void Serialize ( peak::common::serialization::IArchive & archive ) const

inlineoverridevirtual

Serializes the object's internal state into the provided archive.

This function populates the given archive with all parameters required to fully represent the current state of the object. It ensures that the object can be reconstructed or transmitted accurately by saving all relevant data members in a consistent and structured format.

Parameters

archive The target archive that will store the serialized parameters.