All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
Pylon::CBaslerUsbGrabResultData Class Reference

The USB specific grab result data class. More...

#include <pylon/usb/BaslerUsbGrabResultData.h>

Inheritance diagram for Pylon::CBaslerUsbGrabResultData:
Inheritance graph
[legend]

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.
 

Public Attributes

ChunkData - Contains parameters to append chunk data to the image data.
GenApi::IEnumerationT
< ChunkGainSelectorEnums > & 
ChunkGainSelector
 Sets which gain channel to retrieve chunk data from. More...
 
GenApi::IFloat & ChunkGain
 Gain used to acquire the image. More...
 
GenApi::IFloat & ChunkExposureTime
 Exposure time used to acquire the image. More...
 
GenApi::IInteger & ChunkTimestamp
 Value of the timestamp when the image was acquired. More...
 
GenApi::IInteger & ChunkLineStatusAll
 A bit field that indicates the status of all of the camera's input and output lines when the image was acquired. More...
 
GenApi::IEnumerationT
< ChunkCounterSelectorEnums > & 
ChunkCounterSelector
 Sets which counter to retrieve chunk data from. More...
 
GenApi::IInteger & ChunkCounterValue
 Value of the selected chunk counter. More...
 
GenApi::IInteger & ChunkSequencerSetActive
 Index of the active sequencer set. More...
 
GenApi::IInteger & ChunkPayloadCRC16
 CRC checksum of the acquired image. More...
 

Detailed Description

The USB specific grab result data class.

Member Function Documentation

uint64_t Pylon::CGrabResultData::GetBlockID ( ) const
inherited

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 with the value UINT64_MAX indicates that the block ID is invalid and must not be used.
void* Pylon::CGrabResultData::GetBuffer ( ) const
inherited

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
inherited

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
inherited

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
inherited

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
inherited

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
inherited

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
inherited

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.

Member Data Documentation

GenApi::IEnumerationT<ChunkCounterSelectorEnums >& Basler_UsbChunkData::CUsbChunkData_Params::ChunkCounterSelector
inherited

Sets which counter to retrieve chunk data from.

Applies to: ace

Sets which counter to retrieve chunk data from.

Visibility = Expert

GenApi::IInteger& Basler_UsbChunkData::CUsbChunkData_Params::ChunkCounterValue
inherited

Value of the selected chunk counter.

Applies to: ace

Value of the selected chunk counter.

Visibility = Beginner

Selected by : ChunkCounterSelector

GenApi::IFloat& Basler_UsbChunkData::CUsbChunkData_Params::ChunkExposureTime
inherited

Exposure time used to acquire the image.

Applies to: ace

Exposure time used to acquire the image.

Visibility = Beginner

GenApi::IFloat& Basler_UsbChunkData::CUsbChunkData_Params::ChunkGain
inherited

Gain used to acquire the image.

Applies to: ace

Gain used to acquire the image.

Visibility = Beginner

Selected by : ChunkGainSelector

GenApi::IEnumerationT<ChunkGainSelectorEnums >& Basler_UsbChunkData::CUsbChunkData_Params::ChunkGainSelector
inherited

Sets which gain channel to retrieve chunk data from.

Applies to: ace

Sets which gain channel to retrieve chunk data from.

Visibility = Expert

GenApi::IInteger& Basler_UsbChunkData::CUsbChunkData_Params::ChunkLineStatusAll
inherited

A bit field that indicates the status of all of the camera's input and output lines when the image was acquired.

Applies to: ace

A bit field that indicates the status of all of the camera's input and output lines when the image was acquired

Visibility = Beginner

GenApi::IInteger& Basler_UsbChunkData::CUsbChunkData_Params::ChunkPayloadCRC16
inherited

CRC checksum of the acquired image.

Applies to: ace

CRC checksum of the acquired image. The checksum is calculated using all of the image data and all of the appended chunks except for the checksum itself.

Visibility = Beginner

GenApi::IInteger& Basler_UsbChunkData::CUsbChunkData_Params::ChunkSequencerSetActive
inherited

Index of the active sequencer set.

Applies to: ace

Index of the active sequencer set.

Visibility = Beginner

GenApi::IInteger& Basler_UsbChunkData::CUsbChunkData_Params::ChunkTimestamp
inherited

Value of the timestamp when the image was acquired.

Applies to: ace

Value of the timestamp when the image was acquired.

Visibility = Beginner


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

pylon 5.0.5
Copyright © 2006-2016 Basler AG (Thu Aug 11 2016 18:01:29)