![]() |
IDS peak AFL
v1.3.0
|
#include <peak_afl/peak_afl.hpp>
Inherits enable_shared_from_this< Controller >.
Public Member Functions | |
| ~Controller () | |
| bool | IsSkipFramesSupported () const |
| Check if skip frames is supported for a controller. More... | |
| void | SetSkipFrames (std::uint32_t count) |
| Set number of frames skipped for a controller. More... | |
| std::uint32_t | GetSkipFrames () const |
| Get number of frames skipped for a controller. More... | |
| Range< std::uint32_t > | GetSkipFramesRange () const |
| Get range for frames skipped for a controller. More... | |
| bool | IsROISupported () const |
| Check if setting a region of interest is supported for a controller. More... | |
| void | SetROI (peak_afl_rectangle rect) |
| Set the autofeature region of interest for a controller. More... | |
| peak_afl_rectangle | GetROI () const |
| Get the autofeature region of interest for a controller. More... | |
| bool | IsROIPresetSupported () const |
| Check if ROI preset is supported for a controller. More... | |
| void | SetROIPreset (peak_afl_roi_preset preset) |
| Set the autofeature region of interest preset for a controller. More... | |
| bool | IsModeSupported () const |
| Check if auto mode is supported for a controller. More... | |
| void | SetMode (peak_afl_controller_automode mode) |
| Set the autofeature mode for a controller. More... | |
| peak_afl_controller_automode | GetMode () const |
| Get the current autofeature mode for a controller. More... | |
| peak_afl_controller_status | Status () const |
| Get the status for a controller. More... | |
| std::uint8_t | GetLastAutoAverage () const |
| Get the last auto average for a controller. More... | |
| std::tuple< std::uint8_t, std::uint8_t, std::uint8_t > | GetLastAutoAverages () const |
| Get the last auto average for a controller. More... | |
| bool | IsAutoTargetSupported () const |
| check if auto target is supported for a controller. More... | |
| void | SetAutoTarget (uint32_t target) |
| Set the auto target for a controller. More... | |
| std::uint32_t | GetAutoTarget () const |
| Get the currently set auto target for a controller. More... | |
| Range< std::uint32_t > | GetAutoTargetRange () const |
| Get the auto target range for a controller. More... | |
| bool | IsAutoToleranceSupported () const |
| check if auto tolerance is supported for a controller. More... | |
| void | SetAutoTolerance (std::uint32_t tolerance) |
| Set the auto tolerance for a controller. More... | |
| std::uint32_t | GetAutoTolerance () const |
| Get the current auto tolerance for a controller. More... | |
| Range< std::uint32_t > | GetAutoToleranceRange () const |
| Get the auto tolerance range for a controller. More... | |
| bool | IsAutoPercentileSupported () const |
| check if auto percentile is supported for a controller. More... | |
| void | SetAutoPercentile (double percentile) |
| Set the auto percentile for a controller. More... | |
| double | GetAutoPercentile () const |
| Get the auto percentile for a controller. More... | |
| Range< double > | GetAutoPercentileRange () const |
| Get the auto percentile range for a controller. More... | |
| peak_afl_controllerType | Type () const |
| Get the controller type. More... | |
| bool | IsAlgorithmSupported () const |
| check if setting an algorithm is supported for a controller. More... | |
| void | SetAlgorithm (peak_afl_controller_algorithm algorithm) |
| Set the used algorithm for a controller. More... | |
| peak_afl_controller_algorithm | GetAlgorithm () const |
| Get the used algorithm for a controller. More... | |
| std::vector< peak_afl_controller_algorithm > | GetAlgorithmList () const |
| Get the list of supported algorithms for a controller. More... | |
| bool | IsSharpnessAlgorithmSupported () const |
| check setting a sharpness algorithm is supported by a controller. More... | |
| void | SetSharpnessAlgorithm (peak_afl_controller_sharpness_algorithm algorithm) |
| Set the used sharpness algorithm for a controller. More... | |
| peak_afl_controller_sharpness_algorithm | GetSharpnessAlgorithm () const |
| Get the used sharpness algorithm for a controller. More... | |
| std::vector< peak_afl_controller_sharpness_algorithm > | GetSharpnessAlgorithmList () const |
| Get the list of supported sharpness algorithms for a controller. More... | |
| void | RegisterFinishedCallback (const callback::FinishedCallback &callback) |
| Set finished callback for a controller. | |
| void | UnRegisterFinishedCallback () |
| Reset the finished callback for a controller. | |
| void | RegisterComponentCallback (peak_afl_controller_brightness_component component, const callback::FinishedCallback &callback) |
| Set component callback for a controller. | |
| void | UnRegisterComponentCallback (peak_afl_controller_brightness_component component) |
| Reset the component callback for a controller. | |
| void | RegisterDataProcessingCallback (const callback::DataProcessingCallback &callback) |
| Set the data callback for a controller. | |
| void | UnRegisterDataProcessingCallback () |
| Reset the finished callback for a controller. | |
| bool | IsWeightedROISupported () const |
| Check if weighted region of interest is supported for a controller. More... | |
| void | SetWeightedROIs (const std::vector< peak_afl_weighted_rectangle > &list) |
| Set the autofeature weighted region of interest for a controller. More... | |
| void | SetWeightedROI (const peak_afl_weighted_rectangle &rect) |
| Set single autofeature weighted region of interest for a controller. More... | |
| peak_afl_size | GetWeightedROIMinSize () const |
| Get the autofeature minimum size of weighted region of interest for a controller. More... | |
| std::vector< peak_afl_weighted_rectangle > | GetWeightedROIs () const |
| Get the autofeature weighted region of interest for a controller. More... | |
| bool | IsLimitSupported () const |
| Check if limit is supported for a controller. More... | |
| void | SetLimit (peak_afl_controller_limit limit) |
| Set the autofeature limit for a controller. More... | |
| peak_afl_controller_limit | GetLimit () const |
| Get the autofeature limit for a controller. More... | |
| peak_afl_controller_limit | GetDefaultLimit () const |
| Get the autofeature default limit. More... | |
| bool | IsHysteresisSupported () const |
| Check if hysteresis is supported for a controller. More... | |
| void | SetHysteresis (std::uint8_t hysteresis) |
| Set the autofeature hysteresis for a controller. More... | |
| std::uint8_t | GetHysteresis () const |
| Get the autofeature hysteresis for a controller. More... | |
| std::uint8_t | GetDefaultHysteresis () const |
| Get the autofeature hysteresis default. More... | |
| Range< std::uint8_t > | GetHysteresisRange () const |
| Get autofeature hysteresis range for a controller. More... | |
| bool | IsBrightnessComponentModeSupported () const |
| Check if auto mode is supported for a brightness controller component. More... | |
| void | BrightnessComponentSetMode (peak_afl_controller_brightness_component component, peak_afl_controller_automode mode) |
| Set the autofeature mode for a brightness controller component. More... | |
| peak_afl_controller_automode | BrightnessComponentGetMode (peak_afl_controller_brightness_component component) const |
| Get the current autofeature mode for a brightness controller component. More... | |
| peak_afl_controller_status | BrightnessComponentStatus (peak_afl_controller_brightness_component component) const |
| Get the status for a brightness controller component. More... | |
| bool | IsGainLimitSupported () const |
| Check if auto gain limit is supported for a controller. More... | |
| void | SetGainLimit (peak_afl_double_limit limit) |
| Set the gain limit for a controller. More... | |
| peak_afl_double_limit | GetGainLimit () const |
| Get autofeature gain limit for a controller. More... | |
| peak_afl_double_limit | GetGainLimitRange () const |
| Get autofeature gain limit range for a controller. More... | |
Static Public Member Functions | |
| static std::shared_ptr< Controller > | Create (peak_afl_controllerType type) |
| Create a new controller. More... | |
The Controller class
|
inline |
Destructor for the controller
|
inline |
Get the current autofeature mode for a brightness controller component.
| [in] | component | autofeature brightness component |
| peak::afl::error::Exception | if function fails |
|
inline |
Set the autofeature mode for a brightness controller component.
Will set the controller mode to mode. See peak_afl_controller_automode for a list of valid values.
| [in] | component | autofeature brightness component |
| [in] | mode | autofeature mode |
| peak::afl::error::Exception | if function fails |
|
inline |
Get the status for a brightness controller component.
See peak_afl_controller_status for a list of values.
| [in] | component | autofeature brightness component |
| peak::afl::error::Exception | if function fails |
|
inlinestatic |
Create a new controller.
| [in] | type | controller type |
| peak::afl::error::Exception | if function fails |
|
inline |
Get the used algorithm for a controller.
|
inline |
Get the list of supported algorithms for a controller.
To set a value, see SetAlgorithm.
| peak::afl::error::Exception | if function fails |
|
inline |
Get the auto percentile for a controller.
| peak::afl::error::Exception | if function fails |
|
inline |
Get the auto percentile range for a controller.
Call this function to get the range of valid values which can be set by a call to SetAutoPercentile.
| peak::afl::error::Exception | if function fails |
|
inline |
Get the currently set auto target for a controller.
| peak::afl::error::Exception | if function fails |
|
inline |
Get the auto target range for a controller.
Call this function to get the range of valid values which can be set by a call to SetAutoTarget.
| peak::afl::error::Exception | if function fails |
|
inline |
Get the current auto tolerance for a controller.
| peak::afl::error::Exception | if function fails |
|
inline |
Get the auto tolerance range for a controller.
Call this function to get the range of valid values which can be set by a call to SetAutoTolerance.
| peak::afl::error::Exception | if function fails |
|
inline |
Get the autofeature hysteresis default.
| peak::afl::error::Exception | if function fails |
|
inline |
Get the autofeature default limit.
| peak::afl::error::Exception | if function fails |
|
inline |
Get autofeature gain limit for a controller.
| peak::afl::error::Exception | if function fails |
|
inline |
Get autofeature gain limit range for a controller.
| peak::afl::error::Exception | if function fails |
|
inline |
Get the autofeature hysteresis for a controller.
| peak::afl::error::Exception | if function fails |
|
inline |
Get autofeature hysteresis range for a controller.
| peak::afl::error::Exception | if function fails |
|
inline |
Get the last auto average for a controller.
Used by Controllers processing a mono image.
| peak::afl::error::Exception | if function fails |
|
inline |
Get the last auto average for a controller.
Used by Controllers processing a color image.
| peak::afl::error::Exception | if function fails |
|
inline |
Get the autofeature limit for a controller.
| peak::afl::error::Exception | if function fails |
|
inline |
Get the current autofeature mode for a controller.
| peak::afl::error::Exception | if function fails |
|
inline |
Get the autofeature region of interest for a controller.
Get the region of interest for a controller. The processed image will be cropped to the region of interest set.
| peak::afl::error::Exception | if function fails |
|
inline |
Get the used sharpness algorithm for a controller.
| peak::afl::error::Exception | if function fails |
|
inline |
Get the list of supported sharpness algorithms for a controller.
To set a value, see SetSharpnessAlgorithm.
| peak::afl::error::Exception | if function fails |
|
inline |
Get number of frames skipped for a controller.
Gets the skipped frames for the controller. Only every N-th image will be processed.
| peak::afl::error::Exception | if function fails |
|
inline |
Get range for frames skipped for a controller.
| peak::afl::error::Exception | if function fails |
|
inline |
Get the autofeature minimum size of weighted region of interest for a controller.
| peak::afl::error::Exception | if function fails |
|
inline |
Get the autofeature weighted region of interest for a controller.
| peak::afl::error::Exception | if function fails |
|
inline |
check if setting an algorithm is supported for a controller.
True if algorithm is supported, otherwise it is unsupported.
Call GetAlgorithmList to get a list of supported algorithms.
| peak::afl::error::Exception | if function fails |
|
inline |
check if auto percentile is supported for a controller.
True if auto percentile is supported, otherwise it is unsupported.
| peak::afl::error::Exception | if function fails |
|
inline |
check if auto target is supported for a controller.
True if auto target is supported, otherwise it is unsupported.
| peak::afl::error::Exception | if function fails |
|
inline |
check if auto tolerance is supported for a controller.
True if auto tolerance is supported, otherwise it is unsupported.
| peak::afl::error::Exception | if function fails |
|
inline |
Check if auto mode is supported for a brightness controller component.
true if auto mode is supported, otherwise it is unsupported.
| peak::afl::error::Exception | if function fails |
|
inline |
Check if auto gain limit is supported for a controller.
| peak::afl::error::Exception | if function fails |
|
inline |
Check if hysteresis is supported for a controller.
True if hysteresis is supported, otherwise it is unsupported.
| peak::afl::error::Exception | if function fails |
|
inline |
Check if limit is supported for a controller.
True if limit is supported, otherwise it is unsupported.
| peak::afl::error::Exception | if function fails |
|
inline |
Check if auto mode is supported for a controller.
true if auto mode is supported, otherwise it is unsupported.
| peak::afl::error::Exception | if function fails |
|
inline |
Check if ROI preset is supported for a controller.
true if ROI preset is supported, otherwise it is unsupported.
| peak::afl::error::Exception | if function fails |
|
inline |
Check if setting a region of interest is supported for a controller.
If true region of interest is supported, otherwise it is unsupported.
| peak::afl::error::Exception | if function fails |
|
inline |
check setting a sharpness algorithm is supported by a controller.
True if sharpness algorithm is supported, otherwise it is unsupported.
Call GetSharpnessAlgorithmList to get a list of supported sharpness algorithms.
| peak::afl::error::Exception | if function fails |
|
inline |
Check if skip frames is supported for a controller.
| peak::afl::error::Exception | if function fails |
|
inline |
Check if weighted region of interest is supported for a controller.
True if weighted region of interest is supported, otherwise it is unsupported.
| peak::afl::error::Exception | if function fails |
|
inline |
Set the used algorithm for a controller.
To get a list of supported algorithms see peak_afl_AutoController_Algorithm_GetList.
| [in] | algorithm | auto controller algorithm |
| peak::afl::error::Exception | if function fails |
|
inline |
Set the auto percentile for a controller.
This is the used percentile value for a controller. To get the valid range, call peak_afl_AutoController_AutoPercentile_GetRange.
| [in] | percentile | auto percentile value |
| peak::afl::error::Exception | if function fails |
|
inline |
Set the auto target for a controller.
Set an auto target. Call peak_afl_AutoController_AutoTarget_GetRange to get the valid range. End value which will be targeted by the controller.
| [in] | target | auto target value |
| peak::afl::error::Exception | if function fails |
|
inline |
Set the auto tolerance for a controller.
Sets the +/- tolerance for the auto target value.
| [in] | tolerance | auto target value |
| peak::afl::error::Exception | if function fails |
|
inline |
Set the gain limit for a controller.
The valid values are dependend on the used gain node and can be between minimum and maximum. Default is the complete range. The used priority list is: Analog -> Digital -> Any -> IPL (if supplied).
If any value of the limit is out of range, the value is clamped to be valid. In this case no exception is thrown. It is recommended to check the current values by calling GetGainLimit after this call.
| [in] | limit | limits the controller to adjust the gain to the supplied range between min and max of limit. |
| peak::afl::error::Exception | if function fails |
|
inline |
Set the autofeature hysteresis for a controller.
Set the hysteresis for the algorithm set by SetAlgorithm
| [in] | hysteresis | the hysteresis to set |
| peak::afl::error::Exception | if function fails |
|
inline |
Set the autofeature limit for a controller.
Sets the minimum and maximum limit for the algorithm set by peak_afl_AutoController_Algorithm_Set
| [in] | limit | the limit to set |
| peak::afl::error::Exception | if function fails |
|
inline |
Set the autofeature mode for a controller.
Will set the controller mode to mode. See peak_afl_controller_automode for a list of valid values.
| [in] | mode | autofeature mode |
| peak::afl::error::Exception | if function fails |
|
inline |
Set the autofeature region of interest for a controller.
Set the region of interest for a controller. The processed image will be cropped to the region of interest set.
| [in] | rect | region of interest |
| peak::afl::error::Exception | if function fails |
|
inline |
Set the autofeature region of interest preset for a controller.
Will set the supplied preset as region of interest. See also SetROI.
| [in] | preset | region of interest preset |
| peak::afl::error::Exception | if function fails |
|
inline |
Set the used sharpness algorithm for a controller.
To get a list of supported algorithms see peak_afl_AutoController_SharpnessAlgorithm_GetList.
| [in] | algorithm | auto controller sharpness algorithm |
| peak::afl::error::Exception | if function fails |
|
inline |
Set number of frames skipped for a controller.
Sets the skipped frames for the controller. Only every N-th image will be processed.
| [in] | count | number of frames skipped |
| peak::afl::error::Exception | if function fails |
|
inline |
Set single autofeature weighted region of interest for a controller.
Already set weighted regions of interest will be overwritten
| [in] | rect | weighted region of interest |
| peak::afl::error::Exception | if function fails |
|
inline |
Set the autofeature weighted region of interest for a controller.
Already set weighted regions of interest will be overwritten
| [in] | list | vector of weighted region of interest |
| peak::afl::error::Exception | if function fails |
|
inline |
Get the status for a controller.
See peak_afl_controller_status for a list of values.
| peak::afl::error::Exception | if function fails |
|
inline |
Get the controller type.
See peak_afl_controllerType for a list of values.
| peak::afl::error::Exception | if function fails |