Digital gain limit feature implementation for brightness controllers. More...

#include <peak_afl/pipeline/modules/controllers/features/peak_afl_brightness_limit.hpp>

Inheritance diagram for BrightnessGainDigitalLimit:

Public Member Functions
	BrightnessGainDigitalLimit (std::shared_ptr< peak::afl::Controller > controller)
	Constructs a digital gain limit feature with the specified controller.
void	Set (const IntervalD &value) override
	Sets the digital gain limits.
IntervalD	Get () const override
	Gets the current digital gain limits.
Public Member Functions inherited from BrightnessLimit
void	Serialize (peak::common::serialization::IArchive &archive) const override
	Serializes the current brightness limit to an archive.
void	Deserialize (const peak::common::serialization::IArchive &archive) override
	Deserializes the brightness limit from an archive.
Public Member Functions inherited from IFeature< IntervalD >
virtual	~IFeature ()=default
	Virtual destructor for proper cleanup of derived classes.

Detailed Description

Digital gain limit feature implementation for brightness controllers.

The BrightnessGainDigitalLimit class manages digital gain limits that are applied after sensor digitization. Digital gain is applied to the digital signal after analog-to-digital conversion, providing additional amplification but potentially introducing more noise compared to analog gain.

This feature allows automatic brightness controllers to constrain the digital gain values within specified limits, balancing brightness requirements with acceptable noise levels.

See also: BrightnessLimit; peak::afl::Controller::SetGainDigitalLimit(); peak::afl::Controller::GetGainDigitalLimit(); BrightnessGainAnalogLimit

Since: 1.8

Constructor & Destructor Documentation

◆ BrightnessGainDigitalLimit()

BrightnessGainDigitalLimit ( std::shared_ptr< peak::afl::Controller > controller )

inlineexplicit

Constructs a digital gain limit feature with the specified controller.

Parameters

[in] controller Shared pointer to the auto controller that will be used to manage the digital gain limits. The controller must support digital gain operations.

Precondition: controller must not be null; controller must support digital gain functionality

Since: 1.8

Member Function Documentation

◆ Get()

IntervalD Get ( ) const

inlineoverridevirtual

Gets the current digital gain limits.

Returns: The current digital gain limits as an IntervalD object

Exceptions

May	throw exceptions based on the underlying controller implementation if the controller is in an invalid state

See also: Set()

Since: 1.8

Implements IFeature< IntervalD >.

◆ Set()

void Set ( const IntervalD & value )