Makes the data for one grabbed buffer available. More...
#include <pylon/GrabResultData.h>
Public Member Functions | |
bool | GrabSucceeded () const |
Returns true if an image has been grabbed successfully and false in the case of an error. | |
String_t | GetErrorDescription () const |
This method returns a description of the error if GrabSucceeded() returns false due to an error. | |
uint32_t | GetErrorCode () const |
This method returns the error code if GrabSucceeded() returns false due to an error. | |
EPayloadType | GetPayloadType () const |
Get the current payload type. | |
EPixelType | GetPixelType () const |
Get the current pixel type. | |
uint32_t | GetWidth () const |
Get the current number of columns. | |
uint32_t | GetHeight () const |
Get the current number of rows expressed as number of pixels. | |
uint32_t | GetOffsetX () const |
Get the current starting column. | |
uint32_t | GetOffsetY () const |
Get the current starting row. | |
uint32_t | GetPaddingX () const |
Get the number of extra data at the end of each row in bytes. | |
uint32_t | GetPaddingY () const |
Get the number of extra data at the end of the image data in bytes. | |
void * | GetBuffer () const |
Get the pointer to the buffer. More... | |
size_t | GetPayloadSize () const |
Get the current payload size in bytes. | |
uint32_t | GetFrameNumber () const |
Deprecated: GetBlockID() should be used instead. Get the index of the grabbed frame (camera device specific). | |
uint64_t | GetBlockID () const |
Get the block ID of the grabbed frame (camera device specific). More... | |
uint64_t | GetTimeStamp () const |
Get the camera specific tick count (camera device specific). More... | |
bool | GetStride (size_t &strideBytes) const |
Get the stride in byte. | |
size_t | GetImageSize () const |
Get the size of the image in byte. | |
intptr_t | GetCameraContext () const |
Get the context value assigned to the camera object. The context is attached to the result when it is retrieved. | |
int64_t | GetID () const |
Get the ID of the grabbed image. More... | |
int64_t | GetImageNumber () const |
Get the number of the image. This number is incremented when an image is retrieved using CInstantCamera::RetrieveResult(). More... | |
int64_t | GetNumberOfSkippedImages () const |
Get the number of skipped images before this image. More... | |
bool | IsChunkDataAvailable () const |
Returns true if chunk data is available. More... | |
GenApi::INodeMap & | GetChunkDataNodeMap () const |
Get the reference to the chunk data node map connected to the result. More... | |
bool | HasCRC () const |
Checks if buffer has a CRC attached. This needs not be activated for the device. See the PayloadCRC16 chunk. | |
bool | CheckCRC () const |
Checks CRC sum of buffer, returns true if CRC sum is OK. | |
intptr_t | GetBufferContext () const |
Get the context value assigned to the buffer. The context is set when CInstamtCamera is using a custom buffer factory. | |
Makes the data for one grabbed buffer available.
uint64_t Pylon::CGrabResultData::GetBlockID | ( | ) | const |
Get the block ID of the grabbed frame (camera device specific).
void* Pylon::CGrabResultData::GetBuffer | ( | ) | const |
Get the pointer to the buffer.
If the chunk data feature is activated for the device, chunk data is appended to the image data. When writing past the image section while performing image processing, the chunk data will be corrupted.
GenApi::INodeMap& Pylon::CGrabResultData::GetChunkDataNodeMap | ( | ) | const |
Get the reference to the chunk data node map connected to the result.
An empty node map is returned when the device does not support this feature or when chunks are disabled.
int64_t Pylon::CGrabResultData::GetID | ( | ) | const |
Get the ID of the grabbed image.
Always returns a number larger than 0. The counting starts with 1 and is never reset during the lifetime of the Instant Camera object.
int64_t Pylon::CGrabResultData::GetImageNumber | ( | ) | const |
Get the number of the image. This number is incremented when an image is retrieved using CInstantCamera::RetrieveResult().
Always returns a number larger than 0. The counting starts with 1 and is reset with every call to CInstantCamera::StartGrabbing().
int64_t Pylon::CGrabResultData::GetNumberOfSkippedImages | ( | ) | const |
Get the number of skipped images before this image.
This value can be larger than 0 if EGrabStrategy_LatestImageOnly grab strategy or GrabStrategy_LatestImages grab strategy is used. Always returns a number larger than or equal 0. This number does not include the number of images lost in case of a buffer underrun in the driver.
uint64_t Pylon::CGrabResultData::GetTimeStamp | ( | ) | const |
Get the camera specific tick count (camera device specific).
This describes when the image exposure was started. Cameras that do not support this feature return zero. If supported, this can be used to determine which image AOIs were acquired simultaneously.
bool Pylon::CGrabResultData::IsChunkDataAvailable | ( | ) | const |
Returns true if chunk data is available.
This is the case if the chunk mode is enabled for the camera device. The parameter CInstantCamera::ChunkNodeMapsEnable of the used Instant Camera object is set to true (default setting). Chunk data node maps are supported by the Transport Layer of the camera device.