Darknet/YOLO v3.0-177-gfa2353b
Object Detection Framework
 
Loading...
Searching...
No Matches
Darknet::NetworkDetails Struct Reference

A place to store other details related to the neural network which we cannot easily add to the usual Darknet::Network structure. More...

#include "darknet_network.hpp"

Collaboration diagram for Darknet::NetworkDetails:

Public Member Functions

 NetworkDetails ()
 Default constructor.
 

Public Attributes

bool annotate_draw_bb
 Whether bounding boxes are drawn when annotating images.
 
bool annotate_draw_label
 Whether text labels are drawn above bounding boxes when annotating images.
 
float bounding_boxes_corner_roundness
 The "roundness" of the corners when bounding_boxes_with_rounded_corners is set to true.
 
bool bounding_boxes_with_rounded_corners
 Whether bounding boxes should use rounded corners.
 
std::vector< cv::Scalar > class_colours
 BGR colours to use for each class.
 
VStr class_names
 The name to use for every object class.
 
SInt classes_to_ignore
 Indexes of classes which Darknet should ignore.
 
cv::HersheyFonts cv_font_face
 The OpenCV built-in font to use when generating text, such as the labels above bounding boxes.
 
double cv_font_scale
 The OpenCV font scale to use when generating text, such as the labels above bounding boxes.
 
int cv_font_thickness
 The OpenCV font thickness to use when generating text, such as the labels above bounding boxes.
 
cv::LineTypes cv_line_type
 The OpenCV line type to use when drawing lines such as bounding boxes.
 
float detection_threshold
 Object detection threshold to apply.
 
bool fix_out_of_bound_normalized_coordinates
 Fix out-of-bound values for objects near the edges of images.
 
float non_maximal_suppression_threshold
 Non maximal suppression threshold to apply.
 
std::vector< cv::Scalar > text_colours
 BGR colours to use for the label text.
 
std::filesystem::path cfg_path
 Filename used to load the neural nework.
 
std::filesystem::path names_path
 Filename used to load the neural nework.
 
std::filesystem::path weights_path
 Filename used to load the neural nework.
 

Detailed Description

A place to store other details related to the neural network which we cannot easily add to the usual Darknet::Network structure.

These are typically C++ objects, or things added post Darknet V3 (2024-08).

See also
Darknet::Network::details
Since
2024-08-06

Constructor & Destructor Documentation

◆ NetworkDetails()

Darknet::NetworkDetails::NetworkDetails ( )

Default constructor.

Member Data Documentation

◆ annotate_draw_bb

bool Darknet::NetworkDetails::annotate_draw_bb

Whether bounding boxes are drawn when annotating images.

Default is true.

See also
Darknet::set_annotation_draw_bb()
Darknet::set_annotation_draw_label()
Since
2024-07-30

◆ annotate_draw_label

bool Darknet::NetworkDetails::annotate_draw_label

Whether text labels are drawn above bounding boxes when annotating images.

Default is true.

See also
Darknet::set_annotation_draw_bb()
Darknet::set_annotation_draw_label()
Since
2024-07-30

◆ bounding_boxes_corner_roundness

float Darknet::NetworkDetails::bounding_boxes_corner_roundness

The "roundness" of the corners when bounding_boxes_with_rounded_corners is set to true.

Default is 0.5.

See also
Darknet::set_rounded_corner_bounding_boxes()
Since
2024-07-30

◆ bounding_boxes_with_rounded_corners

bool Darknet::NetworkDetails::bounding_boxes_with_rounded_corners

Whether bounding boxes should use rounded corners.

Default is false (meaning square bounding boxes).

See also
Darknet::set_rounded_corner_bounding_boxes()
Since
2024-07-30

◆ cfg_path

std::filesystem::path Darknet::NetworkDetails::cfg_path

Filename used to load the neural nework.

Since
2024-08-06

◆ class_colours

std::vector<cv::Scalar> Darknet::NetworkDetails::class_colours

BGR colours to use for each class.

See also
Darknet::NetworkDetails::class_names
Darknet::assign_default_class_colours()
Since
2024-08-07

◆ class_names

VStr Darknet::NetworkDetails::class_names

The name to use for every object class.

Will always match the number of classes in the neural network.

See also
Darknet::assign_default_class_colours()
Darknet::load_names()
Since
2024-08-07

◆ classes_to_ignore

SInt Darknet::NetworkDetails::classes_to_ignore

Indexes of classes which Darknet should ignore.

Darknet::skipped_classes()

Since
2024-10-07

◆ cv_font_face

cv::HersheyFonts Darknet::NetworkDetails::cv_font_face

The OpenCV built-in font to use when generating text, such as the labels above bounding boxes.

Default is cv::HersheyFonts::FONT_HERSHEY_PLAIN.

See also
Darknet::set_annotation_font()
Since
2024-07-30

◆ cv_font_scale

double Darknet::NetworkDetails::cv_font_scale

The OpenCV font scale to use when generating text, such as the labels above bounding boxes.

Default is 1.0.

See also
Darknet::set_annotation_font()
Since
2024-07-30

◆ cv_font_thickness

int Darknet::NetworkDetails::cv_font_thickness

The OpenCV font thickness to use when generating text, such as the labels above bounding boxes.

Default is 1.

See also
Darknet::set_annotation_font()
Since
2024-07-30

◆ cv_line_type

cv::LineTypes Darknet::NetworkDetails::cv_line_type

The OpenCV line type to use when drawing lines such as bounding boxes.

Possible values include cv::LineTypes::LINE_4, cv::LineTypes::LINE_8, and cv::LineTypes::CV_LINE_AA. LINE_4 is the fastest but lowest quality, while LINE_AA (anti-alias) is the slowest with highest quality. Default is cv::LineTypes::LINE_4.

See also
Darknet::set_annotation_font()
Darknet::set_annotation_line_type()
Since
2024-07-30

◆ detection_threshold

float Darknet::NetworkDetails::detection_threshold

Object detection threshold to apply.

Default is 0.25.

See also
Darknet::set_detection_threshold()
Since
2024-07-24

◆ fix_out_of_bound_normalized_coordinates

bool Darknet::NetworkDetails::fix_out_of_bound_normalized_coordinates

Fix out-of-bound values for objects near the edges of images.

Default is true.

See also
Darknet::fix_out_of_bound_values()
Since
2024-07-25

◆ names_path

std::filesystem::path Darknet::NetworkDetails::names_path

Filename used to load the neural nework.

Since
2024-08-06

◆ non_maximal_suppression_threshold

float Darknet::NetworkDetails::non_maximal_suppression_threshold

Non maximal suppression threshold to apply.

Default is 0.45.

See also
Darknet::set_non_maximal_suppression_threshold()
Since
2024-07-24

◆ text_colours

std::vector<cv::Scalar> Darknet::NetworkDetails::text_colours

BGR colours to use for the label text.

See also
Darknet::NetworkDetails::class_names
Darknet::assign_default_class_colours()
Since
2024-08-07

◆ weights_path

std::filesystem::path Darknet::NetworkDetails::weights_path

Filename used to load the neural nework.

Since
2024-08-06

The documentation for this struct was generated from the following files: