Impact Acquire SDK Python
CameraSettingsV4L2Device Class Reference

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

Inheritance diagram for CameraSettingsV4L2Device:
[legend]

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.
 

Properties

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

Reimplemented from BasicDeviceSettingsWithAOI.

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()

Property Documentation

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

◆ 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

◆ 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 representationnumerical representation
V4L2_CID_POWER_LINE_FREQUENCY_DISABLED0
V4L2_CID_POWER_LINE_FREQUENCY_50HZ1
V4L2_CID_POWER_LINE_FREQUENCY_60HZ2

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