CameraSettingsFrameGrabber Class Reference

A class to access frame grabber related camera settings (Device specific interface layout only). More...

Inheritance diagram for CameraSettingsFrameGrabber:

Public Member Functions
	CameraSettingsFrameGrabber (Device device)
	Constructs a new mv.impact.acquire.CameraSettingsFrameGrabber object.
	CameraSettingsFrameGrabber (Device device, String settingName)
	Constructs a new mv.impact.acquire.CameraSettingsFrameGrabber 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.
TriggerControl	triggerControl (int nr)
	Returns a const pointer to a mv.impact.acquire.TriggerControl object.
TriggerControl	triggerControl (String name)
	Returns a const pointer to a mv.impact.acquire.TriggerControl object. If the name passed to the function does not specify a valid trigger control an ArgumentException will be raised.

Public Attributes
readonly EnumPropertyI< TAcquisitionField >	acquisitionField = new EnumPropertyI<TAcquisitionField>()
	An enumerated integer property defining which frame(s) of an interlaced video signal will be digitised or triggers the start of the acquisition.
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 PropertyI	contrast_pc = new PropertyI()
	An integer property defining the contrast value to be applied to the image data by the frame grabber in per cent.
readonly PropertyF	gain_dB = new PropertyF()
	A float property defining the gain in dB.
readonly PropertyI	hue_pc = new PropertyI()
	An integer property defining the hue value to be applied to the image data by the frame grabber in per cent.
readonly PropertyI	imageRequestTimeout_ms = new PropertyI()
	An integer property defining the maximum time to wait for an image in ms.
readonly EnumPropertyI< TInterlacedMode >	interlacedMode = new EnumPropertyI<TInterlacedMode>()
	An enumerated integer property defining how the image from the camera shall be captured.
readonly EnumPropertyI< TLineCounter >	lineCounter = new EnumPropertyI<TLineCounter>()
	An enumerated integer property defining the way line counter information is handled by the device.
readonly PropertyI	luminance_pc = new PropertyI()
	An integer property defining the luminance value to be applied to the image data by the frame grabber in per cent.
readonly PropertyI	offset_mV = new PropertyI()
	An integer property defining the offset in milli-Volt.
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 PropertyI	saturation_pc = new PropertyI()
	An integer property defining the saturation value to be applied to the image data by the frame grabber in per cent.
readonly EnumPropertyI< TScanClock >	scanClock = new EnumPropertyI<TScanClock>()
	An enumerated integer property defining the scan clock mode used for the current acquisition.
readonly PropertyI	scanRate_kHz = new PropertyI()
	An integer property defining the current scan frequency of the capture device.
readonly EnumPropertyI< TDeviceScanRateMode >	scanRateMode = new EnumPropertyI<TDeviceScanRateMode>()
	An enumerated integer property defining the scan rate mode for this setting.
readonly EnumPropertyI< TCameraSerialPortBaudRate >	serialPortBaudrate = new EnumPropertyI<TCameraSerialPortBaudRate>()
	An enumerated integer property defining the baud rate of the serial communication port between frame grabber and camera.
readonly PropertyI	softwareTriggerPeriod_ms = new PropertyI()
	An integer property defining the software simulated trigger period.
readonly EnumPropertyI< TDeviceTriggerMode >	triggerMode = new EnumPropertyI<TDeviceTriggerMode>()
	An enumerated integer property defining the behaviour of the frame grabbers trigger input.
readonly PropertyI	type = new PropertyI()
	An enumerated integer property defining the camera description used for the image acquisition.

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.
int	triggerControlCount [get]
	Returns the number of mv.impact.acquire.TriggerControls available for this device.

Detailed Description

A class to access frame grabber related camera settings (Device specific interface layout only).

This class contains properties to control the way the a frame grabber behaves in connection with the connected camera.

Note

Not every frame grabber will support every property defined in this class. Please refer to the description of the individual properties and make heavy use of the function mv.impact.acquire.Component.isValid in order to check whether a property is available for the device.

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.

Constructs a new mv.impact.acquire.GenICam.InterfaceModule object.

Constructor & Destructor Documentation

CameraSettingsFrameGrabber() [1/2]

CameraSettingsFrameGrabber ( Device device )

inline

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

Parameters

[in]

device

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

CameraSettingsFrameGrabber() [2/2]

CameraSettingsFrameGrabber ( Device device, String settingName )

inline

Constructs a new mv.impact.acquire.CameraSettingsFrameGrabber 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 framework's 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 framework's 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.

triggerControl() [1/2]

TriggerControl triggerControl ( int nr )

inline

Returns a const pointer to a mv.impact.acquire.TriggerControl object.

Parameters

[in]

nr

The number of the trigger control

triggerControl() [2/2]

TriggerControl triggerControl ( String name )

inline

Returns a const pointer to a mv.impact.acquire.TriggerControl object. If the name passed to the function does not specify a valid trigger control an ArgumentException will be raised.

Parameters

[in]

name

The name of the trigger control

Member Data Documentation

acquisitionField

readonly EnumPropertyI<TAcquisitionField> acquisitionField = new EnumPropertyI<TAcquisitionField>()

An enumerated integer property defining which frame(s) of an interlaced video signal will be digitised or triggers the start of the acquisition.

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

Note

This property will not be available for every frame grabber, so before using it, check if the property is available at all by calling mv.impact.acquire.Component.isValid. Accessing an invalid property will raise an exception!

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.

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

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

contrast_pc

readonly PropertyI contrast_pc = new PropertyI()

An integer property defining the contrast value to be applied to the image data by the frame grabber in per cent.

Note

This property will not be available for every frame grabber, so before using it, check if the property is available at all by calling mv.impact.acquire.Component.isValid. Accessing an invalid property will raise an exception!

gain_dB

readonly PropertyF gain_dB = new PropertyF()

A float property defining the gain in dB.

This is the gain applied during the analogue to digital conversion inside the frame grabber, not applied inside the camera.

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

Note

This property will not be available for every frame grabber, so before using it, check if the property is available at all by calling mv.impact.acquire.Component.isValid. Accessing an invalid property will raise an exception!

hue_pc

readonly PropertyI hue_pc = new PropertyI()

An integer property defining the hue value to be applied to the image data by the frame grabber in per cent.

Note

This property will not be available for every frame grabber, so before using it, check if the property is available at all by calling mv.impact.acquire.Component.isValid. Accessing an invalid property will raise an exception!

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.

interlacedMode

readonly EnumPropertyI<TInterlacedMode> interlacedMode = new EnumPropertyI<TInterlacedMode>()

An enumerated integer property defining how the image from the camera shall be captured.

If a video signal is transmitted to the capture device in an interlaced format, the device can either capture each individual frame, or merge two frames together into a complete image.

This property will be invisible when the camera description selected by the property mv.impact.acquire.CameraSettingsFrameGrabber.type does define it property mv.impact.acquire.CameraDescriptionBase.interlacedType to be mv.impact.acquire.TCameraInterlacedType.citNone as the decision whether an interlaced image shall be reconstructed from frames or left as individual frame is redundant if the video source transmits full frames only.

The visibility of a property can be checked by calling mv.impact.acquire.Component.isVisible

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

Note

This property will not be available for every frame grabber, so before using it, check if the property is available at all by calling mv.impact.acquire.Component.isValid. Accessing an invalid property will raise an exception!

lineCounter

readonly EnumPropertyI<TLineCounter> lineCounter = new EnumPropertyI<TLineCounter>()

An enumerated integer property defining the way line counter information is handled by the device.

This is interesting for line scan camera applications. Valid values for this property are defined by the enumeration mv.impact.acquire.TLineCounter.

Note

This property will not be available for every frame grabber, so before using it, check if the property is available at all by calling mv.impact.acquire.Component.isValid. Accessing an invalid property will raise an exception!

luminance_pc

readonly PropertyI luminance_pc = new PropertyI()

An integer property defining the luminance value to be applied to the image data by the frame grabber in per cent.

Note

This property will not be available for every frame grabber, so before using it, check if the property is available at all by calling mv.impact.acquire.Component.isValid. Accessing an invalid property will raise an exception!

offset_mV

readonly PropertyI offset_mV = new PropertyI()

An integer property defining the offset in milli-Volt.

This is the analogue offset applied during the analogue to digital conversion inside the frame grabber, not applied inside the camera.

