PySpin.ChunkData

class ChunkData(*args)

The chunk data which contains additional information about an image.

GetBlackLevel(self) → float64_t

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

GetCRC(self) → int64_t

Spinnaker::ChunkData::GetCRC Description: Returns the CRC of the image payload. Visibility:

GetCompressionMode(self) → int64_t

Spinnaker::ChunkData::GetCompressionMode Description: Visibility:

GetCompressionRatio(self) → float64_t

Spinnaker::ChunkData::GetCompressionRatio Description: Visibility:

GetCounterValue(self) → int64_t

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

GetCurrentDatarate(self) → int64_t

Spinnaker::ChunkData::GetCurrentDatarate Description: Visibility:

GetEnable(self) → bool

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

GetEncoderValue(self) → int64_t

Spinnaker::ChunkData::GetEncoderValue 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

GetExposureEndLineStatusAll(self) → int64_t

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

GetExposureTime(self) → float64_t

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

GetFrameID(self) → int64_t

Spinnaker::ChunkData::GetFrameID Description: Returns the image frame ID. Visibility:

GetGain(self) → float64_t

Spinnaker::ChunkData::GetGain Description: Returns the gain used to capture the image. Visibility:

GetHeight(self) → int64_t

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

GetImage(self) → int64_t

Spinnaker::ChunkData::GetImage Description: Returns the image payload. Visibility:

GetInferenceBoundingBoxResult(self) → InferenceBoundingBoxResult

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

GetInferenceConfidence(self) → float64_t

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

GetInferenceFrameId(self) → int64_t

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

GetInferenceResult(self) → int64_t

Spinnaker::ChunkData::GetInferenceResult Description: Returns the chunk data inference result. Visibility: Expert

GetLargePenalty(self) → int64_t

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

GetLinePitch(self) → int64_t

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

GetLineStatusAll(self) → int64_t

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

GetMaxZ(self) → float64_t

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

GetMinZ(self) → float64_t

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

GetModeActive(self) → bool

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

GetOffsetX(self) → int64_t

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

GetOffsetY(self) → int64_t

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

GetPartSelector(self) → int64_t

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

GetPixelDynamicRangeMax(self) → int64_t

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

GetPixelDynamicRangeMin(self) → int64_t

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

GetScan3dAxisMax(self) → float64_t

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

GetScan3dAxisMin(self) → float64_t

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

GetScan3dBaseline(self) → float64_t

Spinnaker::ChunkData::GetScan3dBaseline 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

GetScan3dCoordinateOffset(self) → float64_t

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

GetScan3dCoordinateReferenceValue(self) → float64_t

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

GetScan3dCoordinateScale(self) → float64_t

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

GetScan3dFocalLength(self) → float64_t

Spinnaker::ChunkData::GetScan3dFocalLength 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

GetScan3dInvalidDataFlag(self) → bool

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

GetScan3dInvalidDataValue(self) → float64_t

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

GetScan3dPrincipalPointU(self) → float64_t

Spinnaker::ChunkData::GetScan3dPrincipalPointU 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

GetScan3dPrincipalPointV(self) → float64_t

Spinnaker::ChunkData::GetScan3dPrincipalPointV 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

GetScan3dTransformValue(self) → float64_t

Spinnaker::ChunkData::GetScan3dTransformValue Description: Returns the transform value. Visibility: Expert

GetScanLineSelector(self) → int64_t

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

GetSequencerSetActive(self) → int64_t

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

GetSerialData(self) → uint8_t *

Spinnaker::ChunkData::GetSerialData Description: Returns the serial data that was received. Visibility:

GetSerialDataLength(self) → int64_t

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

GetSerialReceiveOverflow(self) → bool

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

GetSmallPenalty(self) → int64_t

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

GetStereoHeight(self) → int64_t

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

GetStereoWidth(self) → int64_t

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

GetStreamChannelID(self) → int64_t

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

GetTimerValue(self) → float64_t

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

GetTimestamp(self) → int64_t

Spinnaker::ChunkData::GetTimestamp Description: Returns the Timestamp of the image. Visibility:

GetTimestampLatchValue(self) → int64_t

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

GetTransferBlockID(self) → int64_t

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

GetTransferQueueCurrentBlockCount(self) → int64_t

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

GetUniquenessRatio(self) → int64_t

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

GetWidth(self) → int64_t

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

SetChunks(self, pNodeMap)

Parameters

pNodeMap: Spinnaker::GenApi::INodeMap &

Spinnaker::ChunkData::SetChunks