BARKLY DOCS human-readable engineering reference
BARKLY LABS · AUTOMATED DOCUMENTATION

SecuServe OpenCV

Human-centered computer vision infrastructure for SecuServe, designed to provide understandable, modular, and extensible visual processing capabilities for security-oriented systems while keeping people and responsible system operation at the center.

generation #1 23 python files 76 functions 23 classes 0 endpoints
01
BARKLY DOCS

Project

The smallest useful picture of what this project is.

PROJECT DOCUMENTATION

SecuServe OpenCV

Human-centered computer vision infrastructure for SecuServe, designed to provide understandable, modular, and extensible visual processing capabilities for security-oriented systems while keeping people and responsible system operation at the center.

TYPE
Security / Computer Vision / Software / Systems
STATUS
Active
PYTHON FILES
23
GENERATION
#1
02
BARKLY DOCS

Principles

The rules and design principles the project is built around.

01
Human First
02
Understandable
03
Privacy Where Practical
04
Responsible Vision
05
Modular
06
Accessible
07
Experimental
08
Open and Extensible
03
BARKLY DOCS

Components

The major systems and pieces that make up the project.

01
OpenCV Integration
02
Image Processing
03
Video Processing
04
Computer Vision
05
Detection + Analysis
06
Camera Interfaces
07
Security Tools
08
API + Integrations
04
BARKLY DOCS

API Endpoints

Every discovered route is compact by default and expandable when you need its technical details.

0
No API endpoints were discovered.
05
BARKLY DOCS

Functions & Methods

Searchable, grouped symbols with details hidden until requested.

0
barkly_docs.py
50 symbols
esc
No description documented yet.
barkly_docs.py:233
WHAT IT DOES

No description documented yet.

SIGNATURE
esc(value: object) -> str
PARAMETERS
value
object
RETURNS str
SOURCE barkly_docs.py:233
compact_doc
No description documented yet.
barkly_docs.py:237
WHAT IT DOES

No description documented yet.

SIGNATURE
compact_doc(doc: str, limit: int = 180) -> str
PARAMETERS
doc
str
limit
int
= 180
RETURNS str
SOURCE barkly_docs.py:237
full_doc
No description documented yet.
barkly_docs.py:249
WHAT IT DOES

No description documented yet.

SIGNATURE
full_doc(doc: str) -> str
PARAMETERS
doc
str
RETURNS str
SOURCE barkly_docs.py:249
expression_text
No description documented yet.
barkly_docs.py:256
WHAT IT DOES

No description documented yet.

SIGNATURE
expression_text(node: Optional[ast.AST]) -> str
PARAMETERS
node
Optional[ast.AST]
RETURNS str
SOURCE barkly_docs.py:256
annotation_text
No description documented yet.
barkly_docs.py:266
WHAT IT DOES

No description documented yet.

SIGNATURE
annotation_text(node: Optional[ast.AST]) -> str
PARAMETERS
node
Optional[ast.AST]
RETURNS str
SOURCE barkly_docs.py:266
relative_file
No description documented yet.
barkly_docs.py:270
WHAT IT DOES

No description documented yet.

SIGNATURE
relative_file(path: Path, root: Path) -> str
PARAMETERS
path
Path
root
Path
RETURNS str
SOURCE barkly_docs.py:270
code_line
No description documented yet.
barkly_docs.py:277
WHAT IT DOES

No description documented yet.

SIGNATURE
code_line(file: str, line: int) -> str
PARAMETERS
file
str
line
int
RETURNS str
SOURCE barkly_docs.py:277
short_hash
No description documented yet.
barkly_docs.py:281
WHAT IT DOES

No description documented yet.

SIGNATURE
short_hash(value: str) -> str
PARAMETERS
value
str
RETURNS str
SOURCE barkly_docs.py:281
safe_call
No description documented yet.
barkly_docs.py:285
WHAT IT DOES

No description documented yet.

SIGNATURE
safe_call(command: list[str], cwd: Path) -> str
PARAMETERS
command
list[str]
cwd
Path
RETURNS str
SOURCE barkly_docs.py:285
git_branch
No description documented yet.
barkly_docs.py:304
WHAT IT DOES

No description documented yet.

SIGNATURE
git_branch(root: Path) -> str
PARAMETERS
root
Path
RETURNS str
SOURCE barkly_docs.py:304
git_commit
No description documented yet.
barkly_docs.py:311
WHAT IT DOES

No description documented yet.

SIGNATURE
git_commit(root: Path) -> str
PARAMETERS
root
Path
RETURNS str
SOURCE barkly_docs.py:311
git_log
No description documented yet.
barkly_docs.py:318
WHAT IT DOES

No description documented yet.

SIGNATURE
git_log(root: Path, limit: int = 8) -> list[str]
PARAMETERS
root
Path
limit
int
= 8
RETURNS list[str]
SOURCE barkly_docs.py:318
node_doc
No description documented yet.
barkly_docs.py:340
WHAT IT DOES

No description documented yet.

SIGNATURE
node_doc(node: ast.AST) -> str
PARAMETERS
node
ast.AST
RETURNS str
SOURCE barkly_docs.py:340
decorator_name
No description documented yet.
barkly_docs.py:344
WHAT IT DOES

No description documented yet.

SIGNATURE
decorator_name(node: ast.AST) -> str
PARAMETERS
node
ast.AST
RETURNS str
SOURCE barkly_docs.py:344
decorator_text
No description documented yet.
barkly_docs.py:358
WHAT IT DOES

No description documented yet.

SIGNATURE
decorator_text(node: ast.AST) -> str
PARAMETERS
node
ast.AST
RETURNS str
SOURCE barkly_docs.py:358
decorators_for
No description documented yet.
barkly_docs.py:362
WHAT IT DOES

No description documented yet.

SIGNATURE
decorators_for(node: ast.AST) -> list[str]
PARAMETERS
node
ast.AST
RETURNS list[str]
SOURCE barkly_docs.py:362
parameter_kind
No description documented yet.
barkly_docs.py:369
WHAT IT DOES

No description documented yet.

SIGNATURE
parameter_kind(name: str, default_node: Optional[ast.AST]) -> str
PARAMETERS
name
str
default_node
Optional[ast.AST]
RETURNS str
SOURCE barkly_docs.py:369
collect_parameters
No description documented yet.
barkly_docs.py:394
WHAT IT DOES

No description documented yet.

SIGNATURE
collect_parameters(node: ast.FunctionDef | ast.AsyncFunctionDef) -> list[Parameter]
PARAMETERS
node
ast.FunctionDef | ast.AsyncFunctionDef
RETURNS list[Parameter]
SOURCE barkly_docs.py:394
call_root_name
No description documented yet.
barkly_docs.py:462
WHAT IT DOES

No description documented yet.

SIGNATURE
call_root_name(node: ast.Call) -> str
PARAMETERS
node
ast.Call
RETURNS str
SOURCE barkly_docs.py:462
extract_string_argument
No description documented yet.
barkly_docs.py:472
WHAT IT DOES

No description documented yet.

SIGNATURE
extract_string_argument(call: ast.Call, index: int = 0) -> str
PARAMETERS
call
ast.Call
index
int
= 0
RETURNS str
SOURCE barkly_docs.py:472
extract_methods_keyword
No description documented yet.
barkly_docs.py:487
WHAT IT DOES

No description documented yet.

SIGNATURE
extract_methods_keyword(call: ast.Call) -> list[str]
PARAMETERS
call
ast.Call
RETURNS list[str]
SOURCE barkly_docs.py:487
endpoint_from_decorator
No description documented yet.
barkly_docs.py:506
WHAT IT DOES

No description documented yet.

SIGNATURE
endpoint_from_decorator(decorator: ast.AST, function: ast.FunctionDef | ast.AsyncFunctionDef, file: str) -> Optional[EndpointInfo]
PARAMETERS
decorator
ast.AST
function
ast.FunctionDef | ast.AsyncFunctionDef
file
str
RETURNS Optional[EndpointInfo]
SOURCE barkly_docs.py:506
scan_python
No description documented yet.
barkly_docs.py:767
WHAT IT DOES

No description documented yet.

SIGNATURE
scan_python(root: Path) -> PythonScanner
PARAMETERS
root
Path
RETURNS PythonScanner
SOURCE barkly_docs.py:767
symbol_key
No description documented yet.
barkly_docs.py:777
WHAT IT DOES

No description documented yet.

SIGNATURE
symbol_key(function: FunctionInfo) -> str
PARAMETERS
function
FunctionInfo
RETURNS str
SOURCE barkly_docs.py:777
class_key
No description documented yet.
barkly_docs.py:781
WHAT IT DOES

No description documented yet.

SIGNATURE
class_key(item: ClassInfo) -> str
PARAMETERS
item
ClassInfo
RETURNS str
SOURCE barkly_docs.py:781
endpoint_key
No description documented yet.
barkly_docs.py:785
WHAT IT DOES

No description documented yet.

SIGNATURE
endpoint_key(item: EndpointInfo) -> str
PARAMETERS
item
EndpointInfo
RETURNS str
SOURCE barkly_docs.py:785
function_fingerprint
No description documented yet.
barkly_docs.py:794
WHAT IT DOES

No description documented yet.

SIGNATURE
function_fingerprint(item: FunctionInfo) -> str
PARAMETERS
item
FunctionInfo
RETURNS str
SOURCE barkly_docs.py:794
class_fingerprint
No description documented yet.
barkly_docs.py:808
WHAT IT DOES