Note

This property will not be available for every frame grabber, so before using it, check if the property is available at all by calling mv.impact.acquire.Component.isValid. Accessing an invalid property will raise an exception!

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.

saturation_pc

readonly PropertyI saturation_pc = new PropertyI()

An integer property defining the saturation value to be applied to the image data by the frame grabber in per cent.

Note

This property will not be available for every frame grabber, so before using it, check if the property is available at all by calling mv.impact.acquire.Component.isValid. Accessing an invalid property will raise an exception!

scanClock

readonly EnumPropertyI<TScanClock> scanClock = new EnumPropertyI<TScanClock>()

An enumerated integer property defining the scan clock mode used for the current acquisition.

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

Note

This property will not be available for every frame grabber, so before using it, check if the property is available at all by calling mv.impact.acquire.Component.isValid. Accessing an invalid property will raise an exception! Digital frame grabbers will however NOT support this property.

scanRate_kHz

readonly PropertyI scanRate_kHz = new PropertyI()

An integer property defining the current scan frequency of the capture device.

This property is only visible if the mv.impact.acquire.CameraSettingsFrameGrabber.scanRateMode property is NOT in an auto mode.

Note

This property will not be available for every frame grabber, so before using it, check if the property is available at all by calling mv.impact.acquire.Component.isValid. Accessing an invalid property will raise an exception!

scanRateMode

readonly EnumPropertyI<TDeviceScanRateMode> scanRateMode = new EnumPropertyI<TDeviceScanRateMode>()

An enumerated integer property defining the scan rate mode for this setting.

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

Note

This property will not be available for every frame grabber, so before using it, check if the property is available at all by calling mv.impact.acquire.Component.isValid. Accessing an invalid property will raise an exception!

serialPortBaudrate

readonly EnumPropertyI<TCameraSerialPortBaudRate> serialPortBaudrate = new EnumPropertyI<TCameraSerialPortBaudRate>()

An enumerated integer property defining the baud rate of the serial communication port between frame grabber and camera.

Currently this property is only available for CameraLink® frame grabbers.

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

Note

This property will not be available for every frame grabber, so before using it, check if the property is available at all by calling mv.impact.acquire.Component.isValid. Accessing an invalid property will raise an exception!

softwareTriggerPeriod_ms

readonly PropertyI softwareTriggerPeriod_ms = new PropertyI()

An integer property defining the software simulated trigger period.

When mv.impact.acquire.CameraSettingsFrameGrabber.triggerMode is set to mv.impact.acquire.TDeviceTriggerMode.dtmPeriodically this property defines the interval between two consecutive external trigger events simulated by the driver.

Currently this property is only available for mvTITAN and mvGAMMA frame grabbers.

Note

This property will not be available for every frame grabber, so before using it, check if the property is available at all by calling mv.impact.acquire.Component.isValid. Accessing an invalid property will raise an exception!

triggerMode

readonly EnumPropertyI<TDeviceTriggerMode> triggerMode = new EnumPropertyI<TDeviceTriggerMode>()

An enumerated integer property defining the behaviour of the frame grabbers trigger input.

Note

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TDeviceTriggerMode. However not every device will offer all these trigger modes but a subset of them. Valid trigger modes therefore can be found by reading the properties translation dictionary.

This property will not be available for every frame grabber, so before using it, check if the property is available at all by calling mv.impact.acquire.Component.isValid. Accessing an invalid property will raise an exception!

type

readonly PropertyI type = new PropertyI()

An enumerated integer property defining the camera description used for the image acquisition.

This property ALWAYS defines a translation dictionary containing a string representation and a numerical value for the camera descriptions available for the device. The string representation of the camera description will be built from the property name of the class this camera description belongs to (e.g. 'Standard', 'NonStandard' or 'CameraLink') and the name of the camera description itself. Assuming a the device can handle standard video cameras and a description for a camera named 'MyCCIRCamera' will therefore add 'Standard_MyCCIRCamera' and a unique numerical representation to the properties translation dictionary.

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 framework's 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 framework's 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.

triggerControlCount

int triggerControlCount

get

Returns the number of mv.impact.acquire.TriggerControls available for this device.

This might be 0 if the device either does not support this feature.