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

Inheritance diagram for CameraSettingsV4L2Device:

Public Member Functions
	__init__ (self, *args)
	Constructs a new mvIMPACT.acquire.CameraSettingsV4L2Device object.
	getCustomFeatureIterator (self)
	Returns an iterator to for iterating inside a device specific feature list.
	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.
	autoGain = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_autoGain_get, doc=)
	An enumerated integer property to switch on/off the auto gain.
	autoWhiteBalance = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_autoWhiteBalance_get, doc=)
	An enumerated integer property to switch on/off the auto white balance function of the V4L2-device.
	backlightCompensation = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_backlightCompensation_get, doc=)
	An integer property to adjust the backlight compensation.
	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.
	blackLevel = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_blackLevel_get, doc=)
	An integer property to adjust the black level.
	blueBalance = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_blueBalance_get, doc=)
	An integer property to adjust the blue balance.
	brightness = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_brightness_get, doc=)
	An integer property to adjust the brightness.
	contrast = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_contrast_get, doc=)
	An integer property to adjust the contrast.
	exposure = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_exposure_get, doc=)
	An integer property to adjust the exposure.
	gain = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_gain_get, doc=)
	An integer property to adjust the gain.
	gamma = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_gamma_get, doc=)
	An integer property to adjust the gamma.
	HFlip = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_HFlip_get, doc=)
	An enumerated integer property to mirror the frames horizontally.
	hue = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_hue_get, doc=)
	An integer property to adjust the hue.
	hueAuto = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_hueAuto_get, doc=)
	An enumerated integer property to switch on/off auto hue.
	imageHeight = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_imageHeight_get, doc=)
	An integer property defining the height of the image supplied by the V4L2 device.
	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.
	imageWidth = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_imageWidth_get, doc=)
	An integer property defining the width of the image supplied by the V4L2 device.
	pixelFormat = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_pixelFormat_get, doc=)
	An integer property defining the pixel format of captured frames.
	powerLineFrequency = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_powerLineFrequency_get, doc=)
	An enumerated integer property to enable power line frequency filter.
	redBalance = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_redBalance_get, doc=)
	An integer property to adjust the red balance.
	saturation = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_saturation_get, doc=)
	An integer property to adjust the saturation.
	sharpness = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_sharpness_get, doc=)
	An integer property to adjust the sharpness.
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
	VFlip = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_VFlip_get, doc=)
	An integer property to mirror the frames vertically.
	videoStandard = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_videoStandard_get, doc=)
	An integer property defining the video standard.
	whiteBalanceTemperature = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_whiteBalanceTemperature_get, doc=)
	An integer property to adjust white balance temperature.

Detailed Description

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

Note: UNDER CONSTRUCTION! Subject to change.; 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.CameraSettingsV4L2Device 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

◆ getCustomFeatureIterator()

getCustomFeatureIterator ( self )

Returns an iterator to for iterating inside a device specific feature list.

This can be useful a device offers custom features that are not defined in the V4L2 standard and thus can't be known at compile time.

It allows to write code like this:

cs = acquire.CameraSettingsV4L2Device(pDev)
it = acquire.Component(cs.getCustomFeatureIterator())
m = {}
while it.isValid:
  # collect all entries that are properties and store their current name and value in a map
  if it.isProp and it.isVisible:
    prop = acquire.Property(it);
    m[prop.name()] = prop.readS()
  it = it.nextSibling()

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

◆ autoGain

autoGain = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_autoGain_get, doc=)

static

An enumerated integer property to switch on/off the auto gain.

This property represents a boolean-valued V4L2-control ID. Valid values for this property may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

◆ autoWhiteBalance

autoWhiteBalance = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_autoWhiteBalance_get, doc=)

static

An enumerated integer property to switch on/off the auto white balance function of the V4L2-device.

This property represents a boolean-valued V4L2-control ID. Valid values for this property may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

◆ backlightCompensation

backlightCompensation = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_backlightCompensation_get, doc=)

static

An integer property to adjust the backlight compensation.

This property represents a V4L2-control ID.

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a min-value, a max-value and step-width are defined. Thus, invalid values may be tuned after writing to fit within the limits.

◆ 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

◆ blackLevel

blackLevel = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_blackLevel_get, doc=)

static

An integer property to adjust the black level.

This property represents a V4L2-control ID.

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

◆ blueBalance

blueBalance = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_blueBalance_get, doc=)

static

An integer property to adjust the blue balance.

This property represents a V4L2-control ID.

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

◆ brightness

brightness = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_brightness_get, doc=)

static

An integer property to adjust the brightness.

This property represents a V4L2-control ID.

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

◆ contrast

