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

Inheritance diagram for IGain:

[legend]

Public Member Functions
virtual void	SetMaster (float value)=0
	Sets the master gain value.

virtual float	GetMaster () const =0
	Retrieves the current master gain value.

virtual void	SetRed (float value)=0
	Sets the gain value for the red channel.

virtual float	GetRed () const =0
	Retrieves the gain value for the red channel.

virtual void	SetGreen (float value)=0
	Sets the gain value for the green channel.

virtual float	GetGreen () const =0
	Retrieves the gain value for the green channel.

virtual void	SetBlue (float value)=0
	Sets the gain value for the blue channel.

virtual float	GetBlue () const =0
	Retrieves the gain value for the blue channel.

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 gain control functionality.

A gain module consists of a master gain value applied to all channels, along with individual gain values for the red, green, and blue channels.

Definition at line 30 of file peak_common_igain_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.

◆ GetBlue()

virtual float GetBlue ( ) const

pure virtual

Retrieves the gain value for the blue channel.

Returns: The blue channel gain value.

Since: ids_peak_common 1.0

Implemented in GainModule.

◆ GetGreen()

virtual float GetGreen ( ) const

pure virtual

Retrieves the gain value for the green channel.

Returns: The green channel gain value.

Since: ids_peak_common 1.0

Implemented in GainModule.

◆ GetMaster()

virtual float GetMaster ( ) const

pure virtual

Retrieves the current master gain value.

Returns: The master gain value.

Since: ids_peak_common 1.0

Implemented in GainModule.

◆ GetRed()

virtual float GetRed ( ) const

pure virtual

Retrieves the gain value for the red channel.

Returns: The red channel gain value.

Since: ids_peak_common 1.0

Implemented in GainModule.

◆ 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.

◆ SetBlue()

virtual void SetBlue ( float value )

pure virtual

Sets the gain value for the blue channel.

Parameters

value The gain value for the blue channel.

Since: ids_peak_common 1.0

Implemented in GainModule.

◆ 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.

◆ SetGreen()

virtual void SetGreen ( float value )

pure virtual

Sets the gain value for the green channel.

Parameters

value The gain value for the green channel.

Since: ids_peak_common 1.0

Implemented in GainModule.

◆ SetMaster()

virtual void SetMaster ( float value )

pure virtual

Sets the master gain value.

This value is applied uniformly to all color channels.

Parameters

value The master gain value to apply.

Since: ids_peak_common 1.0

Implemented in GainModule.

◆ SetRed()

virtual void SetRed ( float value )

pure virtual

Sets the gain value for the red channel.

Parameters

value The gain value for the red channel.

Since: ids_peak_common 1.0

Implemented in GainModule.

Public Member Functions

Detailed Description

Member Function Documentation

◆ Deserialize()

◆ GetBlue()

◆ GetGreen()

◆ GetMaster()

◆ GetRed()

◆ GetType()

◆ IsEnabled()

◆ Process()

◆ ResetToDefault()

◆ Serialize()

◆ SetBlue()

◆ SetEnabled()

◆ SetGreen()

◆ SetMaster()

◆ SetRed()