Impact Acquire SDK Python
Public Member Functions | Properties
CameraDescriptionManager Class Reference
Device Specific Interface Layout

Grants access to camera description objects(Device specific interface layout only) (deprecated. More...

Inheritance diagram for CameraDescriptionManager:
[legend]

Public Member Functions

 __init__ (self, src)
 Constructs a new mvIMPACT.acquire.CameraDescriptionManager from an existing one.
 
 cameraDescriptionCameraLink (self, *args)
 Returns a pointer to a mvIMPACT.acquire.CameraDescriptionCameraLink object specifying the camera description found at the given index in the camera description managers internal list.
 
 cameraDescriptionDigital (self, *args)
 Returns a pointer to a mvIMPACT.acquire.CameraDescriptionDigital object specifying the camera description found at the given index in the camera description managers internal list.
 
 cameraDescriptionNonStandard (self, *args)
 Returns a pointer to a mvIMPACT.acquire.CameraDescriptionNonStandard object specifying the camera description found at the given index in the camera description managers internal list.
 
 cameraDescriptionSDI (self, *args)
 Returns a pointer to a mvIMPACT.acquire.CameraDescriptionSDI object specifying the camera description found at the given index in the camera description managers internal list.
 
 cameraDescriptionStandard (self, *args)
 Returns a pointer to a mvIMPACT.acquire.CameraDescriptionStandard object specifying the camera description found at the given index in the camera description managers internal list.
 
 getCLCameraDescriptionCount (self)
 Returns the number of CameraLink® camera descriptions currently available for the device that constructed this instance of the class.
 
 getDigitalCameraDescriptionCount (self)
 Returns the number of non-standard digital camera descriptions currently available for the device that constructed this instance of the class.
 
 getNonStandardCameraDescriptionCount (self)
 Returns the number of non-standard camera descriptions currently available for the device that constructed this instance of the class.
 
 getSDICameraDescriptionCount (self)
 Returns the number of SDI camera descriptions currently available for the device that constructed this instance of the class.
 
 getStandardCameraDescriptionCount (self)
 Returns the number of standard camera descriptions currently available for the device that constructed this instance of the class.
 
 getTotalCameraDescriptionCount (self)
 Returns the total number camera descriptions currently available for the device that constructed this instance of the class.
 

Properties

 cLCameraDescriptionCount = property (getCLCameraDescriptionCount, None, None, None)
 An integer property (read-only) which holds the number of CameraLink® camera descriptions currently available for the device that constructed this instance of the class.
 
 digitalCameraDescriptionCount = property (getDigitalCameraDescriptionCount, None, None, None)
 An integer property (read-only) which holds the number of non-standard digital camera descriptions currently available for the device that constructed this instance of the class.
 
 nonStandardCameraDescriptionCount = property (getNonStandardCameraDescriptionCount, None, None, None)
 An integer property (read-only) which holds the number of non-standard camera descriptions currently available for the device that constructed this instance of the class.
 
 standardCameraDescriptionCount = property (getStandardCameraDescriptionCount, None, None, None)
 An integer property (read-only) which holds the number of standard camera descriptions currently available for the device that constructed this instance of the class.
 
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

Detailed Description

Grants access to camera description objects(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 provides access to the various camera description objects. Each device recognizes a different set of camera descriptions. E.g. a digital frame grabber will not be able to work with analogue cameras. Each camera description class will be derived from mvIMPACT.acquire.CameraDescriptionBase.

Note
Please note that instances of this class will ONLY list camera descriptions that have once been selected by the property mvIMPACT.acquire.CameraSettingsFrameGrabber.type at runtime. This is to save memory. A complete list of camera descriptions available for the current device therefore can only be queried by reading the the translation dictionary of the property mvIMPACT.acquire.CameraSettingsFrameGrabber.type.
# ...
# display the name of every camera description available for this device.
# this might be less than the number of camera descriptions available on the system as e.g.
# an analog frame grabber can't use descriptions for digital cameras
cs = acquire.CameraSettingsFrameGrabber(pDev)
availableDescriptions = []
cs.type.getTranslationDict(availableDescriptions)
print()
print("Available camera descriptions: " + str(availableDescriptions.size()))
print("----------------------------------")
for description in availableDescriptions:
print(description)
# list all descriptions that already have been selected at least once
camMgr = acquire.CameraDescriptionManager(pDev)
camCnt = camMgr.getCLCameraDescriptionCount()
print("Available CL descriptions: " + str(camCnt))
for a in range(camCnt):
print(" " + camMgr.cameraDescriptionCameraLink(a).name.readS())
camCnt = camMgr.getStandardCameraDescriptionCount()
print("Available Std descriptions: " + str(camCnt))
for b in range(camCnt):
print(" " << camMgr.cameraDescriptionStandard(b).name.readS())
camCnt = camMgr.getNonStandardCameraDescriptionCount()
print("Available NonStd descriptions: " + str(camCnt))
for c in range(camCnt):
print(" " << camMgr.cameraDescriptionNonStandard(c).name.readS())
Note
This class will only be available for frame grabber devices. For other devices the class constructor will raise an exception.
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 )

Constructs a new mvIMPACT.acquire.CameraDescriptionManager from an existing one.

Parameters
srcA constant reference to the mvIMPACT.acquire.CameraDescriptionManager object, this object shall be created from

Member Function Documentation

◆ cameraDescriptionCameraLink()

cameraDescriptionCameraLink ( self,
* args )

Returns a pointer to a mvIMPACT.acquire.CameraDescriptionCameraLink object specifying the camera description found at the given index in the camera description managers internal list.

OVERLOAD 1:

Parameters
index[in] The index of the camera description to return

OVERLOAD 2: Returns a pointer to a mvIMPACT.acquire.CameraDescriptionCameraLink object specifying the camera description with the given name in the camera description managers internal list.

Returns
  • a pointer to a mvIMPACT.acquire.CameraDescriptionCameraLink object specifying the camera description with the given name in the camera description managers internal list if a camera description with name is available.
  • an invalid pointer or reference otherwise.
Parameters
name[in] The name of the camera description. This can either be the name of the list like e.g. 'CameraLink_Generic' or the value of the property 'name' of this description like e.g. 'Generic'.

◆ cameraDescriptionDigital()

cameraDescriptionDigital ( self,
* args )

Returns a pointer to a mvIMPACT.acquire.CameraDescriptionDigital object specifying the camera description found at the given index in the camera description managers internal list.

OVERLOAD 1:

Parameters
index[in] The index of the camera description to return

OVERLOAD 2: Returns a pointer to a mvIMPACT.acquire.CameraDescriptionDigital object specifying the camera description with the given name in the camera description managers internal list.

Returns
  • a pointer to a mvIMPACT.acquire.CameraDescriptionDigital object specifying the camera description with the given name in the camera description managers internal list if a camera description with name is available.
  • an invalid pointer or reference otherwise.
Parameters
name[in] The name of the camera description. This can either be the name of the list like e.g. 'Digital_Generic' or the value of the property 'name' of this description like e.g. 'Generic'.

◆ cameraDescriptionNonStandard()

cameraDescriptionNonStandard ( self,
* args )

Returns a pointer to a mvIMPACT.acquire.CameraDescriptionNonStandard object specifying the camera description found at the given index in the camera description managers internal list.

OVERLOAD 1:

Parameters
index[in] The index of the camera description to return

OVERLOAD 2: Returns a pointer to a mvIMPACT.acquire.CameraDescriptionNonStandard object specifying the camera description with the given name in the camera description managers internal list.

Returns
  • a pointer to a mvIMPACT.acquire.CameraDescriptionNonStandard object specifying the camera description with the given name in the camera description managers internal list if a camera description with name is available.
  • an invalid pointer or reference otherwise.
Parameters
name[in] The name of the camera description. This can either be the name of the list like e.g. 'NonStandard_Generic' or the value of the property 'name' of this description like e.g. 'Generic'.

◆ cameraDescriptionSDI()

cameraDescriptionSDI ( self,
* args )

Returns a pointer to a mvIMPACT.acquire.CameraDescriptionSDI object specifying the camera description found at the given index in the camera description managers internal list.

OVERLOAD 1:

Parameters
index[in] The index of the camera description to return

OVERLOAD 2: Returns a pointer to a mvIMPACT.acquire.CameraDescriptionSDI object specifying the camera description with the given name in the camera description managers internal list.

Returns
  • a pointer to a mvIMPACT.acquire.CameraDescriptionSDI object specifying the camera description with the given name in the camera description managers internal list if a camera description with name is available.
  • an invalid pointer or reference otherwise.
Parameters
name[in] The name of the camera description. This can either be the name of the list like e.g. 'CameraLink_Generic' or the value of the property 'name' of this description like e.g. 'Generic'.

◆ cameraDescriptionStandard()

cameraDescriptionStandard ( self,
* args )

Returns a pointer to a mvIMPACT.acquire.CameraDescriptionStandard object specifying the camera description found at the given index in the camera description managers internal list.

OVERLOAD 1:

Parameters
index[in] The index of the camera description to return

OVERLOAD 2: Returns a pointer to a mvIMPACT.acquire.CameraDescriptionStandard object specifying the camera description with the given name in the camera description managers internal list.

Returns
  • a pointer to a mvIMPACT.acquire.CameraDescriptionStandard object specifying the camera description with the given name in the camera description managers internal list if a camera description with name is available.
  • an invalid pointer or reference otherwise.
Parameters
name[in] The name of the camera description. This can either be the name of the list like e.g. 'Standard_Generic' or the value of the property 'name' of this description like e.g. 'Generic'.

◆ getCLCameraDescriptionCount()

getCLCameraDescriptionCount ( self)

Returns the number of CameraLink® camera descriptions currently available for the device that constructed this instance of the class.

◆ getDigitalCameraDescriptionCount()

getDigitalCameraDescriptionCount ( self)

Returns the number of non-standard digital camera descriptions currently available for the device that constructed this instance of the class.

◆ getNonStandardCameraDescriptionCount()

getNonStandardCameraDescriptionCount ( self)

Returns the number of non-standard camera descriptions currently available for the device that constructed this instance of the class.

◆ getSDICameraDescriptionCount()

getSDICameraDescriptionCount ( self)

Returns the number of SDI camera descriptions currently available for the device that constructed this instance of the class.

◆ getStandardCameraDescriptionCount()

getStandardCameraDescriptionCount ( self)

Returns the number of standard camera descriptions currently available for the device that constructed this instance of the class.

◆ getTotalCameraDescriptionCount()

getTotalCameraDescriptionCount ( self)

Returns the total number camera descriptions currently available for the device that constructed this instance of the class.

Since
2.1.4

Property Documentation

◆ cLCameraDescriptionCount

cLCameraDescriptionCount = property (getCLCameraDescriptionCount, None, None, None)
static

An integer property (read-only) which holds the number of CameraLink® camera descriptions currently available for the device that constructed this instance of the class.

See mvIMPACT.acquire.CameraDescriptionManager.getCLCameraDescriptionCount()

◆ digitalCameraDescriptionCount

digitalCameraDescriptionCount = property (getDigitalCameraDescriptionCount, None, None, None)
static

An integer property (read-only) which holds the number of non-standard digital camera descriptions currently available for the device that constructed this instance of the class.

See mvIMPACT.acquire.CameraDescriptionManager.getDigitalCameraDescriptionCount()

◆ nonStandardCameraDescriptionCount

nonStandardCameraDescriptionCount = property (getNonStandardCameraDescriptionCount, None, None, None)
static

An integer property (read-only) which holds the number of non-standard camera descriptions currently available for the device that constructed this instance of the class.

See mvIMPACT.acquire.CameraDescriptionManager.getNonStandardCameraDescriptionCount()

◆ standardCameraDescriptionCount

standardCameraDescriptionCount = property (getStandardCameraDescriptionCount, None, None, None)
static

An integer property (read-only) which holds the number of standard camera descriptions currently available for the device that constructed this instance of the class.

See mvIMPACT.acquire.CameraDescriptionManager.getStandardCameraDescriptionCount()

◆ thisown

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