BufferPart Class Reference

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

Inheritance diagram for BufferPart:

Public Member Functions
synchronized void	delete ()
PropertyPtr	getAddress ()
	A pointer property (read-only) containing the start address of this buffer part.
PropertyI64	getBayerMosaicParity ()
	An enumerated 64-bit integer property (read-only) containing the Bayer parity of this buffer part.
PropertyI64	getBytesPerPixel ()
	A 64-bit integer property (read-only) containing the number of bytes per pixel in this buffer part.
PropertyI64	getChannelBitDepth ()
	A 64-bit integer property (read-only) containing the number of effective bits stored in each channel belonging to the current buffer part.
PropertyI64	getChannelCount ()
	A 64-bit integer property (read-only) containing the number of channels this buffer part consists of.
PropertyS	getChannelDesc ()
	A string property (read-only) containing the string descriptors of each channel belonging to the current buffer part.
PropertyI64	getChannelOffset ()
	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.getAddress().
PropertyI64	getDataSize ()
	A 64-bit integer property (read-only) containing the size (in bytes) of this buffer part.
PropertyI64	getDataType ()
	An enumerated 64-bit integer property (read-only) containing the data type of this buffer part.
PropertyI64	getGroupID ()
	Identifier allowing to group data parts having the same purpose (usually corresponding with the ComponentSelector feature from SFNC).
PropertyI64	getHeight ()
	A 64-bit integer property (read-only) containing the height of the buffer part in pixels.
ImageBufferDesc	getImageBufferDesc ()
	Returns a const reference to the image buffer descriptor of this buffer part.
PropertyI64	getLinePitch ()
	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.
PropertyI64	getOffsetX ()
	A 64-bit integer property (read-only) containing the X-offset of the buffer part in pixels.
PropertyI64	getOffsetY ()
	A 64-bit integer property (read-only) containing the Y-offset of the buffer part in pixels.
PropertyI64	getPaddingX ()
	A 64-bit integer property (read-only) containing the number of padding bytes in X direction of the buffer part.
PropertyI	getPixelFormat ()
	An enumerated integer property defining the pixel format of this buffer part.
PropertyI64	getPixelPitch ()
	A 64-bit integer property (read-only) containing the offset (in bytes) to the next pixel of the specified channel of this buffer part.
PropertyI64	getRegionID ()
	Identifier allowing to group data parts belonging to the same region (usually corresponding with the RegionSelector/ChunkRegionID features from SFNC).
PropertyI64	getSourceID ()
	Identifier allowing to group data parts belonging to the same source (usually corresponding with the SourceSelector/ChunkSourceID features from SFNC).
PropertyI64	getWidth ()
	A 64-bit integer property (read-only) containing the width of the buffer part in pixels.
int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.
ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

Protected Member Functions
	BufferPart (long cPtr, boolean cMemoryOwn)
void	finalize ()

Static Protected Member Functions
static long	swigRelease (BufferPart obj)
static long	swigRelease (ComponentCollection obj)

Protected Attributes
transient boolean	swigCMemOwn

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

BufferPart()

BufferPart ( long cPtr, boolean cMemoryOwn )

protected

Member Function Documentation

delete()

synchronized void delete

(

)

Reimplemented from ComponentCollection.

finalize()

void finalize ( )

protected

Reimplemented from ComponentCollection.

getAddress()

PropertyPtr getAddress

(

)

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

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

getBayerMosaicParity()

PropertyI64 getBayerMosaicParity

(

)

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.TBayerMosaicParity.bmpUndefined.

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TBayerMosaicParity.

getBytesPerPixel()

PropertyI64 getBytesPerPixel

(

)

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

getChannelBitDepth()

PropertyI64 getChannelBitDepth

(

)

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.

getChannelCount()

PropertyI64 getChannelCount

(

)

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.getPixelPitch(),
mvIMPACT.acquire.BufferPart.getLinePitch(),
mvIMPACT.acquire.BufferPart.getChannelBitDepth(),
mvIMPACT.acquire.BufferPart.getChannelDesc() and
mvIMPACT.acquire.BufferPart.getChannelOffset().

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

getChannelDesc()

PropertyS getChannelDesc

(

)

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

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

getChannelOffset()

PropertyI64 getChannelOffset

(

)

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.getAddress().

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.

getDataSize()

PropertyI64 getDataSize

(

)

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

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

getDataType()

PropertyI64 getDataType

(

)

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

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TBufferPartDataType.

getGroupID()

PropertyI64 getGroupID

(

)

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

Since

2.50.0

getHeight()

PropertyI64 getHeight

(

)

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

getImageBufferDesc()

ImageBufferDesc getImageBufferDesc

(

)

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.

getLinePitch()

PropertyI64 getLinePitch

(

)

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.

getOffsetX()

PropertyI64 getOffsetX

(

)

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

getOffsetY()

PropertyI64 getOffsetY

(

)

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

getPaddingX()

PropertyI64 getPaddingX

(

)

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

getPixelFormat()

PropertyI getPixelFormat

(

)

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

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TImageBufferPixelFormat.

getPixelPitch()

PropertyI64 getPixelPitch

(

)

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.

getRegionID()

PropertyI64 getRegionID

(

)

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

getSourceID()

PropertyI64 getSourceID

(

)

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.

getWidth()

PropertyI64 getWidth

(

)

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

hObj()

int hObj ( )

inherited

Returns a unique identifier for the component collection referenced by this object.

This handle will always reference an object of type mvIMPACT.acquire.ComponentList.

Returns

A unique identifier for the component referenced by this object.

restoreDefault()

ComponentCollection restoreDefault ( )

inherited

Restores the default for every component of this collection.

Calling this function will restore the default value for every component belonging to this collection.

Note

The caller must have the right to modify the component. Otherwise an exception will be thrown.

Returns

A const reference to the component.

swigRelease() [1/2]

static long swigRelease ( BufferPart obj )

staticprotected

swigRelease() [2/2]

static long swigRelease ( ComponentCollection obj )

staticprotectedinherited

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited