Pylon Logo Basler Logo
Public Member Functions | List of all members
Pylon::GrabResult Class Reference

Low Level API: A grab result that combines the used image buffer and status information. More...

#include <pylon/Result.h>

Public Member Functions

bool Succeeded () const
 True if status is grabbed.
 
StreamBufferHandle Handle () const
 Get the buffer handle.
 
void * Buffer () const
 Get the pointer to the buffer.
 
EGrabStatus Status () const
 Get the grab status.
 
const void * Context () const
 Get the pointer the user provided context.
 
EPayloadType GetPayloadType () const
 Get the actual payload type.
 
EPixelType GetPixelType () const
 Get the actual pixel type. This is only defined in case of image data.
 
uint64_t GetTimeStamp () const
 Get the camera specific tick count. More...
 
int32_t GetSizeX () const
 Get the actual number of columns in pixel. This is only defined in case of image data.
 
int32_t GetSizeY () const
 Get the actual number of rows in pixel. This is only defined in case of image data.
 
int32_t GetOffsetX () const
 Get the actual starting column. This is only defined in case of image data.
 
int32_t GetOffsetY () const
 Get the actual starting row. This is only defined in case of image data.
 
int32_t GetPaddingX () const
 Get the number of extra data at the end of each row in bytes. This is only defined in case of image data.
 
int32_t GetPaddingY () const
 Get the number of extra data at the end of the image data in bytes. This is only defined in case of image data.
 
int64_t GetPayloadSize () const
 Get the number of valid bytes in the buffer returned by Buffer().
 
size_t GetPayloadSize_t () const
 Get the number of valid bytes in the buffer returned by Buffer() as size_t.
 
String_t GetErrorDescription () const
 Get a description of the current error.
 
uint32_t GetErrorCode () const
 Get the current error code.
 
CGrabResultImageRef GetImage () const
 Provides an adapter from the grab result to Pylon::IImage interface. More...
 
uint64_t GetBlockID () const
 Get the block ID of the grabbed frame (camera device specific). More...
 
size_t GetBufferSize () const
 Get the size of the buffer returned by Buffer().
 

Detailed Description

Low Level API: A grab result that combines the used image buffer and status information.

Note that depending on the used interface technology, the specific camera and the situation some of the attributes are not meaningful, e. g. timestamp in case of an canceled grab.

Member Function Documentation

uint64_t Pylon::GrabResult::GetBlockID ( ) const
inline

Get the block ID of the grabbed frame (camera device specific).

IEEE 1394 Camera Devices
The value of block ID is always UINT64_MAX.
GigE Camera Devices
The sequence number starts with 1 and wraps at 65535. The value 0 has a special meaning and indicates that this feature is not supported by the camera.
USB Camera Devices
The sequence number starts with 0 and uses the full 64 Bit range.
Attention
A block ID of value UINT64_MAX indicates that the Block ID is invalid and must not be used.
CGrabResultImageRef Pylon::GrabResult::GetImage ( ) const
inline

Provides an adapter from the grab result to Pylon::IImage interface.

This returned adapter allows passing the grab result to saving functions or image format converter.

Attention
The returned reference is only valid as long the grab result is not destroyed.
uint64_t Pylon::GrabResult::GetTimeStamp ( ) const
inline

Get the camera specific tick count.

In case of GigE-Vision this describes when the image exposure was started. Cameras that do not support this feature return zero. If supported this may be used to determine which ROIs were acquired simultaneously.


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

pylon 6.1.0
Copyright (c) 2006-2020 Basler AG (Mon Mar 16 2020 10:57:00)