Impact Acquire SDK Python
Public Member Functions | Properties
BufferPart Class Reference
Common

Contains information about a specific part of a captured buffer. More...

Inheritance diagram for BufferPart:
[legend]

Public Member Functions

 __init__ (self, *args, **kwargs)
 
 getImageBufferDesc (self)
 Returns a const reference to the image buffer descriptor of this buffer part.
 

Properties

 address = property(lib_mvIMPACT_acquire.BufferPart_address_get, doc=)
 A pointer property (read-only) containing the start address of this buffer part.
 
 bayerMosaicParity = property(lib_mvIMPACT_acquire.BufferPart_bayerMosaicParity_get, doc=)
 An enumerated 64-bit integer property (read-only) containing the Bayer parity of this buffer part.
 
 bytesPerPixel = property(lib_mvIMPACT_acquire.BufferPart_bytesPerPixel_get, doc=)
 A 64-bit integer property (read-only) containing the number of bytes per pixel in this buffer part.
 
 channelBitDepth = property(lib_mvIMPACT_acquire.BufferPart_channelBitDepth_get, doc=)
 A 64-bit integer property (read-only) containing the number of effective bits stored in each channel belonging to the current buffer part.
 
 channelCount = property(lib_mvIMPACT_acquire.BufferPart_channelCount_get, doc=)
 A 64-bit integer property (read-only) containing the number of channels this buffer part consists of.
 
 channelDesc = property(lib_mvIMPACT_acquire.BufferPart_channelDesc_get, doc=)
 A string property (read-only) containing the string descriptors of each channel belonging to the current buffer part.
 
 channelOffset = property(lib_mvIMPACT_acquire.BufferPart_channelOffset_get, doc=)
 A 64-bit integer property (read-only) containing the offset (in bytes) to each channel belonging to the current buffer part relative to the address contained in mvIMPACT.acquire.BufferPart.address.
 
 dataSize = property(lib_mvIMPACT_acquire.BufferPart_dataSize_get, doc=)
 A 64-bit integer property (read-only) containing the size (in bytes) of this buffer part.
 
 dataType = property(lib_mvIMPACT_acquire.BufferPart_dataType_get, doc=)
 An enumerated 64-bit integer property (read-only) containing the data type of this buffer part.
 
 groupID = property(lib_mvIMPACT_acquire.BufferPart_groupID_get, doc=)
 Identifier allowing to group data parts having the same purpose (usually corresponding with the ComponentSelector feature from SFNC).
 
 height = property(lib_mvIMPACT_acquire.BufferPart_height_get, doc=)
 A 64-bit integer property (read-only) containing the height of the buffer part in pixels.
 
 linePitch = property(lib_mvIMPACT_acquire.BufferPart_linePitch_get, doc=)
 A 64-bit integer property (read-only) containing the offset (in bytes) to the next line of each channel belonging to the current buffer part.
 
 offsetX = property(lib_mvIMPACT_acquire.BufferPart_offsetX_get, doc=)
 A 64-bit integer property (read-only) containing the X-offset of the buffer part in pixels.
 
 offsetY = property(lib_mvIMPACT_acquire.BufferPart_offsetY_get, doc=)
 A 64-bit integer property (read-only) containing the Y-offset of the buffer part in pixels.
 
 paddingX = property(lib_mvIMPACT_acquire.BufferPart_paddingX_get, doc=)
 A 64-bit integer property (read-only) containing the number of padding bytes in X direction of the buffer part.
 
 pixelFormat = property(lib_mvIMPACT_acquire.BufferPart_pixelFormat_get, doc=)
 An enumerated integer property defining the pixel format of this buffer part.
 
 pixelPitch = property(lib_mvIMPACT_acquire.BufferPart_pixelPitch_get, doc=)
 A 64-bit integer property (read-only) containing the offset (in bytes) to the next pixel of the specified channel of this buffer part.
 
 regionID = property(lib_mvIMPACT_acquire.BufferPart_regionID_get, doc=)
 Identifier allowing to group data parts belonging to the same region (usually corresponding with the RegionSelector/ChunkRegionID features from SFNC).
 
 sourceID = property(lib_mvIMPACT_acquire.BufferPart_sourceID_get, doc=)
 Identifier allowing to group data parts belonging to the same source (usually corresponding with the SourceSelector/ChunkSourceID features from SFNC).
 
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
 width = property(lib_mvIMPACT_acquire.BufferPart_width_get, doc=)
 A 64-bit integer property (read-only) containing the width of the buffer part in pixels.
 

Detailed Description

Contains information about a specific part of a captured buffer.

This class provides access to all sorts of information about a specific part of a captured buffer. Only Instances of mvIMPACT.acquire.Request are allowed to create objects of mvIMPACT.acquire.BufferPart. Consequently the only way to get access to a mvIMPACT.acquire.BufferPart object is via a call to mvIMPACT.acquire.Request.getBufferPart.

See also
Multi-Part Format
Since
2.20.0

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
* args,
** kwargs )

Reimplemented from ComponentCollection.

Member Function Documentation

◆ getImageBufferDesc()

getImageBufferDesc ( self)

Returns a const reference to the image buffer descriptor of this buffer part.

This function returns a const reference to the mvIMPACT.acquire.ImageBufferDesc associated with this mvIMPACT.acquire.BufferPart.

Attention
Please do NEVER work with old references to this structure. So do NOT store this reference in some variable to use it for the evaluation of the next mvIMPACT.acquire.BufferPart object as well, as this will not work. Whenever mvIMPACT.acquire.BufferPart.getImageBufferDesc is called the function will make sure that the data in the returned structure is up to date while when working with an old reference to the mvIMPACT.acquire.ImageBufferDesc structure the containing data might refer to a previous result or even worse invalid memory locations. This reference will remain valid until an application calls mvIMPACT.acquire.Request.unlock for the corresponding request.

Property Documentation

◆ address

address = property(lib_mvIMPACT_acquire.BufferPart_address_get, doc=)
static

A pointer property (read-only) containing the start address of this buffer part.

See remarks under mvIMPACT.acquire.Request.imageData. Most of the information provided there will be valid for this property as well.

◆ bayerMosaicParity

bayerMosaicParity = property(lib_mvIMPACT_acquire.BufferPart_bayerMosaicParity_get, doc=)
static

An enumerated 64-bit integer property (read-only) containing the Bayer parity of this buffer part.

If the current buffer part does not contain Bayer data, this value will be mvIMPACT.acquire.bmpUndefined.

Valid values for this property may be: mvIMPACT.acquire.bmpUndefined, mvIMPACT.acquire.bmpGR, mvIMPACT.acquire.bmpRG, mvIMPACT.acquire.bmpBG, mvIMPACT.acquire.bmpGB.

◆ bytesPerPixel

bytesPerPixel = property(lib_mvIMPACT_acquire.BufferPart_bytesPerPixel_get, doc=)
static

A 64-bit integer property (read-only) containing the number of bytes per pixel in this buffer part.

◆ channelBitDepth

channelBitDepth = property(lib_mvIMPACT_acquire.BufferPart_channelBitDepth_get, doc=)
static

A 64-bit integer property (read-only) containing the number of effective bits stored in each channel belonging to the current buffer part.

Note
This property will store channelCount values. These can be queried one by one using the index parameter of the function mvIMPACT.acquire.PropertyI64.read() or in a single call by using the overloaded read function accepting a reference to a vector.

◆ channelCount

channelCount = property(lib_mvIMPACT_acquire.BufferPart_channelCount_get, doc=)
static

A 64-bit integer property (read-only) containing the number of channels this buffer part consists of.

For an RGB image this value e.g. would be 3. This value also defines how many parameters are stored by the properties mvIMPACT.acquire.BufferPart.pixelPitch,
mvIMPACT.acquire.BufferPart.linePitch,
mvIMPACT.acquire.BufferPart.channelBitDepth,
mvIMPACT.acquire.BufferPart.channelDesc and
mvIMPACT.acquire.BufferPart.channelOffset.

If e.g. the channel count is 3 a call like bufferPart.channelOffset.read( 2 ) would return the channel offset of channel 3 (as calls to the read functions of properties are '0' based).

◆ channelDesc

channelDesc = property(lib_mvIMPACT_acquire.BufferPart_channelDesc_get, doc=)
static

A string property (read-only) containing the string descriptors of each channel belonging to the current buffer part.

See remarks under mvIMPACT.acquire.Request.imageChannelDesc. Most of the information provided there will be valid for this property as well.

◆ channelOffset

channelOffset = property(lib_mvIMPACT_acquire.BufferPart_channelOffset_get, doc=)
static

A 64-bit integer property (read-only) containing the offset (in bytes) to each channel belonging to the current buffer part relative to the address contained in mvIMPACT.acquire.BufferPart.address.

Note
This property will store channelCount values. These can be queried one by one using the index parameter of the function mvIMPACT.acquire.PropertyI64.read() or in a single call by using the overloaded read function accepting a reference to a vector.

◆ dataSize

dataSize = property(lib_mvIMPACT_acquire.BufferPart_dataSize_get, doc=)
static

A 64-bit integer property (read-only) containing the size (in bytes) of this buffer part.

See remarks under mvIMPACT.acquire.Request.imageData. Most of the information provided there will be valid for this property as well.

◆ dataType

dataType = property(lib_mvIMPACT_acquire.BufferPart_dataType_get, doc=)
static

An enumerated 64-bit integer property (read-only) containing the data type of this buffer part.

Valid values for this property may be: mvIMPACT.acquire.bpdtUnknown, mvIMPACT.acquire.bpdt2DImage, mvIMPACT.acquire.bpdt2DPlaneBiplanar, mvIMPACT.acquire.bpdt2DPlaneTriplanar, mvIMPACT.acquire.bpdt2DPlaneQuadplanar, mvIMPACT.acquire.bpdt3DImage, mvIMPACT.acquire.bpdt3DPlaneBiplanar, mvIMPACT.acquire.bpdt3DPlaneTriplanar, mvIMPACT.acquire.bpdt3DPlaneQuadplanar, mvIMPACT.acquire.bpdtConfidenceMap, mvIMPACT.acquire.bpdtGenICamChunkData, mvIMPACT.acquire.bpdtJPEG, mvIMPACT.acquire.bpdtJPEG2000, mvIMPACT.acquire.bpdtGDC_GenICamChunkData, mvIMPACT.acquire.bpdtGDC_GenICamXML, mvIMPACT.acquire.bpdtGDC_2DImage, mvIMPACT.acquire.bpdtGDC_JPEG, mvIMPACT.acquire.bpdtGDC_JPEG2000, mvIMPACT.acquire.bpdtGDC_H264.

◆ groupID

groupID = property(lib_mvIMPACT_acquire.BufferPart_groupID_get, doc=)
static

Identifier allowing to group data parts having the same purpose (usually corresponding with the ComponentSelector feature from SFNC).

Since
2.50.0

◆ height

height = property(lib_mvIMPACT_acquire.BufferPart_height_get, doc=)
static

A 64-bit integer property (read-only) containing the height of the buffer part in pixels.

◆ linePitch

linePitch = property(lib_mvIMPACT_acquire.BufferPart_linePitch_get, doc=)
static

A 64-bit integer property (read-only) containing the offset (in bytes) to the next line of each channel belonging to the current buffer part.

Note
This property will store channelCount values. These can be queried one by one using the index parameter of the function mvIMPACT.acquire.PropertyI64.read() or in a single call by using the overloaded read function accepting a reference to a vector.

◆ offsetX

offsetX = property(lib_mvIMPACT_acquire.BufferPart_offsetX_get, doc=)
static

A 64-bit integer property (read-only) containing the X-offset of the buffer part in pixels.

◆ offsetY

offsetY = property(lib_mvIMPACT_acquire.BufferPart_offsetY_get, doc=)
static

A 64-bit integer property (read-only) containing the Y-offset of the buffer part in pixels.

◆ paddingX

paddingX = property(lib_mvIMPACT_acquire.BufferPart_paddingX_get, doc=)
static

A 64-bit integer property (read-only) containing the number of padding bytes in X direction of the buffer part.

◆ pixelFormat

pixelFormat = property(lib_mvIMPACT_acquire.BufferPart_pixelFormat_get, doc=)
static

An enumerated integer property defining the pixel format of this buffer part.

Valid values for this property may be: mvIMPACT.acquire.ibpfRaw, mvIMPACT.acquire.ibpfMono8, mvIMPACT.acquire.ibpfMono16, mvIMPACT.acquire.ibpfRGBx888Packed, mvIMPACT.acquire.ibpfYUV422Packed, mvIMPACT.acquire.ibpfRGBx888Planar, mvIMPACT.acquire.ibpfMono10, mvIMPACT.acquire.ibpfMono12, mvIMPACT.acquire.ibpfMono14, mvIMPACT.acquire.ibpfRGB888Packed, mvIMPACT.acquire.ibpfYUV444Planar, mvIMPACT.acquire.ibpfMono32, mvIMPACT.acquire.ibpfYUV422Planar, mvIMPACT.acquire.ibpfRGB101010Packed, mvIMPACT.acquire.ibpfRGB121212Packed, mvIMPACT.acquire.ibpfRGB141414Packed, mvIMPACT.acquire.ibpfRGB161616Packed, mvIMPACT.acquire.ibpfYUV422_UYVYPacked, mvIMPACT.acquire.ibpfMono12Packed_V2, mvIMPACT.acquire.ibpfYUV422_10Packed, mvIMPACT.acquire.ibpfYUV422_UYVY_10Packed, mvIMPACT.acquire.ibpfBGR888Packed, mvIMPACT.acquire.ibpfBGR101010Packed_V2, mvIMPACT.acquire.ibpfYUV444_UYVPacked, mvIMPACT.acquire.ibpfYUV444_UYV_10Packed, mvIMPACT.acquire.ibpfYUV444Packed, mvIMPACT.acquire.ibpfYUV444_10Packed, mvIMPACT.acquire.ibpfMono12Packed_V1, mvIMPACT.acquire.ibpfYUV411_UYYVYY_Packed, mvIMPACT.acquire.ibpfRGB888Planar, mvIMPACT.acquire.ibpfAuto.

◆ pixelPitch

pixelPitch = property(lib_mvIMPACT_acquire.BufferPart_pixelPitch_get, doc=)
static

A 64-bit integer property (read-only) containing the offset (in bytes) to the next pixel of the specified channel of this buffer part.

Note
This property will store channelCount values. These can be queried one by one using the index parameter of the function mvIMPACT.acquire.PropertyI64.read() or in a single call by using the overloaded read function accepting a reference to a vector.

◆ regionID

regionID = property(lib_mvIMPACT_acquire.BufferPart_regionID_get, doc=)
static

Identifier allowing to group data parts belonging to the same region (usually corresponding with the RegionSelector/ChunkRegionID features from SFNC).

Parts marked with the same region_id can be pixel mapped together. Parts carrying data from different ROI's of the same source would typically be marked with the same source_id but with different region_ids.

Since
2.50.0

◆ sourceID

sourceID = property(lib_mvIMPACT_acquire.BufferPart_sourceID_get, doc=)
static

Identifier allowing to group data parts belonging to the same source (usually corresponding with the SourceSelector/ChunkSourceID features from SFNC).

Parts marked with the same source_id can be pixel mapped together. Parts carrying data from different ROI's of the same source would typically be marked with the same source_id. It is not mandatory that source_id's within a given buffer make a contiguous sequence of numbers starting with zero.

Note
For example with a dual-source 3D camera, the buffer can contain data parts carrying the 3D data and Confidence data corresponding to both of the two different sources. In this case the source ID helps to match the 3D and Confidence parts belonging together.

◆ thisown

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

◆ width

width = property(lib_mvIMPACT_acquire.BufferPart_width_get, doc=)
static

A 64-bit integer property (read-only) containing the width of the buffer part in pixels.