AutoControlParameters Class Reference

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

Inheritance diagram for AutoControlParameters:

Public Member Functions
	__init__ (self, *args, **kwargs)
	getIsAvailable (self)
	This function should be called to check if this device offers auto control parameters.

Properties
	aoiHeight = property(lib_mvIMPACT_acquire.AutoControlParameters_aoiHeight_get, doc=)
	An integer property defining the height of the rectangle used for the parameter calculation.
	aoiMode = property(lib_mvIMPACT_acquire.AutoControlParameters_aoiMode_get, doc=)
	An enumerated integer property defining the which area of the image is used for the calculation of the parameters.
	aoiStartX = property(lib_mvIMPACT_acquire.AutoControlParameters_aoiStartX_get, doc=)
	An integer property defining the X-offset of the rectangle used for the parameter calculation.
	aoiStartY = property(lib_mvIMPACT_acquire.AutoControlParameters_aoiStartY_get, doc=)
	An integer property defining the Y-offset of the rectangle used for the parameter calculation.
	aoiWidth = property(lib_mvIMPACT_acquire.AutoControlParameters_aoiWidth_get, doc=)
	An integer property defining the width of the rectangle.
	controllerDelay_Images = property(lib_mvIMPACT_acquire.AutoControlParameters_controllerDelay_Images_get, doc=)
	An integer property to influence the speed the AGC and/or AEC control circuit will react and adapt to changes.
	controllerDerivativeTime_ms = property(lib_mvIMPACT_acquire.AutoControlParameters_controllerDerivativeTime_ms_get, doc=)
	The D fraction of the controller.
	controllerGain = property(lib_mvIMPACT_acquire.AutoControlParameters_controllerGain_get, doc=)
	The P fraction of the controller.
	controllerIntegralTime_ms = property(lib_mvIMPACT_acquire.AutoControlParameters_controllerIntegralTime_ms_get, doc=)
	The I fraction of the controller.
	controllerSpeed = property(lib_mvIMPACT_acquire.AutoControlParameters_controllerSpeed_get, doc=)
	An enumerated integer property defining the speed the control circuit will be operated in.
	desiredAverageGreyValue = property(lib_mvIMPACT_acquire.AutoControlParameters_desiredAverageGreyValue_get, doc=)
	An integer property defining the average grey value to be reached within the AOI in the image by the control circuit.
	exposeLowerLimit_us = property(lib_mvIMPACT_acquire.AutoControlParameters_exposeLowerLimit_us_get, doc=)
	A float property defining the lower limit for the sensors expose time(in us).
	exposeUpperLimit_us = property(lib_mvIMPACT_acquire.AutoControlParameters_exposeUpperLimit_us_get, doc=)
	An integer property defining the upper limit for the sensors expose time in us.
	gainLowerLimit_dB = property(lib_mvIMPACT_acquire.AutoControlParameters_gainLowerLimit_dB_get, doc=)
	A float property defining the lower limit for the cameras gain(in dB).
	gainUpperLimit_dB = property(lib_mvIMPACT_acquire.AutoControlParameters_gainUpperLimit_dB_get, doc=)
	A float property defining the upper limit for the cameras gain(in dB).
	isAvailable = property(getIsAvailable, None, None, None)
	A bool property (read-only) which checks if if this device offers auto control parameters.
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

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.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		*	args,
		**	kwargs )

Reimplemented from ComponentCollection.

Member Function Documentation

getIsAvailable()

getIsAvailable

(

self

)

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

Property Documentation

aoiHeight

aoiHeight = property(lib_mvIMPACT_acquire.AutoControlParameters_aoiHeight_get, doc=)

static

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

aoiMode

aoiMode = property(lib_mvIMPACT_acquire.AutoControlParameters_aoiMode_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.amCentered, mvIMPACT.acquire.amFull, mvIMPACT.acquire.amUseAoi.

aoiStartX

aoiStartX = property(lib_mvIMPACT_acquire.AutoControlParameters_aoiStartX_get, doc=)

static

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

aoiStartY = property(lib_mvIMPACT_acquire.AutoControlParameters_aoiStartY_get, doc=)

static

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

aoiWidth = property(lib_mvIMPACT_acquire.AutoControlParameters_aoiWidth_get, doc=)

static

An integer property defining the width of the rectangle.

controllerDelay_Images

controllerDelay_Images = property(lib_mvIMPACT_acquire.AutoControlParameters_controllerDelay_Images_get, doc=)

static

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

controllerDerivativeTime_ms = property(lib_mvIMPACT_acquire.AutoControlParameters_controllerDerivativeTime_ms_get, doc=)

static

The D fraction of the controller.

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

controllerGain

controllerGain = property(lib_mvIMPACT_acquire.AutoControlParameters_controllerGain_get, doc=)

static

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

controllerIntegralTime_ms = property(lib_mvIMPACT_acquire.AutoControlParameters_controllerIntegralTime_ms_get, doc=)

static

The I fraction of the controller.

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

controllerSpeed

controllerSpeed = property(lib_mvIMPACT_acquire.AutoControlParameters_controllerSpeed_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.acsSlow, mvIMPACT.acquire.acsMedium, mvIMPACT.acquire.acsFast, mvIMPACT.acquire.acsUserDefined.

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

desiredAverageGreyValue = property(lib_mvIMPACT_acquire.AutoControlParameters_desiredAverageGreyValue_get, doc=)

static

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

exposeLowerLimit_us = property(lib_mvIMPACT_acquire.AutoControlParameters_exposeLowerLimit_us_get, doc=)

static

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

exposeUpperLimit_us = property(lib_mvIMPACT_acquire.AutoControlParameters_exposeUpperLimit_us_get, doc=)

static

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

gainLowerLimit_dB = property(lib_mvIMPACT_acquire.AutoControlParameters_gainLowerLimit_dB_get, doc=)

static

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

gainUpperLimit_dB = property(lib_mvIMPACT_acquire.AutoControlParameters_gainUpperLimit_dB_get, doc=)

static

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.

isAvailable

isAvailable = property(getIsAvailable, None, None, None)

static

A bool property (read-only) which checks if if this device offers auto control parameters.

See mvIMPACT.acquire.AutoControlParameters.getIsAvailable()

thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static