Cpp-Processing
Modules | Classes | Typedefs | Enumerations | Functions
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...
 
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::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

const PerTypeProcessingConfig celantur::DEFAULT_PER_TYPE_PROCESSING_CONFIG ({ {CelanturClassId::LicensePlate, DetectionProcessingConfig{ BlurType::BBox_Rectangle, 0.3f, 0.0f, 1.0f, true }}, {CelanturClassId::Person, {BlurType::None}}, {CelanturClassId::Face, { BlurType::BBox_Oval, 0.3f, 0.0f, 0.2f, true }}, {CelanturClassId::Vehicle, {BlurType::None}}, })
 Default per-type processing configuration. More...
 
std::ostream & operator<< (std::ostream &os, const celantur::BlurType &blur_type)
 
std::istream & operator>> (std::istream &os, celantur::BlurType &blur_type)
 
std::ostream & operator<< (std::ostream &os, const celantur::CelanturClassId &id)
 
std::istream & operator>> (std::istream &os, celantur::CelanturClassId &id)
 
std::istream & operator>> (std::istream &in, celantur::OptimisationLevel &opt_level)
 
std::ostream & operator<< (std::ostream &out, const celantur::OptimisationLevel &opt_level)
 
std::istream & operator>> (std::istream &in, celantur::CompilePrecision &precision)
 
std::ostream & operator<< (std::ostream &out, const celantur::CompilePrecision &precision)
 
std::istream & operator>> (std::istream &in, celantur::MinOptMaxDims &dims)
 
std::ostream & operator<< (std::ostream &out, const celantur::MinOptMaxDims &dims)
 
std::istream & operator>> (std::istream &in, celantur::InferenceEnginePluginId &plugin_id)
 
std::ostream & operator<< (std::ostream &out, const celantur::InferenceEnginePluginId &plugin_id)
 
std::istream & operator>> (std::istream &in, celantur::LogSeverity &log_severity)
 
std::ostream & operator<< (std::ostream &out, const celantur::LogSeverity &log_severity)
 

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

◆ DEFAULT_PER_TYPE_PROCESSING_CONFIG()

const PerTypeProcessingConfig celantur::DEFAULT_PER_TYPE_PROCESSING_CONFIG ( { {CelanturClassId::LicensePlate, DetectionProcessingConfig{ BlurType::BBox_Rectangle, 0.3f, 0.0f, 1.0f, true }}, {CelanturClassId::Person, {BlurType::None}}, {CelanturClassId::Face, { BlurType::BBox_Oval, 0.3f, 0.0f, 0.2f, true }}, {CelanturClassId::Vehicle, {BlurType::None}}, }  )

◆ operator<<() [1/7]

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

◆ operator<<() [2/7]

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

◆ operator<<() [3/7]

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

◆ operator<<() [4/7]

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

◆ operator<<() [5/7]

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

◆ operator<<() [6/7]

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

◆ operator<<() [7/7]

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

◆ operator>>() [1/7]

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

◆ operator>>() [2/7]

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

◆ operator>>() [3/7]

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

◆ operator>>() [4/7]

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

◆ operator>>() [5/7]

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

◆ operator>>() [6/7]

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

◆ operator>>() [7/7]

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