peak::pipeline::modules::IAutoFeature Class Reference

Interface for modules that provide auto feature functionality. More...

#include <peak_common/pipeline/modules/peak_common_iautofeature_module.hpp>

Inheritance diagram for peak::pipeline::modules::IAutoFeature:

Public Member Functions
virtual void	SetGainModule (std::shared_ptr< IGain > gainModule)=0
	Called by the pipeline to set the gain module for the auto feature module.
virtual void	SetColorCorrectionMatrix (const std::array< float, 9 > &matrix)=0
	Notifies the auto feature module of the currently used color correction matrix.
Public Member Functions inherited from peak::pipeline::modules::IModule
	~IModule () override=default
virtual void	SetEnabled (bool enabled)=0
	Sets the enabled state of the module.
virtual PEAK_COMMON_NO_DISCARD bool	IsEnabled () const =0
	Checks whether the module is currently enabled.
virtual PEAK_COMMON_NO_DISCARD const char *	GetType () const =0
	Returns the type identifier of the module.
virtual PEAK_COMMON_NO_DISCARD peak::common::Any	Process (const peak::common::Any &input) const =0
	Processes input data and returns the result.
virtual void	ResetToDefault ()=0
	Resets the module to its default state. The enabled state is not reset.
Public Member Functions inherited from peak::common::serialization::ISerializable
virtual	~ISerializable ()=default
virtual void	Serialize (IArchive &archive) const =0
	Serializes the current object into the provided archive.
virtual void	Deserialize (const IArchive &archive)=0
	Deserializes the object's state from the provided archive.

Detailed Description

Interface for modules that provide auto feature functionality.

Defines the necessary functions that any auto feature module must implement.

Since

ids_peak_common 1.0

Member Function Documentation

SetColorCorrectionMatrix()

virtual void peak::pipeline::modules::IAutoFeature::SetColorCorrectionMatrix ( const std::array< float, 9 > & matrix )

pure virtual

Notifies the auto feature module of the currently used color correction matrix.

Allows the auto feature module to adjust its algorithms and gain values based on the provided color correction matrix.

Parameters

matrix

The 3x3 color correction matrix in row-major order that is currently in use.

SetGainModule()

virtual void peak::pipeline::modules::IAutoFeature::SetGainModule ( std::shared_ptr< IGain > gainModule )

pure virtual

Called by the pipeline to set the gain module for the auto feature module.

This function provides the gain module that the auto feature module can use to apply gain adjustments as needed.

Parameters

gainModule

The gain module to be controlled by the auto feature module.

Since

ids_peak_common 1.0

---

The documentation for this class was generated from the following file:

• peak_common/pipeline/modules/peak_common_iautofeature_module.hpp