Pylon::CBaslerUniversalGrabResultData#

Module: Instant Camera / Universal Instant Camera for All Basler Devices

The Universal grab result data.

#include <pylon/BaslerUniversalGrabResultData.h>

Inherits from Pylon::CGrabResultData, Basler_UniversalChunkDataParams::CUniversalChunkDataParams_Params, Basler_UniversalChunkDataParams::CUniversalChunkDataParams_Params_v9_0_0

Public Functions#

Protected Functions#

Public Attributes#

Additional inherited members#

Friends inherited from Pylon::CGrabResultData

Public Functions Documentation#

function GrabSucceeded#

bool GrabSucceeded() const

Returns true if an image has been grabbed successfully and false in the case of an error.

function GetErrorDescription#

String_t GetErrorDescription() const

This method returns a description of the error if GrabSucceeded() returns false due to an error.

function GetErrorCode#

uint32_t GetErrorCode() const

This method returns the error code if GrabSucceeded() returns false due to an error.

function GetPayloadType#

EPayloadType GetPayloadType() const

Get the current payload type.

function GetPixelType#

EPixelType GetPixelType() const

Get the current pixel type.

function GetWidth#

uint32_t GetWidth() const

Get the current number of columns.

function GetHeight#

uint32_t GetHeight() const

Get the current number of rows expressed as number of pixels.

function GetOffsetX#

uint32_t GetOffsetX() const

Get the current starting column.

function GetOffsetY#

uint32_t GetOffsetY() const

Get the current starting row.

function GetPaddingX#

uint32_t GetPaddingX() const

Get the number of extra data at the end of each row in bytes.

function GetPaddingY#

uint32_t GetPaddingY() const

Get the number of extra data at the end of the image data in bytes.

function GetBuffer#

void * 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.

function GetPayloadSize#

size_t GetPayloadSize() const

Get the current payload size in bytes.

function GetBufferSize#

size_t GetBufferSize() const

Get the size of the buffer returned by GetBuffer() in bytes.

function GetBlockID#

uint64_t GetBlockID() const

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

Attention: A block ID with the value UINT64_MAX indicates that the block ID is invalid and must not be used.

GigE Camera Devices

If the Extended ID mode is disabled (default), the sequence number starts with 1 and wraps at 65535. If the Extended ID mode is enabled, the sequence number starts with 1 and uses the full 64-bit unsigned integer value range.

USB Camera Devices

The sequence number starts with 0 and uses the full 64 Bit range.

A value of 0 indicates that this feature is not supported by the camera. You can configure the Extended ID mode by setting the GevGVSPExtendedIDMode or the BslGevGVSPExtendedIDMode parameter, if available. The Instant Camera class and the pylon GigE stream grabber provide additional parameters for controlling the Extended ID mode.

function GetTimeStamp#

uint64_t 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.

function GetStride#

bool GetStride(
    size_t & strideBytes
) const

Get the stride in bytes.

function GetImageSize#

size_t GetImageSize() const

Get the size of the image in byte.

function GetCameraContext#

intptr_t GetCameraContext() const

Get the context value assigned to the camera object. The context is attached to the result when it is retrieved.

function GetID#

int64_t 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.

function GetImageNumber#

int64_t 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().

function GetNumberOfSkippedImages#

int64_t 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.

function IsChunkDataAvailable#

bool 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.

function GetChunkDataNodeMap#

GenApi::INodeMap & 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.

function HasCRC#

bool HasCRC() const

Checks if buffer has a CRC attached. This needs not be activated for the device. See the PayloadCRC16 chunk.

function CheckCRC#

bool CheckCRC() const

Checks CRC sum of buffer, returns true if CRC sum is OK.

function GetBufferContext#

intptr_t GetBufferContext() const

Get the context value assigned to the buffer. The context is set when CInstamtCamera is using a custom buffer factory.

function GetDataContainer#

CPylonDataContainer GetDataContainer() const

Returns the grab result as a CPylonDataContainer.

function GetDataComponentCount#

size_t GetDataComponentCount() const

Returns the number of components contained in the container.

Return: Returns the number of components contained in the container.

Error Safety:

Does not throw C++ exceptions.

Thread Safety:

This class is not thread-safe. If you access the same instance from multiple threads, you must make sure to synchronize the access accordingly.

You can use the return value to iterate over the existing components by calling Pylon::CPylonDataContainer::GetDataComponent().

function GetDataComponent#

CPylonDataComponent GetDataComponent(
    size_t index
)

Returns a specific component from the container.

Parameters:

• index Index of the component to return. The index must be less than the value returned by Pylon::CPylonDataContainer::GetComponentCount().

Return: Returns the component specified by the index parameter.

Error Safety:

Throws an exception if the index parameter is out of range. Can throw exceptions in low-memory conditions.

Thread Safety:

This class is not thread-safe. If you access the same instance from multiple threads, you must make sure to synchronize the access accordingly.

Protected Functions Documentation#

function Destroy#

inline virtual void Destroy()

Reimplements: Pylon::CGrabResultData::Destroy

function Initialize#

inline virtual void Initialize()

Reimplements: Pylon::CGrabResultData::Initialize

Public Attributes Documentation#

variable BslChunkAutoBrightnessStatus#

Pylon::IEnumParameterT< BslChunkAutoBrightnessStatusEnums > & BslChunkAutoBrightnessStatus;

Indicates the status of the target brightness adjustments performed by the Exposure Auto and Gain Auto auto functions - Applies to: ace 2 GigE, ace 2 USB, dart 2 USB and dart USB.

Visibility: Expert

variable BslChunkTimestampSelector#

Pylon::IEnumParameterT< BslChunkTimestampSelectorEnums > & BslChunkTimestampSelector;

Sets which information should be included in the Chunk Timestamp Value chunk - Applies to: ace 2 GigE, ace 2 USB, dart 2 USB and dart USB.

Visibility: Expert

Selecting Parameters: BslChunkTimestampValue

variable BslChunkTimestampValue#

Pylon::IIntegerEx & BslChunkTimestampValue;

Value of the timestamp when the image was acquired - Applies to: ace 2 GigE, ace 2 USB, dart 2 USB and dart USB.

Visibility: Expert

Selected by: BslChunkTimestampSelector

variable ChunkBslLineRatio#

Pylon::IFloatEx & ChunkBslLineRatio;

Returns the exposure ratio of the selected output line - Applies to: Stereo ace.

Visibility: Expert

Selected by: ChunkLineSelector

variable ChunkBslMaxDepth#

Pylon::IFloatEx & ChunkBslMaxDepth;

Maximum depth that was used - Applies to: Stereo ace.

Visibility: Expert

variable ChunkBslMinDepth#

Pylon::IFloatEx & ChunkBslMinDepth;

Minimum depth that was used - Applies to: Stereo ace.

Minimum depth that was used. This can be higher than anticipated due to camera or memory requirements.

Visibility: Expert

variable ChunkBslNoise#

Pylon::IFloatEx & ChunkBslNoise;

Returns the noise of the image - Applies to: Stereo ace.

Visibility: Expert

variable ChunkBslReducedDepthRange#

Pylon::IBooleanEx & ChunkBslReducedDepthRange;

Signals if the depth range had to be reduced due to memory limits - Applies to: Stereo ace.

Visibility: Expert

variable ChunkComponentID#

Pylon::IEnumParameterT< ChunkComponentIDEnums > & ChunkComponentID;

Returns the component of the payload image - Applies to: Stereo ace.

Returns the component of the payload image. This can be used to identify the image component of a generic part in a multi-part transfer.

Visibility: Expert

Selected by: ChunkComponentSelector

variable ChunkComponentIDValue#