contrast = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_contrast_get, doc=)

static

An integer property to adjust the contrast.

This property represents a V4L2-control ID.

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

◆ exposure

exposure = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_exposure_get, doc=)

static

An integer property to adjust the exposure.

This property represents a V4L2-control ID.

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

◆ gain

gain = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_gain_get, doc=)

static

An integer property to adjust the gain.

This property represents a V4L2-control ID.

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

◆ gamma

gamma = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_gamma_get, doc=)

static

An integer property to adjust the gamma.

This property represents a V4L2-control ID

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a min-value, a max-value and step-width are defined. Thus, invalid values may be tuned after writing to fit within the limits.

◆ HFlip

HFlip = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_HFlip_get, doc=)

static

An enumerated integer property to mirror the frames horizontally.

This property represents a boolean-valued V4L2-control ID. Valid values for this property may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

◆ hue

hue = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_hue_get, doc=)

static

An integer property to adjust the hue.

This property represents a V4L2-control ID.

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

◆ hueAuto

hueAuto = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_hueAuto_get, doc=)

static

An enumerated integer property to switch on/off auto hue.

This property represents a boolean-valued V4L2-control ID. Valid values for this property may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

◆ imageHeight

imageHeight = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_imageHeight_get, doc=)

static

An integer property defining the height of the image supplied by the V4L2 device.

See also: V4L2 API at http://v4l2spec.bytesex.org/spec-single/v4l2.html

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

◆ imageWidth

imageWidth = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_imageWidth_get, doc=)

static

An integer property defining the width of the image supplied by the V4L2 device.

See also: V4L2 API at http://v4l2spec.bytesex.org/spec-single/v4l2.html

◆ pixelFormat

pixelFormat = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_pixelFormat_get, doc=)

static

An integer property defining the pixel format of captured frames.

Use this property to set the pixel format within the image buffer supplied by the V4L2-device. Available pixel formats depend on the V4L2-device and conform to v4l2_fourcc()

See also: V4L2 API at http://v4l2spec.bytesex.org/spec-single/v4l2.html

◆ powerLineFrequency

powerLineFrequency = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_powerLineFrequency_get, doc=)

static

An enumerated integer property to enable power line frequency filter.

This property represents a V4L2-control ID.

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

If supported, possible values conform to V4L2 API:

string representation	numerical representation
V4L2_CID_POWER_LINE_FREQUENCY_DISABLED	0
V4L2_CID_POWER_LINE_FREQUENCY_50HZ	1
V4L2_CID_POWER_LINE_FREQUENCY_60HZ	2

◆ redBalance

redBalance = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_redBalance_get, doc=)

static

An integer property to adjust the red balance.

This property represents a V4L2-control ID.

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

◆ saturation

saturation = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_saturation_get, doc=)

static

An integer property to adjust the saturation.

This property represents a V4L2-control ID.

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

◆ sharpness

sharpness = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_sharpness_get, doc=)

static

An integer property to adjust the sharpness.

This property represents a V4L2-control ID.

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

◆ thisown

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

static

◆ VFlip

VFlip = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_VFlip_get, doc=)

static

An integer property to mirror the frames vertically.

This property represents a boolean-valued V4L2-control ID. Valid values for this property may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

◆ videoStandard

videoStandard = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_videoStandard_get, doc=)

static

An integer property defining the video standard.

Use this property to configure the V4L2-device corresponding to the connected video source. Available video standards depend on the V4L2-device and conform to v4l2_std_id

See also: V4L2 API at http://v4l2spec.bytesex.org/spec-single/v4l2.html

◆ whiteBalanceTemperature

whiteBalanceTemperature = property(lib_mvIMPACT_acquire.CameraSettingsV4L2Device_whiteBalanceTemperature_get, doc=)

static

An integer property to adjust white balance temperature.

This property represents a V4L2-control ID.

Note: This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ getCustomFeatureIterator()

◆ hObj()

◆ restoreDefault()

Property Documentation

◆ aoiHeight

◆ aoiStartX

◆ aoiStartY

◆ aoiWidth

◆ autoGain

◆ autoWhiteBalance

◆ backlightCompensation

◆ basedOn

◆ blackLevel

◆ blueBalance

◆ brightness

◆ contrast

◆ exposure

◆ gain

◆ gamma

◆ HFlip

◆ hue

◆ hueAuto

◆ imageHeight

◆ imageRequestTimeout_ms

◆ imageWidth

◆ pixelFormat

◆ powerLineFrequency

◆ redBalance

◆ saturation

◆ sharpness

◆ thisown

◆ VFlip

◆ videoStandard

◆ whiteBalanceTemperature

◆ init()