Argus API
Argus Camera API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions
Argus::IAutoControlSettings Class Reference

#include <Settings.h>

Inheritance diagram for Argus::IAutoControlSettings:
Argus::Interface Argus::NonCopyable

List of all members.

Public Member Functions

virtual Status setAeAntibandingMode (AeAntibandingMode mode)=0
 Sets the AE antibanding mode.
virtual AeAntibandingMode getAeAntibandingMode () const =0
 Returns the AE antibanding mode.
virtual Status setAeLock (bool lock)=0
 Sets the AE lock.
virtual bool getAeLock () const =0
 Returns the AE lock.
virtual Status setAeRegions (const std::vector< AcRegion > &regions)=0
 Sets the AE regions of interest.
virtual Status getAeRegions (std::vector< AcRegion > *regions) const =0
 Returns the AE regions of interest.
virtual Status setAwbLock (bool lock)=0
 Sets the AWB lock.
virtual bool getAwbLock () const =0
 Returns the AWB lock.
virtual Status setAwbMode (const AwbMode &mode)=0
 Sets the AWB mode.
virtual AwbMode getAwbMode () const =0
 Returns the AWB mode.
virtual Status setAwbRegions (const std::vector< AcRegion > &regions)=0
 Sets the AWB regions of interest.
virtual Status getAwbRegions (std::vector< AcRegion > *regions) const =0
 Returns the AWB regions of interest.
virtual Status setWbGains (const BayerTuple< float > &gains)=0
 Sets the Manual White Balance gains.
virtual BayerTuple< float > getWbGains () const =0
 Returns the Manual White Balance gains.
virtual Size getColorCorrectionMatrixSize () const =0
 Returns the size of the color correction matrix.
virtual Status setColorCorrectionMatrix (const std::vector< float > &matrix)=0
 Sets the user-specified color correction matrix.
virtual Status getColorCorrectionMatrix (std::vector< float > *matrix) const =0
 Returns the user-specified color correction matrix.
virtual Status setColorCorrectionMatrixEnable (bool enable)=0
 Enables the user-specified color correction matrix.
virtual bool getColorCorrectionMatrixEnable () const =0
 Returns the enable for the user-specified color correction matrix.
virtual Status setColorSaturation (float saturation)=0
 Sets the user-specified absolute color saturation.