No description documented yet.

SIGNATURE
class_fingerprint(item: ClassInfo) -> str
PARAMETERS
item
ClassInfo
RETURNS str
SOURCE barkly_docs.py:808
endpoint_fingerprint
No description documented yet.
barkly_docs.py:825
WHAT IT DOES

No description documented yet.

SIGNATURE
endpoint_fingerprint(item: EndpointInfo) -> str
PARAMETERS
item
EndpointInfo
RETURNS str
SOURCE barkly_docs.py:825
load_state
No description documented yet.
barkly_docs.py:850
WHAT IT DOES

No description documented yet.

SIGNATURE
load_state(path: Path) -> dict
PARAMETERS
path
Path
RETURNS dict
SOURCE barkly_docs.py:850
apply_state
No description documented yet.
barkly_docs.py:876
WHAT IT DOES

No description documented yet.

SIGNATURE
apply_state(scanner: PythonScanner, previous: dict) -> dict
PARAMETERS
scanner
PythonScanner
previous
dict
RETURNS dict
SOURCE barkly_docs.py:876
load_project_config
No description documented yet.
barkly_docs.py:934
WHAT IT DOES

No description documented yet.

SIGNATURE
load_project_config(root: Path) -> dict
PARAMETERS
root
Path
RETURNS dict
SOURCE barkly_docs.py:934
init_project
No description documented yet.
barkly_docs.py:956
WHAT IT DOES

No description documented yet.

SIGNATURE
init_project(root: Path) -> None
PARAMETERS
root
Path
RETURNS None
SOURCE barkly_docs.py:956
badge
No description documented yet.
barkly_docs.py:978
WHAT IT DOES

No description documented yet.

SIGNATURE
badge(text: str, kind: str = '') -> str
PARAMETERS
text
str
kind
str
= ''
RETURNS str
SOURCE barkly_docs.py:978
status_badges
No description documented yet.
barkly_docs.py:992
WHAT IT DOES

No description documented yet.

SIGNATURE
status_badges(is_new: bool, is_changed: bool) -> str
PARAMETERS
is_new
bool
is_changed
bool
RETURNS str
SOURCE barkly_docs.py:992
parameter_summary
No description documented yet.
barkly_docs.py:1012
WHAT IT DOES

No description documented yet.

SIGNATURE
parameter_summary(params: list[Parameter]) -> str
PARAMETERS
params
list[Parameter]
RETURNS str
SOURCE barkly_docs.py:1012
parameter_details
No description documented yet.
barkly_docs.py:1025
WHAT IT DOES

No description documented yet.

SIGNATURE
parameter_details(params: list[Parameter]) -> str
PARAMETERS
params
list[Parameter]
RETURNS str
SOURCE barkly_docs.py:1025
function_row
No description documented yet.
barkly_docs.py:1085
WHAT IT DOES

No description documented yet.

SIGNATURE
function_row(item: FunctionInfo, show_class: bool = False) -> str
PARAMETERS
item
FunctionInfo
show_class
bool
= False
RETURNS str
SOURCE barkly_docs.py:1085
method_group
No description documented yet.
barkly_docs.py:1194
WHAT IT DOES

No description documented yet.

SIGNATURE
method_group(title: str, functions: list[FunctionInfo]) -> str
PARAMETERS
title
str
functions
list[FunctionInfo]
RETURNS str
SOURCE barkly_docs.py:1194
class_group
No description documented yet.
barkly_docs.py:1259
WHAT IT DOES

No description documented yet.

SIGNATURE
class_group(item: ClassInfo) -> str
PARAMETERS
item
ClassInfo
RETURNS str
SOURCE barkly_docs.py:1259
endpoint_row
No description documented yet.
barkly_docs.py:1347
WHAT IT DOES

No description documented yet.

SIGNATURE
endpoint_row(item: EndpointInfo) -> str
PARAMETERS
item
EndpointInfo
RETURNS str
SOURCE barkly_docs.py:1347
module_row
No description documented yet.
barkly_docs.py:1462
WHAT IT DOES

No description documented yet.

SIGNATURE
module_row(module: ModuleInfo) -> str
PARAMETERS
module
ModuleInfo
RETURNS str
SOURCE barkly_docs.py:1462
section
No description documented yet.
barkly_docs.py:1541
WHAT IT DOES

No description documented yet.

SIGNATURE
section(number: str, title: str, description: str, body: str) -> str
PARAMETERS
number
str
title
str
description
str
body
str
RETURNS str
SOURCE barkly_docs.py:1541
info_card
No description documented yet.
barkly_docs.py:1581
WHAT IT DOES

No description documented yet.

SIGNATURE
info_card(title: str, value: str, description: str = '') -> str
PARAMETERS
title
str
value
str
description
str
= ''
RETURNS str
SOURCE barkly_docs.py:1581
simple_card_grid
No description documented yet.
barkly_docs.py:1608
WHAT IT DOES

No description documented yet.

SIGNATURE
simple_card_grid(values: list[str]) -> str
PARAMETERS
values
list[str]
RETURNS str
SOURCE barkly_docs.py:1608
search_toolbar
No description documented yet.
barkly_docs.py:1625
WHAT IT DOES

No description documented yet.

SIGNATURE
search_toolbar(input_id: str, count_id: str, new_id: str, placeholder: str) -> str
PARAMETERS
input_id
str
count_id
str
new_id
str
placeholder
str
RETURNS str
SOURCE barkly_docs.py:1625
build_html
No description documented yet.
barkly_docs.py:1671
WHAT IT DOES

No description documented yet.

SIGNATURE
build_html(project: dict, scanner: PythonScanner, state: dict, root: Path) -> str
PARAMETERS
project
dict
scanner
PythonScanner
state
dict
root
Path
RETURNS str
SOURCE barkly_docs.py:1671
generate
No description documented yet.
barkly_docs.py:3406
WHAT IT DOES

No description documented yet.

SIGNATURE
generate(source: Path, output: Path, name: Optional[str] = None, project_type: Optional[str] = None, status: Optional[str] = None) -> None
PARAMETERS
source
Path
output
Path
name
Optional[str]
= None
project_type
Optional[str]
= None
status
Optional[str]
= None
RETURNS None
SOURCE barkly_docs.py:3406
build_parser
No description documented yet.
barkly_docs.py:3498
WHAT IT DOES

No description documented yet.

SIGNATURE
build_parser() -> argparse.ArgumentParser
PARAMETERS
No parameters documented.
RETURNS argparse.ArgumentParser
SOURCE barkly_docs.py:3498
main
No description documented yet.
barkly_docs.py:3562
WHAT IT DOES

No description documented yet.

SIGNATURE
main() -> None
PARAMETERS
No parameters documented.
RETURNS None
SOURCE barkly_docs.py:3562
videoprocessingsrc/__main__.py
1 symbols
main
No description documented yet.
videoprocessingsrc/__main__.py:17
WHAT IT DOES

No description documented yet.

SIGNATURE
main()
PARAMETERS
No parameters documented.
RETURNS Not documented
SOURCE videoprocessingsrc/__main__.py:17
videoprocessingsrc/consoleLog.py
6 symbols
Debug
No description documented yet.
videoprocessingsrc/consoleLog.py:6
WHAT IT DOES

No description documented yet.

SIGNATURE
Debug(text)
PARAMETERS
text
RETURNS Not documented
SOURCE videoprocessingsrc/consoleLog.py:6
Warning
No description documented yet.
videoprocessingsrc/consoleLog.py:13
WHAT IT DOES

No description documented yet.

SIGNATURE
Warning(text)
PARAMETERS
text
RETURNS Not documented
SOURCE videoprocessingsrc/consoleLog.py:13
Error
No description documented yet.
videoprocessingsrc/consoleLog.py:20
WHAT IT DOES

No description documented yet.

SIGNATURE
Error(text)
PARAMETERS
text
RETURNS Not documented
SOURCE videoprocessingsrc/consoleLog.py:20
PipeLine_Ok
No description documented yet.
videoprocessingsrc/consoleLog.py:26
WHAT IT DOES

No description documented yet.

SIGNATURE
PipeLine_Ok(text)
PARAMETERS
text
RETURNS Not documented
SOURCE videoprocessingsrc/consoleLog.py:26
PipeLine_init
No description documented yet.
videoprocessingsrc/consoleLog.py:32
WHAT IT DOES

No description documented yet.

SIGNATURE
PipeLine_init(text)
PARAMETERS
text
RETURNS Not documented
SOURCE videoprocessingsrc/consoleLog.py:32
PipeLine_Data
No description documented yet.
videoprocessingsrc/consoleLog.py:38
WHAT IT DOES

No description documented yet.

SIGNATURE
PipeLine_Data(text)
PARAMETERS
text
RETURNS Not documented
SOURCE videoprocessingsrc/consoleLog.py:38
videoprocessingsrc/database.py
12 symbols
getFaces
No description documented yet.
videoprocessingsrc/database.py:8
WHAT IT DOES

No description documented yet.

SIGNATURE
getFaces()
PARAMETERS
No parameters documented.
RETURNS Not documented
SOURCE videoprocessingsrc/database.py:8
getAmountOfEntrys
No description documented yet.
videoprocessingsrc/database.py:30
WHAT IT DOES

No description documented yet.

SIGNATURE
getAmountOfEntrys()
PARAMETERS
No parameters documented.
RETURNS Not documented
SOURCE videoprocessingsrc/database.py:30
getKey
No description documented yet.
videoprocessingsrc/database.py:49
WHAT IT DOES

No description documented yet.

SIGNATURE
getKey(result_set, i)
PARAMETERS
result_set
i
RETURNS Not documented
SOURCE videoprocessingsrc/database.py:49
getID
No description documented yet.
videoprocessingsrc/database.py:54
WHAT IT DOES

No description documented yet.

SIGNATURE
getID(result_set, i)
PARAMETERS
result_set
i
RETURNS Not documented
SOURCE videoprocessingsrc/database.py:54
getName
No description documented yet.
videoprocessingsrc/database.py:61
WHAT IT DOES

No description documented yet.

SIGNATURE
getName(result_set, i)
PARAMETERS
result_set
i
RETURNS Not documented
SOURCE videoprocessingsrc/database.py:61
getStatus
No description documented yet.
videoprocessingsrc/database.py:66
WHAT IT DOES

No description documented yet.

SIGNATURE
getStatus(result_set, i)
PARAMETERS
result_set
i
RETURNS Not documented
SOURCE videoprocessingsrc/database.py:66
getImageName
No description documented yet.
videoprocessingsrc/database.py:71
WHAT IT DOES

No description documented yet.

SIGNATURE
getImageName(result_set, i)
PARAMETERS
result_set
i
RETURNS Not documented
SOURCE videoprocessingsrc/database.py:71
getImageUrI
No description documented yet.
videoprocessingsrc/database.py:75
WHAT IT DOES

No description documented yet.

SIGNATURE
getImageUrI(result_set, i)
PARAMETERS
result_set
i
RETURNS Not documented
SOURCE videoprocessingsrc/database.py:75
getUserUUID
No description documented yet.
videoprocessingsrc/database.py:79
WHAT IT DOES

No description documented yet.

SIGNATURE
getUserUUID(result_set, i)
PARAMETERS
result_set
i
RETURNS Not documented
SOURCE videoprocessingsrc/database.py:79
getPhoneNum
No description documented yet.
videoprocessingsrc/database.py:83
WHAT IT DOES

No description documented yet.

SIGNATURE
getPhoneNum(result_set, i)
PARAMETERS
result_set
i
RETURNS Not documented
SOURCE videoprocessingsrc/database.py:83
getLifefaces
No description documented yet.
videoprocessingsrc/database.py:87
WHAT IT DOES

No description documented yet.

SIGNATURE
getLifefaces(result_set)
PARAMETERS
result_set
RETURNS Not documented
SOURCE videoprocessingsrc/database.py:87
getLifePlates
No description documented yet.
videoprocessingsrc/database.py:92
WHAT IT DOES

No description documented yet.

SIGNATURE
getLifePlates(result_set, i)
PARAMETERS
result_set
i
RETURNS Not documented
SOURCE videoprocessingsrc/database.py:92
videoprocessingsrc/knnClasifiyer.py
7 symbols
loadTrainingData
No description documented yet.
videoprocessingsrc/knnClasifiyer.py:25
WHAT IT DOES

No description documented yet.

SIGNATURE
loadTrainingData(train_dir, verbose = True)
PARAMETERS
train_dir
verbose
= True
RETURNS Not documented
SOURCE videoprocessingsrc/knnClasifiyer.py:25
train
No description documented yet.
videoprocessingsrc/knnClasifiyer.py:46
WHAT IT DOES

No description documented yet.

SIGNATURE
train(train_dir, model_save_path = None, n_neighbors = 2, knn_algo = 'ball_tree', verbose = True)
PARAMETERS
train_dir
model_save_path
= None
n_neighbors
= 2
knn_algo
= 'ball_tree'
verbose
= True
RETURNS Not documented
SOURCE videoprocessingsrc/knnClasifiyer.py:46
saveTrainingData
No description documented yet.
videoprocessingsrc/knnClasifiyer.py:64
WHAT IT DOES

No description documented yet.

SIGNATURE
saveTrainingData(model_save_path, knn_clf)
PARAMETERS
model_save_path
knn_clf
RETURNS Not documented
SOURCE videoprocessingsrc/knnClasifiyer.py:64
loadTrainedModel
No description documented yet.
videoprocessingsrc/knnClasifiyer.py:71
WHAT IT DOES

No description documented yet.

SIGNATURE
loadTrainedModel(knn_clf, model_path)
PARAMETERS
knn_clf
model_path
RETURNS Not documented
SOURCE videoprocessingsrc/knnClasifiyer.py:71
predict
No description documented yet.
videoprocessingsrc/knnClasifiyer.py:84
WHAT IT DOES

No description documented yet.

SIGNATURE
predict(Camera_frame, knn_clf = None, distance_threshold = 0.4)
PARAMETERS
Camera_frame
knn_clf
= None
distance_threshold
= 0.4
RETURNS Not documented
SOURCE videoprocessingsrc/knnClasifiyer.py:84
face_predict_data
Suppost to be like this but it wont work so reverting it back to og state return [(pred, loc) if rec else ("unknown", loc) for pr…
videoprocessingsrc/knnClasifiyer.py:110
WHAT IT DOES

Suppost to be like this but it wont work so reverting it back to og state return [(pred, loc) if rec else ("unknown", loc) for pred, loc, rec in zip(knn_clf.predict(faces_encodings), X_face_locations, are_matches)]

SIGNATURE
face_predict_data(knn_clf, faces_encodings, X_face_locations, are_matches)
PARAMETERS
knn_clf
faces_encodings
X_face_locations
are_matches
RETURNS Not documented
SOURCE videoprocessingsrc/knnClasifiyer.py:110
face_distance_to_conf
No description documented yet.
videoprocessingsrc/knnClasifiyer.py:125
WHAT IT DOES

No description documented yet.

SIGNATURE
face_distance_to_conf(face_distance, face_match_threshold = 0.56)
PARAMETERS
face_distance
face_match_threshold
= 0.56
RETURNS Not documented
SOURCE videoprocessingsrc/knnClasifiyer.py:125
barkly_docs.py · FunctionInfo
2 symbols
qualified_name
No description documented yet.
barkly_docs.py:161
WHAT IT DOES

No description documented yet.

SIGNATURE
qualified_name(self) -> str
PARAMETERS
self
RETURNS str
SOURCE barkly_docs.py:161
DECORATORS
property
signature
No description documented yet.
barkly_docs.py:167
WHAT IT DOES

No description documented yet.

SIGNATURE
signature(self) -> str
PARAMETERS
self
RETURNS str
SOURCE barkly_docs.py:167
DECORATORS
property
barkly_docs.py · EndpointInfo
1 symbols
method_text
No description documented yet.
barkly_docs.py:217
WHAT IT DOES

No description documented yet.

SIGNATURE
method_text(self) -> str
PARAMETERS
self
RETURNS str
SOURCE barkly_docs.py:217
DECORATORS
property
barkly_docs.py · PythonScanner
7 symbols
__init__
No description documented yet.
barkly_docs.py:607
WHAT IT DOES

No description documented yet.

SIGNATURE
__init__(self, root: Path)
PARAMETERS
self
root
Path
RETURNS Not documented
SOURCE barkly_docs.py:607
scan
No description documented yet.
barkly_docs.py:615
WHAT IT DOES

No description documented yet.

SIGNATURE
scan(self) -> None
PARAMETERS
self
RETURNS None
SOURCE barkly_docs.py:615
scan_file
No description documented yet.
barkly_docs.py:622
WHAT IT DOES

No description documented yet.

SIGNATURE
scan_file(self, path: Path) -> None
PARAMETERS
self
path
Path
RETURNS None
SOURCE barkly_docs.py:622
function_node_for_class_method
No description documented yet.
barkly_docs.py:680
WHAT IT DOES

No description documented yet.

SIGNATURE
function_node_for_class_method(self, class_node: ast.ClassDef, method_name: str) -> Optional[ast.FunctionDef | ast.AsyncFunctionDef]
PARAMETERS
self
class_node
ast.ClassDef
method_name
str
RETURNS Optional[ast.FunctionDef | ast.AsyncFunctionDef]
SOURCE barkly_docs.py:680
make_function
No description documented yet.
barkly_docs.py:695
WHAT IT DOES

No description documented yet.

SIGNATURE
make_function(self, node: ast.FunctionDef | ast.AsyncFunctionDef, file: str, class_name: str = '') -> FunctionInfo
PARAMETERS
self
node
ast.FunctionDef | ast.AsyncFunctionDef
file
str
class_name
str
= ''
RETURNS FunctionInfo
SOURCE barkly_docs.py:695
make_class
No description documented yet.
barkly_docs.py:714
WHAT IT DOES

No description documented yet.

SIGNATURE
make_class(self, node: ast.ClassDef, file: str) -> ClassInfo
PARAMETERS
self
node
ast.ClassDef
file
str
RETURNS ClassInfo
SOURCE barkly_docs.py:714
find_endpoints
No description documented yet.
barkly_docs.py:744
WHAT IT DOES

No description documented yet.

SIGNATURE
find_endpoints(self, node: Optional[ast.FunctionDef | ast.AsyncFunctionDef], file: str) -> None
PARAMETERS
self
node
Optional[ast.FunctionDef | ast.AsyncFunctionDef]
file
str
RETURNS None
SOURCE barkly_docs.py:744
tests/test_config.py · TestConfig
1 symbols
test_config_reading
No description documented yet.
tests/test_config.py:80
WHAT IT DOES

No description documented yet.

SIGNATURE
test_config_reading(self)
PARAMETERS
self
RETURNS Not documented
SOURCE tests/test_config.py:80
tests/test_face_data_structure.py · TestFaceData
5 symbols
test_data_structure_user_name_
No description documented yet.
tests/test_face_data_structure.py:12
WHAT IT DOES

No description documented yet.

SIGNATURE
test_data_structure_user_name_(self)
PARAMETERS
self
RETURNS Not documented
SOURCE tests/test_face_data_structure.py:12
test_data_structure_user_status
No description documented yet.
tests/test_face_data_structure.py:21
WHAT IT DOES

No description documented yet.

SIGNATURE
test_data_structure_user_status(self)
PARAMETERS
self
RETURNS Not documented
SOURCE tests/test_face_data_structure.py:21
test_data_structure_user_image
No description documented yet.
tests/test_face_data_structure.py:30
WHAT IT DOES

No description documented yet.

SIGNATURE
test_data_structure_user_image(self)
PARAMETERS
self
RETURNS Not documented
SOURCE tests/test_face_data_structure.py:30
test_data_structure_user_image_url
No description documented yet.
tests/test_face_data_structure.py:40
WHAT IT DOES

No description documented yet.

SIGNATURE
test_data_structure_user_image_url(self)
PARAMETERS
self
RETURNS Not documented
SOURCE tests/test_face_data_structure.py:40
test_data_structure_user_phonenumber
No description documented yet.
tests/test_face_data_structure.py:49
WHAT IT DOES

No description documented yet.

SIGNATURE
test_data_structure_user_phonenumber(self)
PARAMETERS
self
RETURNS Not documented
SOURCE tests/test_face_data_structure.py:49
videoprocessingsrc/faceDataStruture.py · UserData
13 symbols
__init__
No description documented yet.
videoprocessingsrc/faceDataStruture.py:18
WHAT IT DOES

No description documented yet.

SIGNATURE
__init__(self, name: str, status: str, image: str, downloadurl: str, phonenumber: str) -> list
PARAMETERS
self
name
str
status
str
image
str
downloadurl
str
phonenumber
str
RETURNS list
SOURCE videoprocessingsrc/faceDataStruture.py:18
getSumOfDigits
No description documented yet.
videoprocessingsrc/faceDataStruture.py:26
WHAT IT DOES

No description documented yet.

SIGNATURE
getSumOfDigits(self, phonenumber) -> int
PARAMETERS
self
phonenumber
RETURNS int
SOURCE videoprocessingsrc/faceDataStruture.py:26
setUserName
No description documented yet.
videoprocessingsrc/faceDataStruture.py:32
WHAT IT DOES

No description documented yet.

SIGNATURE
setUserName(self, name) -> str
PARAMETERS
self
name
RETURNS str
SOURCE videoprocessingsrc/faceDataStruture.py:32
setUserStatus
No description documented yet.
videoprocessingsrc/faceDataStruture.py:43
WHAT IT DOES

No description documented yet.

SIGNATURE
setUserStatus(self, status) -> str
PARAMETERS
self
status
RETURNS str
SOURCE videoprocessingsrc/faceDataStruture.py:43
setUserImg
No description documented yet.
videoprocessingsrc/faceDataStruture.py:53
WHAT IT DOES

No description documented yet.

SIGNATURE
setUserImg(self, img) -> str
PARAMETERS
self
img
RETURNS str
SOURCE videoprocessingsrc/faceDataStruture.py:53
setUserUrl
No description documented yet.
videoprocessingsrc/faceDataStruture.py:62
WHAT IT DOES

No description documented yet.

SIGNATURE
setUserUrl(self, url)
PARAMETERS
self
url
RETURNS Not documented
SOURCE videoprocessingsrc/faceDataStruture.py:62
setUserPhoneNumber
No description documented yet.
videoprocessingsrc/faceDataStruture.py:72
WHAT IT DOES

No description documented yet.

SIGNATURE
setUserPhoneNumber(self, phonenumber) -> int
PARAMETERS
self
phonenumber
RETURNS int
SOURCE videoprocessingsrc/faceDataStruture.py:72
getUserName
No description documented yet.
videoprocessingsrc/faceDataStruture.py:90
WHAT IT DOES

No description documented yet.

SIGNATURE
getUserName(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/faceDataStruture.py:90
getUserStatus
No description documented yet.
videoprocessingsrc/faceDataStruture.py:95
WHAT IT DOES

No description documented yet.

SIGNATURE
getUserStatus(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/faceDataStruture.py:95
getUserImg
No description documented yet.
videoprocessingsrc/faceDataStruture.py:100
WHAT IT DOES

No description documented yet.

SIGNATURE
getUserImg(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/faceDataStruture.py:100
getUserUrl
No description documented yet.
videoprocessingsrc/faceDataStruture.py:105
WHAT IT DOES

No description documented yet.

SIGNATURE
getUserUrl(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/faceDataStruture.py:105
getUserPhoneNumber
No description documented yet.
videoprocessingsrc/faceDataStruture.py:110
WHAT IT DOES

No description documented yet.

SIGNATURE
getUserPhoneNumber(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/faceDataStruture.py:110
__repr__
No description documented yet.
videoprocessingsrc/faceDataStruture.py:114
WHAT IT DOES

No description documented yet.

SIGNATURE
__repr__(self) -> list
PARAMETERS
self
RETURNS list
SOURCE videoprocessingsrc/faceDataStruture.py:114
videoprocessingsrc/pipelineStates.py · SetupPipeLine
1 symbols
on_event
No description documented yet.
videoprocessingsrc/pipelineStates.py:27
WHAT IT DOES

No description documented yet.

SIGNATURE
on_event(self, event, sender)
PARAMETERS
self
event
sender
RETURNS Not documented
SOURCE videoprocessingsrc/pipelineStates.py:27
videoprocessingsrc/pipelineStates.py · TrainPipeline
1 symbols
on_event
No description documented yet.
videoprocessingsrc/pipelineStates.py:41
WHAT IT DOES

No description documented yet.

SIGNATURE
on_event(self, event, sender)
PARAMETERS
self
event
sender
RETURNS Not documented
SOURCE videoprocessingsrc/pipelineStates.py:41
videoprocessingsrc/pipelineStates.py · RunReconitionPipeLine
1 symbols
on_event
No description documented yet.
videoprocessingsrc/pipelineStates.py:55
WHAT IT DOES

No description documented yet.

SIGNATURE
on_event(self, event, sender)
PARAMETERS
self
event
sender
RETURNS Not documented
SOURCE videoprocessingsrc/pipelineStates.py:55
videoprocessingsrc/pipelineStates.py · Idle
1 symbols
on_event
No description documented yet.
videoprocessingsrc/pipelineStates.py:69
WHAT IT DOES

No description documented yet.

SIGNATURE
on_event(self, event, sender)
PARAMETERS
self
event
sender
RETURNS Not documented
SOURCE videoprocessingsrc/pipelineStates.py:69
videoprocessingsrc/pipelineStates.py · Error
2 symbols
__init__
No description documented yet.
videoprocessingsrc/pipelineStates.py:83
WHAT IT DOES

No description documented yet.

SIGNATURE
__init__(self, message)
PARAMETERS
self
message
RETURNS Not documented
SOURCE videoprocessingsrc/pipelineStates.py:83
on_event
No description documented yet.
videoprocessingsrc/pipelineStates.py:87
WHAT IT DOES

No description documented yet.

SIGNATURE
on_event(self, event, sender)
PARAMETERS
self
event
sender
RETURNS Not documented
SOURCE videoprocessingsrc/pipelineStates.py:87
videoprocessingsrc/pipelineStates.py · PipeLine
3 symbols
__init__
Initialize the components.
videoprocessingsrc/pipelineStates.py:104
WHAT IT DOES

Initialize the components.

SIGNATURE
__init__(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/pipelineStates.py:104
on_event
This is the bread and butter of the state machine. Incoming events are delegated to the given states which then handle the event.…
videoprocessingsrc/pipelineStates.py:111
WHAT IT DOES

This is the bread and butter of the state machine. Incoming events are delegated to the given states which then handle the event. The result is then assigned as the new state.

SIGNATURE
on_event(self, event, sender)
PARAMETERS
self
event
sender
RETURNS Not documented
SOURCE videoprocessingsrc/pipelineStates.py:111
getCurrentStat
No description documented yet.
videoprocessingsrc/pipelineStates.py:121
WHAT IT DOES

No description documented yet.

SIGNATURE
getCurrentStat(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/pipelineStates.py:121
videoprocessingsrc/state.py · State
5 symbols
__init__
No description documented yet.
videoprocessingsrc/state.py:12
WHAT IT DOES

No description documented yet.

SIGNATURE
__init__(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/state.py:12
next_state
No description documented yet.
videoprocessingsrc/state.py:15
WHAT IT DOES

No description documented yet.

SIGNATURE
next_state(self, state)
PARAMETERS
self
state
RETURNS Not documented
SOURCE videoprocessingsrc/state.py:15
on_event
Handle events that are delegated to this State.
videoprocessingsrc/state.py:20
WHAT IT DOES

Handle events that are delegated to this State.

SIGNATURE
on_event(self, event)
PARAMETERS
self
event
RETURNS Not documented
SOURCE videoprocessingsrc/state.py:20
__repr__
Leverages the __str__ method to describe the State.
videoprocessingsrc/state.py:26
WHAT IT DOES

Leverages the __str__ method to describe the State.

SIGNATURE
__repr__(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/state.py:26
__str__
Returns the name of the State.
videoprocessingsrc/state.py:32
WHAT IT DOES

Returns the name of the State.

SIGNATURE
__str__(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/state.py:32
videoprocessingsrc/userStats.py · UserStats
6 symbols
saveImage
No description documented yet.
videoprocessingsrc/userStats.py:10
WHAT IT DOES

No description documented yet.

SIGNATURE
saveImage(self, imagepath, imagename, frame)
PARAMETERS
self
imagepath
imagename
frame
RETURNS Not documented
SOURCE videoprocessingsrc/userStats.py:10
userAdmin
No description documented yet.
videoprocessingsrc/userStats.py:15
WHAT IT DOES

No description documented yet.

SIGNATURE
userAdmin(self, status, name, frame, font, imagename, imagepath, left, right, bottom, top, recperesntage)
PARAMETERS
self
status
name
frame
font
imagename
imagepath
left
right
bottom
top
recperesntage
RETURNS Not documented
SOURCE videoprocessingsrc/userStats.py:15
userUser
No description documented yet.
videoprocessingsrc/userStats.py:37
WHAT IT DOES

No description documented yet.

SIGNATURE
userUser(self, status, name, frame, font, left, right, bottom, top, recperesntage, imagename, imagepath)
PARAMETERS
self
status
name
frame
font
left
right
bottom
top
recperesntage
imagename
imagepath
RETURNS Not documented
SOURCE videoprocessingsrc/userStats.py:37
userUnwanted
No description documented yet.
videoprocessingsrc/userStats.py:60
WHAT IT DOES

No description documented yet.

SIGNATURE
userUnwanted(self, status, name, frame, font, imagename, imagePath, left, right, bottom, top, recperesntage)
PARAMETERS
self
status
name
frame
font
imagename
imagePath
left
right
bottom
top
recperesntage
RETURNS Not documented
SOURCE videoprocessingsrc/userStats.py:60
userUnknown
No description documented yet.
videoprocessingsrc/userStats.py:74
WHAT IT DOES

No description documented yet.

SIGNATURE
userUnknown(self, opencvconfig, name, frame, font, imagepath, imagename, left, right, bottom, top, framenum, recperesntage)
PARAMETERS
self
opencvconfig
name
frame
font
imagepath
imagename
left
right
bottom
top
framenum
recperesntage
RETURNS Not documented
SOURCE videoprocessingsrc/userStats.py:74
userGroup
No description documented yet.
videoprocessingsrc/userStats.py:95
WHAT IT DOES

No description documented yet.

SIGNATURE
userGroup(self, frame, font, imagepath, imagename, left, right, bottom, top)
PARAMETERS
self
frame
font
imagepath
imagename
left
right
bottom
top
RETURNS Not documented
SOURCE videoprocessingsrc/userStats.py:95
videoprocessingsrc/videoRequired.py · RequiredCode
14 symbols
setupPipeline
No description documented yet.
videoprocessingsrc/videoRequired.py:38
WHAT IT DOES

No description documented yet.

SIGNATURE
setupPipeline(self, sender)
PARAMETERS
self
sender
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:38
trainPipeLine
No description documented yet.
videoprocessingsrc/videoRequired.py:76
WHAT IT DOES

No description documented yet.

SIGNATURE
trainPipeLine(self, sender)
PARAMETERS
self
sender
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:76
reconitionPipeline
No description documented yet.
videoprocessingsrc/videoRequired.py:90
WHAT IT DOES

No description documented yet.

SIGNATURE
reconitionPipeline(self, sender)
PARAMETERS
self
sender
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:90
getAmmountOfFaces
No description documented yet.
videoprocessingsrc/videoRequired.py:263
WHAT IT DOES

No description documented yet.

SIGNATURE
getAmmountOfFaces(self, image)
PARAMETERS
self
image
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:263
makefiledirs
No description documented yet.
videoprocessingsrc/videoRequired.py:268
WHAT IT DOES

No description documented yet.

SIGNATURE
makefiledirs(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:268
covertDictUserData
No description documented yet.
videoprocessingsrc/videoRequired.py:277
WHAT IT DOES

No description documented yet.

SIGNATURE
covertDictUserData(self, i)
PARAMETERS
self
i
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:277
UserDataList
No description documented yet.
videoprocessingsrc/videoRequired.py:283
WHAT IT DOES

No description documented yet.

SIGNATURE
UserDataList(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:283
downloadFacesAndProssesThem
No description documented yet.
videoprocessingsrc/videoRequired.py:310
WHAT IT DOES

No description documented yet.

SIGNATURE
downloadFacesAndProssesThem(self, data, filepath)
PARAMETERS
self
data
filepath
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:310
downloadUserFaces
No description documented yet.
videoprocessingsrc/videoRequired.py:324
WHAT IT DOES

No description documented yet.

SIGNATURE
downloadUserFaces(self, imagePath)
PARAMETERS
self
imagePath
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:324
sendProgramStatus
No description documented yet.
videoprocessingsrc/videoRequired.py:350
WHAT IT DOES

No description documented yet.

SIGNATURE
sendProgramStatus(self, sender, status, pipelinePos, time)
PARAMETERS
self
sender
status
pipelinePos
time
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:350
sendFaceCount
No description documented yet.
videoprocessingsrc/videoRequired.py:360
WHAT IT DOES

No description documented yet.

SIGNATURE
sendFaceCount(self, sender, total, unknown, reconized, time)
PARAMETERS
self
sender
total
unknown
reconized
time
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:360
sendUserInfoToSocket
No description documented yet.
videoprocessingsrc/videoRequired.py:371
WHAT IT DOES

No description documented yet.

SIGNATURE
sendUserInfoToSocket(self, sender, status, user, image, time, phonenumber)
PARAMETERS
self
sender
status
user
image
time
phonenumber
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:371
setUpIndicatorLight
No description documented yet.
videoprocessingsrc/videoRequired.py:379
WHAT IT DOES

No description documented yet.

SIGNATURE
setUpIndicatorLight(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:379
setProcessingLed
No description documented yet.
videoprocessingsrc/videoRequired.py:389
WHAT IT DOES

No description documented yet.

SIGNATURE
setProcessingLed(self, processing)
PARAMETERS
self
processing
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:389
videoprocessingsrc/videoThread.py · ThreadingClass
4 symbols
__init__
No description documented yet.
videoprocessingsrc/videoThread.py:8
WHAT IT DOES

No description documented yet.

SIGNATURE
__init__(self, name)
PARAMETERS
self
name
RETURNS Not documented
SOURCE videoprocessingsrc/videoThread.py:8
_reader
No description documented yet.
videoprocessingsrc/videoThread.py:19
WHAT IT DOES

No description documented yet.

SIGNATURE
_reader(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/videoThread.py:19
read
No description documented yet.
videoprocessingsrc/videoThread.py:31
WHAT IT DOES

No description documented yet.

SIGNATURE
read(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/videoThread.py:31
release
No description documented yet.
videoprocessingsrc/videoThread.py:34
WHAT IT DOES

No description documented yet.

SIGNATURE
release(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/videoThread.py:34
06
BARKLY DOCS

Classes

Classes stay collapsed so large projects remain readable.

0
Parameter
No description documented yet.
0 methods
barkly_docs.py:139
No description documented yet.
No methods discovered.
FunctionInfo
No description documented yet.
2 methods
barkly_docs.py:147
No description documented yet.
qualified_name
No description documented yet.
barkly_docs.py:161
WHAT IT DOES

No description documented yet.

SIGNATURE
qualified_name(self) -> str
PARAMETERS
self
RETURNS str
SOURCE barkly_docs.py:161
DECORATORS
property
signature
No description documented yet.
barkly_docs.py:167
WHAT IT DOES

No description documented yet.

SIGNATURE
signature(self) -> str
PARAMETERS
self
RETURNS str
SOURCE barkly_docs.py:167
DECORATORS
property
ClassInfo
No description documented yet.
0 methods
barkly_docs.py:190
No description documented yet.
No methods discovered.
EndpointInfo
No description documented yet.
1 methods
barkly_docs.py:202
No description documented yet.
method_text
No description documented yet.
barkly_docs.py:217
WHAT IT DOES

No description documented yet.

SIGNATURE
method_text(self) -> str
PARAMETERS
self
RETURNS str
SOURCE barkly_docs.py:217
DECORATORS
property
ModuleInfo
No description documented yet.
0 methods
barkly_docs.py:222
No description documented yet.
No methods discovered.
PythonScanner
No description documented yet.
7 methods
barkly_docs.py:606
No description documented yet.
__init__
No description documented yet.
barkly_docs.py:607
WHAT IT DOES

No description documented yet.

SIGNATURE
__init__(self, root: Path)
PARAMETERS
self
root
Path
RETURNS Not documented
SOURCE barkly_docs.py:607
scan
No description documented yet.
barkly_docs.py:615
WHAT IT DOES

No description documented yet.

SIGNATURE
scan(self) -> None
PARAMETERS
self
RETURNS None
SOURCE barkly_docs.py:615
scan_file
No description documented yet.
barkly_docs.py:622
WHAT IT DOES

No description documented yet.

SIGNATURE
scan_file(self, path: Path) -> None
PARAMETERS
self
path
Path
RETURNS None
SOURCE barkly_docs.py:622
function_node_for_class_method
No description documented yet.
barkly_docs.py:680
WHAT IT DOES

No description documented yet.

SIGNATURE
function_node_for_class_method(self, class_node: ast.ClassDef, method_name: str) -> Optional[ast.FunctionDef | ast.AsyncFunctionDef]
PARAMETERS
self
class_node
ast.ClassDef
method_name
str
RETURNS Optional[ast.FunctionDef | ast.AsyncFunctionDef]
SOURCE barkly_docs.py:680
make_function
No description documented yet.
barkly_docs.py:695
WHAT IT DOES

No description documented yet.

SIGNATURE
make_function(self, node: ast.FunctionDef | ast.AsyncFunctionDef, file: str, class_name: str = '') -> FunctionInfo
PARAMETERS
self
node
ast.FunctionDef | ast.AsyncFunctionDef
file
str
class_name
str
= ''
RETURNS FunctionInfo
SOURCE barkly_docs.py:695
make_class
No description documented yet.
barkly_docs.py:714
WHAT IT DOES

No description documented yet.

SIGNATURE
make_class(self, node: ast.ClassDef, file: str) -> ClassInfo
PARAMETERS
self
node
ast.ClassDef
file
str
RETURNS ClassInfo
SOURCE barkly_docs.py:714
find_endpoints
No description documented yet.
barkly_docs.py:744
WHAT IT DOES

No description documented yet.

SIGNATURE
find_endpoints(self, node: Optional[ast.FunctionDef | ast.AsyncFunctionDef], file: str) -> None
PARAMETERS
self
node
Optional[ast.FunctionDef | ast.AsyncFunctionDef]
file
str
RETURNS None
SOURCE barkly_docs.py:744
TestConfig
No description documented yet.
1 methods
tests/test_config.py:73
No description documented yet.
test_config_reading
No description documented yet.
tests/test_config.py:80
WHAT IT DOES

No description documented yet.

SIGNATURE
test_config_reading(self)
PARAMETERS
self
RETURNS Not documented
SOURCE tests/test_config.py:80
TestFaceData
This is for only testing the name is correct
5 methods
tests/test_face_data_structure.py:7
This is for only testing the name is correct
test_data_structure_user_name_
No description documented yet.
tests/test_face_data_structure.py:12
WHAT IT DOES

No description documented yet.

SIGNATURE
test_data_structure_user_name_(self)
PARAMETERS
self
RETURNS Not documented
SOURCE tests/test_face_data_structure.py:12
test_data_structure_user_status
No description documented yet.
tests/test_face_data_structure.py:21
WHAT IT DOES

No description documented yet.

SIGNATURE
test_data_structure_user_status(self)
PARAMETERS
self
RETURNS Not documented
SOURCE tests/test_face_data_structure.py:21
test_data_structure_user_image
No description documented yet.
tests/test_face_data_structure.py:30
WHAT IT DOES

No description documented yet.

SIGNATURE
test_data_structure_user_image(self)
PARAMETERS
self
RETURNS Not documented
SOURCE tests/test_face_data_structure.py:30
test_data_structure_user_image_url
No description documented yet.
tests/test_face_data_structure.py:40
WHAT IT DOES

No description documented yet.

SIGNATURE
test_data_structure_user_image_url(self)
PARAMETERS
self
RETURNS Not documented
SOURCE tests/test_face_data_structure.py:40
test_data_structure_user_phonenumber
No description documented yet.
tests/test_face_data_structure.py:49
WHAT IT DOES

No description documented yet.

SIGNATURE
test_data_structure_user_phonenumber(self)
PARAMETERS
self
RETURNS Not documented
SOURCE tests/test_face_data_structure.py:49
TestKnnClass
This is for only testing if kkn clasifiyer is none def test_training_knn_clasifiyer(self): data= knn.train(train_dir=co…
0 methods
tests/test_knn_clasifiyer.py:9
This is for only testing if kkn clasifiyer is none def test_training_knn_clasifiyer(self): data= knn.train(train_dir=config.TEST_TRAIN_DIR,model_save_path=config.TEST_TRAIN_DIR+"test.model",n_neighbors=2) self.assertIsNone(data) this will test trained test knn classifiyer aginst a known image UwU def test_read_knn_classifiyer(self): predict = knn.predict(config.READIMAGE,knn_clf=knn.loadTrainedModel(knn_clf=None,model_path=config.TEST_TRAIN_DIR+"test.model"), distance_threshold=0.65) self.assertEqual(predict,('me', (145, 312, 287, 170)))
No methods discovered.
UserData
No description documented yet.
0 methods
video-processing-src/faceDataStruture.py:9
No description documented yet.
No methods discovered.
UserData
No description documented yet.
13 methods
videoprocessingsrc/faceDataStruture.py:7
No description documented yet.
__init__
No description documented yet.
videoprocessingsrc/faceDataStruture.py:18
WHAT IT DOES

No description documented yet.

SIGNATURE
__init__(self, name: str, status: str, image: str, downloadurl: str, phonenumber: str) -> list
PARAMETERS
self
name
str
status
str
image
str
downloadurl
str
phonenumber
str
RETURNS list
SOURCE videoprocessingsrc/faceDataStruture.py:18
getSumOfDigits
No description documented yet.
videoprocessingsrc/faceDataStruture.py:26
WHAT IT DOES

No description documented yet.

SIGNATURE
getSumOfDigits(self, phonenumber) -> int
PARAMETERS
self
phonenumber
RETURNS int
SOURCE videoprocessingsrc/faceDataStruture.py:26
setUserName
No description documented yet.
videoprocessingsrc/faceDataStruture.py:32
WHAT IT DOES

No description documented yet.

SIGNATURE
setUserName(self, name) -> str
PARAMETERS
self
name
RETURNS str
SOURCE videoprocessingsrc/faceDataStruture.py:32
setUserStatus
No description documented yet.
videoprocessingsrc/faceDataStruture.py:43
WHAT IT DOES

No description documented yet.

SIGNATURE
setUserStatus(self, status) -> str
PARAMETERS
self
status
RETURNS str
SOURCE videoprocessingsrc/faceDataStruture.py:43
setUserImg
No description documented yet.
videoprocessingsrc/faceDataStruture.py:53
WHAT IT DOES

No description documented yet.

SIGNATURE
setUserImg(self, img) -> str
PARAMETERS
self
img
RETURNS str
SOURCE videoprocessingsrc/faceDataStruture.py:53
setUserUrl
No description documented yet.
videoprocessingsrc/faceDataStruture.py:62
WHAT IT DOES

No description documented yet.

SIGNATURE
setUserUrl(self, url)
PARAMETERS
self
url
RETURNS Not documented
SOURCE videoprocessingsrc/faceDataStruture.py:62
setUserPhoneNumber
No description documented yet.
videoprocessingsrc/faceDataStruture.py:72
WHAT IT DOES

No description documented yet.

SIGNATURE
setUserPhoneNumber(self, phonenumber) -> int
PARAMETERS
self
phonenumber
RETURNS int
SOURCE videoprocessingsrc/faceDataStruture.py:72
getUserName
No description documented yet.
videoprocessingsrc/faceDataStruture.py:90
WHAT IT DOES

No description documented yet.

SIGNATURE
getUserName(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/faceDataStruture.py:90
getUserStatus
No description documented yet.
videoprocessingsrc/faceDataStruture.py:95
WHAT IT DOES

No description documented yet.

SIGNATURE
getUserStatus(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/faceDataStruture.py:95
getUserImg
No description documented yet.
videoprocessingsrc/faceDataStruture.py:100
WHAT IT DOES

No description documented yet.

SIGNATURE
getUserImg(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/faceDataStruture.py:100
getUserUrl
No description documented yet.
videoprocessingsrc/faceDataStruture.py:105
WHAT IT DOES

No description documented yet.

SIGNATURE
getUserUrl(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/faceDataStruture.py:105
getUserPhoneNumber
No description documented yet.
videoprocessingsrc/faceDataStruture.py:110
WHAT IT DOES

No description documented yet.

SIGNATURE
getUserPhoneNumber(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/faceDataStruture.py:110
__repr__
No description documented yet.
videoprocessingsrc/faceDataStruture.py:114
WHAT IT DOES

No description documented yet.

SIGNATURE
__repr__(self) -> list
PARAMETERS
self
RETURNS list
SOURCE videoprocessingsrc/faceDataStruture.py:114
States
No description documented yet.
0 methods
videoprocessingsrc/pipelineStates.py:14
No description documented yet.
No methods discovered.
SetupPipeLine
The state which Sets Up Whole opencv pipeline
1 methods
videoprocessingsrc/pipelineStates.py:22
The state which Sets Up Whole opencv pipeline
on_event
No description documented yet.
videoprocessingsrc/pipelineStates.py:27
WHAT IT DOES

No description documented yet.

SIGNATURE
on_event(self, event, sender)
PARAMETERS
self
event
sender
RETURNS Not documented
SOURCE videoprocessingsrc/pipelineStates.py:27
TrainPipeline
The state which Trains the Reconized face Models
1 methods
videoprocessingsrc/pipelineStates.py:36
The state which Trains the Reconized face Models
on_event
No description documented yet.
videoprocessingsrc/pipelineStates.py:41
WHAT IT DOES

No description documented yet.

SIGNATURE
on_event(self, event, sender)
PARAMETERS
self
event
sender
RETURNS Not documented
SOURCE videoprocessingsrc/pipelineStates.py:41
RunReconitionPipeLine
The state which Reconizes Faces
1 methods
videoprocessingsrc/pipelineStates.py:50
The state which Reconizes Faces
on_event
No description documented yet.
videoprocessingsrc/pipelineStates.py:55
WHAT IT DOES

No description documented yet.

SIGNATURE
on_event(self, event, sender)
PARAMETERS
self
event
sender
RETURNS Not documented
SOURCE videoprocessingsrc/pipelineStates.py:55
Idle
The state which The program waits for a face to be spotted
1 methods
videoprocessingsrc/pipelineStates.py:64
The state which The program waits for a face to be spotted
on_event
No description documented yet.
videoprocessingsrc/pipelineStates.py:69
WHAT IT DOES

No description documented yet.

SIGNATURE
on_event(self, event, sender)
PARAMETERS
self
event
sender
RETURNS Not documented
SOURCE videoprocessingsrc/pipelineStates.py:69
Error
The state which The program waits for a face to be spotted
2 methods
videoprocessingsrc/pipelineStates.py:78
The state which The program waits for a face to be spotted
__init__
No description documented yet.
videoprocessingsrc/pipelineStates.py:83
WHAT IT DOES

No description documented yet.

SIGNATURE
__init__(self, message)
PARAMETERS
self
message
RETURNS Not documented
SOURCE videoprocessingsrc/pipelineStates.py:83
on_event
No description documented yet.
videoprocessingsrc/pipelineStates.py:87
WHAT IT DOES

No description documented yet.

SIGNATURE
on_event(self, event, sender)
PARAMETERS
self
event
sender
RETURNS Not documented
SOURCE videoprocessingsrc/pipelineStates.py:87
PipeLine
A simple state machine that mimics the functionality of a device from a high level.
3 methods
videoprocessingsrc/pipelineStates.py:98
A simple state machine that mimics the functionality of a device from a high level.
__init__
Initialize the components.
videoprocessingsrc/pipelineStates.py:104
WHAT IT DOES

Initialize the components.

SIGNATURE
__init__(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/pipelineStates.py:104
on_event
This is the bread and butter of the state machine. Incoming events are delegated to the given states which then handle the event.…
videoprocessingsrc/pipelineStates.py:111
WHAT IT DOES

This is the bread and butter of the state machine. Incoming events are delegated to the given states which then handle the event. The result is then assigned as the new state.

SIGNATURE
on_event(self, event, sender)
PARAMETERS
self
event
sender
RETURNS Not documented
SOURCE videoprocessingsrc/pipelineStates.py:111
getCurrentStat
No description documented yet.
videoprocessingsrc/pipelineStates.py:121
WHAT IT DOES

No description documented yet.

SIGNATURE
getCurrentStat(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/pipelineStates.py:121
State
We define a state object which provides some utility functions for the individual states within the state machine.
5 methods
videoprocessingsrc/state.py:6
We define a state object which provides some utility functions for the individual states within the state machine.
__init__
No description documented yet.
videoprocessingsrc/state.py:12
WHAT IT DOES

No description documented yet.

SIGNATURE
__init__(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/state.py:12
next_state
No description documented yet.
videoprocessingsrc/state.py:15
WHAT IT DOES

No description documented yet.

SIGNATURE
next_state(self, state)
PARAMETERS
self
state
RETURNS Not documented
SOURCE videoprocessingsrc/state.py:15
on_event
Handle events that are delegated to this State.
videoprocessingsrc/state.py:20
WHAT IT DOES

Handle events that are delegated to this State.

SIGNATURE
on_event(self, event)
PARAMETERS
self
event
RETURNS Not documented
SOURCE videoprocessingsrc/state.py:20
__repr__
Leverages the __str__ method to describe the State.
videoprocessingsrc/state.py:26
WHAT IT DOES

Leverages the __str__ method to describe the State.

SIGNATURE
__repr__(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/state.py:26
__str__
Returns the name of the State.
videoprocessingsrc/state.py:32
WHAT IT DOES

Returns the name of the State.

SIGNATURE
__str__(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/state.py:32
UserStats
No description documented yet.
6 methods
videoprocessingsrc/userStats.py:7
No description documented yet.
saveImage
No description documented yet.
videoprocessingsrc/userStats.py:10
WHAT IT DOES

No description documented yet.

SIGNATURE
saveImage(self, imagepath, imagename, frame)
PARAMETERS
self
imagepath
imagename
frame
RETURNS Not documented
SOURCE videoprocessingsrc/userStats.py:10
userAdmin
No description documented yet.
videoprocessingsrc/userStats.py:15
WHAT IT DOES

No description documented yet.

SIGNATURE
userAdmin(self, status, name, frame, font, imagename, imagepath, left, right, bottom, top, recperesntage)
PARAMETERS
self
status
name
frame
font
imagename
imagepath
left
right
bottom
top
recperesntage
RETURNS Not documented
SOURCE videoprocessingsrc/userStats.py:15
userUser
No description documented yet.
videoprocessingsrc/userStats.py:37
WHAT IT DOES

No description documented yet.

SIGNATURE
userUser(self, status, name, frame, font, left, right, bottom, top, recperesntage, imagename, imagepath)
PARAMETERS
self
status
name
frame
font
left
right
bottom
top
recperesntage
imagename
imagepath
RETURNS Not documented
SOURCE videoprocessingsrc/userStats.py:37
userUnwanted
No description documented yet.
videoprocessingsrc/userStats.py:60
WHAT IT DOES

No description documented yet.

SIGNATURE
userUnwanted(self, status, name, frame, font, imagename, imagePath, left, right, bottom, top, recperesntage)
PARAMETERS
self
status
name
frame
font
imagename
imagePath
left
right
bottom
top
recperesntage
RETURNS Not documented
SOURCE videoprocessingsrc/userStats.py:60
userUnknown
No description documented yet.
videoprocessingsrc/userStats.py:74
WHAT IT DOES

No description documented yet.

SIGNATURE
userUnknown(self, opencvconfig, name, frame, font, imagepath, imagename, left, right, bottom, top, framenum, recperesntage)
PARAMETERS
self
opencvconfig
name
frame
font
imagepath
imagename
left
right
bottom
top
framenum
recperesntage
RETURNS Not documented
SOURCE videoprocessingsrc/userStats.py:74
userGroup
No description documented yet.
videoprocessingsrc/userStats.py:95
WHAT IT DOES

No description documented yet.

SIGNATURE
userGroup(self, frame, font, imagepath, imagename, left, right, bottom, top)
PARAMETERS
self
frame
font
imagepath
imagename
left
right
bottom
top
RETURNS Not documented
SOURCE videoprocessingsrc/userStats.py:95
Status
No description documented yet.
0 methods
videoprocessingsrc/videoRequired.py:21
No description documented yet.
No methods discovered.
RequiredCode
No description documented yet.
14 methods
videoprocessingsrc/videoRequired.py:27
No description documented yet.
setupPipeline
No description documented yet.
videoprocessingsrc/videoRequired.py:38
WHAT IT DOES

No description documented yet.

SIGNATURE
setupPipeline(self, sender)
PARAMETERS
self
sender
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:38
trainPipeLine
No description documented yet.
videoprocessingsrc/videoRequired.py:76
WHAT IT DOES

No description documented yet.

SIGNATURE
trainPipeLine(self, sender)
PARAMETERS
self
sender
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:76
reconitionPipeline
No description documented yet.
videoprocessingsrc/videoRequired.py:90
WHAT IT DOES

No description documented yet.

SIGNATURE
reconitionPipeline(self, sender)
PARAMETERS
self
sender
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:90
getAmmountOfFaces
No description documented yet.
videoprocessingsrc/videoRequired.py:263
WHAT IT DOES

No description documented yet.

SIGNATURE
getAmmountOfFaces(self, image)
PARAMETERS
self
image
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:263
makefiledirs
No description documented yet.
videoprocessingsrc/videoRequired.py:268
WHAT IT DOES

No description documented yet.

SIGNATURE
makefiledirs(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:268
covertDictUserData
No description documented yet.
videoprocessingsrc/videoRequired.py:277
WHAT IT DOES

No description documented yet.

SIGNATURE
covertDictUserData(self, i)
PARAMETERS
self
i
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:277
UserDataList
No description documented yet.
videoprocessingsrc/videoRequired.py:283
WHAT IT DOES

No description documented yet.

SIGNATURE
UserDataList(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:283
downloadFacesAndProssesThem
No description documented yet.
videoprocessingsrc/videoRequired.py:310
WHAT IT DOES

No description documented yet.

SIGNATURE
downloadFacesAndProssesThem(self, data, filepath)
PARAMETERS
self
data
filepath
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:310
downloadUserFaces
No description documented yet.
videoprocessingsrc/videoRequired.py:324
WHAT IT DOES

No description documented yet.

SIGNATURE
downloadUserFaces(self, imagePath)
PARAMETERS
self
imagePath
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:324
sendProgramStatus
No description documented yet.
videoprocessingsrc/videoRequired.py:350
WHAT IT DOES

No description documented yet.

SIGNATURE
sendProgramStatus(self, sender, status, pipelinePos, time)
PARAMETERS
self
sender
status
pipelinePos
time
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:350
sendFaceCount
No description documented yet.
videoprocessingsrc/videoRequired.py:360
WHAT IT DOES

No description documented yet.

SIGNATURE
sendFaceCount(self, sender, total, unknown, reconized, time)
PARAMETERS
self
sender
total
unknown
reconized
time
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:360
sendUserInfoToSocket
No description documented yet.
videoprocessingsrc/videoRequired.py:371
WHAT IT DOES

No description documented yet.

SIGNATURE
sendUserInfoToSocket(self, sender, status, user, image, time, phonenumber)
PARAMETERS
self
sender
status
user
image
time
phonenumber
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:371
setUpIndicatorLight
No description documented yet.
videoprocessingsrc/videoRequired.py:379
WHAT IT DOES

No description documented yet.

SIGNATURE
setUpIndicatorLight(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:379
setProcessingLed
No description documented yet.
videoprocessingsrc/videoRequired.py:389
WHAT IT DOES

No description documented yet.

SIGNATURE
setProcessingLed(self, processing)
PARAMETERS
self
processing
RETURNS Not documented
SOURCE videoprocessingsrc/videoRequired.py:389
ThreadingClass
No description documented yet.
4 methods
videoprocessingsrc/videoThread.py:6
No description documented yet.
__init__
No description documented yet.
videoprocessingsrc/videoThread.py:8
WHAT IT DOES

No description documented yet.

SIGNATURE
__init__(self, name)
PARAMETERS
self
name
RETURNS Not documented
SOURCE videoprocessingsrc/videoThread.py:8
_reader
No description documented yet.
videoprocessingsrc/videoThread.py:19
WHAT IT DOES

No description documented yet.

SIGNATURE
_reader(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/videoThread.py:19
read
No description documented yet.
videoprocessingsrc/videoThread.py:31
WHAT IT DOES

No description documented yet.

SIGNATURE
read(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/videoThread.py:31
release
No description documented yet.
videoprocessingsrc/videoThread.py:34
WHAT IT DOES

No description documented yet.

SIGNATURE
release(self)
PARAMETERS
self
RETURNS Not documented
SOURCE videoprocessingsrc/videoThread.py:34
07
BARKLY DOCS

Modules

A lightweight map of source files and their discovered contents.

barkly_docs.py
66 symbols
10 imports
FUNCTIONS 50
CLASSES 6
IMPORTS 10
IMPORTS
__future__argparseasthashlibhtmljsonsubprocessdataclassespathlibtyping
bin/SecuSeveCVModel.py
0 symbols
0 imports
FUNCTIONS 0
CLASSES 0
IMPORTS 0
tests/__init__.py
0 symbols
0 imports
FUNCTIONS 0
CLASSES 0
IMPORTS 0
tests/config.py
0 symbols
2 imports
FUNCTIONS 0
CLASSES 0
IMPORTS 2
IMPORTS
cv2pathlib
tests/test_config.py
2 symbols
4 imports
FUNCTIONS 0
CLASSES 1
IMPORTS 4
IMPORTS
configparserunittestunittest.mockpathlib
tests/test_face_data_structure.py
6 symbols
2 imports
FUNCTIONS 0
CLASSES 1
IMPORTS 2
IMPORTS
unittestvideoprocessingsrc.faceDataStruture
tests/test_knn_clasifiyer.py
1 symbols
2 imports
FUNCTIONS 0
CLASSES 1
IMPORTS 2
IMPORTS
unittestvideoprocessingsrc
video-processing-src/__init__.py
0 symbols
3 imports
FUNCTIONS 0
CLASSES 0
IMPORTS 3
IMPORTS
wgetpathlibcv2
video-processing-src/faceDataStruture.py
1 symbols
1 imports
FUNCTIONS 0
CLASSES 1
IMPORTS 1
IMPORTS
dataclasses
videoprocessingsrc/__init__.py
0 symbols
0 imports
FUNCTIONS 0
CLASSES 0
IMPORTS 0
videoprocessingsrc/__main__.py
1 symbols
3 imports
FUNCTIONS 1
CLASSES 0
IMPORTS 3
IMPORTS
importspipelineStatesconst
videoprocessingsrc/consoleLog.py
6 symbols
1 imports
FUNCTIONS 6
CLASSES 0
IMPORTS 1
IMPORTS
imports
videoprocessingsrc/const.py
0 symbols
2 imports
FUNCTIONS 0
CLASSES 0
IMPORTS 2
IMPORTS
importspipelineStates
videoprocessingsrc/database.py
12 symbols
2 imports
FUNCTIONS 12
CLASSES 0
IMPORTS 2
IMPORTS
importsconst
videoprocessingsrc/faceDataStruture.py
14 symbols
0 imports
FUNCTIONS 0
CLASSES 1
IMPORTS 0
videoprocessingsrc/imports.py
0 symbols
59 imports
FUNCTIONS 0
CLASSES 0
IMPORTS 59
IMPORTS
loggingnumbersgcos.pathshutiltokenizecv2face_recognitionnumpyosdatetimetimeloggingzmqtimethreadingsysmathpathlibrequestssqlalchemysqlalchemy.dialects.sqliteconfigparsersqlalchemy.ormwgetpathlibconfigparserloggingnumbersos.pathshutiltokenizecv2face_recognitionnumpyosdatetimetimeloggingzmqtimethreadingmathfaceDataStrutureconsoleLogvideoRequiredrequestssqlalchemysqlalchemy.dialects.sqliteconfigparsersqlalchemy.ormwgetpathlibconfigparsercoloramadatabasethreadingqueuezmq.asyncio
videoprocessingsrc/knnClasifiyer.py
7 symbols
8 imports
FUNCTIONS 7
CLASSES 0
IMPORTS 8
IMPORTS
ospickleface_recognitionmathjsonsklearnface_recognition.face_recognition_cliconst
videoprocessingsrc/pipelineStates.py
16 symbols
6 imports
FUNCTIONS 0
CLASSES 7
IMPORTS 6
IMPORTS
enumzmq.sugar.framevideoRequiredconsoleLogstatedatetime
videoprocessingsrc/recvmessage.py
0 symbols
2 imports
FUNCTIONS 0
CLASSES 0
IMPORTS 2
IMPORTS
zmqcolorama
videoprocessingsrc/state.py
6 symbols
1 imports
FUNCTIONS 0
CLASSES 1
IMPORTS 1
IMPORTS
consoleLog
videoprocessingsrc/userStats.py
7 symbols
1 imports
FUNCTIONS 0
CLASSES 1
IMPORTS 1
IMPORTS
imports
videoprocessingsrc/videoRequired.py
16 symbols
10 imports
FUNCTIONS 0
CLASSES 2
IMPORTS 10
IMPORTS
enumosJetson.GPIO.gpioimportsconstpipelineStatesknnClasifiyervideoThreaduserStatsRPi.GPIO
videoprocessingsrc/videoThread.py
5 symbols
1 imports
FUNCTIONS 0
CLASSES 1
IMPORTS 1
IMPORTS
imports
08
BARKLY DOCS

Imports

Dependencies discovered from Python import statements.

DISCOVERED 57
SOURCE FILES 23
Jetson.GPIO.gpioRPi.GPIO__future__argparseastcoloramaconfigparserconsoleLogconstcv2databasedataclassesdatetimeenumfaceDataStrutureface_recognitionface_recognition.face_recognition_cligchashlibhtmlimportsjsonknnClasifiyerloggingmathnumbersnumpyosos.pathpathlibpicklepipelineStatesqueuerequestsshutilsklearnsqlalchemysqlalchemy.dialects.sqlitesqlalchemy.ormstatesubprocesssysthreadingtimetokenizetypingunittestunittest.mockuserStatsvideoRequiredvideoThreadvideoprocessingsrcvideoprocessingsrc.faceDataStruturewgetzmqzmq.asynciozmq.sugar.frame
09
BARKLY DOCS

Lifecycle

The development path used by the project.

01
Idea
02
Research
03
Experiment
04
Prototype
05
Validation
06
Engineering
07
Integration
08
Testing
09
Release
10
Feedback
11
Continued Development
10
BARKLY DOCS

Git

Repository state and recent development history.

BRANCH
main
COMMIT
16e353f
NEW FUNCTIONS
0
CHANGED FUNCTIONS
0
NEW CLASSES
0
CHANGED CLASSES
0
NEW ENDPOINTS
0
CHANGED ENDPOINTS
0
RECENT COMMITS
16e353f|2021-09-30|Update codesee-arch-diagram.yml
dd848bb|2021-09-30|Merge pull request #1 from NicholasBlackburn1/Dev
ea8f879|2021-09-30|Update codesee-arch-diagram.yml
f095b41|2021-09-30|Update codesee-arch-diagram.yml
b9028fb|2021-09-30|Add CodeSee architecture diagram workflow to repository
834dd27|2021-09-02|fixed data layout in image output and fixed distances to reconze faces
a3c0132|2021-09-01|added face accuracy to the saved image output
4aa06bd|2021-08-31|fixed admin accuracy doispay
11
BARKLY DOCS

Changelog

What BARKLY DOCS noticed changed between documentation generations.

DOCUMENTATION RUN
#1
Persistent documentation snapshot.
NEW FUNCTIONS
0
Detected since the previous documentation run.
CHANGED FUNCTIONS
0
Signatures, decorators, or documentation changed.
NEW CLASSES
0
Detected since the previous documentation run.
NEW ENDPOINTS
0
Detected since the previous documentation run.
How change detection works

BARKLY DOCS stores a small local snapshot of discovered symbols and compares the next scan against it. The scanner uses static Python AST analysis and never imports or executes the project.

On the first generation, the existing project becomes the baseline. Later generations can identify newly discovered and changed functions, methods, classes, and API endpoints.