Advanced automatic focus controller with comprehensive feature set. More...

#include <peak_afl/pipeline/modules/controllers/peak_afl_advanced_auto_focus.hpp>

Inheritance diagram for AdvancedAutoFocus:

Public Member Functions
	AdvancedAutoFocus (peak::afl::Manager &manager)
	Constructs an AdvancedAutoFocus instance.
	~AdvancedAutoFocus () override=default
	Destructor.
std::string	GetName () const override
	Gets the controller name.
void	Serialize (peak::common::serialization::IArchive &archive) const override
	Serializes the controller configuration to an archive.
void	Deserialize (const peak::common::serialization::IArchive &archive) override
	Deserializes the controller configuration from an archive.
void	SetMode (ControllerMode mode) override
	Sets the controller operation mode.
ControllerMode	GetMode () const override
	Gets the current controller operation mode.
bool	IsRunning () const override
	Checks if the controller is currently running.
void	ResetToDefault () override
	Resets the controller to its default configuration.
features::SkipFrames &	SkipFrames () const
	Gets the skip frames feature controller.
features::Hysteresis &	Hysteresis () const
	Gets the hysteresis feature controller.
features::WeightedRois &	WeightedROIs () const
	Gets the weighted regions of interest feature controller.
features::SharpnessAlgorithm &	SharpnessAlgorithm () const
	Gets the sharpness algorithm feature controller.
features::SearchAlgorithm &	SearchAlgorithm () const
	Gets the search algorithm feature controller.
features::FocusLimit &	FocusLimit () const
	Gets the focus limit feature controller.
ControllerType	GetType () const override
	Gets the controller type identifier.
IController::FinishedCallbackHandle	RegisterFinishedCallback (const IController::FinishedCallback &callback)
	Registers a callback for processing completion notifications.
void	UnregisterFinishedCallback (IController::FinishedCallbackHandle callbackHandle)
	Unregisters a previously registered callback.
Public Member Functions inherited from IController
virtual	~IController ()=default
	Virtual destructor for proper cleanup of derived classes.
	IController (const IController &)=delete
	Copy constructor deleted to prevent copying.
IController &	operator= (const IController &)=delete
	Copy assignment deleted to prevent copying.
	IController (IController &&)=delete
	Move constructor deleted to prevent moving.
IController &	operator= (IController &&)=delete
	Move assignment deleted to prevent moving.

Additional Inherited Members
Public Types inherited from IController
using	FinishedCallback
	Callback function type for operation completion notifications.
using	FinishedCallbackHandle
	Handle type for managing callback registrations.
Protected Member Functions inherited from IController
peak::afl::Manager &	GetManager ()
	Gets a reference to the API manager.

Detailed Description

Advanced automatic focus controller with comprehensive feature set.

The AdvancedAutoFocus class provides a sophisticated and highly configurable interface for automatic focus control. This controller offers the complete focus feature set with granular control over all focusing mechanisms and algorithmic options.

Advanced Features:

Comprehensive algorithm suite: All search and sharpness algorithms with fine-tuning
Advanced ROI management: Complex weighted region configurations
Precision control: Granular focus limits and hysteresis settings
Callback architecture: Comprehensive event notification system
Full serialization: Complete configuration state management
Processing notifications: Real-time focus operation feedback

Focus Search Algorithms:

Auto Selection: Intelligent algorithm choice based on scene analysis
Golden Ratio Search: Optimized for smooth, predictable focus curves
Hill Climbing: Fast convergence for time-critical applications
Global Search: Maximum accuracy for challenging focus conditions
Full Scan: Complete range analysis for precision applications

Focus Sharpness Analysis:

Tenengrad: High-precision gradient analysis for technical imaging
Sobel: Robust edge detection for varied lighting conditions
Mean Score: Statistical analysis for textured or patterned subjects
Histogram Variance: Optimal for uniform illumination scenarios
Auto Selection: Scene-adaptive sharpness measurement

