![]() |
![]() |
The Universal grab result data. More...
#include <pylon/BaslerUniversalGrabResultData.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. | |
size_t | GetBufferSize () const |
Get the size of the buffer returned by GetBuffer in bytes. | |
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 | |
Categories: Root | |
Pylon::IEnumParameterT< ChunkCounterSelectorEnums > & | ChunkCounterSelector |
Sets which counter to retrieve chunk data from - Applies to: ace USB. More... | |
Pylon::IIntegerEx & | ChunkCounterValue |
Value of the selected chunk counter - Applies to: ace USB. More... | |
Pylon::IIntegerEx & | ChunkDynamicRangeMax |
Maximum possible pixel value in the acquired image - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ChunkDynamicRangeMin |
Minimum possible pixel value in the acquired image - Applies to: GigE. More... | |
Pylon::IFloatEx & | ChunkExposureTime |
Exposure time used to acquire the image - Applies to: GigE and ace USB. More... | |
Pylon::IIntegerEx & | ChunkFrameTriggerCounter |
Value of the Frame Trigger counter when the image was acquired - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ChunkFrameTriggerIgnoredCounter |
Value of the Frame Trigger Ignored counter when the image was acquired - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ChunkFramecounter |
Value of the Frame counter when the image was acquired - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ChunkFramesPerTriggerCounter |
Value of the Frames per Trigger counter when the image was acquired - Applies to: GigE. More... | |
Pylon::IFloatEx & | ChunkGain |
Gain used during image acquisition - Applies to: ace USB. More... | |
Pylon::IIntegerEx & | ChunkGainAll |
Gain All value of the acquired image - Applies to: GigE. More... | |
Pylon::IEnumParameterT< ChunkGainSelectorEnums > & | ChunkGainSelector |
Sets which gain channel to retrieve chunk data from - Applies to: ace USB. More... | |
Pylon::IIntegerEx & | ChunkHeight |
AOI height of the acquired image - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ChunkInputStatusAtLineTriggerBitsPerLine |
Number of bits per line used for the Input Status At Line Trigger parameter - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ChunkInputStatusAtLineTriggerIndex |
Index number used for the Input Status At Line Trigger parameter - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ChunkInputStatusAtLineTriggerValue |
Value indicating the status of the camera's input lines when a specific line was acquired - Applies to: GigE. More... | |
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 and ace USB. More... | |
Pylon::IIntegerEx & | ChunkLineTriggerCounter |
Value of the Line Trigger counter when the image was acquired - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ChunkLineTriggerEndToEndCounter |
Value of the Line Trigger End to End counter when the image was acquired - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ChunkLineTriggerIgnoredCounter |
Value of the Line Trigger Ignored counter when the image was acquired - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ChunkOffsetX |
X offset of the AOI of the acquired image - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ChunkOffsetY |
Y offset of the AOI of the acquired image - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ChunkPayloadCRC16 |
CRC checksum of the acquired image - Applies to: GigE and ace USB. More... | |
Pylon::IEnumParameterT< ChunkPixelFormatEnums > & | ChunkPixelFormat |
Indicates the pixel format of the acquired image - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ChunkSequenceSetIndex |
Sequence set index number related to the acquired image - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ChunkSequencerSetActive |
Index of the active sequencer set - Applies to: ace USB. More... | |
Pylon::IIntegerEx & | ChunkShaftEncoderCounter |
Value of the Shaft Encoder counter when the image was acquired - Applies to: GigE. More... | |
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. More... | |
Pylon::IIntegerEx & | ChunkTimestamp |
Value of the timestamp when the image was acquired - Applies to: GigE and ace USB. More... | |
Pylon::IIntegerEx & | ChunkTriggerinputcounter |
Value of the Trigger Input counter when the image was acquired - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ChunkVirtLineStatusAll |
Status of all of the camera's virtual input and output lines when the image was acquired - Applies to: GigE. More... | |
Pylon::IIntegerEx & | ChunkWidth |
Width of the AOI of the acquired image - Applies to: GigE. More... | |
The Universal grab result data.
|
inherited |
Get the block ID of the grabbed frame (camera device specific).
|
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.
|
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.
|
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.
|
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().
|
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.
|
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.
|
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.
|
inherited |
Sets which counter to retrieve chunk data from - Applies to: ace USB.
Visibility: Expert
Selecting Parameters: ChunkCounterValue
|
inherited |
Value of the selected chunk counter - Applies to: ace USB.
Visibility: Beginner
Selected by: ChunkCounterSelector
|
inherited |
Maximum possible pixel value in the acquired image - Applies to: GigE.
Visibility: Beginner
|
inherited |
Minimum possible pixel value in the acquired image - Applies to: GigE.
Visibility: Beginner
|
inherited |
Exposure time used to acquire the image - Applies to: GigE and ace USB.
Visibility: Beginner
|
inherited |
Value of the Frame counter when the image was acquired - Applies to: GigE.
Visibility: Beginner
|
inherited |
Value of the Frames per Trigger counter when the image was acquired - Applies to: GigE.
Visibility: Beginner
|
inherited |
Value of the Frame Trigger counter when the image was acquired - Applies to: GigE.
Visibility: Beginner
|
inherited |
Value of the Frame Trigger Ignored counter when the image was acquired - Applies to: GigE.
Visibility: Beginner
|
inherited |
Gain used during image acquisition - Applies to: ace USB.
Visibility: Beginner
Selected by: ChunkGainSelector
|
inherited |
Gain All value of the acquired image - Applies to: GigE.
Visibility: Beginner
|
inherited |
Sets which gain channel to retrieve chunk data from - Applies to: ace USB.
Visibility: Expert
Selecting Parameters: ChunkGain
|
inherited |
AOI height of the acquired image - Applies to: GigE.
Visibility: Beginner
|
inherited |
Number of bits per line used for the Input Status At Line Trigger parameter - Applies to: GigE.
Visibility: Beginner
|
inherited |
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
|
inherited |
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
|
inherited |
Bit field that indicates the status of all of the camera's input and output lines when the image was acquired - Applies to: GigE and ace USB.
Visibility: Beginner
|
inherited |
Value of the Line Trigger counter when the image was acquired - Applies to: GigE.
Visibility: Beginner
|
inherited |
Value of the Line Trigger End to End counter when the image was acquired - Applies to: GigE.
Visibility: Beginner
|
inherited |
Value of the Line Trigger Ignored counter when the image was acquired - Applies to: GigE.
Visibility: Beginner
|
inherited |
X offset of the AOI of the acquired image - Applies to: GigE.
Visibility: Beginner
|
inherited |
Y offset of the AOI of the acquired image - Applies to: GigE.
Visibility: Beginner
|
inherited |
CRC checksum of the acquired image - Applies to: GigE and ace 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
|
inherited |
Indicates the pixel format of the acquired image - Applies to: GigE.
Visibility: Beginner
|
inherited |
Index of the active sequencer set - Applies to: ace USB.
Visibility: Beginner
|
inherited |
Sequence set index number related to the acquired image - Applies to: GigE.
Visibility: Beginner
|
inherited |
Value of the Shaft Encoder counter when the image was acquired - Applies to: GigE.
Visibility: Beginner
|
inherited |
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.
Visibility: Beginner
|
inherited |
Value of the timestamp when the image was acquired - Applies to: GigE and ace USB.
Visibility: Beginner
|
inherited |
Value of the Trigger Input counter when the image was acquired - Applies to: GigE.
Visibility: Beginner
|
inherited |
Status of all of the camera's virtual input and output lines when the image was acquired - Applies to: GigE.
Visibility: Beginner
|
inherited |
Width of the AOI of the acquired image - Applies to: GigE.
Visibility: Beginner