Common module

Collaboration diagram for Common module:

Modules
	Common parameters
	Compilation Parameters
	CPU Info
	Detection Utilities
	Utilities to work with celantur::CelanturDetection.
	Image Encoding
	Utilities for encoding and decoding images in JPEG formats, including handling EXIF metadata.

Classes
struct	celantur::CelanturDetection
	Structure to hold information about a detection made by the Celantur SDK. More...
class	celantur::ModelCompileException
	Exception class for errors during model compilation. This exception is thrown when there are issues encountered while compiling a machine learning model. More...
class	celantur::ModelLoadException
	Exception class for errors during model loading. This exception is thrown when there are issues encountered while loading a machine learning model. More...
class	celantur::DimensionMismatchException
	Exception class for dimension mismatches. This exception is thrown when there is a mismatch in expected dimensions, such as input size or tensor shapes. More...
class	celantur::WrongConfig
	Exception that is getting thrown in case the user tries to set wrong configuration for the processor, for example, if the detection type is lower than the blur type. More...
struct	celantur::DetectionProcessingConfig
	Configuration that describes processing of a particular class This structure contains the type of blurring to be applied to detections of a specific class. More...
struct	celantur::ProcessorParams
	Structure to hold parameters for the image processor. This structure contains various settings for configuring the image processing. More...
struct	celantur::ImageMetadata
	Metadata associated with an image or frame. for now, just a placeholder. More...
struct	celantur::FrameMetadata
	Metadata associated with a video frame. for now, just a placeholder. More...
struct	celantur::MatContainer
	Container for an image and its associated metadata. for now, just a placeholder. More...
struct	celantur::MinOptMaxDims
	A tuple representing minimum, optimal, and maximum dimensions. This tuple is used to specify the range of dimensions for model optimization. The three integers represent the minimum, optimal, and maximum dimensions respectively. More...
struct	celantur::ModelThresholds
	Structure to hold model threshold values for different object classes. This structure contains threshold values for detecting faces, license plates, persons, and vehicles. Class ids are identical to the celantur container. More...
struct	celantur::CPUInfo
	Structure to hold CPU information. More...
struct	celantur::Dims
	Structure to hold dimensions information. This structure contains the name, number of dimensions, dimension sizes, and whether it is an input dimension. More...
struct	celantur::ExifMetadata
	Structure to manage EXIF metadata for images. This structure encapsulates EXIF data and provides methods to manipulate and retrieve information from it. It is used in conjunction with JPEG encoding and decoding functions to preserve image metadata. More...

Typedefs
typedef std::map< std::string, std::any >	celantur::InferenceEnginePluginSettings
	The settings for the inference engine used during runtime. The settings are passed as a map of key-value pairs. More...
typedef std::map< std::string, std::any >	celantur::InferenceEnginePluginCompileSettings
	The settings for compiling the model for the inference engine. The settings are passed as a map of key-value pairs. More...

Enumerations
enum class	celantur::Rotation { celantur::None = 0 , celantur::Rotated90Clockwise = 1 , celantur::Rotated180 = 2 , celantur::Rotated90CounterClockwise = 3 }
	Enum to represent image rotation states. is used in celantur::FrameMetadata to describe the rotation of the frame. More...
enum class	celantur::LogSeverity { celantur::Error , celantur::Warning , celantur::Debug }
	Enumeration for different log severity levels. More...

Functions
std::ostream &	celantur::operator<< (std::ostream &os, const celantur::BlurType &blur_type)
std::istream &	celantur::operator>> (std::istream &os, celantur::BlurType &blur_type)
std::ostream &	celantur::operator<< (std::ostream &os, const celantur::DetectionType &blur_type)
std::istream &	celantur::operator>> (std::istream &os, celantur::DetectionType &blur_type)
std::ostream &	celantur::operator<< (std::ostream &os, const celantur::CelanturClassId &id)
std::istream &	celantur::operator>> (std::istream &os, celantur::CelanturClassId &id)
std::istream &	celantur::operator>> (std::istream &in, celantur::OptimisationLevel &opt_level)
std::ostream &	celantur::operator<< (std::ostream &out, const celantur::OptimisationLevel &opt_level)
std::istream &	celantur::operator>> (std::istream &in, celantur::CompilePrecision &precision)
std::ostream &	celantur::operator<< (std::ostream &out, const celantur::CompilePrecision &precision)
std::istream &	celantur::operator>> (std::istream &in, celantur::MinOptMaxDims &dims)
std::ostream &	celantur::operator<< (std::ostream &out, const celantur::MinOptMaxDims &dims)
std::istream &	celantur::operator>> (std::istream &in, celantur::InferenceEnginePluginId &plugin_id)
std::ostream &	celantur::operator<< (std::ostream &out, const celantur::InferenceEnginePluginId &plugin_id)
std::istream &	celantur::operator>> (std::istream &in, celantur::LogSeverity &log_severity)
std::ostream &	celantur::operator<< (std::ostream &out, const celantur::LogSeverity &log_severity)
std::string	celantur::detection_to_yolo_repr (const CelanturDetection &detection, const cv::Size &image_size)
std::string	celantur::detections_to_yolo_repr (const std::vector< CelanturDetection > &detections, const cv::Size &image_size)

Variables
const PerTypeProcessingConfig	celantur::FACE_LICENSE_PLATE_PROCESSING_CONFIG
	Default per-type processing configuration. More...
const PerTypeProcessingConfig	celantur::DEFAULT_PER_TYPE_PROCESSING_CONFIG = FACE_LICENSE_PLATE_PROCESSING_CONFIG
const PerTypeProcessingConfig	celantur::PERSON_VEHICLE_PROCESSING_CONFIG
const PerTypeProcessingConfig	celantur::DETECT_ONLY_CONFIG

Detailed Description

Typedef Documentation

InferenceEnginePluginCompileSettings

typedef std::map<std::string, std::any > celantur::InferenceEnginePluginCompileSettings

The settings for compiling the model for the inference engine. The settings are passed as a map of key-value pairs.

InferenceEnginePluginSettings

typedef std::map<std::string, std::any > celantur::InferenceEnginePluginSettings

The settings for the inference engine used during runtime. The settings are passed as a map of key-value pairs.

Enumeration Type Documentation

LogSeverity

enum celantur::LogSeverity

strong

Enumeration for different log severity levels.

used to set the logging verbosity of the inference engine (if available)

Enumerator
Error
Warning
Debug

Rotation

enum celantur::Rotation

strong

Enum to represent image rotation states. is used in celantur::FrameMetadata to describe the rotation of the frame.

Note

Normally not needed by the end user.

Enumerator
None
Rotated90Clockwise
Rotated180
Rotated90CounterClockwise

Function Documentation

detection_to_yolo_repr()

std::string celantur::detection_to_yolo_repr	(	const CelanturDetection &	detection,
		const cv::Size &	image_size
	)

References celantur::CelanturDetection::box, celantur::CelanturDetection::confidence, celantur::CelanturDetection::model_class_id, and celantur::CelanturDetection::segm_mask.

detections_to_yolo_repr()

std::string celantur::detections_to_yolo_repr	(	const std::vector< CelanturDetection > &	detections,
		const cv::Size &	image_size
	)

References celantur::detection_to_yolo_repr().

operator<<() [1/8]

std::ostream & celantur::operator<<	(	std::ostream &	os,
		const celantur::BlurType &	blur_type
	)

References celantur::BBox_Oval, celantur::BBox_Rectangle, celantur::None, and celantur::Segmentation.

operator<<() [2/8]

std::ostream & celantur::operator<<	(	std::ostream &	os,
		const celantur::CelanturClassId &	id
	)

References celantur::Face, celantur::LicensePlate, celantur::Person, and celantur::Vehicle.

operator<<() [3/8]

std::ostream & celantur::operator<<	(	std::ostream &	os,
		const celantur::DetectionType &	blur_type
	)

References celantur::Auto, celantur::BBox, celantur::None, and celantur::Segmentation.

operator<<() [4/8]

std::ostream & celantur::operator<<	(	std::ostream &	out,
		const celantur::CompilePrecision &	precision
	)

References celantur::FP16, celantur::FP32, and celantur::INT8.

operator<<() [5/8]

std::ostream & celantur::operator<<	(	std::ostream &	out,
		const celantur::InferenceEnginePluginId &	plugin_id
	)

operator<<() [6/8]

std::ostream & celantur::operator<<	(	std::ostream &	out,
		const celantur::LogSeverity &	log_severity
	)

References celantur::Debug, celantur::Error, and celantur::Warning.

operator<<() [7/8]

std::ostream & celantur::operator<<	(	std::ostream &	out,
		const celantur::MinOptMaxDims &	dims
	)

References celantur::MinOptMaxDims::values.

operator<<() [8/8]

std::ostream & celantur::operator<<	(	std::ostream &	out,
		const celantur::OptimisationLevel &	opt_level
	)

References celantur::Full, celantur::Low, and celantur::Medium.

operator>>() [1/8]

std::istream & celantur::operator>>	(	std::istream &	in,
		celantur::CompilePrecision &	precision
	)

References celantur::FP16, celantur::FP32, and celantur::INT8.

operator>>() [2/8]

std::istream & celantur::operator>>	(	std::istream &	in,
		celantur::InferenceEnginePluginId &	plugin_id
	)

operator>>() [3/8]

std::istream & celantur::operator>>	(	std::istream &	in,
		celantur::LogSeverity &	log_severity
	)

References celantur::Debug, celantur::Error, and celantur::Warning.

operator>>() [4/8]

std::istream & celantur::operator>>	(	std::istream &	in,
		celantur::MinOptMaxDims &	dims
	)

References celantur::MinOptMaxDims::values.

operator>>() [5/8]

std::istream & celantur::operator>>	(	std::istream &	in,
		celantur::OptimisationLevel &	opt_level
	)

References celantur::Full, celantur::Low, and celantur::Medium.

operator>>() [6/8]

std::istream & celantur::operator>>	(	std::istream &	os,
		celantur::BlurType &	blur_type
	)

References celantur::BBox_Oval, celantur::BBox_Rectangle, celantur::None, and celantur::Segmentation.

operator>>() [7/8]

std::istream & celantur::operator>>	(	std::istream &	os,
		celantur::CelanturClassId &	id
	)

References celantur::Face, celantur::LicensePlate, celantur::Person, and celantur::Vehicle.

operator>>() [8/8]

std::istream & celantur::operator>>	(	std::istream &	os,
		celantur::DetectionType &	blur_type
	)

References celantur::Auto, celantur::BBox, celantur::None, and celantur::Segmentation.

Variable Documentation

DEFAULT_PER_TYPE_PROCESSING_CONFIG

const PerTypeProcessingConfig celantur::DEFAULT_PER_TYPE_PROCESSING_CONFIG = FACE_LICENSE_PLATE_PROCESSING_CONFIG

DETECT_ONLY_CONFIG

const PerTypeProcessingConfig celantur::DETECT_ONLY_CONFIG

FACE_LICENSE_PLATE_PROCESSING_CONFIG

const PerTypeProcessingConfig celantur::FACE_LICENSE_PLATE_PROCESSING_CONFIG

Default per-type processing configuration.

PERSON_VEHICLE_PROCESSING_CONFIG

const PerTypeProcessingConfig celantur::PERSON_VEHICLE_PROCESSING_CONFIG