Image interface. It represents the image buffer grabbed from the device. The ownership of the image instance belongs to the client code, so it needs to be disposed when it's no longer required via IImage::Dispose.
◆ GetWidth()
virtual size_t Itala::IImage::GetWidth |
( |
| ) |
const |
|
pure virtual |
Get the width of the image in pixels.
◆ GetHeight()
virtual size_t Itala::IImage::GetHeight |
( |
| ) |
const |
|
pure virtual |
Get the height of the image in pixels.
◆ GetOffsetX()
virtual size_t Itala::IImage::GetOffsetX |
( |
| ) |
const |
|
pure virtual |
Get the offsex along the X axis of the image, in pixels.
◆ GetOffsetY()
virtual size_t Itala::IImage::GetOffsetY |
( |
| ) |
const |
|
pure virtual |
Get the offsex along the Y axis of the image, in pixels.
◆ GetPaddingX()
virtual size_t Itala::IImage::GetPaddingX |
( |
| ) |
const |
|
pure virtual |
Get the padding along the X axis of the image, in pixels.
◆ GetPaddingY()
virtual size_t Itala::IImage::GetPaddingY |
( |
| ) |
const |
|
pure virtual |
Get the padding along the Y axis of the image, in pixels.
◆ GetPixelFormat()
virtual PfncFormat Itala::IImage::GetPixelFormat |
( |
| ) |
const |
|
pure virtual |
Get the pixel format of the image. The PFNC standard from GenICam is used to identify the format.
◆ GetFrameID()
virtual uint64_t Itala::IImage::GetFrameID |
( |
| ) |
const |
|
pure virtual |
◆ GetTimestamp()
virtual uint64_t Itala::IImage::GetTimestamp |
( |
| ) |
const |
|
pure virtual |
Get the timestamp of the image.
◆ GetPayloadSize()
virtual size_t Itala::IImage::GetPayloadSize |
( |
| ) |
const |
|
pure virtual |
Get the payload size of the image, in bytes.
◆ IsIncomplete()
virtual bool Itala::IImage::IsIncomplete |
( |
| ) |
const |
|
pure virtual |
Reports wether the grabbed image is incomplete, i.e. some bytes are missing due to transfer issues.
◆ GetBytesFilled()
virtual size_t Itala::IImage::GetBytesFilled |
( |
| ) |
const |
|
pure virtual |
Get the amount of bytes actually stored in the buffer.
◆ GetData()
virtual void* Itala::IImage::GetData |
( |
| ) |
const |
|
pure virtual |
Get the pointer to the memory buffer containing the grabbed data. The content is retrieved directly from the device and, if chunk data functionality is enabled, the chunks are also included in the buffer.
◆ HasChunkData()
virtual bool Itala::IImage::HasChunkData |
( |
| ) |
const |
|
pure virtual |
Report wether the buffer contains chunk data or not.
◆ GetChunkNode()
virtual GenApi::INode* Itala::IImage::GetChunkNode |
( |
GenICam::gcstring |
name | ) |
const |
|
pure virtual |
Get the specified node from the internal chunk data nodemap.
◆ Clone()
virtual IImage* Itala::IImage::Clone |
( |
| ) |
const |
|
pure virtual |
Creates a new image cloned from the current one with its own allocated memory. It needs to be disposed when it's no longer required via Dispose().
- Warning
- Chunk data access via GenApi is not available for cloned images: if the source image is directly coming from a grab, it's highly recommended to manually retrieve the needed chunk values before the source image gets disposed.
- Returns
- Pointer to the cloned image instance.
◆ Convert()
virtual IImage* Itala::IImage::Convert |
( |
PfncFormat |
dest_format | ) |
const |
|
pure virtual |
Creates a new image converted from the current one with its own allocated memory and the specified pixel format. It needs to be disposed when it's no longer required via Dispose().
- Warning
- Chunk data access via GenApi is not available for converted images: if the source image is directly coming from a grab, it's highly recommended to manually retrieve the needed chunk values before the source image gets disposed.
-
When converting from packed to unpacked formats, the resulting data is aligned according to the PFNC specification. Most of the time the resulting data is LSB aligned, e.g. a 12-bit pixel value stored in a 16-bit component has its MSBs padded with zeroes. See the official PFNC document hosted by EMVA for details.
- Returns
- Pointer to the converted image instance.
The documentation for this struct was generated from the following file:
- /builds/randd/itala-sdk/projects/itala-api/include/ItalaApi/IImage.h