Multimedia API Reference

November 16, 2016 | 24.2.1 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Argus::IAutoControlSettings Class Referenceabstract

Detailed Description

An interface to settings related to autocontrol.

Definition at line 155 of file Settings.h.

Inheritance diagram for Argus::IAutoControlSettings:
Collaboration diagram for Argus::IAutoControlSettings:

Public Member Functions

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

Static Public Member Functions

static const InterfaceIDid ()
 

Protected Member Functions

 ~IAutoControlSettings ()
 

Constructor & Destructor Documentation

Argus::IAutoControlSettings::~IAutoControlSettings ( )
inlineprotected

Definition at line 342 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]regionsA vector 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]regionsA vector 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]matrixA matrix 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::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.
static const InterfaceID& Argus::IAutoControlSettings::id ( )
inlinestatic

Definition at line 158 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.

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, libargus will use the user-specified matrix.
See also
setColorCorrectionMatrix()
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, libargus will use the user-specified tone map.
Returns
success/status of the call.

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