celantur::CelanturDetection Struct Reference

Structure to hold information about a detection made by the Celantur SDK. More...

#include <CelanturDetection.h>

Public Member Functions
int	get_area () const

Public Attributes
int	class_id {0}
	Celantur class ID. More...
std::string	class_name {}
	Human-readable class name like "face" or "license_plate". More...
float	confidence {0.0}
	Confidence score of the detection, between 0 and 1 (1 means 100% confidence) More...
cv::Rect	box {}
	Bounding box of the detection in the format (x, y, width, height) More...
int	model_class_id {0}
	Model-specific class ID, which may differ from the Celantur class ID; not needed to the end user. More...
std::optional< cv::Mat >	segm_mask {std::nullopt}
	Optional segmentation mask for the detection, if available. More...

Detailed Description

Structure to hold information about a detection made by the Celantur SDK.

This structure contains details about the detected object, including its class ID, class name, confidence score, bounding box, model-specific class ID, and an optional segmentation mask. Is returned by the CelanturSDK::Processor after processing an image or a frame.

Check also Detection Utilities for utility functions to work with detections.

Member Function Documentation

get_area()

int celantur::CelanturDetection::get_area

(

)

const

Member Data Documentation

box

cv::Rect celantur::CelanturDetection::box {}

Bounding box of the detection in the format (x, y, width, height)

class_id

int celantur::CelanturDetection::class_id {0}

Celantur class ID.

See also

celantur::CelanturClassId

class_name

std::string celantur::CelanturDetection::class_name {}

Human-readable class name like "face" or "license_plate".

confidence

float celantur::CelanturDetection::confidence {0.0}

Confidence score of the detection, between 0 and 1 (1 means 100% confidence)

model_class_id

int celantur::CelanturDetection::model_class_id {0}

Model-specific class ID, which may differ from the Celantur class ID; not needed to the end user.

segm_mask

std::optional<cv::Mat> celantur::CelanturDetection::segm_mask {std::nullopt}

Optional segmentation mask for the detection, if available.