Spinnaker C++
3.1.0.78
Public Member Functions | Friends | List of all members
ChunkData Class Reference

The chunk data which contains additional information about an image. More...

Inheritance diagram for ChunkData:
IChunkData

Public Member Functions

 ChunkData ()
 
 ChunkData (const ChunkData &src)
 
virtual ~ChunkData (void)
 
void SetChunks (GenApi::INodeMap &pNodeMap)
 
float64_t GetBlackLevel () const
 Description: Returns the black level used to capture the image. More...
 
int64_t GetFrameID () const
 Description: Returns the image frame ID. More...
 
float64_t GetExposureTime () const
 Description: Returns the exposure time used to capture the image. More...
 
int64_t GetCompressionMode () const
 Description: Returns the compression mode of the last image payload. More...
 
float64_t GetCompressionRatio () const
 Description: Returns the compression ratio of the last image payload. More...
 
int64_t GetTimestamp () const
 Description: Returns the Timestamp of the image. More...
 
int64_t GetExposureEndLineStatusAll () const
 Description: Returns the status of all the I/O lines at the end of exposure event. More...
 
int64_t GetWidth () const
 Description: Returns the width of the image included in the payload. More...
 
int64_t GetImage () const
 Description: Returns the image payload. More...
 
int64_t GetHeight () const
 Description: Returns the height of the image included in the payload. More...
 
float64_t GetGain () const
 Description: Returns the gain used to capture the image. More...
 
int64_t GetSequencerSetActive () const
 Description: Returns the index of the active set of the running sequencer included in the payload. More...
 
int64_t GetCRC () const
 Description: Returns the CRC of the image payload. More...
 
int64_t GetOffsetX () const
 Description: Returns the Offset X of the image included in the payload. More...
 
int64_t GetOffsetY () const
 Description: Returns the Offset Y of the image included in the payload. More...
 
int64_t GetSerialDataLength () const
 Description: Returns the length of the received serial data that was included in the payload. More...
 
int64_t GetPartSelector () const
 Description: Selects the part to access in chunk data in a multipart transmission. More...
 
int64_t GetPixelDynamicRangeMin () const
 Description: Returns the minimum value of dynamic range of the image included in the payload. More...
 
int64_t GetPixelDynamicRangeMax () const
 Description: Returns the maximum value of dynamic range of the image included in the payload. More...
 
int64_t GetTimestampLatchValue () const
 Description: Returns the last Timestamp latched with the TimestampLatch command. More...
 
int64_t GetLineStatusAll () const
 Description: Returns the status of all the I/O lines at the time of the FrameStart internal event. More...
 
int64_t GetCounterValue () const
 Description: Returns the value of the selected Chunk counter at the time of the FrameStart event. More...
 
float64_t GetTimerValue () const
 Description: Returns the value of the selected Timer at the time of the FrameStart internal event. More...
 
int64_t GetScanLineSelector () const
 Description: Index for vector representation of one chunk value per line in an image. More...
 
int64_t GetEncoderValue () const
 Description: Returns the counter's value of the selected Encoder at the time of the FrameStart in area scan mode or the counter's value at the time of the LineStart selected by ChunkScanLineSelector in LineScan mode. More...
 
int64_t GetLinePitch () const
 Description: Returns the LinePitch of the image included in the payload. More...
 
int64_t GetTransferBlockID () const
 Description: Returns the unique identifier of the transfer block used to transport the payload. More...
 
int64_t GetTransferQueueCurrentBlockCount () const
 Description: Returns the current number of blocks in the transfer queue. More...
 
int64_t GetStreamChannelID () const
 Description: Returns identifier of the stream channel used to carry the block. More...
 
float64_t GetScan3dCoordinateScale () const
 Description: Returns the Scale for the selected coordinate axis of the image included in the payload. More...
 
float64_t GetScan3dCoordinateOffset () const
 Description: Returns the Offset for the selected coordinate axis of the image included in the payload. More...
 
float64_t GetScan3dInvalidDataValue () const
 Description: Returns the Invalid Data Value used for the image included in the payload. More...
 
float64_t GetScan3dAxisMin () const
 Description: Returns the Minimum Axis value for the selected coordinate axis of the image included in the payload. More...
 
float64_t GetScan3dAxisMax () const
 Description: Returns the Maximum Axis value for the selected coordinate axis of the image included in the payload. More...
 
