Impact Acquire SDK Python

Contains features to control motorized lenses Contains features to control motorized lenses. More...

Inheritance diagram for mvLensControl:
[legend]

Public Member Functions

 __init__ (self, *args)
 Constructs a new mvIMPACT.acquire.mvLensControl object.
 

Properties

 mvDriveBackward = property(lib_mvIMPACT_acquire.mvLensControl_mvDriveBackward_get, doc=)
 A method object.
 
 mvDriveDuration = property(lib_mvIMPACT_acquire.mvLensControl_mvDriveDuration_get, doc=)
 An integer property.
 
 mvDriveForward = property(lib_mvIMPACT_acquire.mvLensControl_mvDriveForward_get, doc=)
 A method object.
 
 mvDriveLevel = property(lib_mvIMPACT_acquire.mvLensControl_mvDriveLevel_get, doc=)
 An integer property.
 
 mvDriveSelector = property(lib_mvIMPACT_acquire.mvLensControl_mvDriveSelector_get, doc=)
 An enumerated integer property.
 
 mvIrisMode = property(lib_mvIMPACT_acquire.mvLensControl_mvIrisMode_get, doc=)
 An enumerated integer property.
 
 mvIrisSignalLevelMax = property(lib_mvIMPACT_acquire.mvLensControl_mvIrisSignalLevelMax_get, doc=)
 An integer property.
 
 mvIrisSignalLevelMin = property(lib_mvIMPACT_acquire.mvLensControl_mvIrisSignalLevelMin_get, doc=)
 An integer property.
 
 mvIrisType = property(lib_mvIMPACT_acquire.mvLensControl_mvIrisType_get, doc=)
 An enumerated integer property.
 
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

Detailed Description

Contains features to control motorized lenses Contains features to control motorized lenses.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
* args )

Constructs a new mvIMPACT.acquire.mvLensControl 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 ComponentCollection.

Property Documentation

◆ mvDriveBackward

mvDriveBackward = property(lib_mvIMPACT_acquire.mvLensControl_mvDriveBackward_get, doc=)
static

A method object.

Generates a pulse defined by 'mvDriveDuration' and 'mvDriveLevel' to move the selected motor in backward direction.

Generates a pulse defined by 'mvDriveDuration' and 'mvDriveLevel' to move the selected motor in backward direction.

◆ mvDriveDuration

mvDriveDuration = property(lib_mvIMPACT_acquire.mvLensControl_mvDriveDuration_get, doc=)
static

An integer property.

Sets the duration of the drive command in us.

Sets the duration of the drive command in us.

◆ mvDriveForward

mvDriveForward = property(lib_mvIMPACT_acquire.mvLensControl_mvDriveForward_get, doc=)
static

A method object.

Generates a pulse defined by 'mvDriveDuration' and 'mvDriveLevel' to move the selected motor in forward direction.

Generates a pulse defined by 'mvDriveDuration' and 'mvDriveLevel' to move the selected motor in forward direction.

◆ mvDriveLevel

mvDriveLevel = property(lib_mvIMPACT_acquire.mvLensControl_mvDriveLevel_get, doc=)
static

An integer property.

Sets the voltage level of the drive command in mV.

Sets the voltage level of the drive command in mV.

◆ mvDriveSelector

mvDriveSelector = property(lib_mvIMPACT_acquire.mvLensControl_mvDriveSelector_get, doc=)
static

An enumerated integer property.

Selects the lens drive that should be adjusted.

Selects the lens drive that should be adjusted.

The following string values might be valid for this feature:

  • mvFocus (Display string: 'mv Focus'): Selects the motor to control the focus.
  • mvZoom (Display string: 'mv Zoom'): Selects the motor to control the zoom.
  • mvIris (Display string: 'mv Iris'): Selects the motor to control the iris.
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT.acquire.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ mvIrisMode

mvIrisMode = property(lib_mvIMPACT_acquire.mvLensControl_mvIrisMode_get, doc=)
static

An enumerated integer property.

Sets the iris operating mode.

Sets the iris operating mode.

The following string values might be valid for this feature:

  • Off (Display string: 'Off'): No iris adjustment will be done.
  • mvIrisAuto (Display string: 'mv Iris Auto'): The iris adjustment will be done automatically by evaluating the current image data.
  • mvIrisOpen (Display string: 'mv Iris Open'): The iris is fully open.
  • mvIrisClose (Display string: 'mv Iris Close'): The iris is fully closed.
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT.acquire.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ mvIrisSignalLevelMax

mvIrisSignalLevelMax = property(lib_mvIMPACT_acquire.mvLensControl_mvIrisSignalLevelMax_get, doc=)
static

An integer property.

Sets the maximum iris signal level in mV.

Sets the maximum iris signal level in mV.

◆ mvIrisSignalLevelMin

mvIrisSignalLevelMin = property(lib_mvIMPACT_acquire.mvLensControl_mvIrisSignalLevelMin_get, doc=)
static

An integer property.

Sets the minimum iris signal level in mV.

Sets the minimum iris signal level in mV.

◆ mvIrisType

mvIrisType = property(lib_mvIMPACT_acquire.mvLensControl_mvIrisType_get, doc=)
static

An enumerated integer property.

Sets the iris type.

Sets the iris type.

The following string values might be valid for this feature:

  • mvVideoIris (Display string: 'mv Video Iris')
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT.acquire.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ thisown

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