CameraSettingsVirtualDevice Class Reference

mvVirtualDevice related camera settings (Device specific interface layout only). More...

Inheritance diagram for CameraSettingsVirtualDevice:

Public Member Functions
	CameraSettingsVirtualDevice (Device device)
	Constructs a new mv.impact.acquire.CameraSettingsVirtualDevice object.
	CameraSettingsVirtualDevice (Device device, String settingName)
	Constructs a new mv.impact.acquire.CameraSettingsVirtualDevice object.
IEnumerable< T >	getEnumerable< T > ()
	Returns an enumerator of a certain type that iterates through the collection.
IEnumerator< int >	GetEnumerator ()
	Returns an enumerator that iterates through the collection.
void	restoreDefault ()
	Restores the default for every component of this collection.

Public Attributes
readonly PropertyI	aoiHeight = new PropertyI()
	An integer property defining the number of lines to capture.
readonly EnumPropertyI< TCameraAoiMode >	aoiMode = new EnumPropertyI<TCameraAoiMode>()
	An enumerated integer property defining the used AOI mode for the image capture.
readonly PropertyI	aoiStartX = new PropertyI()
	An integer property defining the X-offset for each capture line.
readonly PropertyI	aoiStartY = new PropertyI()
	An integer property defining the Y-offset.
readonly PropertyI	aoiWidth = new PropertyI()
	An integer property defining the number of pixels to capture per line.
readonly PropertyS	basedOn = new PropertyS()
	A string property (read-only) containing the name of the setting this setting is based on.
readonly EnumPropertyI< TBayerMosaicParity >	bayerMosaicParity = new EnumPropertyI<TBayerMosaicParity>()
	An enumerated integer property defining the bayer attribute assigned to the generated test image.
readonly PropertyI	bufferPartCount = new PropertyI()
	An integer property defining the number of buffer part to transmit in each request.
readonly PropertyI	channelBitDepth = new PropertyI()
	An integer property defining the channel bit depth for certain test image generation modes.
readonly PropertyI	frameDelay_us = new PropertyI()
	An integer property defining a delay in us before the 'captured' image is returned to the user.
readonly PropertyF	gain_dB = new PropertyF()
	A float property defining the gain in dB to be applied to the test image.
readonly PropertyS	imageDirectory = new PropertyS()
	A string property defining the directory to capture images from.
readonly PropertyI	imageRequestTimeout_ms = new PropertyI()
	An integer property defining the maximum time to wait for an image in ms.
readonly EnumPropertyI< TVirtualDeviceImageType >	imageType = new EnumPropertyI<TVirtualDeviceImageType>()
	An enumerated integer property defining what images shall be captured from hard disk.
readonly PropertyI	paddingX = new PropertyI()
	An integer property defining the padding(in bytes) in X-direction for certain test image generation modes.
readonly EnumPropertyI< TImageBufferPixelFormat >	pixelFormat = new EnumPropertyI<TImageBufferPixelFormat>()
	An enumerated integer property defining the pixel format used to transfer the image data into the target systems host memory.
readonly EnumPropertyI< TCameraTapsXGeometry >	tapsXGeometry = new EnumPropertyI<TCameraTapsXGeometry>()
	An enumerated integer property defining the way this camera transmits the pixel data in X direction.
readonly EnumPropertyI< TCameraTapsYGeometry >	tapsYGeometry = new EnumPropertyI<TCameraTapsYGeometry>()
	An enumerated integer property defining the way this camera transmits the pixel data in Y direction.
readonly PropertyI	testImageBarWidth = new PropertyI()
	An integer property defining the width (in pixels) of the different bars in certain test modes.
readonly EnumPropertyI< TVirtualDeviceTestMode >	testMode = new EnumPropertyI<TVirtualDeviceTestMode>()
	An enumerated integer property defining the test mode use to generate the dummy images.
readonly PropertyS	userData = new PropertyS()
	A string property that will be copied into the user data property of each request.

Properties
IEnumerable< Component >	componentEnumerable [get]
	Returns an enumerator that iterates through the collection.
IEnumerable< ComponentList >	componentListEnumerable [get]
	Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.
int	hObj [get]
	Returns a unique identifier for the component collection referenced by this object.

Detailed Description

mvVirtualDevice related camera settings (Device specific interface layout only).

Note

As this is a device driver meant for testing the interface an allowing to start the integration of Impact Acquire into an application, this class might change at ANY time! Changes in the virtual device driver might not be backward compatible!

This class will only be available if mv.impact.acquire.Device.interfaceLayout is set to mv.impact.acquire.TDeviceInterfaceLayout.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

CameraSettingsVirtualDevice() [1/2]

CameraSettingsVirtualDevice ( Device device )

inline

Constructs a new mv.impact.acquire.CameraSettingsVirtualDevice object.

Parameters

[in]

device

A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.

CameraSettingsVirtualDevice() [2/2]

CameraSettingsVirtualDevice ( Device device, String settingName )

inline

Constructs a new mv.impact.acquire.CameraSettingsVirtualDevice object.

Parameters

[in]	device	A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.
[in]	settingName	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 mv.impact.acquire.FunctionInterface.availableSettings, new settings can be created with the function mv.impact.acquire.FunctionInterface.createSetting

Member Function Documentation

getEnumerable< T >()

IEnumerable< T > getEnumerable< T > ( )

inlineinherited

Returns an enumerator of a certain type that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Property c in info.getEnumerable<Property>())
{
  validateProperty(c);
}

See the frameworks documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

GetEnumerator()

IEnumerator< int > GetEnumerator ( )

inlineinherited

Returns an enumerator that iterates through the collection.

See the frameworks documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

restoreDefault()

void restoreDefault ( )

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.

Member Data Documentation

aoiHeight

readonly PropertyI aoiHeight = new PropertyI()

inherited

An integer property defining the number of lines to capture.

aoiMode

readonly EnumPropertyI<TCameraAoiMode> aoiMode = new EnumPropertyI<TCameraAoiMode>()

An enumerated integer property defining the used AOI mode for the image capture.

This feature will only be visible, when the property mv.impact.acquire.CameraSettingsVirtualDevice.testMode is set to mv.impact.acquire.TVirtualDeviceTestMode.vdtmImageDirectory. Then this property will allow to enforce a certain image dimension ( mv.impact.acquire.TCameraAoiMode.camUser ) or to capture every image file in its original dimensions ( mv.impact.acquire.TCameraAoiMode.camFull ). Valid values for this property are defined by the enumeration mv.impact.acquire.TCameraAoiMode.

Since

2.11.9

aoiStartX

readonly PropertyI aoiStartX = new PropertyI()

inherited

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

readonly PropertyI aoiStartY = new PropertyI()

inherited

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

readonly PropertyI aoiWidth = new PropertyI()

inherited

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

basedOn

readonly PropertyS basedOn = new PropertyS()

inherited

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

Since

1.12.67

bayerMosaicParity

readonly EnumPropertyI<TBayerMosaicParity> bayerMosaicParity = new EnumPropertyI<TBayerMosaicParity>()

An enumerated integer property defining the bayer attribute assigned to the generated test image.

When images are acquired via a directory, or a bayer test pattern is generated this can be used to specify the bayer parity. mv.impact.acquire.TBayerMosaicParity.bmpUndefined will set the buffers bayer attribute thus will result in a grey(mono) buffer being returned.

Valid values for this property are defined by the enumeration mv.impact.acquire.TBayerMosaicParity.

bufferPartCount

readonly PropertyI bufferPartCount = new PropertyI()

An integer property defining the number of buffer part to transmit in each request.

This property is meant to test the multi-part buffer feature of Impact Acquire mainly. When set to 0 multi-part buffer handling is switched off. When set to a value greater than 0 the virtual device will transmit data in multi-part mode, meaning that mv.impact.acquire.Request.bufferPartCount will return a value larger than zero. Only when this is the case the properties belonging to the individual buffer parts are guaranteed to contain up to date data while then all properties whose name starts with image within that request might not.

Since

2.20.0

channelBitDepth

readonly PropertyI channelBitDepth = new PropertyI()

An integer property defining the channel bit depth for certain test image generation modes.

When mv.impact.acquire.CameraSettingsBase.pixelFormat is NOT set to mv.impact.acquire.TImageBufferPixelFormat.ibpfAuto, this this property will become invisible.

When mv.impact.acquire.CameraSettingsVirtualDevice.testMode is set to mv.impact.acquire.TVirtualDeviceTestMode.vdtmMovingMonoRamp, mv.impact.acquire.TVirtualDeviceTestMode.vdtmMovingBayerDataRamp or mv.impact.acquire.TVirtualDeviceTestMode.vdtmBayerWhiteBalanceTestImage this property will allow to define the pixel format for the test image.

frameDelay_us

readonly PropertyI frameDelay_us = new PropertyI()

An integer property defining a delay in us before the 'captured' image is returned to the user.

gain_dB

readonly PropertyF gain_dB = new PropertyF()

A float property defining the gain in dB to be applied to the test image.

The formula for given gain_dB is

gain_x= 10 ^ (gain_dB/20)

Example:

gain_x = 10 ^ (6/20) = 1.995

I.e. increasing the gain setting by 6dB corresponds to factor of 2.

The formula for given gain_x is

gain_dB = 20*log(gain_x) dB

Where:
gain_dB: Balluff gain value (logarithmic)
gain_x: multiplicative gain
^: power function

imageDirectory

readonly PropertyS imageDirectory = new PropertyS()

A string property defining the directory to capture images from.

This feature will only be visible, when the property mv.impact.acquire.CameraSettingsVirtualDevice.testMode is set to mv.impact.acquire.TVirtualDeviceTestMode.vdtmImageDirectory.

See mv.impact.acquire.CameraSettingsVirtualDevice.imageType to find out how to configure what kind of images shall be captured from disk.

imageRequestTimeout_ms

readonly PropertyI imageRequestTimeout_ms = new PropertyI()

inherited

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 mv.impact.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.

Examples

Callback.cs.

imageType

readonly EnumPropertyI<TVirtualDeviceImageType> imageType = new EnumPropertyI<TVirtualDeviceImageType>()

An enumerated integer property defining what images shall be captured from hard disk.

This feature will only be visible, when the property mv.impact.acquire.CameraSettingsVirtualDevice.testMode is set to mv.impact.acquire.TVirtualDeviceTestMode.vdtmImageDirectory.

Valid values for this property are defined by the enumeration mv.impact.acquire.TVirtualDeviceImageType.

paddingX

readonly PropertyI paddingX = new PropertyI()

An integer property defining the padding(in bytes) in X-direction for certain test image generation modes.

When mv.impact.acquire.CameraSettingsVirtualDevice.testMode is set to a mono format(not the weird packed ones!), mv.impact.acquire.TVirtualDeviceTestMode.vdtmMovingBayerDataRamp or mv.impact.acquire.TVirtualDeviceTestMode.vdtmBayerWhiteBalanceTestImage this property will allow to define the padding in bytes for each line. This will result in images where the line pitch differs from the width multiplied by the bytes per pixel value. E.g. a padding of 1 in X-direction and a width of 5 for a 16 bit mono format will result in a line pitch of 11 bytes(5*2 + 1).

pixelFormat

readonly EnumPropertyI<TImageBufferPixelFormat> pixelFormat = new EnumPropertyI<TImageBufferPixelFormat>()

inherited

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 mv.impact.acquire.TImageBufferPixelFormat.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 mv.impact.acquire.CameraSettingsBase.pixelFormat to mv.impact.acquire.TImageBufferPixelFormat.ibpfYUV422Packed and mv.impact.acquire.ImageDestination.pixelFormat to mv.impact.acquire.TImageBufferPixelFormat.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 enumeration defining this property.

Valid values for this property are defined by the enumeration mv.impact.acquire.TImageBufferPixelFormat.

tapsXGeometry

readonly EnumPropertyI<TCameraTapsXGeometry> tapsXGeometry = new EnumPropertyI<TCameraTapsXGeometry>()

An enumerated integer property defining the way this camera transmits the pixel data in X direction.

Within the virtual device driver, modifying this property internally will only attach the corresponding attribute to the request buffer, thus might result in the tap sort filter to process the data. This is mainly meant for testing purposes.

Valid values for this property are defined by the enumeration mv.impact.acquire.TCameraTapsXGeometry.

tapsYGeometry

readonly EnumPropertyI<TCameraTapsYGeometry> tapsYGeometry = new EnumPropertyI<TCameraTapsYGeometry>()

An enumerated integer property defining the way this camera transmits the pixel data in Y direction.

Within the virtual device driver, modifying this property internally will only attach the corresponding attribute to the request buffer, thus might result in the tap sort filter to process the data. This is mainly meant for testing purposes.

Valid values for this property are defined by the enumeration mv.impact.acquire.TCameraTapsYGeometry.

testImageBarWidth

readonly PropertyI testImageBarWidth = new PropertyI()

An integer property defining the width (in pixels) of the different bars in certain test modes.

testMode

readonly EnumPropertyI<TVirtualDeviceTestMode> testMode = new EnumPropertyI<TVirtualDeviceTestMode>()

An enumerated integer property defining the test mode use to generate the dummy images.

When mv.impact.acquire.CameraSettingsBase.pixelFormat is NOT set to mv.impact.acquire.TImageBufferPixelFormat.ibpfAuto, this this property will become invisible.

Valid values for this property are defined by the enumeration mv.impact.acquire.TVirtualDeviceTestMode.

userData

readonly PropertyS userData = new PropertyS()

A string property that will be copied into the user data property of each request.

This e.g. can be used to assign a certain identifier to each image request.

Property Documentation

componentEnumerable

IEnumerable<Component> componentEnumerable

getinherited

Returns an enumerator that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Component c in info.componentEnumerable)
{
  Console.WriteLine("{0}", c.name);
}

See the frameworks documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

componentListEnumerable

IEnumerable<ComponentList> componentListEnumerable

getinherited

Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (ComponentList cl in info.componentListEnumerable)
{
  Console.WriteLine("{0}", cl.name);
}

See the frameworks documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

hObj

int hObj

getinherited

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

This handle will always reference an object of type mv.impact.acquire.ComponentList.

Returns

A unique identifier for the component referenced by this object.