Class Spinnaker::ChunkData¶

ClassList > Spinnaker > ChunkData

The chunk data which contains additional information about an image.

#include <ChunkData.h>

Inherits the following classes: Spinnaker::IChunkData

Public Functions¶

Type	Name
	ChunkData ()
	ChunkData (const ChunkData & src)
virtual float64_t	GetBlackLevel () const
virtual int64_t	GetCRC () const
virtual int64_t	GetCompressionMode () const
virtual float64_t	GetCompressionRatio () const
virtual int64_t	GetCounterValue () const
virtual int64_t	GetCurrentDatarate () const
virtual bool	GetEnable () const
virtual int64_t	GetEncoderValue () const
virtual int64_t	GetExposureEndLineStatusAll () const
virtual float64_t	GetExposureTime () const
virtual int64_t	GetFrameID () const
virtual float64_t	GetGain () const
virtual int64_t	GetHeight () const
virtual int64_t	GetImage () const
virtual InferenceBoundingBoxResult	GetInferenceBoundingBoxResult () const
virtual float64_t	GetInferenceConfidence () const
virtual int64_t	GetInferenceFrameId () const
virtual int64_t	GetInferenceResult () const
virtual int64_t	GetLargePenalty () const
virtual int64_t	GetLinePitch () const
virtual int64_t	GetLineStatusAll () const
virtual float64_t	GetMaxZ () const
virtual float64_t	GetMinZ () const
virtual bool	GetModeActive () const
virtual int64_t	GetOffsetX () const
virtual int64_t	GetOffsetY () const
virtual int64_t	GetPartSelector () const
virtual int64_t	GetPixelDynamicRangeMax () const
virtual int64_t	GetPixelDynamicRangeMin () const
virtual float64_t	GetScan3dAxisMax () const
virtual float64_t	GetScan3dAxisMin () const
virtual float64_t	GetScan3dBaseline () const
virtual float64_t	GetScan3dCoordinateOffset () const
virtual float64_t	GetScan3dCoordinateReferenceValue () const
virtual float64_t	GetScan3dCoordinateScale () const
virtual float64_t	GetScan3dFocalLength () const
virtual bool	GetScan3dInvalidDataFlag () const
virtual float64_t	GetScan3dInvalidDataValue () const
virtual float64_t	GetScan3dPrincipalPointU () const
virtual float64_t	GetScan3dPrincipalPointV () const
virtual float64_t	GetScan3dTransformValue () const
virtual int64_t	GetScanLineSelector () const
virtual int64_t	GetSequencerSetActive () const
virtual uint8_t *	GetSerialData () const
virtual int64_t	GetSerialDataLength () const
virtual bool	GetSerialReceiveOverflow () const
virtual int64_t	GetSmallPenalty () const
virtual int64_t	GetStereoHeight () const
virtual int64_t	GetStereoWidth () const
virtual int64_t	GetStreamChannelID () const
virtual float64_t	GetTimerValue () const
virtual int64_t	GetTimestamp () const
virtual int64_t	GetTimestampLatchValue () const
virtual int64_t	GetTransferBlockID () const
virtual int64_t	GetTransferQueueCurrentBlockCount () const
virtual int64_t	GetUniquenessRatio () const
virtual int64_t	GetWidth () const
virtual void	SetChunks (GenApi::INodeMap & pNodeMap)
ChunkData &	operator= (const ChunkData & chunk)
virtual	~ChunkData (void)

Public Functions inherited from Spinnaker::IChunkData¶

See Spinnaker::IChunkData

Type	Name
virtual float64_t	GetBlackLevel () const = 0
virtual int64_t	GetCRC () const = 0
virtual int64_t	GetCompressionMode () const = 0
virtual float64_t	GetCompressionRatio () const = 0
virtual int64_t	GetCounterValue () const = 0
virtual int64_t	GetCurrentDatarate () const = 0
virtual bool	GetEnable () const = 0
virtual int64_t	GetEncoderValue () const = 0
virtual int64_t	GetExposureEndLineStatusAll () const = 0
virtual float64_t	GetExposureTime () const = 0
virtual int64_t	GetFrameID () const = 0
virtual float64_t	GetGain () const = 0
virtual int64_t	GetHeight () const = 0
virtual int64_t	GetImage () const = 0
virtual InferenceBoundingBoxResult	GetInferenceBoundingBoxResult () const = 0
virtual float64_t	GetInferenceConfidence () const = 0
virtual int64_t	GetInferenceFrameId () const = 0
virtual int64_t	GetInferenceResult () const = 0
virtual int64_t	GetLargePenalty () const = 0
virtual int64_t	GetLinePitch () const = 0
virtual int64_t	GetLineStatusAll () const = 0
virtual float64_t	GetMaxZ () const = 0
virtual float64_t	GetMinZ () const = 0
virtual bool	GetModeActive () const = 0
virtual int64_t	GetOffsetX () const = 0
virtual int64_t	GetOffsetY () const = 0
virtual int64_t	GetPartSelector () const = 0
virtual int64_t	GetPixelDynamicRangeMax () const = 0
virtual int64_t	GetPixelDynamicRangeMin () const = 0
virtual float64_t	GetScan3dAxisMax () const = 0
virtual float64_t	GetScan3dAxisMin () const = 0
virtual float64_t	GetScan3dBaseline () const = 0
virtual float64_t	GetScan3dCoordinateOffset () const = 0
virtual float64_t	GetScan3dCoordinateReferenceValue () const = 0
virtual float64_t	GetScan3dCoordinateScale () const = 0
virtual float64_t	GetScan3dFocalLength () const = 0
virtual bool	GetScan3dInvalidDataFlag () const = 0
virtual float64_t	GetScan3dInvalidDataValue () const = 0
virtual float64_t	GetScan3dPrincipalPointU () const = 0
virtual float64_t	GetScan3dPrincipalPointV () const = 0
virtual float64_t	GetScan3dTransformValue () const = 0
virtual int64_t	GetScanLineSelector () const = 0
virtual int64_t	GetSequencerSetActive () const = 0
virtual uint8_t *	GetSerialData () const = 0
virtual int64_t	GetSerialDataLength () const = 0
virtual bool	GetSerialReceiveOverflow () const = 0
virtual int64_t	GetSmallPenalty () const = 0
virtual int64_t	GetStereoHeight () const = 0
virtual int64_t	GetStereoWidth () const = 0
virtual int64_t	GetStreamChannelID () const = 0
virtual float64_t	GetTimerValue () const = 0
virtual int64_t	GetTimestamp () const = 0
virtual int64_t	GetTimestampLatchValue () const = 0
virtual int64_t	GetTransferBlockID () const = 0
virtual int64_t	GetTransferQueueCurrentBlockCount () const = 0
virtual int64_t	GetUniquenessRatio () const = 0
virtual int64_t	GetWidth () const = 0
virtual void	SetChunks (GenApi::INodeMap & pNodeMap) = 0
virtual	~IChunkData ()

Protected Attributes inherited from Spinnaker::IChunkData¶

See Spinnaker::IChunkData

Type	Name
ChunkDataData *	m_pChunkDataData

Protected Functions inherited from Spinnaker::IChunkData¶

See Spinnaker::IChunkData

Type	Name
	IChunkData ()

Public Functions Documentation¶

function ChunkData [1/2]¶

Spinnaker::ChunkData::ChunkData ()

function ChunkData [2/2]¶

Spinnaker::ChunkData::ChunkData (
    const ChunkData & src
)

function GetBlackLevel¶

virtual float64_t Spinnaker::ChunkData::GetBlackLevel () const

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

Implements Spinnaker::IChunkData::GetBlackLevel

function GetCRC¶

virtual int64_t Spinnaker::ChunkData::GetCRC () const

Description: Returns the CRC of the image payload. Visibility:

Implements Spinnaker::IChunkData::GetCRC

function GetCompressionMode¶

virtual int64_t Spinnaker::ChunkData::GetCompressionMode () const

Description: Visibility:

Implements Spinnaker::IChunkData::GetCompressionMode

function GetCompressionRatio¶

virtual float64_t Spinnaker::ChunkData::GetCompressionRatio () const

Description: Visibility:

Implements Spinnaker::IChunkData::GetCompressionRatio

function GetCounterValue¶

virtual int64_t Spinnaker::ChunkData::GetCounterValue () const

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

Implements Spinnaker::IChunkData::GetCounterValue

function GetCurrentDatarate¶

virtual int64_t Spinnaker::ChunkData::GetCurrentDatarate () const

Description: Visibility:

Implements Spinnaker::IChunkData::GetCurrentDatarate

function GetEnable¶

virtual bool Spinnaker::ChunkData::GetEnable () const

Description: Enables the inclusion of the selected Chunk data in the payload of the image. Visibility:

Implements Spinnaker::IChunkData::GetEnable

function GetEncoderValue¶

virtual int64_t Spinnaker::ChunkData::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. Visibility: Expert

Implements Spinnaker::IChunkData::GetEncoderValue

function GetExposureEndLineStatusAll¶

virtual int64_t Spinnaker::ChunkData::GetExposureEndLineStatusAll () const

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

Implements Spinnaker::IChunkData::GetExposureEndLineStatusAll

function GetExposureTime¶

virtual float64_t Spinnaker::ChunkData::GetExposureTime () const

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

Implements Spinnaker::IChunkData::GetExposureTime

function GetFrameID¶

virtual int64_t Spinnaker::ChunkData::GetFrameID () const

Description: Returns the image frame ID. Visibility:

Implements Spinnaker::IChunkData::GetFrameID

function GetGain¶

virtual float64_t Spinnaker::ChunkData::GetGain () const

Description: Returns the gain used to capture the image. Visibility:

Implements Spinnaker::IChunkData::GetGain

function GetHeight¶

virtual int64_t Spinnaker::ChunkData::GetHeight () const

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

Implements Spinnaker::IChunkData::GetHeight

function GetImage¶

virtual int64_t Spinnaker::ChunkData::GetImage () const

Description: Returns the image payload. Visibility:

Implements Spinnaker::IChunkData::GetImage

function GetInferenceBoundingBoxResult¶

virtual InferenceBoundingBoxResult Spinnaker::ChunkData::GetInferenceBoundingBoxResult () const

Description: Returns the chunk inference bounding box result data. Visibility: Expert

Implements Spinnaker::IChunkData::GetInferenceBoundingBoxResult

function GetInferenceConfidence¶

virtual float64_t Spinnaker::ChunkData::GetInferenceConfidence () const

Description: Returns the chunk data inference confidence percentage. Visibility: Expert

Implements Spinnaker::IChunkData::GetInferenceConfidence

function GetInferenceFrameId¶

virtual int64_t Spinnaker::ChunkData::GetInferenceFrameId () const

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

Implements Spinnaker::IChunkData::GetInferenceFrameId

function GetInferenceResult¶

virtual int64_t Spinnaker::ChunkData::GetInferenceResult () const

Description: Returns the chunk data inference result. Visibility: Expert

Implements Spinnaker::IChunkData::GetInferenceResult

function GetLargePenalty¶

virtual int64_t Spinnaker::ChunkData::GetLargePenalty () const

Description: Returns the penalty when the change of Disparity Change is plus or minus 1. Visibility: Expert

Implements Spinnaker::IChunkData::GetLargePenalty

function GetLinePitch¶

virtual int64_t Spinnaker::ChunkData::GetLinePitch () const

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

Implements Spinnaker::IChunkData::GetLinePitch

function GetLineStatusAll¶

virtual int64_t Spinnaker::ChunkData::GetLineStatusAll () const

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

Implements Spinnaker::IChunkData::GetLineStatusAll

function GetMaxZ¶

virtual float64_t Spinnaker::ChunkData::GetMaxZ () const

Description: Returns the maximum depth in meters for the point cloud range. Visibility: Expert

Implements Spinnaker::IChunkData::GetMaxZ

function GetMinZ¶

virtual float64_t Spinnaker::ChunkData::GetMinZ () const

Description: Returns the minimum depth in meters for the point cloud range. Visibility: Expert

Implements Spinnaker::IChunkData::GetMinZ

function GetModeActive¶

virtual bool Spinnaker::ChunkData::GetModeActive () const

Description: Activates the inclusion of Chunk data in the payload of the image. Visibility:

Implements Spinnaker::IChunkData::GetModeActive

function GetOffsetX¶

virtual int64_t Spinnaker::ChunkData::GetOffsetX () const

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

Implements Spinnaker::IChunkData::GetOffsetX

function GetOffsetY¶

virtual int64_t Spinnaker::ChunkData::GetOffsetY () const

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

Implements Spinnaker::IChunkData::GetOffsetY

function GetPartSelector¶

virtual int64_t Spinnaker::ChunkData::GetPartSelector () const

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

Implements Spinnaker::IChunkData::GetPartSelector

function GetPixelDynamicRangeMax¶

virtual int64_t Spinnaker::ChunkData::GetPixelDynamicRangeMax () const

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

Implements Spinnaker::IChunkData::GetPixelDynamicRangeMax

function GetPixelDynamicRangeMin¶

virtual int64_t Spinnaker::ChunkData::GetPixelDynamicRangeMin () const

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

Implements Spinnaker::IChunkData::GetPixelDynamicRangeMin

function GetScan3dAxisMax¶

virtual float64_t Spinnaker::ChunkData::GetScan3dAxisMax () const

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

Implements Spinnaker::IChunkData::GetScan3dAxisMax

function GetScan3dAxisMin¶

virtual float64_t Spinnaker::ChunkData::GetScan3dAxisMin () const

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

Implements Spinnaker::IChunkData::GetScan3dAxisMin

function GetScan3dBaseline¶

virtual float64_t Spinnaker::ChunkData::GetScan3dBaseline () const

Description: Returns the baseline as the physical distance of two cameras in a stereo camera setup. The value of this feature can be used for 3D reconstruction from disparity images. In this case, the unit of the 3D coordinates corresponds to the unit of the baseline. Visibility: Expert

Implements Spinnaker::IChunkData::GetScan3dBaseline

function GetScan3dCoordinateOffset¶

virtual float64_t Spinnaker::ChunkData::GetScan3dCoordinateOffset () const

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

Implements Spinnaker::IChunkData::GetScan3dCoordinateOffset

function GetScan3dCoordinateReferenceValue¶

virtual float64_t Spinnaker::ChunkData::GetScan3dCoordinateReferenceValue () const

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 Spinnaker::IChunkData::GetScan3dCoordinateReferenceValue

function GetScan3dCoordinateScale¶

virtual float64_t Spinnaker::ChunkData::GetScan3dCoordinateScale () const

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

Implements Spinnaker::IChunkData::GetScan3dCoordinateScale

function GetScan3dFocalLength¶

virtual float64_t Spinnaker::ChunkData::GetScan3dFocalLength () const

Description: Returns the focal length of the camera in pixel. The focal length depends on the selected region. The value of this feature takes into account horizontal binning, decimation, or any other function changing the image resolution. Visibility: Expert

Implements Spinnaker::IChunkData::GetScan3dFocalLength

function GetScan3dInvalidDataFlag¶

virtual bool Spinnaker::ChunkData::GetScan3dInvalidDataFlag () const

Description: Returns if a specific non-valid data flag is used in the data stream. Visibility: Expert

Implements Spinnaker::IChunkData::GetScan3dInvalidDataFlag

function GetScan3dInvalidDataValue¶

virtual float64_t Spinnaker::ChunkData::GetScan3dInvalidDataValue () const

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

Implements Spinnaker::IChunkData::GetScan3dInvalidDataValue

function GetScan3dPrincipalPointU¶

virtual float64_t Spinnaker::ChunkData::GetScan3dPrincipalPointU () const

Description: Returns the value of this feature gives the horizontal position of the principal point, relative to the region origin, i.e. OffsetX. The value of this feature takes into account horizontal binning, decimation, or any other function changing the image resolution. Visibility: Expert

Implements Spinnaker::IChunkData::GetScan3dPrincipalPointU

function GetScan3dPrincipalPointV¶

virtual float64_t Spinnaker::ChunkData::GetScan3dPrincipalPointV () const

Description: Returns the value of this feature gives the vertical position of the principal point, relative to the region origin, i.e. OffsetY. The value of this feature takes into account vertical binning, decimation, or any other function changing the image resolution. Visibility: Expert

Implements Spinnaker::IChunkData::GetScan3dPrincipalPointV

function GetScan3dTransformValue¶

virtual float64_t Spinnaker::ChunkData::GetScan3dTransformValue () const

Description: Returns the transform value. Visibility: Expert

Implements Spinnaker::IChunkData::GetScan3dTransformValue

function GetScanLineSelector¶

virtual int64_t Spinnaker::ChunkData::GetScanLineSelector () const

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

Implements Spinnaker::IChunkData::GetScanLineSelector

function GetSequencerSetActive¶

virtual int64_t Spinnaker::ChunkData::GetSequencerSetActive () const

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

Implements Spinnaker::IChunkData::GetSequencerSetActive

function GetSerialData¶

virtual uint8_t * Spinnaker::ChunkData::GetSerialData () const

Description: Returns the serial data that was received. Visibility:

Implements Spinnaker::IChunkData::GetSerialData

function GetSerialDataLength¶

virtual int64_t Spinnaker::ChunkData::GetSerialDataLength () const

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

Implements Spinnaker::IChunkData::GetSerialDataLength

function GetSerialReceiveOverflow¶

virtual bool Spinnaker::ChunkData::GetSerialReceiveOverflow () const

Description: Returns the status of the chunk serial receive overflow. Visibility:

Implements Spinnaker::IChunkData::GetSerialReceiveOverflow

function GetSmallPenalty¶

virtual int64_t Spinnaker::ChunkData::GetSmallPenalty () const

Description: Returns the penalty when the change of Disparity Change is plus or minus 1. Visibility: Expert

Implements Spinnaker::IChunkData::GetSmallPenalty

function GetStereoHeight¶

virtual int64_t Spinnaker::ChunkData::GetStereoHeight () const

Description: Returns the height of the image after stereo processing by the device (in pixels). Visibility: Expert

Implements Spinnaker::IChunkData::GetStereoHeight

function GetStereoWidth¶

virtual int64_t Spinnaker::ChunkData::GetStereoWidth () const

Description: Returns the width of the image after stereo processing by the device (in pixels). Visibility: Expert

Implements Spinnaker::IChunkData::GetStereoWidth

function GetStreamChannelID¶

virtual int64_t Spinnaker::ChunkData::GetStreamChannelID () const

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

Implements Spinnaker::IChunkData::GetStreamChannelID

function GetTimerValue¶

virtual float64_t Spinnaker::ChunkData::GetTimerValue () const

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

Implements Spinnaker::IChunkData::GetTimerValue

function GetTimestamp¶

virtual int64_t Spinnaker::ChunkData::GetTimestamp () const

Description: Returns the Timestamp of the image. Visibility:

Implements Spinnaker::IChunkData::GetTimestamp

function GetTimestampLatchValue¶

virtual int64_t Spinnaker::ChunkData::GetTimestampLatchValue () const

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

Implements Spinnaker::IChunkData::GetTimestampLatchValue

function GetTransferBlockID¶

virtual int64_t Spinnaker::ChunkData::GetTransferBlockID () const

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

Implements Spinnaker::IChunkData::GetTransferBlockID

function GetTransferQueueCurrentBlockCount¶

virtual int64_t Spinnaker::ChunkData::GetTransferQueueCurrentBlockCount () const

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

Implements Spinnaker::IChunkData::GetTransferQueueCurrentBlockCount

function GetUniquenessRatio¶

virtual int64_t Spinnaker::ChunkData::GetUniquenessRatio () const

Description: Returns the difference between the best matching disparity and the second-best matching disparity. Visibility: Expert

Implements Spinnaker::IChunkData::GetUniquenessRatio

function GetWidth¶

virtual int64_t Spinnaker::ChunkData::GetWidth () const

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

Implements Spinnaker::IChunkData::GetWidth

function SetChunks¶

virtual void Spinnaker::ChunkData::SetChunks (
    GenApi::INodeMap & pNodeMap
)

Implements Spinnaker::IChunkData::SetChunks

function operator=¶

ChunkData & Spinnaker::ChunkData::operator= (
    const ChunkData & chunk
)

function ~ChunkData¶

virtual Spinnaker::ChunkData::~ChunkData (
    void
)

Friends Documentation¶

friend ChunkDataImpl¶

class Spinnaker::ChunkData::ChunkDataImpl (
    ChunkDataImpl
)

The documentation for this class was generated from the following file C:/workspace/include/ChunkData.h