Pylon::IIntegerEx & ChunkComponentIDValue;

Returns a unique Identifier value that corresponds to the selected chunk component - Applies to: Stereo ace.

Visibility: Expert

Selected by: ChunkComponentSelector

variable ChunkComponentSelector#

Pylon::IEnumParameterT< ChunkComponentSelectorEnums > & ChunkComponentSelector;

Selects the Component from which to retreive data from - Applies to: Stereo ace.

Visibility: Expert

Selecting Parameters: ChunkComponentID, ChunkComponentIDValue, ChunkDecimationHorizontal, ChunkDecimationVertical, ChunkHeight, ChunkOffsetX, ChunkOffsetY, ChunkPartIndex, ChunkPixelFormat, ChunkScan3dFocalLength, ChunkScan3dPrincipalPointU, ChunkScan3dPrincipalPointV and ChunkWidth

variable ChunkComponents#

Pylon::IIntegerEx & ChunkComponents;

Returns the bitmask of components contained in this block - Applies to: Stereo ace.

Visibility: Expert

variable ChunkCounterSelector#

Pylon::IEnumParameterT< ChunkCounterSelectorEnums > & ChunkCounterSelector;

Sets which counter to retrieve chunk data from - Applies to: ace 2 GigE, ace 2 USB, ace USB, dart 2 USB and dart USB.

Visibility: Expert

Selecting Parameters: ChunkCounterValue

variable ChunkCounterValue#

Pylon::IIntegerEx & ChunkCounterValue;

Value of the selected chunk counter - Applies to: ace 2 GigE, ace 2 USB, ace USB, dart 2 USB and dart USB.

Visibility: Beginner

Selected by: ChunkCounterSelector

variable ChunkDecimationHorizontal#

Pylon::IIntegerEx & ChunkDecimationHorizontal;

Horizontal sub-sampling of the image - Applies to: Stereo ace.

Visibility: Expert

Selected by: ChunkComponentSelector

variable ChunkDecimationVertical#

Pylon::IIntegerEx & ChunkDecimationVertical;

Vertical sub-sampling of the image - Applies to: Stereo ace.

Visibility: Expert

Selected by: ChunkComponentSelector

variable ChunkDynamicRangeMax#

Pylon::IIntegerEx & ChunkDynamicRangeMax;

Maximum possible pixel value in the acquired image - Applies to: GigE and ace 2 GigE.

Visibility: Beginner

variable ChunkDynamicRangeMin#

Pylon::IIntegerEx & ChunkDynamicRangeMin;

Minimum possible pixel value in the acquired image - Applies to: GigE and ace 2 GigE.

Visibility: Beginner

variable ChunkExposureTime#

Pylon::IFloatEx & ChunkExposureTime;

Exposure time used to acquire the image - Applies to: GigE, Stereo ace, ace 2 GigE, ace 2 USB, ace USB, dart 2 USB and dart USB.

Visibility: Beginner

Selected by: ChunkExposureTimeSelector

variable ChunkExposureTimeSelector#

Pylon::IEnumParameterT< ChunkExposureTimeSelectorEnums > & ChunkExposureTimeSelector;

Sets which exposure time to retrieve chunk data from - Applies to: ace 2 GigE, ace 2 USB and dart USB.

Visibility: Expert

Selecting Parameters: ChunkExposureTime

variable ChunkFrameID#

Pylon::IIntegerEx & ChunkFrameID;

Unique identifier of the current frame - Applies to: Stereo ace, ace 2 GigE, ace 2 USB, dart 2 USB and dart USB.

Unique identifier of the current frame. The frame ID starts at 0 and keeps incrementing by 1 for each exposed image until the camera is powered off. The maximum value is 2^48.

Visibility: Expert

variable ChunkFrameTriggerCounter#

Pylon::IIntegerEx & ChunkFrameTriggerCounter;

