Impact Acquire SDK Python
ImageMemoryManager Class Reference

An interface class to access DMA memory related properties(Device specific interface layout only). More...

Inheritance diagram for ImageMemoryManager:
[legend]

Public Member Functions

 __init__ (self, pDev)
 Constructs a new mvIMPACT.acquire.ImageMemoryManager object.
 

Properties

 allocatedDMAMemory_bytes = property(lib_mvIMPACT_acquire.ImageMemoryManager_allocatedDMAMemory_bytes_get, doc=)
 An integer property (read-only) containing the size of the allocated DMA memory (in bytes).
 
 mode = property(lib_mvIMPACT_acquire.ImageMemoryManager_mode_get, doc=)
 An enumerated integer property containing the mode the memory manager is currently operated in.
 
 poolBlockCount = property(lib_mvIMPACT_acquire.ImageMemoryManager_poolBlockCount_get, doc=)
 An integer property (read-only) containing the number of individual blocks of DMA memory currently available when using the current pool block size and pool mode.
 
 poolBlockSize_bytes = property(lib_mvIMPACT_acquire.ImageMemoryManager_poolBlockSize_bytes_get, doc=)
 An integer property defining the size (in bytes) to use for each block of DMA memory.
 
 poolMode = property(lib_mvIMPACT_acquire.ImageMemoryManager_poolMode_get, doc=)
 An enumerated integer property containing the mode the memory managers memory pool is currently operated in.
 
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
 usedBlocks = property(lib_mvIMPACT_acquire.ImageMemoryManager_usedBlocks_get, doc=)
 An integer property (read-only) containing the number of individual blocks of DMA memory currently used by the device.
 
 usedDMAMemory_bytes = property(lib_mvIMPACT_acquire.ImageMemoryManager_usedDMAMemory_bytes_get, doc=)
 An integer property (read-only) containing the size of the DMA memory (in bytes) currently used by the device.
 

Detailed Description

An interface class to access DMA memory related properties(Device specific interface layout only).

This class can be used to configure the way the device works with DMA memory. This is an advanced feature and shall only be used if necessary or to fine tune an application to achieve optimal performance.

All frame grabbers belonging to the mvTITAN, mvGAMMA, mvSIGMA and mvDELTA series use a special, preallocated block of memory(DMA memory) as target for fast image transfer. The total size of this block has to be set during driver installation. The memory is claimed from the operating system during startup and is shared between all installed devices.

The memory size needed to achieve optimal performance depends on the image size to grab, the queue depth and the mode the memory manager is operated in. Valid values for this property may be: mvIMPACT.acquire.mmmAuto, mvIMPACT.acquire.mmmPool and can be selected by modifying the property mvIMPACT.acquire.ImageMemoryManager.mode.

Note
This class is currently available for frame grabber devices only.
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,
pDev )

Constructs a new mvIMPACT.acquire.ImageMemoryManager object.

Parameters
pDev[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.

Reimplemented from ComponentCollection.

Property Documentation

◆ allocatedDMAMemory_bytes

allocatedDMAMemory_bytes = property(lib_mvIMPACT_acquire.ImageMemoryManager_allocatedDMAMemory_bytes_get, doc=)
static

An integer property (read-only) containing the size of the allocated DMA memory (in bytes).

◆ mode

mode = property(lib_mvIMPACT_acquire.ImageMemoryManager_mode_get, doc=)
static

An enumerated integer property containing the mode the memory manager is currently operated in.

Valid values for this property may be: mvIMPACT.acquire.mmmAuto, mvIMPACT.acquire.mmmPool.

◆ poolBlockCount

poolBlockCount = property(lib_mvIMPACT_acquire.ImageMemoryManager_poolBlockCount_get, doc=)
static

An integer property (read-only) containing the number of individual blocks of DMA memory currently available when using the current pool block size and pool mode.

◆ poolBlockSize_bytes

poolBlockSize_bytes = property(lib_mvIMPACT_acquire.ImageMemoryManager_poolBlockSize_bytes_get, doc=)
static

An integer property defining the size (in bytes) to use for each block of DMA memory.

◆ poolMode

poolMode = property(lib_mvIMPACT_acquire.ImageMemoryManager_poolMode_get, doc=)
static

An enumerated integer property containing the mode the memory managers memory pool is currently operated in.

Valid values for this property may be: mvIMPACT.acquire.mmpmOff, mvIMPACT.acquire.mmpmFixed, mvIMPACT.acquire.mmpmAuto.

◆ thisown

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

◆ usedBlocks

usedBlocks = property(lib_mvIMPACT_acquire.ImageMemoryManager_usedBlocks_get, doc=)
static

An integer property (read-only) containing the number of individual blocks of DMA memory currently used by the device.

◆ usedDMAMemory_bytes

usedDMAMemory_bytes = property(lib_mvIMPACT_acquire.ImageMemoryManager_usedDMAMemory_bytes_get, doc=)
static

An integer property (read-only) containing the size of the DMA memory (in bytes) currently used by the device.