mvIMPACT Acquire SDK C++
AutoControlParameters Class Reference

A class to control the automatic control parameters of a device(Device specific interface layout only). More...

Inheritance diagram for AutoControlParameters:
ComponentCollection

Public Member Functions

HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
bool isAvailable (void) const
 This function should be called to check if this device offers auto control parameters. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

PropertyI aoiHeight
 An integer property defining the height of the rectangle used for the parameter calculation. More...
 
PropertyIAoiMode aoiMode
 An enumerated integer property defining the which area of the image is used for the calculation of the parameters. More...
 
PropertyI aoiStartX
 An integer property defining the X-offset of the rectangle used for the parameter calculation. More...
 
PropertyI aoiStartY
 An integer property defining the Y-offset of the rectangle used for the parameter calculation. More...
 
PropertyI aoiWidth
 An integer property defining the width of the rectangle. More...
 
PropertyI controllerDelay_Images
 An integer property to influence the speed the AGC and/or AEC control circuit will react and adapt to changes. More...
 
PropertyF controllerDerivativeTime_ms
 The D fraction of the controller. More...
 
PropertyF controllerGain
 The P fraction of the controller. More...
 
PropertyF controllerIntegralTime_ms
 The I fraction of the controller. More...
 
PropertyIAutoControlSpeed controllerSpeed
 An enumerated integer property defining the speed the control circuit will be operated in. More...
 
PropertyI desiredAverageGreyValue
 An integer property defining the average grey value to be reached within the AOI in the image by the control circuit. More...
 
PropertyI exposeLowerLimit_us
 A float property defining the lower limit for the sensors expose time(in us). More...
 
PropertyI exposeUpperLimit_us
 An integer property defining the upper limit for the sensors expose time in us. More...
 
PropertyF gainLowerLimit_dB
 A float property defining the lower limit for the cameras gain(in dB). More...
 
PropertyF gainUpperLimit_dB
 A float property defining the upper limit for the cameras gain(in dB). More...
 

Protected Attributes

HOBJ m_hRoot
 

Friends

class CameraSettingsBlueDevice
 

Detailed Description

A class to control the automatic control parameters of a device(Device specific interface layout only).

Currently this class provides access to the properties, which control the way the AGC(A utomatic G ain C ontrol) and the AEC (A utomatic E xpose C ontrol) operates.

The values used to capture the image, which are directly influenced by this properties (e.g. the gain or the exposure time) will be returned as part of the result of the image request.

Note
Not every device will offer the features provided in this class. Before accessing any members and/or properties call the function mvIMPACT::acquire::AutoControlParameters::isAvailable. If this function returns false, no other member or function call in this class will return valid results.
Instances of these class can't be constructed directly. Its parameters can be accessed via an instance of the class mvIMPACT::acquire::CameraSettingsBlueDevice.
This class will only be available if mvIMPACT::acquire::Device::interfaceLayout is set to mvIMPACT::acquire::dilDeviceSpecific before the device is opened.

Member Function Documentation

◆ hObj()

HOBJ hObj ( void  ) const
inlineinherited

Returns a unique identifier for the component collection referenced by this object.

This handle will always reference an object of type mvIMPACT::acquire::ComponentList.

Returns
A unique identifier for the component referenced by this object.

◆ isAvailable()

bool isAvailable ( void  ) const
inline

This function should be called to check if this device offers auto control parameters.

Returns
  • true if the device offers the features defined by this object.
  • false otherwise

◆ restoreDefault()

const ComponentCollection& restoreDefault ( void  ) const
inlineinherited

Restores the default for every component of this collection.

Calling this function will restore the default value for every component belonging to this collection.

Note
The caller must have the right to modify the component. Otherwise an exception will be thrown.
Returns
A const reference to the component.

Friends And Related Function Documentation

◆ CameraSettingsBlueDevice

friend class CameraSettingsBlueDevice
friend

Member Data Documentation

◆ aoiHeight

PropertyI aoiHeight

An integer property defining the height of the rectangle used for the parameter calculation.

◆ aoiMode

An enumerated integer property defining the which area of the image is used for the calculation of the parameters.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TAoiMode.

◆ aoiStartX

PropertyI aoiStartX

An integer property defining the X-offset of the rectangle used for the parameter calculation.

Example: When setting this property to 5 the first pixel in each line of the resulting rectangle used for the calculation will be pixel number 5 of each line transmitted by the camera.

◆ aoiStartY

PropertyI aoiStartY

An integer property defining the Y-offset of the rectangle used for the parameter calculation.

Example: When setting this property to 5 the first line of the resulting rectangle used for the calculation will be line number 5 of the image transmitted by the camera.

◆ aoiWidth

PropertyI aoiWidth

An integer property defining the width of the rectangle.

◆ controllerDelay_Images

PropertyI controllerDelay_Images

An integer property to influence the speed the AGC and/or AEC control circuit will react and adapt to changes.

While AutoControlParameters::controllerSpeed influences the overall time needed to adjust the controller to a new situation, this property can be used to define a delay when the controller shall start to adapt to a changed situation.

◆ controllerDerivativeTime_ms

PropertyF controllerDerivativeTime_ms

The D fraction of the controller.

This feature will only be visible when mvIMPACT::acquire::AutoControlParameters::controllerSpeed is set to mvIMPACT::acquire::acsUserDefined.

◆ controllerGain

PropertyF controllerGain

The P fraction of the controller.

This feature will only be visible when mvIMPACT::acquire::AutoControlParameters::controllerSpeed is set to mvIMPACT::acquire::acsUserDefined.

◆ controllerIntegralTime_ms

PropertyF controllerIntegralTime_ms

The I fraction of the controller.

This feature will only be visible when mvIMPACT::acquire::AutoControlParameters::controllerSpeed is set to mvIMPACT::acquire::acsUserDefined.

◆ controllerSpeed

PropertyIAutoControlSpeed controllerSpeed

An enumerated integer property defining the speed the control circuit will be operated in.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TAutoControlSpeed.

Once the controller started to react and adapt itself to a new situation, this property will define how long this adaption will take, while AutoControlParameters::controllerDelay_Images defines the number of images to wait from a detected change to the actual start of the adaption to this new situation.

◆ desiredAverageGreyValue

PropertyI desiredAverageGreyValue

An integer property defining the average grey value to be reached within the AOI in the image by the control circuit.

For multi-byte pixel formats like e.g. mvIMPACT::acquire::ibpfMono10 this value will refer to the 8 most significant bits of the pixel data, thus e.g a value of 128 for this property will result it the controller trying reach an average grey value of 512 (0x200).

◆ exposeLowerLimit_us

PropertyI exposeLowerLimit_us

A float property defining the lower limit for the sensors expose time(in us).

When the AEC is active this value defines the minimum value for the sensors expose time(in us). Even if the controller can reach the desired average grey value, the expose time will never fall below this value.

◆ exposeUpperLimit_us

PropertyI exposeUpperLimit_us

An integer property defining the upper limit for the sensors expose time in us.

When the AEC is active this value defines the maximum value for the sensors expose time(in us). Even if the controller can reach the desired average grey value, the expose time will never exceed this value.

◆ gainLowerLimit_dB

PropertyF gainLowerLimit_dB

A float property defining the lower limit for the cameras gain(in dB).

When the AGC is active this value defines the minimum value for the cameras gain. Even if the controller can reach the desired average grey value, the gain will never fall below this value.

◆ gainUpperLimit_dB

PropertyF gainUpperLimit_dB

A float property defining the upper limit for the cameras gain(in dB).

When the AGC is active this value defines the maximum value for the cameras gain. Even if the controller can reach the desired average grey value, the gain will never exceed this value.

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

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