Value of the Frame Trigger counter when the image was acquired - Applies to: GigE.

Visibility: Beginner

variable ChunkFrameTriggerIgnoredCounter#

Pylon::IIntegerEx & ChunkFrameTriggerIgnoredCounter;

Value of the Frame Trigger Ignored counter when the image was acquired - Applies to: GigE.

Visibility: Beginner

variable ChunkFramecounter#

Pylon::IIntegerEx & ChunkFramecounter;

Value of the Frame counter when the image was acquired - Applies to: GigE.

Visibility: Beginner

variable ChunkFramesPerTriggerCounter#

Pylon::IIntegerEx & ChunkFramesPerTriggerCounter;

Value of the Frames per Trigger counter when the image was acquired - Applies to: GigE.

Visibility: Beginner

variable ChunkGain#

Pylon::IFloatEx & ChunkGain;

Gain used during image acquisition - Applies to: Stereo ace, ace 2 GigE, ace 2 USB, ace USB, dart 2 USB and dart USB.

Visibility: Beginner

Selected by: ChunkGainSelector

variable ChunkGainAll#

Pylon::IIntegerEx & ChunkGainAll;

Gain All value of the acquired image - Applies to: GigE.

Visibility: Beginner

variable ChunkGainSelector#

Pylon::IEnumParameterT< ChunkGainSelectorEnums > & ChunkGainSelector;

Sets which gain channel to retrieve chunk data from - Applies to: ace 2 GigE, ace 2 USB, ace USB and dart USB.

Visibility: Expert

Selecting Parameters: ChunkGain

variable ChunkHeight#

Pylon::IIntegerEx & ChunkHeight;

AOI height of the acquired image - Applies to: GigE, Stereo ace and ace 2 GigE.

Visibility: Beginner

Selected by: ChunkComponentSelector

variable ChunkInputStatusAtLineTriggerBitsPerLine#

Pylon::IIntegerEx & ChunkInputStatusAtLineTriggerBitsPerLine;

Number of bits per line used for the Input Status At Line Trigger parameter - Applies to: GigE.

Visibility: Beginner

variable ChunkInputStatusAtLineTriggerIndex#

Pylon::IIntegerEx & ChunkInputStatusAtLineTriggerIndex;

Index number used for the Input Status At Line Trigger parameter - Applies to: GigE.

Index number used for the Input Status At Line Trigger parameter. The index number can be used to get the state of the camera's input lines when a specific line was acquired. For example, if you want to know the state of the camera's input lines when line 30 was acquired, set the index to 30, then retrieve the value of Status Index parameter.

Visibility: Beginner

variable ChunkInputStatusAtLineTriggerValue#

Pylon::IIntegerEx & ChunkInputStatusAtLineTriggerValue;

Value indicating the status of the camera's input lines when a specific line was acquired - Applies to: GigE.

Value indicating the status of the camera's input lines when a specific line was acquired. The information is stored in a 4-bit value (bit 0 = input line 1 state, bit 1 = input line 2 state etc.). For more information, see the Status Index parameter documentation.

Visibility: Beginner

variable ChunkLineSelector#

Pylon::IEnumParameterT< ChunkLineSelectorEnums > & ChunkLineSelector;

Selects the output for which to read the LineSource - Applies to: Stereo ace.

Visibility: Expert

Selecting Parameters: ChunkBslLineRatio, ChunkLineSource and ChunkLineStatus

variable ChunkLineSource#

Pylon::IEnumParameterT< ChunkLineSourceEnums > & ChunkLineSource;

Line source for selected line - Applies to: Stereo ace.

Visibility: Expert

Selected by: ChunkLineSelector

variable ChunkLineStatus#

Pylon::IBooleanEx & ChunkLineStatus;

Returns the current status of the selected input or output Line - Applies to: Stereo ace.

Visibility: Expert

Selected by: ChunkLineSelector

variable ChunkLineStatusAll#

Pylon::IIntegerEx & ChunkLineStatusAll;

Bit field that indicates the status of all of the camera's input and output lines when the image was acquired - Applies to: GigE, Stereo ace, ace 2 GigE, ace 2 USB, ace USB, dart 2 USB and dart USB.

Visibility: Beginner

variable ChunkLineTriggerCounter#

Pylon::IIntegerEx & ChunkLineTriggerCounter;

Value of the Line Trigger counter when the image was acquired - Applies to: GigE.

Visibility: Beginner

variable ChunkLineTriggerEndToEndCounter#

Pylon::IIntegerEx & ChunkLineTriggerEndToEndCounter;

Value of the Line Trigger End to End counter when the image was acquired - Applies to: GigE.

Visibility: Beginner

variable ChunkLineTriggerIgnoredCounter#

Pylon::IIntegerEx & ChunkLineTriggerIgnoredCounter;

Value of the Line Trigger Ignored counter when the image was acquired - Applies to: GigE.

Visibility: Beginner

variable ChunkOffsetX#

Pylon::IIntegerEx & ChunkOffsetX;

X offset of the AOI of the acquired image - Applies to: GigE, Stereo ace and ace 2 GigE.

Visibility: Beginner

Selected by: ChunkComponentSelector

variable ChunkOffsetY#

Pylon::IIntegerEx & ChunkOffsetY;

Y offset of the AOI of the acquired image - Applies to: GigE, Stereo ace and ace 2 GigE.

Visibility: Beginner

Selected by: ChunkComponentSelector

variable ChunkPartIndex#

Pylon::IIntegerEx & ChunkPartIndex;

Returns index of the image part in this block depending on selected component - Applies to: Stereo ace.

Visibility: Expert

Selected by: ChunkComponentSelector

variable ChunkPayloadCRC16#

Pylon::IIntegerEx & ChunkPayloadCRC16;

CRC checksum of the acquired image - Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB, dart 2 USB and dart USB.

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

variable ChunkPixelDynamicRangeMax#

Pylon::IIntegerEx & ChunkPixelDynamicRangeMax;

Maximum possible pixel value in the acquired image - Applies to: ace 2 GigE.

Visibility: Expert

variable ChunkPixelDynamicRangeMin#

Pylon::IIntegerEx & ChunkPixelDynamicRangeMin;

Minimum possible pixel value in the acquired image - Applies to: ace 2 GigE.

Visibility: Expert

variable ChunkPixelFormat#

Pylon::IEnumParameterT< ChunkPixelFormatEnums > & ChunkPixelFormat;

Indicates the pixel format of the acquired image - Applies to: GigE, Stereo ace and ace 2 GigE.

Visibility: Beginner

Selected by: ChunkComponentSelector

variable ChunkScan3dBaseline#

Pylon::IFloatEx & ChunkScan3dBaseline;

Baseline of the stereo cameras - Applies to: Stereo ace.

Baseline of the stereo cameras in m.

Visibility: Expert

variable ChunkScan3dCoordinateOffset#

Pylon::IFloatEx & ChunkScan3dCoordinateOffset;

Returns the offset when transforming a pixel from relative coordinates to world coordinates - Applies to: Stereo ace.

Visibility: Expert

Selected by: ChunkScan3dCoordinateSelector

variable ChunkScan3dCoordinateScale#

Pylon::IFloatEx & ChunkScan3dCoordinateScale;

Returns the scale factor when transforming a pixel from relative coordinates to world coordinates - Applies to: Stereo ace.

Visibility: Expert

Selected by: ChunkScan3dCoordinateSelector

variable ChunkScan3dCoordinateSelector#

Pylon::IEnumParameterT< ChunkScan3dCoordinateSelectorEnums > & ChunkScan3dCoordinateSelector;

Selects which Coordinate to retrieve data from - Applies to: Stereo ace.

Visibility: Expert

Selecting Parameters: ChunkScan3dCoordinateOffset, ChunkScan3dCoordinateScale, ChunkScan3dInvalidDataFlag and ChunkScan3dInvalidDataValue

variable ChunkScan3dDistanceUnit#

Pylon::IEnumParameterT< ChunkScan3dDistanceUnitEnums > & ChunkScan3dDistanceUnit;

Returns the Distance Unit of the payload image - Applies to: Stereo ace.

Visibility: Expert

variable ChunkScan3dFocalLength#

Pylon::IFloatEx & ChunkScan3dFocalLength;

Focal length - Applies to: Stereo ace.

Focal length of the camera in pixels.

Visibility: Expert

Selected by: ChunkComponentSelector

variable ChunkScan3dInvalidDataFlag#

Pylon::IBooleanEx & ChunkScan3dInvalidDataFlag;

Returns if a specific non-valid data flag is used in the payload image - Applies to: Stereo ace.

Visibility: Expert

Selected by: ChunkScan3dCoordinateSelector

variable ChunkScan3dInvalidDataValue#

Pylon::IFloatEx & ChunkScan3dInvalidDataValue;

Returns the value which identifies a non-valid pixel - Applies to: Stereo ace.

Visibility: Expert

Selected by: ChunkScan3dCoordinateSelector

variable ChunkScan3dOutputMode#

Pylon::IEnumParameterT< ChunkScan3dOutputModeEnums > & ChunkScan3dOutputMode;

Returns the Calibrated Mode of the payload image - Applies to: Stereo ace.

Visibility: Expert

variable ChunkScan3dPrincipalPointU#

Pylon::IFloatEx & ChunkScan3dPrincipalPointU;

Horizontal position of the principal point - Applies to: Stereo ace.

Visibility: Expert

Selected by: ChunkComponentSelector

variable ChunkScan3dPrincipalPointV#

Pylon::IFloatEx & ChunkScan3dPrincipalPointV;

Vertical position of the principal point - Applies to: Stereo ace.

Visibility: Expert

Selected by: ChunkComponentSelector

variable ChunkSequenceSetIndex#

Pylon::IIntegerEx & ChunkSequenceSetIndex;

Sequence set index number related to the acquired image - Applies to: GigE.

Visibility: Beginner

variable ChunkSequencerSetActive#

Pylon::IIntegerEx & ChunkSequencerSetActive;

Index of the active sequencer set - Applies to: ace 2 GigE, ace 2 USB and ace USB.

Visibility: Beginner

variable ChunkShaftEncoderCounter#

Pylon::IIntegerEx & ChunkShaftEncoderCounter;

Value of the Shaft Encoder counter when the image was acquired - Applies to: GigE.

Visibility: Beginner

variable ChunkStride#

Pylon::IIntegerEx & ChunkStride;

Number of bytes of data between the beginning of one line in the acquired image and the beginning of the next line in the acquired image - Applies to: GigE and ace 2 GigE.

Visibility: Beginner

variable ChunkTimestamp#

Pylon::IIntegerEx & ChunkTimestamp;

Value of the timestamp when the image was acquired - Applies to: GigE, Stereo ace and ace USB.

Visibility: Beginner

variable ChunkTriggerinputcounter#

Pylon::IIntegerEx & ChunkTriggerinputcounter;

Value of the Trigger Input counter when the image was acquired - Applies to: GigE.

Visibility: Beginner

variable ChunkVirtLineStatusAll#

Pylon::IIntegerEx & ChunkVirtLineStatusAll;

Status of all of the camera's virtual input and output lines when the image was acquired - Applies to: GigE.

Visibility: Beginner

variable ChunkWidth#

Pylon::IIntegerEx & ChunkWidth;

Width of the AOI of the acquired image - Applies to: GigE, Stereo ace and ace 2 GigE.

Visibility: Beginner

Selected by: ChunkComponentSelector