IDS peak AFL v2.1.0
Loading...
Searching...
No Matches
BrightnessExposureLimit Class Reference

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

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

Inheritance diagram for BrightnessExposureLimit:
BrightnessLimit IFeature< IntervalD > ISerializable

Public Member Functions

 BrightnessExposureLimit (std::shared_ptr< peak::afl::Controller > controller)
 Constructs a BrightnessExposureLimit feature with the specified controller.
void Set (const IntervalD &value) override
 Sets the exposure time limits.
IntervalD Get () const override
 Gets the current exposure time 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

Exposure limit feature implementation for brightness controllers.

The BrightnessExposureLimit class provides a feature interface for managing the exposure time limits in automatic brightness control. This feature defines the minimum and maximum exposure times that the automatic exposure algorithm is allowed to use.

Exposure limits are essential for:

  • Preventing motion blur by limiting maximum exposure time
  • Avoiding underexposure by setting minimum exposure time
  • Maintaining frame rate requirements
  • Preventing camera shake in handheld applications

The limits are typically expressed in seconds or microseconds, depending on the camera implementation.

See also
BrightnessLimit
peak::afl::Controller::SetExposureLimit()
peak::afl::Controller::GetExposureLimit()
Since
1.8

Constructor & Destructor Documentation

◆ BrightnessExposureLimit()

BrightnessExposureLimit ( std::shared_ptr< peak::afl::Controller > controller)
inlineexplicit

Constructs a BrightnessExposureLimit feature with the specified controller.

Parameters
[in]controllerShared pointer to the auto controller that will be used to manage the exposure limit parameter. The controller must support exposure limit operations.
Precondition
controller must not be null
controller must support exposure limit functionality
Since
1.8

Member Function Documentation

◆ Get()

IntervalD Get ( ) const
inlineoverridevirtual

Gets the current exposure time limits.

Retrieves the currently configured minimum and maximum exposure times that constrain the automatic brightness algorithm.

Returns
The current exposure limits as an IntervalD object
Exceptions
Maythrow 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)
inlineoverridevirtual

Sets the exposure time limits.

Sets the minimum and maximum exposure times that the automatic brightness algorithm is allowed to use. The exposure time will be constrained to values within this interval.

Parameters
[in]valueThe interval defining the exposure limits. Minimum value should be less than or equal to maximum value. Units are typically seconds or microseconds.
Exceptions
Maythrow exceptions based on the underlying controller implementation if the interval is invalid or if the controller is in an invalid state.
See also
Get()
Since
1.8

Implements IFeature< IntervalD >.


The documentation for this class was generated from the following file: