Skip to content

Commit 0694260

Browse files
Fix classNames parameter description
1 parent 84fc008 commit 0694260

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

src/ObjectDetector.h

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -151,12 +151,13 @@ class ObjectDetectorParams
151151
float custom3{ 0.0f };
152152
/// List of detected objects.
153153
std::vector<Object> objects;
154-
/// A list of object class names. Used in detectors that recognise different
155-
/// object classes. The detected objects have a attribute type. If detector
156-
/// doesn't support object class recognition or can't recognise object type
157-
/// the field type must be set to 0, otherwise type must have the ordinal
158-
/// number of the class name from the classNames list (if list was set in
159-
/// params) starting from 1 (first element in list -> type == 1).
154+
// A list of object class names used in detectors that recognize different
155+
// object classes. Detected objects have an attribute called 'type.'
156+
// If a detector doesn't support object class recognition or can't determine
157+
// the object type, the 'type' field must be set to 0. Otherwise, the 'type'
158+
// should correspond to the ordinal number of the class name from the
159+
// 'classNames' list (if the list was set in params), starting from 1
160+
// (where the first element in the list has 'type == 1').
160161
std::vector<std::string> classNames{ "" };
161162

162163
JSON_READABLE(ObjectDetectorParams, initString, logMode, frameBufferSize,

0 commit comments

Comments
 (0)