Skip to main content

DetectionResult

Represents a single object detection result.

Properties:

Property

Type

Description

class_name

str

Detection class name

class_id

int

Detection class ID

confidence

float

Confidence score, typically in the range 0.0 ~ 1.0

bbox

BoundingBox2D

2D bounding box

mask

object | None

Segmentation mask or other model extension outputs

keypoints

object | None

Keypoints or other model extension outputs

distance_m

float | None

Distance estimation in m

DetectionResult​

Signature:

DetectionResult(
class_name: str,
class_id: int,
confidence: float,
bbox: BoundingBox2D,
mask: object | None = None,
keypoints: object | None = None,
distance_m: float | None = None,
)

Description:

Constructs a DetectionResult instance. This type is an immutable dataclass.

Parameters:

Parameter

Type

Required

Description

class_name

str

Yes

Detection class name

class_id

int

Yes

Detection class ID

confidence

float

Yes

Confidence score

bbox

BoundingBox2D

Yes

2D bounding box

mask

object | None

No

Segmentation mask or other model extension outputs

keypoints

object | None

No

Keypoints or other model extension outputs

distance_m

float | None

No

Distance estimation in m

Returns:

DetectionResult instance.

Raises:

None.

to_dict​

Signature:

DetectionResult.to_dict() -> dict[str, Any]

Description:

Convert to a dictionary containing class_name / class_id / confidence / bbox; extended fields mask / keypoints / distance_m are not included.

Parameters:

No parameters.

Returns:

dict[str, Any].

Raises:

None.