Basic automatic white balance controller implementation.
More...
#include <peak_afl/pipeline/modules/controllers/peak_afl_basic_auto_white_balance.hpp>
Basic automatic white balance controller implementation.
The BasicAutoWhiteBalance class provides a streamlined interface for automatic white balance control. This controller offers essential color correction capabilities with simplified configuration options suitable for most standard white balance requirements.
Key Features:
- ROI-based analysis: Region-of-interest selection for targeted white balance areas
- Processing callbacks: Real-time notifications during white balance operations
- Multiple control modes: Continuous, once, and manual white balance modes
- Serialization support: Configuration persistence and restoration
- Note
- This controller requires a valid manager instance for camera communication
-
White balance capability depends on underlying device support
- See also
- AdvancedAutoWhiteBalance
-
detail::IController
-
features::Roi
- Since
- 1.8
◆ BasicAutoWhiteBalance()
Constructs a BasicAutoWhiteBalance controller.
- Parameters
-
| manager | Reference to the API manager instance that will manage this controller. The manager must remain valid for the lifetime of this controller. |
| callback | Processing callback function that will be invoked during white balance processing operations. This callback allows for custom processing or notification when white balance adjustments are being performed. |
- Since
- 1.8
◆ ~BasicAutoWhiteBalance()
Destructor.
Cleans up resources and ensures proper shutdown of the auto white balance controller.
- Since
- 1.8
◆ GetMode()
Gets the current operating mode of the auto white balance controller.
- Returns
- The current controller mode.
- Since
- 1.8
Implements IController.
◆ GetRoi()
Gets the current region of interest for white balance evaluation.
- Returns
- Rectangle representing the current ROI used for white balance calculations. If no ROI has been set, this typically returns the entire image area.
- Since
- 1.8
◆ GetSkipFrames()
| uint32_t GetSkipFrames |
( |
| ) |
const |
|
inline |
Gets the current number of frames being skipped.
- Returns
- The number of frames currently being skipped between white balance evaluations.
- Since
- 1.8
◆ GetSkipFramesRange()
Gets the valid range for the skip frames parameter.
- Returns
- Range object containing the minimum and maximum allowed values for the skip frames setting.
- Since
- 1.8
◆ IsRunning()
Checks if the auto white balance controller is currently running.
- Returns
- true if the controller is running (mode is not Off), false otherwise.
- Since
- 1.8
Implements IController.
◆ RegisterFinishedCallback()
| IController::FinishedCallbackHandle RegisterFinishedCallback |
( |
const IController::FinishedCallback & | callback | ) |
|
|
inline |
Registers a callback function to be called when white balance operations complete.
The callback will be invoked when the auto white balance operation finishes, whether it succeeds or fails. This allows for asynchronous monitoring of white balance operations and integration with application workflows.
- Parameters
-
| callback | Function object to be called upon white balance operation completion. The callback should accept parameters indicating the operation result. |
- Returns
- Handle that can be used to unregister the callback later.
- Since
- 1.8
◆ ResetToDefault()
Resets all controller parameters to their default values.
This method restores the controller to its initial configuration, resetting all settings including skip frames and ROI to their default values.
- Since
- 1.8
Implements IController.
◆ SetMode()
Sets the operating mode of the auto white balance controller.
- Parameters
-
| mode | The desired controller mode (e.g., Off, On, Auto, Manual). See ControllerMode enumeration for available options. |
- Since
- 1.8
Implements IController.
◆ SetRoi()
Sets the region of interest (ROI) for white balance evaluation.
The ROI defines the specific area of the image that will be used for white balance calculations. This allows the system to focus on particular regions that are more representative of the desired color temperature, ignoring areas that might contain misleading color information.
- Parameters
-
| roi | Rectangle defining the region of interest in image coordinates. The rectangle should be within the bounds of the image and contain sufficient pixel data for accurate white balance calculation. |
- Since
- 1.8
◆ SetSkipFrames()
| void SetSkipFrames |
( |
uint32_t | value | ) |
|
|
inline |
Sets the number of frames to skip during auto white balance operations.
Frame skipping can be used to reduce computational load by processing only every nth frame during white balance operations. This can improve performance while maintaining acceptable color correction quality.
- Parameters
-
| value | Number of frames to skip between white balance evaluations. Must be within the valid range returned by GetSkipFramesRange(). |
- Since
- 1.8
◆ UnregisterFinishedCallback()
| void UnregisterFinishedCallback |
( |
IController::FinishedCallbackHandle | callbackHandle | ) |
|
|
inline |
Unregisters a previously registered finished callback.
- Parameters
-
- Since
- 1.8
The documentation for this class was generated from the following file:
