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

Inheritance diagram for CameraSettingsFrameGrabber:

[legend]

Public Member Functions
	__init__ (self, args, *kwargs)
	Constructs a new mvIMPACT.acquire.CameraSettingsBase object.

	getTriggerControlCount (self)
	Returns the number of mvIMPACT.acquire.TriggerControls available for this device.

	triggerControl (self, *args)
	Returns a const pointer to a mvIMPACT.acquire.TriggerControl object.

Properties
	acquisitionField = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_acquisitionField_get, doc=)
	An enumerated integer property defining which frame(s) of an interlaced video signal will be digitised or triggers the start of the acquisition.

	aoiMode = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_aoiMode_get, doc=)
	An enumerated integer property defining the used AOI mode for the image capture.

	contrast_pc = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_contrast_pc_get, doc=)
	An integer property defining the contrast value to be applied to the image data by the frame grabber in per cent.

	gain_dB = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_gain_dB_get, doc=)
	A float property defining the gain in dB.

	hue_pc = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_hue_pc_get, doc=)
	An integer property defining the hue value to be applied to the image data by the frame grabber in per cent.

	interlacedMode = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_interlacedMode_get, doc=)
	An enumerated integer property defining how the image from the camera shall be captured.

	lineCounter = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_lineCounter_get, doc=)
	An enumerated integer property defining the way line counter information is handled by the device.

	luminance_pc = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_luminance_pc_get, doc=)
	An integer property defining the luminance value to be applied to the image data by the frame grabber in per cent.

	offset_mV = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_offset_mV_get, doc=)
	An integer property defining the offset in milli-Volt.

	saturation_pc = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_saturation_pc_get, doc=)
	An integer property defining the saturation value to be applied to the image data by the frame grabber in per cent.

	scanClock = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_scanClock_get, doc=)
	An enumerated integer property defining the scan clock mode used for the current acquisition.

	scanRate_kHz = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_scanRate_kHz_get, doc=)
	An integer property defining the current scan frequency of the capture device.

	scanRateMode = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_scanRateMode_get, doc=)
	An enumerated integer property defining the scan rate mode for this setting.

	serialPortBaudrate = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_serialPortBaudrate_get, doc=)
	An enumerated integer property defining the baud rate of the serial communication port between frame grabber and camera.

	softwareTriggerPeriod_ms = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_softwareTriggerPeriod_ms_get, doc=)
	An integer property defining the software simulated trigger period.

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

	triggerControlCount = property (getTriggerControlCount, None, None, None)
	An integer property (read-only) which holds the number of mvIMPACT.acquire.TriggerControls available for this device.

	triggerMode = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_triggerMode_get, doc=)
	An enumerated integer property defining the behaviour of the frame grabbers trigger input.

	type = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_type_get, doc=)
	An enumerated integer property defining the camera description used for the image acquisition.

Detailed Description

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

Deprecated: Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!

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 mvIMPACT.acquire.Component.isValid in order to check whether a property is available for the device.; 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,
		**	kwargs )

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

Reimplemented from CameraSettingsBase.

Member Function Documentation

◆ getTriggerControlCount()

getTriggerControlCount ( self )

Returns the number of mvIMPACT.acquire.TriggerControls available for this device.

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

◆ triggerControl()

triggerControl	(		self,
		*	args )

Returns a const pointer to a mvIMPACT.acquire.TriggerControl object.

OVERLOAD 1:

Parameters

nr	[in] The number of the trigger control

OVERLOAD 2: Returns a const pointer to a mvIMPACT.acquire.TriggerControl object or NULL if the name passed to the function does not specify a valid trigger control.

Parameters

name	[in] The name of the trigger control

Property Documentation

◆ acquisitionField

acquisitionField = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_acquisitionField_get, doc=)

static

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 may be: mvIMPACT.acquire.afAuto, mvIMPACT.acquire.afOdd, mvIMPACT.acquire.afEven, mvIMPACT.acquire.afAny.

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 mvIMPACT.acquire.Component.isValid. Accessing an invalid property will raise an exception!

◆ aoiMode

aoiMode = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_aoiMode_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.camFull, mvIMPACT.acquire.camUser.

◆ contrast_pc

contrast_pc = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_contrast_pc_get, doc=)

static

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 mvIMPACT.acquire.Component.isValid. Accessing an invalid property will raise an exception!

◆ gain_dB

gain_dB = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_gain_dB_get, doc=)

static

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 mvIMPACT.acquire.Component.isValid. Accessing an invalid property will raise an exception!

◆ hue_pc

hue_pc = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_hue_pc_get, doc=)

static

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 mvIMPACT.acquire.Component.isValid. Accessing an invalid property will raise an exception!

◆ interlacedMode

interlacedMode = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_interlacedMode_get, doc=)

static

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 mvIMPACT.acquire.CameraSettingsFrameGrabber.type does define it property mvIMPACT.acquire.CameraDescriptionBase.interlacedType to be mvIMPACT.acquire.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 mvIMPACT.acquire.Component.isVisible

Valid values for this property may be: mvIMPACT.acquire.imOn, mvIMPACT.acquire.imOff.

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 mvIMPACT.acquire.Component.isValid. Accessing an invalid property will raise an exception!

◆ lineCounter

lineCounter = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_lineCounter_get, doc=)

static

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 may be: mvIMPACT.acquire.lcOff, mvIMPACT.acquire.lcOn.

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 mvIMPACT.acquire.Component.isValid. Accessing an invalid property will raise an exception!

◆ luminance_pc

luminance_pc = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_luminance_pc_get, doc=)

static

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 mvIMPACT.acquire.Component.isValid. Accessing an invalid property will raise an exception!

◆ offset_mV

offset_mV = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_offset_mV_get, doc=)

static

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 mvIMPACT.acquire.Component.isValid. Accessing an invalid property will raise an exception!

◆ saturation_pc

saturation_pc = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_saturation_pc_get, doc=)

static

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 mvIMPACT.acquire.Component.isValid. Accessing an invalid property will raise an exception!

◆ scanClock

scanClock = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_scanClock_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.scAuto, mvIMPACT.acquire.scAnalogue, mvIMPACT.acquire.scDigital.

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 mvIMPACT.acquire.Component.isValid. Accessing an invalid property will raise an exception! Digital frame grabbers will however NOT support this property.

◆ scanRate_kHz

scanRate_kHz = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_scanRate_kHz_get, doc=)

static

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

This property is only visible if the mvIMPACT.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 mvIMPACT.acquire.Component.isValid. Accessing an invalid property will raise an exception!

◆ scanRateMode

scanRateMode = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_scanRateMode_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.dsrmAuto, mvIMPACT.acquire.dsrmUser.

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 mvIMPACT.acquire.Component.isValid. Accessing an invalid property will raise an exception!

◆ serialPortBaudrate

serialPortBaudrate = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_serialPortBaudrate_get, doc=)

static

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 may be: mvIMPACT.acquire.cspbr9600, mvIMPACT.acquire.cspbr19200, mvIMPACT.acquire.cspbr38400, mvIMPACT.acquire.cspbr57600, mvIMPACT.acquire.cspbr115200, mvIMPACT.acquire.cspbr230400, mvIMPACT.acquire.cspbr460800, mvIMPACT.acquire.cspbr921600.

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 mvIMPACT.acquire.Component.isValid. Accessing an invalid property will raise an exception!

◆ softwareTriggerPeriod_ms

softwareTriggerPeriod_ms = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_softwareTriggerPeriod_ms_get, doc=)

static

An integer property defining the software simulated trigger period.

When mvIMPACT.acquire.CameraSettingsFrameGrabber.triggerMode is set to mvIMPACT.acquire.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 mvIMPACT.acquire.Component.isValid. Accessing an invalid property will raise an exception!

◆ thisown

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

static

◆ triggerControlCount

triggerControlCount = property (getTriggerControlCount, None, None, None)

static

An integer property (read-only) which holds the number of mvIMPACT.acquire.TriggerControls available for this device.

See mvIMPACT.acquire.CameraSettingsFrameGrabber.getTriggerControlCount()

◆ triggerMode

triggerMode = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_triggerMode_get, doc=)

static

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

Note: Valid values for this property may be: mvIMPACT.acquire.dtmOff, mvIMPACT.acquire.dtmOn, mvIMPACT.acquire.dtmFallingEdge, mvIMPACT.acquire.dtmRisingEdge, mvIMPACT.acquire.dtmPeriodically, mvIMPACT.acquire.dtmOnDemand, mvIMPACT.acquire.dtmStartRisingStopFalling, mvIMPACT.acquire.dtmStartFallingStopRising, mvIMPACT.acquire.dtmLevelHigh, mvIMPACT.acquire.dtmLevelLow. 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 mvIMPACT.acquire.Component.isValid. Accessing an invalid property will raise an exception!

◆ type

type = property(lib_mvIMPACT_acquire.CameraSettingsFrameGrabber_type_get, doc=)

static

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.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ getTriggerControlCount()

◆ triggerControl()

Property Documentation

◆ acquisitionField

◆ aoiMode

◆ contrast_pc

◆ gain_dB

◆ hue_pc

◆ interlacedMode

◆ lineCounter

◆ luminance_pc

◆ offset_mV

◆ saturation_pc

◆ scanClock

◆ scanRate_kHz

◆ scanRateMode

◆ serialPortBaudrate

◆ softwareTriggerPeriod_ms

◆ thisown

◆ triggerControlCount

◆ triggerMode

◆ type

◆ init()