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

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

Inheritance diagram for BrightnessGainHostLimit:

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

Host gain limit feature implementation for brightness controllers.

The BrightnessGainHostLimit class manages host-side gain limits that are applied in software on the host system rather than in the camera hardware. Host gain provides additional amplification through software processing, allowing for extended gain ranges beyond hardware capabilities.

This feature is particularly useful when hardware gain limits are insufficient for the required brightness levels, or when software-based gain processing provides better control over the amplification characteristics.

Note: Host gain is applied after image acquisition and may affect processing performance depending on the implementation.

See also: BrightnessLimit; peak::afl::Controller::SetGainHostLimit(); peak::afl::Controller::GetGainHostLimit(); BrightnessGainAnalogLimit; BrightnessGainDigitalLimit

Since: 1.8

Constructor & Destructor Documentation

◆ BrightnessGainHostLimit()

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

inlineexplicit

Constructs a host gain limit feature with the specified controller.

Parameters

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

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

Since: 1.8

Member Function Documentation

◆ Get()

IntervalD Get ( ) const

inlineoverridevirtual

Gets the current host gain limits.

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