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
synchronized void	delete ()
PropertyI	getAoiHeight ()
	An integer property defining the height of the rectangle used for the parameter calculation.
PropertyI	getAoiMode ()
	An enumerated integer property defining the which area of the image is used for the calculation of the parameters.
PropertyI	getAoiStartX ()
	An integer property defining the X-offset of the rectangle used for the parameter calculation.
PropertyI	getAoiStartY ()
	An integer property defining the Y-offset of the rectangle used for the parameter calculation.
PropertyI	getAoiWidth ()
	An integer property defining the width of the rectangle.
PropertyI	getControllerDelay_Images ()
	An integer property to influence the speed the AGC and/or AEC control circuit will react and adapt to changes.
PropertyF	getControllerDerivativeTime_ms ()
	The D fraction of the controller.
PropertyF	getControllerGain ()
	The P fraction of the controller.
PropertyF	getControllerIntegralTime_ms ()
	The I fraction of the controller.
PropertyI	getControllerSpeed ()
	An enumerated integer property defining the speed the control circuit will be operated in.
PropertyI	getDesiredAverageGreyValue ()
	An integer property defining the average grey value to be reached within the AOI in the image by the control circuit.
PropertyI	getExposeLowerLimit_us ()
	A float property defining the lower limit for the sensors expose time(in us).
PropertyI	getExposeUpperLimit_us ()
	An integer property defining the upper limit for the sensors expose time in us.
PropertyF	getGainLowerLimit_dB ()
	A float property defining the lower limit for the cameras gain(in dB).
PropertyF	getGainUpperLimit_dB ()
	A float property defining the upper limit for the cameras gain(in dB).
int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.
boolean	isAvailable ()
	This function should be called to check if this device offers auto control parameters.
ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

Protected Member Functions
	AutoControlParameters (long cPtr, boolean cMemoryOwn)
void	finalize ()

Static Protected Member Functions
static long	swigRelease (AutoControlParameters obj)
static long	swigRelease (ComponentCollection obj)

Protected Attributes
transient boolean	swigCMemOwn

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.getInterfaceLayout() is set to mvIMPACT.acquire.TDeviceInterfaceLayout.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

AutoControlParameters()

AutoControlParameters ( long cPtr, boolean cMemoryOwn )

protected

Member Function Documentation

delete()

synchronized void delete

(

)

Reimplemented from ComponentCollection.

finalize()

void finalize ( )

protected

Reimplemented from ComponentCollection.

getAoiHeight()

PropertyI getAoiHeight

(

)

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

getAoiMode()

PropertyI getAoiMode

(

)

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.

getAoiStartX()

PropertyI getAoiStartX

(

)

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.

getAoiStartY()

PropertyI getAoiStartY

(

)

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.

getAoiWidth()

PropertyI getAoiWidth

(

)

An integer property defining the width of the rectangle.

getControllerDelay_Images()

PropertyI getControllerDelay_Images

(

)

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

While AutoControlParameters.getControllerSpeed() 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.

getControllerDerivativeTime_ms()

PropertyF getControllerDerivativeTime_ms

(

)

The D fraction of the controller.

This feature will only be visible when mvIMPACT.acquire.AutoControlParameters.getControllerSpeed() is set to mvIMPACT.acquire.TAutoControlSpeed.acsUserDefined.

getControllerGain()

PropertyF getControllerGain

(

)

The P fraction of the controller.

This feature will only be visible when mvIMPACT.acquire.AutoControlParameters.getControllerSpeed() is set to mvIMPACT.acquire.TAutoControlSpeed.acsUserDefined.

getControllerIntegralTime_ms()

PropertyF getControllerIntegralTime_ms

(

)

The I fraction of the controller.

This feature will only be visible when mvIMPACT.acquire.AutoControlParameters.getControllerSpeed() is set to mvIMPACT.acquire.TAutoControlSpeed.acsUserDefined.

getControllerSpeed()

PropertyI getControllerSpeed

(

)

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.getControllerDelay_Images() defines the number of images to wait from a detected change to the actual start of the adaption to this new situation.

getDesiredAverageGreyValue()

PropertyI getDesiredAverageGreyValue

(

)

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.TImageBufferPixelFormat.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).

getExposeLowerLimit_us()

PropertyI getExposeLowerLimit_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.

getExposeUpperLimit_us()

PropertyI getExposeUpperLimit_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.

getGainLowerLimit_dB()

PropertyF getGainLowerLimit_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.

getGainUpperLimit_dB()

PropertyF getGainUpperLimit_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.

hObj()

int hObj ( )

inherited

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()

boolean isAvailable

(

)

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()

ComponentCollection restoreDefault ( )

inherited

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.

swigRelease() [1/2]

static long swigRelease ( AutoControlParameters obj )

staticprotected

swigRelease() [2/2]

static long swigRelease ( ComponentCollection obj )

staticprotectedinherited

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited