Documentation Introduction

prerequisites
  1. About page.
  2. User Guides page. Especially the Generate Code sections (very important).
  3. Basic understanding in the Python programing language.
  4. Basic understanding in the OpenCV library for Python.
  5. Basic understanding in the JSON file formate.
important notes

1-The name of the variables in the .json files in the "settings" folder could also be used in the code in the main.py file. for example if you are using the object detection project then you could write object_detection.AI_model = "YOLO_v3_accurate" or object_detection.confidence = 90. The main two exceptions are the input_type and input variables. The variables are available but you might get errors so it is preferred to select there values in the .json file instead.

2-When the code is generated the "input_type" and "input" values will always be "camera" and 0 respectively if the user did not make his own changes in the .json file.

3-The documentation is mainly about the .json files (in the "settings" folder for the generated code) and the results (and very briefly the results_frames) that can be used in the main.py file (in the generated code).

4-This is how we use the results and results_frames in the main.py file:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
#this is an example for the Object Detection project. 
#if you use another project, then simply 
#replace "object_detection" 
#with the project name
import object_detection
import cv2 as cv
from codes_library import reference as r

JSON_file_name = object_detection.get_settings_file_name()
object_detection.load_settings(JSON_file_name+".json")

input_object = r.InputFrom(input_type=3, input=0)

frame = input_object.read_input()
[results,results_frame] = object_detection.detect(frame)

default