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

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

Inheritance diagram for BrightnessGainAnalogLimit:

Public Member Functions
	BrightnessGainAnalogLimit (std::shared_ptr< peak::afl::Controller > controller)
	Constructs an analog gain limit feature with the specified controller.
void	Set (const IntervalD &value) override
	Sets the analog gain limits.
IntervalD	Get () const override
	Gets the current analog 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

Analog gain limit feature implementation for brightness controllers.

The BrightnessGainAnalogLimit class manages analog gain limits that are applied at the sensor level before digitization. Analog gain affects the signal before it is converted to digital values, providing clean amplification with minimal noise impact compared to digital gain.

This feature allows automatic brightness controllers to constrain the analog gain values within specified limits, ensuring optimal image quality while preventing excessive noise or saturation.

See also: BrightnessLimit; peak::afl::Controller::SetGainAnalogLimit(); peak::afl::Controller::GetGainAnalogLimit(); BrightnessGainDigitalLimit

Since: 1.8

Constructor & Destructor Documentation

◆ BrightnessGainAnalogLimit()

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

inlineexplicit

Constructs an analog gain limit feature with the specified controller.

Parameters

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

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

Since: 1.8

Member Function Documentation

◆ Get()

IntervalD Get ( ) const

inlineoverridevirtual

Gets the current analog gain limits.

Returns: The current analog 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 )