Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



IPvImage Class Referenceabstract

Generic image interface. More...

Public Member Functions

virtual const uint8_t * GetDataPointer () const =0
 Get the image's data pointer. More...
 
virtual uint8_t * GetDataPointer ()=0
 Get the image's data pointer. More...
 
virtual uint32_t GetImageSize () const =0
 Actual image size within the payload or buffer. More...
 
virtual uint32_t GetWidth () const =0
 Get the image's width. More...
 
virtual uint32_t GetHeight () const =0
 Get the image's height. More...
 
virtual PvPixelType GetPixelType () const =0
 The buffer's pixel type. More...
 
virtual uint32_t GetBitsPerPixel () const =0
 Returns how many bits are required to hold a pixel using the current buffer's pixel type. More...
 
virtual uint32_t GetOffsetX () const =0
 Get the image's horizontal offset. More...
 
virtual uint32_t GetOffsetY () const =0
 Get the image's vertical offset. More...
 
virtual uint16_t GetPaddingX () const =0
 Get the horizontal image padding. More...
 
virtual uint16_t GetPaddingY () const =0
 Get the vertical image padding. More...
 
virtual uint64_t GetBlockID () const =0
 Return the block ID. More...
 
virtual uint64_t GetTimestamp () const =0
 Get the image's timestamp. More...
 
virtual uint64_t GetReceptionTime () const =0
 Get the buffer's reception timestamp. More...
 

Detailed Description

Generic image interface.

Member Function Documentation

uint32_t IPvImage::GetBitsPerPixel ( ) const
pure virtual

Returns how many bits are required to hold a pixel using the current buffer's pixel type.

Returns
Bits per pixel for the current buffer's pixel type.
uint64_t IPvImage::GetBlockID ( ) const
pure virtual

Return the block ID.

This method returns the block ID. The GigE Vision or USB3 Vision transmitter typically increments the value by 1 for each new image. You can use this value to ensure the blocks are in order and that none are missing. The value is unsigned and wraps around to 1 (skipping 0) when it reaches 65536.

Returns
The block ID
const uint8_t * IPvImage::GetDataPointer ( ) const
pure virtual

Get the image's data pointer.

Returns
A pointer to the memory pointer.
uint8_t * IPvImage::GetDataPointer ( )
pure virtual

Get the image's data pointer.

Const version.

Returns
A pointer to the memory pointer.
uint32_t IPvImage::GetHeight ( ) const
pure virtual

Get the image's height.

Returns
The image's height, in pixels.
uint32_t IPvImage::GetImageSize ( ) const
pure virtual

Actual image size within the payload or buffer.

Uses the GEV leader for the actual width. Uses the GEV trailer for line count which is the actual height.

Returns
The actual image size within the payload or buffer
uint32_t IPvImage::GetOffsetX ( ) const
pure virtual

Get the image's horizontal offset.

Returns
The image's horizontal offset, in pixels.
uint32_t IPvImage::GetOffsetY ( ) const
pure virtual

Get the image's vertical offset.

Returns
The image's vertical offset, in pixels.
uint16_t IPvImage::GetPaddingX ( ) const
pure virtual

Get the horizontal image padding.

Images lines could be grabbed in increments of, let's say, 32 bytes. For an image 511 bytes across, the video interface adds a meaningless byte to make the line total 512 bytes (divisible by 32). In this case, the paddingX value would be 1 (byte).

Other devices may have different requirements on line length. Divible by 4, 8, 16, etc. or no specific limitations or requirements.

Returns
The horizontal image padding, in bytes; the number of bytes at the end of an image's line that contain meaningless data.
uint16_t IPvImage::GetPaddingY ( ) const
pure virtual

Get the vertical image padding.

Additional bytes appended at the end of an image.

See GetPaddingX.

Returns
The vertical image padding, in bytes.
See also
GetPaddingX
PvPixelType IPvImage::GetPixelType ( ) const
pure virtual

The buffer's pixel type.

Returns
The pixel type. The pixel depth, colorspace, and other information are coded into the value.
uint64_t IPvImage::GetReceptionTime ( ) const
pure virtual

Get the buffer's reception timestamp.

Returns
The buffer's reception time on the host, in micro seconds. Not an absolute time value.
uint64_t IPvImage::GetTimestamp ( ) const
pure virtual

Get the image's timestamp.

With hardware timestamps and GigE Vision devices, the device defines the timestamp tick frequency. The effective value can be retrieved from the GenApi interface of the device.

With hardware timestamps and USB3 Vision devices, timestamps are always defined in nanoseconds.

With software timestamps the timestamps are in micro seconds.

Use the PvStream GenApi interface to configure whether hardware or software time stamps are used.

Returns
The image's hardware timestamp; For Pleora devices, this is the value of the relative timestamp clock when the grabber began receiving data from the camera head - on the rising edge of the FVAL.
uint32_t IPvImage::GetWidth ( ) const
pure virtual

Get the image's width.

Returns
The image's width in pixels.

The documentation for this class was generated from the following files:

Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com