mvIMPACT Acquire SDK C++
CameraSettingsVirtualDevice Class Reference

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

Inheritance diagram for CameraSettingsVirtualDevice:
CameraSettingsBase BasicDeviceSettingsWithAOI BasicDeviceSettings ComponentCollection

Public Member Functions

 CameraSettingsVirtualDevice (Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::CameraSettingsVirtualDevice object. More...
 
HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

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

Protected Attributes

HOBJ m_hRoot
 

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 mvIMPACT 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 mvIMPACT::acquire::Device::interfaceLayout is set to mvIMPACT::acquire::dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

◆ CameraSettingsVirtualDevice()

CameraSettingsVirtualDevice ( Device pDev,
const std::string &  settingName = "Base" 
)
inlineexplicit

Constructs a new mvIMPACT::acquire::CameraSettingsVirtualDevice object.

Parameters
[in]pDevA pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::acquire::DeviceManager object.
[in]settingNameThe 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 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.

◆ 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.

Member Data Documentation

◆ aoiHeight

PropertyI aoiHeight
inherited

An integer property defining the number of lines to capture.

◆ aoiMode

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

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

Since
2.11.9

◆ aoiStartX

PropertyI aoiStartX
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

PropertyI aoiStartY
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

PropertyI aoiWidth
inherited

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

◆ basedOn

PropertyS basedOn
inherited

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

Since
1.12.67

◆ bayerMosaicParity

PropertyIBayerMosaicParity bayerMosaicParity

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. mvIMPACT::acquire::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 mvIMPACT::acquire::TBayerMosaicParity.

◆ bufferPartCount

PropertyI bufferPartCount

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 mvIMPACT 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 mvIMPACT::acquire::Request::getBufferPartCount() 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

PropertyI channelBitDepth

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

When mvIMPACT::acquire::CameraSettingsBase::pixelFormat is NOT set to mvIMPACT::acquire::ibpfAuto, this this property will become invisible.

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

◆ frameDelay_us

PropertyI frameDelay_us

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

◆ gain_dB

PropertyF gain_dB

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)
PropertyF gain_dB
A float property defining the gain in dB to be applied to the test image.
Definition: mvIMPACT_acquire.h:18914

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: MATRIX VISION gain value (logarithmic)
gain_x: multiplicative gain
^: power function

◆ imageDirectory

PropertyS imageDirectory

A string property defining the directory to capture images from.

This feature will only be visible, when the property mvIMPACT::acquire::CameraSettingsVirtualDevice::testMode is set to mvIMPACT::acquire::vdtmImageDirectory.

See mvIMPACT::acquire::CameraSettingsVirtualDevice::imageType to find out how to configure what kind of images shall be captured from disc.

◆ imageRequestTimeout_ms

PropertyI imageRequestTimeout_ms
inherited

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

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.

◆ imageType

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

This feature will only be visible, when the property mvIMPACT::acquire::CameraSettingsVirtualDevice::testMode is set to mvIMPACT::acquire::vdtmImageDirectory.

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

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

◆ paddingX

PropertyI paddingX

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

When mvIMPACT::acquire::CameraSettingsVirtualDevice::testMode is set to a mono format(not the weird packed ones!), mvIMPACT::acquire::vdtmMovingBayerDataRamp or mvIMPACT::acquire::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

PropertyIImageBufferPixelFormat pixelFormat
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 mvIMPACT 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 are defined by the enumeration mvIMPACT::acquire::TImageBufferPixelFormat.

◆ tapsXGeometry

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 mvIMPACT::acquire::TCameraTapsXGeometry.

Since
2.5.2

◆ tapsYGeometry

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 mvIMPACT::acquire::TCameraTapsYGeometry.

Since
2.5.2

◆ testImageBarWidth

PropertyI testImageBarWidth

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

◆ testMode

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

When mvIMPACT::acquire::CameraSettingsBase::pixelFormat is NOT set to mvIMPACT::acquire::ibpfAuto, this this property will become invisible.

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

◆ userData

PropertyS userData

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.


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