virtual float getColorSaturation () const =0
 Returns the user-specified absolute color saturation (.
virtual Status setColorSaturationEnable (bool enable)=0
 Enables the user-specified absolute color saturation.
virtual bool getColorSaturationEnable () const =0
 Returns the enable for the user-specified color saturation.
virtual Status setColorSaturationBias (float bias)=0
 Sets the color saturation bias.
virtual float getColorSaturationBias () const =0
 Returns the color saturation bias.
virtual Status setExposureCompensation (float ev)=0
 Sets the exposure compensation.
virtual float getExposureCompensation () const =0
 Returns the exposure compensation.
virtual uint32_t getToneMapCurveSize (RGBColorChannel channel) const =0
 Returns the number of elements required for the tone map curve.
virtual Status setToneMapCurve (RGBColorChannel channel, const std::vector< float > &curve)=0
 Sets the user-specified tone map curve for a channel on the stream.
virtual Status getToneMapCurve (RGBColorChannel channel, std::vector< float > *curve) const =0
 Returns the user-specified tone map curve for a channel on the stream.
virtual Status setToneMapCurveEnable (bool enable)=0
 Enables the user-specified tone map.
virtual bool getToneMapCurveEnable () const =0
 Returns the enable for the user-specified tone map.

Static Public Member Functions

static const InterfaceIDid ()

Protected Member Functions

 ~IAutoControlSettings ()
- Protected Member Functions inherited from Argus::Interface
 Interface ()
 ~Interface ()

Detailed Description

An interface to settings related to autocontrol.

Definition at line 139 of file Settings.h.


Constructor & Destructor Documentation

Argus::IAutoControlSettings::~IAutoControlSettings ( )
inlineprotected

Definition at line 397 of file Settings.h.


Member Function Documentation

virtual AeAntibandingMode Argus::IAutoControlSettings::getAeAntibandingMode ( ) const
pure virtual

Returns the AE antibanding mode.

virtual bool Argus::IAutoControlSettings::getAeLock ( ) const
pure virtual

Returns the AE lock.

virtual Status Argus::IAutoControlSettings::getAeRegions ( std::vector< AcRegion > *  regions) const
pure virtual

Returns the AE regions of interest.

Parameters:
[out]regions,avector that will be populated with the AE regions of interest.
Returns:
success/status of the call.
virtual bool Argus::IAutoControlSettings::getAwbLock ( ) const
pure virtual

Returns the AWB lock.

virtual AwbMode Argus::IAutoControlSettings::getAwbMode ( ) const
pure virtual

Returns the AWB mode.

virtual Status Argus::IAutoControlSettings::getAwbRegions ( std::vector< AcRegion > *  regions) const
pure virtual

Returns the AWB regions of interest.

Parameters:
[out]regions,avector that will be populated with the AWB regions of interest.
Returns:
success/status of the call.
virtual Status Argus::IAutoControlSettings::getColorCorrectionMatrix ( std::vector< float > *  matrix) const
pure virtual

Returns the user-specified color correction matrix.

Parameters:
[out]matrix,Amatrix that will be populated with the CCM.
Returns:
success/status of the call.
virtual bool Argus::IAutoControlSettings::getColorCorrectionMatrixEnable ( ) const
pure virtual

Returns the enable for the user-specified color correction matrix.

virtual Size Argus::IAutoControlSettings::getColorCorrectionMatrixSize ( ) const
pure virtual

Returns the size of the color correction matrix.

virtual float Argus::IAutoControlSettings::getColorSaturation ( ) const
pure virtual

Returns the user-specified absolute color saturation (.

See also:
setColorSaturation).
virtual float Argus::IAutoControlSettings::getColorSaturationBias ( ) const
pure virtual

Returns the color saturation bias.

virtual bool Argus::IAutoControlSettings::getColorSaturationEnable ( ) const
pure virtual

Returns the enable for the user-specified color saturation.

virtual float Argus::IAutoControlSettings::getExposureCompensation ( ) const
pure virtual

Returns the exposure compensation.

virtual Status Argus::IAutoControlSettings::getToneMapCurve ( RGBColorChannel  channel,
std::vector< float > *  curve 
) const
pure virtual

Returns the user-specified tone map curve for a channel on the stream.

Parameters:
[in]channelThe color the curve corresponds to.
[out]curveA vector that will be populated by the tone map curve for the specified color channel.
Returns:
success/status of the call.
virtual bool Argus::IAutoControlSettings::getToneMapCurveEnable ( ) const
pure virtual

Returns the enable for the user-specified tone map.

virtual uint32_t Argus::IAutoControlSettings::getToneMapCurveSize ( RGBColorChannel  channel) const
pure virtual

Returns the number of elements required for the tone map curve.

Parameters:
[in]channelThe color channel the curve size corresponds to.
virtual BayerTuple<float> Argus::IAutoControlSettings::getWbGains ( ) const
pure virtual

Returns the Manual White Balance gains.

Returns:
Manual White Balance Gains structure
static const InterfaceID& Argus::IAutoControlSettings::id ( )
inlinestatic

Definition at line 142 of file Settings.h.

virtual Status Argus::IAutoControlSettings::setAeAntibandingMode ( AeAntibandingMode  mode)
pure virtual

Sets the AE antibanding mode.

Parameters:
[in]modeThe requested antibanding mode.
Returns:
success/status of the call.
virtual Status Argus::IAutoControlSettings::setAeLock ( bool  lock)
pure virtual

Sets the AE lock.

When locked, AE will maintain constant exposure.

Parameters:
[in]lockIf true, locks AE at its current exposure.
Returns:
success/status of the call.
virtual Status Argus::IAutoControlSettings::setAeRegions ( const std::vector< AcRegion > &  regions)
pure virtual

Sets the AE regions of interest.

If no regions are specified, the entire image is the region of interest.

Parameters:
[in]regionsThe AE regions of interest. The maximum number of regions is returned by ICameraProperties::getMaxAeRegions().
Returns:
success/status of the call.
virtual Status Argus::IAutoControlSettings::setAwbLock ( bool  lock)
pure virtual

Sets the AWB lock.

Parameters:
[in]lockIf true, locks AWB at its current state.
Returns:
success/status of the call.
virtual Status Argus::IAutoControlSettings::setAwbMode ( const AwbMode &  mode)
pure virtual

Sets the AWB mode.

Parameters:
[in]modeThe new AWB mode.
Returns:
success/status of the call.
virtual Status Argus::IAutoControlSettings::setAwbRegions ( const std::vector< AcRegion > &  regions)
pure virtual

Sets the AWB regions of interest.

If no regions are specified, the entire image is the region of interest.

Parameters:
[in]regionsThe AWB regions of interest. The maximum number of regions is returned by ICameraProperties::getMaxAwbRegions().
Returns:
success/status of the call.
virtual Status Argus::IAutoControlSettings::setColorCorrectionMatrix ( const std::vector< float > &  matrix)
pure virtual

Sets the user-specified color correction matrix.

This matrix will be ignored unless getColorCorrectionMatrixEnable() == true. The active color correction matrix used for image processing may be internally modified to account for the active color saturation value (either user-specified or automatically generated, after biasing,

See also:
setColorSaturation and
setColorSaturationBias).
Parameters:
[in]matrixA color correction matrix that maps sensor RGB to linear sRGB. This matrix is given in row-major order and must have the size w*h, where w and h are the width and height of the Size returned by getColorCorrectionMatrixSize()
Returns:
success/status of the call.
virtual Status Argus::IAutoControlSettings::setColorCorrectionMatrixEnable ( bool  enable)
pure virtual

Enables the user-specified color correction matrix.

Parameters:
[in]enableIf true, Argus will use the user-specified matrix.
See also:
setColorCorrectionMatrix()
Returns:
success/status of the call.
virtual Status Argus::IAutoControlSettings::setColorSaturation ( float  saturation)
pure virtual

Sets the user-specified absolute color saturation.

This must be enabled via

See also:
setColorSaturationEnable, otherwise saturation will be determined automatically. This saturation value may be used to modify the color correction matrix used for processing (
setColorCorrectionMatrix), and these changes will be reflected in the color correction matrix output to the capture metadata.
Parameters:
[in]saturationThe absolute color saturation. Acceptable values are in [0.0, 2.0], and the default value is 1.0.
Returns:
success/status of the call.
virtual Status Argus::IAutoControlSettings::setColorSaturationBias ( float  bias)
pure virtual

Sets the color saturation bias.

This bias is used to multiply the active saturation value, either the user-specified or the automatically generated value depending on the state of

See also:
getColorSaturationEnable, and produces the final saturation value to use for capture processing. This is used primarily to tweak automatically generated saturation values when the application prefers more or less saturation than what the implementation or hardware generates by default. The final saturation value (after biasing) may affect the color correction matrix used for processing (
setColorCorrectionMatrix).
Parameters:
[in]biasThe color saturation bias. Acceptable values are in [0.0, 2.0], where 1.0 does not modify the saturation (default), 0.0 is fully desaturated (greyscale), and 2.0 is highly saturated.
Returns:
success/status of the call.
virtual Status Argus::IAutoControlSettings::setColorSaturationEnable ( bool  enable)
pure virtual

Enables the user-specified absolute color saturation.

Parameters:
[in]enableIf true, Argus will use the user-specified color saturation.
See also:
setColorSaturation()
Returns:
success/status of the call.
virtual Status Argus::IAutoControlSettings::setExposureCompensation ( float  ev)
pure virtual

Sets the exposure compensation.

Exposure compensation is applied after AE is solved.

Parameters:
[in]evThe exposure adjustment step in stops.
Returns:
success/status of the call.
virtual Status Argus::IAutoControlSettings::setToneMapCurve ( RGBColorChannel  channel,
const std::vector< float > &  curve 
)
pure virtual

Sets the user-specified tone map curve for a channel on the stream.

The user-specified tone map will be ignored unless getToneMapCurveEnable() == true.

Parameters:
[in]channelThe color the curve corresponds to.
[in]curveA float vector that describes the LUT. The number of elements must match the number of elements returned from getToneMapCurve() of the same channel.
Returns:
success/status of the call.
virtual Status Argus::IAutoControlSettings::setToneMapCurveEnable ( bool  enable)
pure virtual

Enables the user-specified tone map.

Parameters:
[in]enableIf true, Argus will use the user-specified tone map.
Returns:
success/status of the call.
virtual Status Argus::IAutoControlSettings::setWbGains ( const BayerTuple< float > &  gains)
pure virtual

Sets the Manual White Balance gains.

Parameters:
[in]gainsThe Manual White Balance Gains
Returns:
success/status of the call.

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