Generic image interface. More...
Public Member Functions | |
virtual const uint8_t * | GetDataPointer () const =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... | |
Generic image interface.
|
pure virtual |
Returns how many bits are required to hold a pixel using the current buffer's pixel type.
|
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.
|
pure virtual |
Get the image's data pointer.
Const version.
|
pure virtual |
Get the image's height.
|
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.
|
pure virtual |
Get the image's horizontal offset.
|
pure virtual |
Get the image's vertical offset.
|
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.
|
pure virtual |
Get the vertical image padding.
Additional bytes appended at the end of an image.
See GetPaddingX.
|
pure virtual |
The buffer's pixel type.
|
pure virtual |
Get the buffer's reception timestamp.
|
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.
|
pure virtual |
Get the image's width.
Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com