float64_t GetScan3dTransformValue () const
 Description: Returns the transform value. More...
 
float64_t GetScan3dCoordinateReferenceValue () const
 Description: Reads the value of a position or pose coordinate for the anchor or transformed coordinate systems relative to the reference point. More...
 
int64_t GetInferenceFrameId () const
 Description: Returns the frame ID associated with the most recent inference result. More...
 
int64_t GetInferenceResult () const
 Description: Returns the chunk data inference result. More...
 
float64_t GetInferenceConfidence () const
 Description: Returns the chunk data inference confidence percentage. More...
 
InferenceBoundingBoxResult GetInferenceBoundingBoxResult () const
 Description: Returns the chunk inference bounding box result data. More...
 
- Public Member Functions inherited from IChunkData
virtual ~IChunkData ()
 

Friends

class ChunkDataImpl
 

Additional Inherited Members

- Protected Member Functions inherited from IChunkData
 IChunkData ()
 
- Protected Attributes inherited from IChunkData
ChunkDataData * m_pChunkDataData
 

Detailed Description

The chunk data which contains additional information about an image.

Examples:
ActionCommand.cpp, ChunkData.cpp, Compression.cpp, and Inference.cpp.

Constructor & Destructor Documentation

ChunkData ( )
ChunkData ( const ChunkData src)
virtual ~ChunkData ( void  )
virtual

Member Function Documentation

float64_t GetBlackLevel ( ) const
virtual

Description: Returns the black level used to capture the image.

Visibility:

Implements IChunkData.

int64_t GetCompressionMode ( ) const
virtual

Description: Returns the compression mode of the last image payload.

Visibility:

Implements IChunkData.

float64_t GetCompressionRatio ( ) const
virtual

Description: Returns the compression ratio of the last image payload.

Visibility:

Implements IChunkData.

Examples:
Compression.cpp.
int64_t GetCounterValue ( ) const
virtual

Description: Returns the value of the selected Chunk counter at the time of the FrameStart event.

Visibility: Expert

Implements IChunkData.

int64_t GetCRC ( ) const
virtual

Description: Returns the CRC of the image payload.

Visibility:

Implements IChunkData.

Examples:
Compression.cpp.
int64_t GetEncoderValue ( ) const
virtual

Description: Returns the counter's value of the selected Encoder at the time of the FrameStart in area scan mode or the counter's value at the time of the LineStart selected by ChunkScanLineSelector in LineScan mode.

Visibility: Expert

Implements IChunkData.

int64_t GetExposureEndLineStatusAll ( ) const
virtual

Description: Returns the status of all the I/O lines at the end of exposure event.

Visibility:

Implements IChunkData.

float64_t GetExposureTime ( ) const
virtual

Description: Returns the exposure time used to capture the image.

Visibility:

Implements IChunkData.

Examples:
ChunkData.cpp.
int64_t GetFrameID ( ) const
virtual

Description: Returns the image frame ID.

Visibility:

Implements IChunkData.

Examples:
ChunkData.cpp.
float64_t GetGain ( ) const
virtual

Description: Returns the gain used to capture the image.

Visibility:

Implements IChunkData.

Examples:
ChunkData.cpp.
int64_t GetHeight ( ) const
virtual

Description: Returns the height of the image included in the payload.

Visibility:

Implements IChunkData.

Examples:
ChunkData.cpp.
int64_t GetImage ( ) const
virtual

Description: Returns the image payload.

Visibility:

Implements IChunkData.

InferenceBoundingBoxResult GetInferenceBoundingBoxResult ( ) const
virtual

Description: Returns the chunk inference bounding box result data.

Visibility: Expert

Implements IChunkData.

Examples:
Inference.cpp.
float64_t GetInferenceConfidence ( ) const
virtual

Description: Returns the chunk data inference confidence percentage.

Visibility: Expert

Implements IChunkData.

Examples:
Inference.cpp.
int64_t GetInferenceFrameId ( ) const
virtual

Description: Returns the frame ID associated with the most recent inference result.

Visibility: Expert

Implements IChunkData.

Examples:
Inference.cpp.
int64_t GetInferenceResult ( ) const
virtual

Description: Returns the chunk data inference result.

Visibility: Expert

Implements IChunkData.

Examples:
Inference.cpp.
int64_t GetLinePitch ( ) const
virtual

Description: Returns the LinePitch of the image included in the payload.

Visibility: Expert

Implements IChunkData.

int64_t GetLineStatusAll ( ) const
virtual

Description: Returns the status of all the I/O lines at the time of the FrameStart internal event.

Visibility: Expert

Implements IChunkData.

int64_t GetOffsetX ( ) const
virtual

Description: Returns the Offset X of the image included in the payload.

Visibility:

Implements IChunkData.

Examples:
ChunkData.cpp.
int64_t GetOffsetY ( ) const
virtual

Description: Returns the Offset Y of the image included in the payload.

Visibility:

Implements IChunkData.

Examples:
ChunkData.cpp.
int64_t GetPartSelector ( ) const
virtual

Description: Selects the part to access in chunk data in a multipart transmission.

Visibility: Expert

Implements IChunkData.

int64_t GetPixelDynamicRangeMax ( ) const
virtual

Description: Returns the maximum value of dynamic range of the image included in the payload.

Visibility: Expert

Implements IChunkData.

int64_t GetPixelDynamicRangeMin ( ) const
virtual

Description: Returns the minimum value of dynamic range of the image included in the payload.

Visibility: Expert

Implements IChunkData.

float64_t GetScan3dAxisMax ( ) const
virtual

Description: Returns the Maximum Axis value for the selected coordinate axis of the image included in the payload.

Visibility: Expert

Implements IChunkData.

float64_t GetScan3dAxisMin ( ) const
virtual

Description: Returns the Minimum Axis value for the selected coordinate axis of the image included in the payload.

Visibility: Expert

Implements IChunkData.

float64_t GetScan3dCoordinateOffset ( ) const
virtual

Description: Returns the Offset for the selected coordinate axis of the image included in the payload.

Visibility: Expert

Implements IChunkData.

float64_t GetScan3dCoordinateReferenceValue ( ) const
virtual

Description: Reads the value of a position or pose coordinate for the anchor or transformed coordinate systems relative to the reference point.

Visibility: Expert

Implements IChunkData.

float64_t GetScan3dCoordinateScale ( ) const
virtual

Description: Returns the Scale for the selected coordinate axis of the image included in the payload.

Visibility: Expert

Implements IChunkData.

float64_t GetScan3dInvalidDataValue ( ) const
virtual

Description: Returns the Invalid Data Value used for the image included in the payload.

Visibility: Expert

Implements IChunkData.

float64_t GetScan3dTransformValue ( ) const
virtual

Description: Returns the transform value.

Visibility: Expert

Implements IChunkData.

int64_t GetScanLineSelector ( ) const
virtual

Description: Index for vector representation of one chunk value per line in an image.

Visibility: Expert

Implements IChunkData.

int64_t GetSequencerSetActive ( ) const
virtual

Description: Returns the index of the active set of the running sequencer included in the payload.

Visibility:

Implements IChunkData.

Examples:
ChunkData.cpp.
int64_t GetSerialDataLength ( ) const
virtual

Description: Returns the length of the received serial data that was included in the payload.

Visibility:

Implements IChunkData.

int64_t GetStreamChannelID ( ) const
virtual

Description: Returns identifier of the stream channel used to carry the block.

Visibility: Expert

Implements IChunkData.

float64_t GetTimerValue ( ) const
virtual

Description: Returns the value of the selected Timer at the time of the FrameStart internal event.

Visibility: Expert

Implements IChunkData.

int64_t GetTimestamp ( ) const
virtual

Description: Returns the Timestamp of the image.

Visibility:

Implements IChunkData.

Examples:
ActionCommand.cpp, and ChunkData.cpp.
int64_t GetTimestampLatchValue ( ) const
virtual

Description: Returns the last Timestamp latched with the TimestampLatch command.

Visibility: Expert

Implements IChunkData.

int64_t GetTransferBlockID ( ) const
virtual

Description: Returns the unique identifier of the transfer block used to transport the payload.

Visibility: Expert

Implements IChunkData.

int64_t GetTransferQueueCurrentBlockCount ( ) const
virtual

Description: Returns the current number of blocks in the transfer queue.

Visibility: Expert

Implements IChunkData.

int64_t GetWidth ( ) const
virtual

Description: Returns the width of the image included in the payload.

Visibility:

Implements IChunkData.

Examples:
ChunkData.cpp.
void SetChunks ( GenApi::INodeMap pNodeMap)
virtual

Implements IChunkData.

Friends And Related Function Documentation

friend class ChunkDataImpl
friend

The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference