HDRControl Class Reference

A class to control the HDR (High Dynamic Range) parameters of a device (Device specific interface layout only). More...

Inheritance diagram for HDRControl:

Public Member Functions
	__init__ (self, src)
	Copy constructor.
	getHDRKneePoint (self, nr)
	Returns a reference to a set of user definable parameters to configure a HDR (High Dynamic Range) knee point.
	getIsAvailable (self)
	This function should be called to check if this device offers HDR (High Dynamic Range) control parameters.

Properties
	HDREnable = property(lib_mvIMPACT_acquire.HDRControl_HDREnable_get, doc=)
	An enumerated integer property which can be used to enable/disable HDR (High Dynamic Range) mode.
	HDRKneePointCount = property(lib_mvIMPACT_acquire.HDRControl_HDRKneePointCount_get, doc=)
	An integer property to define the number of knee points to work with when mvIMPACT.acquire.HDRControl.HDRMode is set to mvIMPACT.acquire.cHDRmUser.
	HDRMode = property(lib_mvIMPACT_acquire.HDRControl_HDRMode_get, doc=)
	An enumerated integer property which can be used to configure the HDR (High Dynamic Range) mode to work with.
	isAvailable = property(getIsAvailable, None, None, None)
	A bool property (read-only) which checks if this device offers HDR (High Dynamic Range) parameters.
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Detailed Description

A class to control the HDR (High Dynamic Range) parameters of a device (Device specific interface layout only).

Note

Not every device will offer the features provided in this class. Before accessing properties call the function mvIMPACT.acquire.Component.isValid. Right now only the mvBlueFOX-x00wx, mvBlueFOX-x02dx and mvBlueCOUGAR-x00wx as well as mvBlueCOUGAR-x02dx types will support the features defined by this class.

Instances of these class can't be constructed directly. Its parameters can be accessed via an instance of the class mvIMPACT.acquire.CameraSettingsBlueFOX or mvIMPACT.acquire.CameraSettingsBlueCOUGAR.

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,
			src )

Copy constructor.

Creates a new object from an existing device object. Keep in mind that this new object will provide access to the very same hardware and therefore you might as well use the original reference. This constructor is only provided for internal reference counting to guarantee correct operation of the objects of this class under all platforms and languages.

Reimplemented from ComponentCollection.

Member Function Documentation

getHDRKneePoint()

getHDRKneePoint	(		self,
			nr )

Returns a reference to a set of user definable parameters to configure a HDR (High Dynamic Range) knee point.

Use the property mvIMPACT.acquire.HDRControl.HDRKneePointCount to find out how many knee points are available or to change the number of knee points.

Returns

A reference to a set of user definable parameters to configure a HDR (High Dynamic Range) knee point.

Parameters

nr	[in] The number of the knee point to be returned

getIsAvailable()

getIsAvailable

(

self

)

This function should be called to check if this device offers HDR (High Dynamic Range) control parameters.

Returns

• true if the device offers the features defined by this object.
• false otherwise

Property Documentation

HDREnable

HDREnable = property(lib_mvIMPACT_acquire.HDRControl_HDREnable_get, doc=)

static

An enumerated integer property which can be used to enable/disable HDR (High Dynamic Range) mode.

Valid values for this property may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

HDRKneePointCount

HDRKneePointCount = property(lib_mvIMPACT_acquire.HDRControl_HDRKneePointCount_get, doc=)

static

An integer property to define the number of knee points to work with when mvIMPACT.acquire.HDRControl.HDRMode is set to mvIMPACT.acquire.cHDRmUser.

HDRMode

HDRMode = property(lib_mvIMPACT_acquire.HDRControl_HDRMode_get, doc=)

static

An enumerated integer property which can be used to configure the HDR (High Dynamic Range) mode to work with.

Valid values for this property may be: mvIMPACT.acquire.cHDRmFixed0, mvIMPACT.acquire.cHDRmFixed1, mvIMPACT.acquire.cHDRmFixed2, mvIMPACT.acquire.cHDRmFixed3, mvIMPACT.acquire.cHDRmFixed4, mvIMPACT.acquire.cHDRmFixed5, mvIMPACT.acquire.cHDRmFixed6, mvIMPACT.acquire.cHDRmUser.

isAvailable

isAvailable = property(getIsAvailable, None, None, None)

static

A bool property (read-only) which checks if this device offers HDR (High Dynamic Range) parameters.

See mvIMPACT.acquire.HDRControl.getIsAvailable()

thisown

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

static