CameraSettingsBase Class Reference

A base class for camera related settings(Device specific interface layout only). More...

Inheritance diagram for CameraSettingsBase:

Public Member Functions
	__init__ (self, *args)
	Constructs a new mvIMPACT.acquire.CameraSettingsBase object.
	hObj (self)
	Returns a unique identifier for the component collection referenced by this object.
	restoreDefault (self)
	Restores the default for every component of this collection.

Properties
	aoiHeight = property(lib_mvIMPACT_acquire.BasicDeviceSettingsWithAOI_aoiHeight_get, doc=)
	An integer property defining the number of lines to capture.
	aoiStartX = property(lib_mvIMPACT_acquire.BasicDeviceSettingsWithAOI_aoiStartX_get, doc=)
	An integer property defining the X-offset for each capture line.
	aoiStartY = property(lib_mvIMPACT_acquire.BasicDeviceSettingsWithAOI_aoiStartY_get, doc=)
	An integer property defining the Y-offset.
	aoiWidth = property(lib_mvIMPACT_acquire.BasicDeviceSettingsWithAOI_aoiWidth_get, doc=)
	An integer property defining the number of pixels to capture per line.
	basedOn = property(lib_mvIMPACT_acquire.BasicDeviceSettings_basedOn_get, doc=)
	A string property (read-only) containing the name of the setting this setting is based on.
	imageRequestTimeout_ms = property(lib_mvIMPACT_acquire.BasicDeviceSettings_imageRequestTimeout_ms_get, doc=)
	An integer property defining the maximum time to wait for an image in ms.
	pixelFormat = property(lib_mvIMPACT_acquire.CameraSettingsBase_pixelFormat_get, doc=)
	An enumerated integer property defining the pixel format used to transfer the image data into the target systems host memory.
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Detailed Description

A base class for camera related settings(Device specific interface layout only).

This class acts as a base class for camera related settings. It only contains settings that are available for almost every device!

Note

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 )

Constructs a new mvIMPACT.acquire.CameraSettingsBase object.

Parameters