Note: This controller requires a valid manager instance for camera communication; Advanced features may require specific hardware capabilities; For simplified usage, consider BasicAutoFocus instead

See also: BasicAutoFocus; FocusSearchAlgorithm; FocusSharpnessAlgorithm; WeightedROI; detail::IController

Since: 1.8

Constructor & Destructor Documentation

◆ AdvancedAutoFocus()

AdvancedAutoFocus ( peak::afl::Manager & manager )

inlineexplicit

Constructs an AdvancedAutoFocus instance.

Parameters

manager Reference to the API manager that handles controller lifecycle

Initializes the focus controller with the specified manager. The controller will be ready to perform automatic focus operations once configured and activated.

Since: 1.8

◆ ~AdvancedAutoFocus()

~AdvancedAutoFocus ( )

overridedefault

Destructor.

Default destructor that properly cleans up controller resources.

Member Function Documentation

◆ Deserialize()

void Deserialize ( const peak::common::serialization::IArchive & archive )

inlineoverridevirtual

Deserializes the controller configuration from an archive.

Parameters

archive Reference to the serialization archive containing configuration data

Restores the controller configuration state from the provided archive. This allows previously saved focus controller settings to be loaded and applied.

Since: 1.8

Implements ISerializable.

◆ FocusLimit()

features::FocusLimit & FocusLimit ( ) const

inline

Gets the focus limit feature controller.

Returns: features::FocusLimit& Reference to the focus limit feature controller

The focus limit feature defines the minimum and maximum focus positions that the controller is allowed to use. This prevents the focus system from searching beyond physically meaningful or optically useful ranges.

Note: This method is marked as NO_DISCARD to ensure the return value is used

Since: 1.8

◆ GetMode()

ControllerMode GetMode ( ) const

inlineoverridevirtual

Gets the current controller operation mode.

Returns: ControllerMode The current operation mode of the controller

Note: This method is marked as NO_DISCARD to ensure the return value is used

Since: 1.8

Implements IController.

◆ GetName()

std::string GetName ( ) const

inlineoverridevirtual

Gets the controller name.

Returns: std::string The name identifier for this controller ("AdvancedAutoFocus")

Note: This method is marked as NO_DISCARD to ensure the return value is used

Since: 1.8

Implements IController.

◆ GetType()

ControllerType GetType ( ) const

inlineoverridevirtual

Gets the controller type identifier.

Returns: ControllerType The type identifier for this controller (ControllerType::Focus)

Note: This method is marked as NO_DISCARD to ensure the return value is used

Since: 1.8

Implements IController.

◆ Hysteresis()

features::Hysteresis & Hysteresis ( ) const

inline

Gets the hysteresis feature controller.

Returns: features::Hysteresis& Reference to the hysteresis feature controller

The hysteresis feature prevents focus hunting by adding stability to focus decisions. It requires a minimum change in focus quality before triggering a focus adjustment, reducing oscillation around the optimal focus position.

Note: This method is marked as NO_DISCARD to ensure the return value is used

Since: 1.8

◆ IsRunning()

bool IsRunning ( ) const

inlineoverridevirtual

Checks if the controller is currently running.

Returns: bool True if the controller is active (not in Off mode), false otherwise

A controller is considered running when it's not in the Off mode. This indicates whether the automatic focus processing is currently active.

Note: This method is marked as NO_DISCARD to ensure the return value is used

Since: 1.8

Implements IController.

◆ RegisterFinishedCallback()

IController::FinishedCallbackHandle RegisterFinishedCallback ( const IController::FinishedCallback & callback )

inline

Registers a callback for processing completion notifications.

Parameters

callback The callback function to register

Returns: IController::FinishedCallbackHandle Handle for the registered callback

Registers a callback function that will be invoked when focus operations complete. This includes both successful focus acquisitions and focus search failures. The returned handle can be used to unregister the callback later.

Since: 1.8

◆ ResetToDefault()

void ResetToDefault ( )

inlineoverridevirtual

Resets the controller to its default configuration.

Restores all controller settings to their default values. This includes resetting operation mode, focus algorithms, ROI settings, and other configuration parameters to factory defaults.

Since: 1.8

Implements IController.

◆ SearchAlgorithm()

features::SearchAlgorithm & SearchAlgorithm ( ) const

inline

Gets the search algorithm feature controller.

Returns: features::SearchAlgorithm& Reference to the search algorithm feature controller

The search algorithm feature controls how the focus position is adjusted to find the optimal focus. Different algorithms may use hill-climbing, binary search, or other optimization strategies to efficiently locate the best focus position.

Note: This method is marked as NO_DISCARD to ensure the return value is used

Since: 1.8

◆ Serialize()

void Serialize ( peak::common::serialization::IArchive & archive ) const

inlineoverridevirtual

Serializes the controller configuration to an archive.

Parameters

archive Reference to the serialization archive for writing configuration data

Saves the current controller configuration state to the provided archive. This includes all focus algorithm settings, ROI configurations, and other controller parameters for later restoration.

Since: 1.8

Implements ISerializable.

◆ SetMode()

void SetMode ( ControllerMode mode )

inlineoverridevirtual

Sets the controller operation mode.

Parameters

mode	The desired controller operation mode

Changes the controller's operation mode, which determines how the automatic focus behaves. Different modes may include continuous auto-focus, single-shot focus, or manual override modes.

Since: 1.8

Implements IController.

◆ SharpnessAlgorithm()

features::SharpnessAlgorithm & SharpnessAlgorithm ( ) const

inline

Gets the sharpness algorithm feature controller.

Returns: features::SharpnessAlgorithm& Reference to the sharpness algorithm feature controller

The sharpness algorithm feature controls how image sharpness is evaluated. Different algorithms may use gradient-based methods, variance calculations, or frequency domain analysis to determine focus quality.

Note: This method is marked as NO_DISCARD to ensure the return value is used

Since: 1.8

◆ SkipFrames()

features::SkipFrames & SkipFrames ( ) const

inline

Gets the skip frames feature controller.

Returns: features::SkipFrames& Reference to the skip frames feature controller

The skip frames feature allows the controller to process only every Nth frame, which can improve performance when full-rate focus evaluation is not required. This is particularly useful for reducing computational load in high frame rate scenarios.

Note: This method is marked as NO_DISCARD to ensure the return value is used

Since: 1.8

◆ UnregisterFinishedCallback()

void UnregisterFinishedCallback ( IController::FinishedCallbackHandle callbackHandle )

inline

Unregisters a previously registered callback.

Parameters

callbackHandle Handle of the callback to unregister

Removes a previously registered callback using its handle. After unregistration, the callback will no longer be invoked for focus events.

Since: 1.8

◆ WeightedROIs()

features::WeightedRois & WeightedROIs ( ) const

inline

Gets the weighted regions of interest feature controller.

Returns: features::WeightedRois& Reference to the weighted ROIs feature controller

The weighted ROIs feature allows defining multiple rectangular regions within the image with different importance weights for focus evaluation. This enables prioritizing focus on specific areas of the scene while still considering the overall image.

Note: This method is marked as NO_DISCARD to ensure the return value is used

Since: 1.8

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

peak_afl/pipeline/modules/controllers/peak_afl_advanced_auto_focus.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AdvancedAutoFocus()

◆ ~AdvancedAutoFocus()

Member Function Documentation

◆ Deserialize()

◆ FocusLimit()

◆ GetMode()

◆ GetName()

◆ GetType()

◆ Hysteresis()

◆ IsRunning()

◆ RegisterFinishedCallback()

◆ ResetToDefault()

◆ SearchAlgorithm()

◆ Serialize()

◆ SetMode()

◆ SharpnessAlgorithm()

◆ SkipFrames()

◆ UnregisterFinishedCallback()

◆ WeightedROIs()