Gain limit feature implementation for brightness controllers. More...

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

Inheritance diagram for BrightnessGainLimit:

Public Member Functions
	BrightnessGainLimit (std::shared_ptr< peak::afl::Controller > controller)
	Constructs a BrightnessGainLimit feature with the specified controller.

void	Set (const IntervalD &value) override
	Sets the overall gain limits.

PEAK_COMMON_NO_DISCARD IntervalD	Get () const override
	Gets the current overall 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

Gain limit feature implementation for brightness controllers.

The BrightnessGainLimit class provides a feature interface for managing the overall gain limits in automatic brightness control. This feature defines the minimum and maximum gain values that the automatic exposure algorithm is allowed to use.

Gain limits help control:

Image noise by limiting maximum gain
Minimum sensitivity requirements
Dynamic range optimization
Signal-to-noise ratio management

See also: BrightnessLimit; peak::afl::Controller::SetGainLimit(); peak::afl::Controller::GetGainLimit()

Since: 1.8

Constructor & Destructor Documentation

◆ BrightnessGainLimit()

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

inlineexplicit

Constructs a BrightnessGainLimit feature with the specified controller.

Parameters

[in] controller Shared pointer to the auto controller that will be used to manage the gain limit parameter.

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

Since: 1.8

Member Function Documentation

◆ Get()

PEAK_COMMON_NO_DISCARD IntervalD Get ( ) const

inlineoverridevirtual

Gets the current overall gain limits.

Returns: The current gain limits as an IntervalD object

Since: 1.8

Implements IFeature< IntervalD >.

◆ Set()

void Set ( const IntervalD & value )

inlineoverridevirtual

Sets the overall gain limits.