pDev	[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.
settingName	[in] The name of the driver internal setting to access with this instance. A list of valid setting names can be obtained by a call to mvIMPACT.acquire.FunctionInterface.getAvailableSettings, new settings can be created with the function mvIMPACT.acquire.FunctionInterface.createSetting

Member Function Documentation

hObj()

hObj ( self )

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.

restoreDefault()

restoreDefault ( self )

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.

Property Documentation

aoiHeight

aoiHeight = property(lib_mvIMPACT_acquire.BasicDeviceSettingsWithAOI_aoiHeight_get, doc=)

staticinherited

An integer property defining the number of lines to capture.

aoiStartX

aoiStartX = property(lib_mvIMPACT_acquire.BasicDeviceSettingsWithAOI_aoiStartX_get, doc=)

staticinherited

An integer property defining the X-offset for each capture line.

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

aoiStartY

aoiStartY = property(lib_mvIMPACT_acquire.BasicDeviceSettingsWithAOI_aoiStartY_get, doc=)

staticinherited

An integer property defining the Y-offset.

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

aoiWidth

aoiWidth = property(lib_mvIMPACT_acquire.BasicDeviceSettingsWithAOI_aoiWidth_get, doc=)

staticinherited

An integer property defining the number of pixels to capture per line.

basedOn

basedOn = property(lib_mvIMPACT_acquire.BasicDeviceSettings_basedOn_get, doc=)

staticinherited

A string property (read-only) containing the name of the setting this setting is based on.

Since

1.12.67

imageRequestTimeout_ms

imageRequestTimeout_ms = property(lib_mvIMPACT_acquire.BasicDeviceSettings_imageRequestTimeout_ms_get, doc=)

staticinherited

An integer property defining the maximum time to wait for an image in ms.

Attention

Since Impact Acquire 2.32.0 the default value for this property has been changed! See Calling 'imageRequestWaitFor' Never Returns / An Application No Longer Terminates After Upgrading To Impact Acquire 2.32.0 Or Greater for details.

When this property is set to 0 the timeout never elapses. If the timeout this property defines elapses the currently processed request will be returned to the user even if no data has been captured so far. The result structure of the request object should be examined in that case. Also this should be considered as an error from the users point of view in which case he should clean up the acquisition queue by calling mvIMPACT.acquire.FunctionInterface.imageRequestReset. Afterwards the capture loop can be restarted.

Note

It is crucial to understand that this is a timeout PER REQUEST! The timespan taken into account for the measurement starts when the driver begins to capture data into this particular buffer! So when queuing 4 buffers with a timeout of 3000 ms each and no data being transmitted by the device for any reason will cause the last buffer to time out 3000*4 = 12000 ms AFTER the buffer has been queued and the acquisition has been started as the driver will wait for up to 3 seconds for each buffer that is being processed. When the device sends data this timeout does not affect the runtime behaviour at all. No additional delay is introduced by it when everything runs as planned.

pixelFormat

pixelFormat = property(lib_mvIMPACT_acquire.CameraSettingsBase_pixelFormat_get, doc=)

static

An enumerated integer property defining the pixel format used to transfer the image data into the target systems host memory.

Support for this property has been added in version 1.11.0 of Impact Acquire thus old driver versions will raise an exception if an application accesses the property without checking if the property is present.

By default this property will be set to mvIMPACT.acquire.ibpfAuto. This will result in the previous driver behaviour where depending on the various post processing steps that are enabled or disabled the driver will decide which transfer format will be used. However sometimes this could result in a transfer format, which is not ideal for the application (e.g. when a post processing step of the application needs RGBx888Packed but the systems bandwidth is limited the application might want to transfer the data in YUV422 packed and then use the fast format conversion algorithm in the driver). This can be achieved by explicitly setting mvIMPACT.acquire.CameraSettingsBase.pixelFormat to mvIMPACT.acquire.ibpfYUV422Packed and mvIMPACT.acquire.ImageDestination.pixelFormat to mvIMPACT.acquire.ibpfRGBx888Packed.

Note

Selecting a defined transfer format can in some cases result in certain filters (e.g. dark current, ...) to be switched of as then the filters themselves can no longer influence the transfer format, which is sometimes necessary as not every filter does support every input format. Also this property will contain only pixel formats, which are actually supported by the capture device, thus in most of the cases this will be a subset of the pixel formats defined by the enumeration defining this property.

Valid values for this property may be: mvIMPACT.acquire.ibpfRaw, mvIMPACT.acquire.ibpfMono8, mvIMPACT.acquire.ibpfMono16, mvIMPACT.acquire.ibpfRGBx888Packed, mvIMPACT.acquire.ibpfYUV422Packed, mvIMPACT.acquire.ibpfRGBx888Planar, mvIMPACT.acquire.ibpfMono10, mvIMPACT.acquire.ibpfMono12, mvIMPACT.acquire.ibpfMono14, mvIMPACT.acquire.ibpfRGB888Packed, mvIMPACT.acquire.ibpfYUV444Planar, mvIMPACT.acquire.ibpfMono32, mvIMPACT.acquire.ibpfYUV422Planar, mvIMPACT.acquire.ibpfRGB101010Packed, mvIMPACT.acquire.ibpfRGB121212Packed, mvIMPACT.acquire.ibpfRGB141414Packed, mvIMPACT.acquire.ibpfRGB161616Packed, mvIMPACT.acquire.ibpfYUV422_UYVYPacked, mvIMPACT.acquire.ibpfMono12Packed_V2, mvIMPACT.acquire.ibpfYUV422_10Packed, mvIMPACT.acquire.ibpfYUV422_UYVY_10Packed, mvIMPACT.acquire.ibpfBGR888Packed, mvIMPACT.acquire.ibpfBGR101010Packed_V2, mvIMPACT.acquire.ibpfYUV444_UYVPacked, mvIMPACT.acquire.ibpfYUV444_UYV_10Packed, mvIMPACT.acquire.ibpfYUV444Packed, mvIMPACT.acquire.ibpfYUV444_10Packed, mvIMPACT.acquire.ibpfMono12Packed_V1, mvIMPACT.acquire.ibpfYUV411_UYYVYY_Packed, mvIMPACT.acquire.ibpfRGB888Planar, mvIMPACT.acquire.ibpfAuto.

thisown

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

static