IAutoFeature Class Reference

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

Inheritance diagram for 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.
virtual void	SetEnabled (bool enabled)=0
	Sets the enabled state of the module.
virtual bool	IsEnabled () const =0
	Checks whether the module is currently enabled.
virtual const char *	GetType () const =0
	Returns the type identifier of the module.
virtual 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.
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

Definition at line 35 of file peak_common_iautofeature_module.hpp.

Member Function Documentation

Deserialize()

virtual void Deserialize ( const IArchive & archive )

pure virtualinherited

Deserializes the object's state from the provided archive.

This method reads data from the given peak::common::serialization::IArchive and reconstructs the internal state of the object.

Parameters

archive

The archive from which to read the object's data.

Implemented in ColorCorrectionMatrix, ColorMatrixTransformationModule, DebayerModule, DownsamplingModule, GainModule, HotpixelCorrectionModule, MonoConversionModule, PixelFormatConversionModule, SharpeningModule, ToneCurveCorrectionModule, TransformationModule, and UnpackModule.

GetType()

virtual const char * GetType ( ) const

pure virtualinherited

Returns the type identifier of the module.

This should be a unique string identifying the specific implementation of the module.

Returns

A null-terminated string identifying the module type.

Since

ids_peak_common 1.0

Implemented in ColorMatrixTransformationModule, DebayerModule, DownsamplingModule, GainModule, HotpixelCorrectionModule, MonoConversionModule, PixelFormatConversionModule, SharpeningModule, ToneCurveCorrectionModule, TransformationModule, and UnpackModule.

IsEnabled()

virtual bool IsEnabled ( ) const

pure virtualinherited

Checks whether the module is currently enabled.

Returns

True if the module is enabled, false otherwise.

Since

ids_peak_common 1.0

Implemented in ColorMatrixTransformationModule, DebayerModule, DownsamplingModule, GainModule, HotpixelCorrectionModule, MonoConversionModule, PixelFormatConversionModule, SharpeningModule, ToneCurveCorrectionModule, TransformationModule, and UnpackModule.

Process()

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

pure virtualinherited

Processes input data and returns the result.

This function is called by the pipeline to process a unit of data.

Parameters

input

The input data to be processed.

Returns

The processed input.

Since

ids_peak_common 1.0

Implemented in ColorMatrixTransformationModule, DebayerModule, DownsamplingModule, GainModule, HotpixelCorrectionModule, MonoConversionModule, PixelFormatConversionModule, SharpeningModule, ToneCurveCorrectionModule, TransformationModule, and UnpackModule.

ResetToDefault()

virtual void ResetToDefault ( )

pure virtualinherited

Resets the module to its default state. The enabled state is not reset.

Since

ids_peak_common 1.0

Implemented in ColorMatrixTransformationModule, DebayerModule, DownsamplingModule, GainModule, HotpixelCorrectionModule, MonoConversionModule, PixelFormatConversionModule, SharpeningModule, ToneCurveCorrectionModule, TransformationModule, and UnpackModule.

Serialize()

virtual void Serialize ( IArchive & archive ) const

pure virtualinherited

Serializes the current object into the provided archive.

This method writes the internal state of the object into the given peak::common::serialization::IArchive so that it can later be reconstructed using Deserialize().

Parameters

archive

The archive to which the object's data will be written.

Implemented in ColorCorrectionMatrix, ColorMatrixTransformationModule, DebayerModule, DownsamplingModule, GainModule, HotpixelCorrectionModule, MonoConversionModule, PixelFormatConversionModule, SharpeningModule, ToneCurveCorrectionModule, TransformationModule, and UnpackModule.

SetColorCorrectionMatrix()

virtual void 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.

SetEnabled()

virtual void SetEnabled ( bool enabled )

pure virtualinherited

Sets the enabled state of the module.

Parameters

enabled

True to enable the module, false to disable it.

Since

ids_peak_common 1.0

Implemented in ColorMatrixTransformationModule, DebayerModule, DownsamplingModule, GainModule, HotpixelCorrectionModule, MonoConversionModule, PixelFormatConversionModule, SharpeningModule, ToneCurveCorrectionModule, TransformationModule, and UnpackModule.

SetGainModule()

virtual void 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