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

SecuServe Liveness

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

generation #1 13 python files 59 functions 18 classes 0 endpoints
01
BARKLY DOCS

Project

The smallest useful picture of what this project is.

PROJECT DOCUMENTATION

SecuServe Liveness

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

TYPE
Security / Liveness Detection / Software / Systems
STATUS
Active
PYTHON FILES
13
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 Detection
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
Liveness Detection
02
Input Processing
03
Detection + Analysis
04
Validation
05
Security Integration
06
Result Processing
07
System Monitoring
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:235
WHAT IT DOES

No description documented yet.

SIGNATURE
esc(value: object) -> str
PARAMETERS
value
object
RETURNS str
SOURCE barkly_docs.py:235
compact_doc
No description documented yet.
barkly_docs.py:239
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:239
full_doc
No description documented yet.
barkly_docs.py:251
WHAT IT DOES

No description documented yet.

SIGNATURE
full_doc(doc: str) -> str
PARAMETERS
doc
str
RETURNS str
SOURCE barkly_docs.py:251
expression_text
No description documented yet.
barkly_docs.py:258
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:258
annotation_text
No description documented yet.
barkly_docs.py:268
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:268
relative_file
No description documented yet.
barkly_docs.py:272
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:272
code_line
No description documented yet.
barkly_docs.py:279
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:279
short_hash
No description documented yet.
barkly_docs.py:283
WHAT IT DOES

No description documented yet.

SIGNATURE
short_hash(value: str) -> str
PARAMETERS
value
str
RETURNS str
SOURCE barkly_docs.py:283
safe_call
No description documented yet.
barkly_docs.py:287
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:287
git_branch
No description documented yet.
barkly_docs.py:306
WHAT IT DOES

No description documented yet.

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

No description documented yet.

SIGNATURE
git_commit(root: Path) -> str
PARAMETERS
root
Path
RETURNS str
SOURCE barkly_docs.py:313
git_log
No description documented yet.
barkly_docs.py:320
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:320
node_doc
No description documented yet.
barkly_docs.py:342
WHAT IT DOES

No description documented yet.

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

No description documented yet.

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

No description documented yet.

SIGNATURE
decorator_text(node: ast.AST) -> str
PARAMETERS
node
ast.AST
RETURNS str
SOURCE barkly_docs.py:360
decorators_for
No description documented yet.
barkly_docs.py:364
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:364
parameter_kind
No description documented yet.
barkly_docs.py:371
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:371
collect_parameters
No description documented yet.
barkly_docs.py:396
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:396
call_root_name
No description documented yet.
barkly_docs.py:464
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:464
extract_string_argument
No description documented yet.
barkly_docs.py:474
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:474
extract_methods_keyword
No description documented yet.
barkly_docs.py:489
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:489
endpoint_from_decorator
No description documented yet.
barkly_docs.py:508
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:508
scan_python
No description documented yet.
barkly_docs.py:769
WHAT IT DOES

No description documented yet.

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

No description documented yet.

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

No description documented yet.

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

No description documented yet.

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

No description documented yet.

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

No description documented yet.

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

No description documented yet.

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

No description documented yet.

SIGNATURE
load_state(path: Path) -> dict
PARAMETERS
path
Path
RETURNS dict
SOURCE barkly_docs.py:852
apply_state
No description documented yet.
barkly_docs.py:878
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:878
load_project_config
No description documented yet.
barkly_docs.py:936
WHAT IT DOES

No description documented yet.

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

No description documented yet.

SIGNATURE
init_project(root: Path) -> None
PARAMETERS
root
Path
RETURNS None
SOURCE barkly_docs.py:958
badge
No description documented yet.
barkly_docs.py:980
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:980
status_badges
No description documented yet.
barkly_docs.py:994
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:994
parameter_summary
No description documented yet.
barkly_docs.py:1014
WHAT IT DOES

No description documented yet.

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

No description documented yet.

SIGNATURE
parameter_details(params: list[Parameter]) -> str
PARAMETERS
params
list[Parameter]
RETURNS str
SOURCE barkly_docs.py:1027
function_row
No description documented yet.
barkly_docs.py:1087
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:1087
method_group
No description documented yet.
barkly_docs.py:1196
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:1196
class_group
No description documented yet.
barkly_docs.py:1261
WHAT IT DOES

No description documented yet.

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

No description documented yet.

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

No description documented yet.

SIGNATURE
module_row(module: ModuleInfo) -> str
PARAMETERS
module
ModuleInfo
RETURNS str
SOURCE barkly_docs.py:1464
section
No description documented yet.
barkly_docs.py:1543
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:1543
info_card
No description documented yet.
barkly_docs.py:1583
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:1583
simple_card_grid
No description documented yet.
barkly_docs.py:1610
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:1610
search_toolbar
No description documented yet.
barkly_docs.py:1627
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:1627
build_html
No description documented yet.
barkly_docs.py:1673
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:1673
generate
No description documented yet.
barkly_docs.py:3408
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:3408
build_parser
No description documented yet.
barkly_docs.py:3500
WHAT IT DOES

No description documented yet.

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

No description documented yet.

SIGNATURE
main() -> None
PARAMETERS
No parameters documented.
RETURNS None
SOURCE barkly_docs.py:3564
SecuServe-Livenes-Module/__main__.py
1 symbols
main
No description documented yet.
SecuServe-Livenes-Module/__main__.py:22
WHAT IT DOES

No description documented yet.

SIGNATURE
main()
PARAMETERS
No parameters documented.
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/__main__.py:22
SecuServe-Livenes-Module/utils/consoleLog.py
8 symbols
info
No description documented yet.
SecuServe-Livenes-Module/utils/consoleLog.py:9
WHAT IT DOES

No description documented yet.

SIGNATURE
info(text)
PARAMETERS
text
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/utils/consoleLog.py:9
Debug
No description documented yet.
SecuServe-Livenes-Module/utils/consoleLog.py:14
WHAT IT DOES

No description documented yet.

SIGNATURE
Debug(text)
PARAMETERS
text
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/utils/consoleLog.py:14
Warning
No description documented yet.
SecuServe-Livenes-Module/utils/consoleLog.py:19
WHAT IT DOES

No description documented yet.

SIGNATURE
Warning(text)
PARAMETERS
text
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/utils/consoleLog.py:19
Error
No description documented yet.
SecuServe-Livenes-Module/utils/consoleLog.py:24
WHAT IT DOES

No description documented yet.

SIGNATURE
Error(text)
PARAMETERS
text
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/utils/consoleLog.py:24
PipeLine_Ok
No description documented yet.
SecuServe-Livenes-Module/utils/consoleLog.py:29
WHAT IT DOES

No description documented yet.

SIGNATURE
PipeLine_Ok(text)
PARAMETERS
text
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/utils/consoleLog.py:29
PipeLine_init
No description documented yet.
SecuServe-Livenes-Module/utils/consoleLog.py:34
WHAT IT DOES

No description documented yet.

SIGNATURE
PipeLine_init(text)
PARAMETERS
text
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/utils/consoleLog.py:34
PipeLine_Data
No description documented yet.
SecuServe-Livenes-Module/utils/consoleLog.py:39
WHAT IT DOES

No description documented yet.

SIGNATURE
PipeLine_Data(text)
PARAMETERS
text
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/utils/consoleLog.py:39
dmsgLayout
No description documented yet.
SecuServe-Livenes-Module/utils/consoleLog.py:45
WHAT IT DOES

No description documented yet.

SIGNATURE
dmsgLayout(type, color, message) -> str
PARAMETERS
type
color
message
RETURNS str
SOURCE SecuServe-Livenes-Module/utils/consoleLog.py:45
barkly_docs.py · FunctionInfo
2 symbols
qualified_name
No description documented yet.
barkly_docs.py:163
WHAT IT DOES

No description documented yet.

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

No description documented yet.

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

No description documented yet.

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

No description documented yet.

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

No description documented yet.

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

No description documented yet.

SIGNATURE
scan_file(self, path: Path) -> None
PARAMETERS
self
path
Path
RETURNS None
SOURCE barkly_docs.py:624
function_node_for_class_method
No description documented yet.
barkly_docs.py:682
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:682
make_function
No description documented yet.
barkly_docs.py:697
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:697
make_class
No description documented yet.
barkly_docs.py:716
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:716
find_endpoints
No description documented yet.
barkly_docs.py:746
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:746
SecuServe-Livenes-Module/pipeline/LiveDetection.py · LiveDetection
9 symbols
sendLifeStatus
No description documented yet.
SecuServe-Livenes-Module/pipeline/LiveDetection.py:50
WHAT IT DOES

No description documented yet.

SIGNATURE
sendLifeStatus(self, sender, Alive: bool, hasbody: bool, timesblinked: int)
PARAMETERS
self
sender
Alive
bool
hasbody
bool
timesblinked
int
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/LiveDetection.py:50
sendProgramStatus
No description documented yet.
SecuServe-Livenes-Module/pipeline/LiveDetection.py:58
WHAT IT DOES

No description documented yet.

SIGNATURE
sendProgramStatus(self, sender, status)
PARAMETERS
self
sender
status
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/LiveDetection.py:58
pipelineSetUp
No description documented yet.
SecuServe-Livenes-Module/pipeline/LiveDetection.py:65
WHAT IT DOES

No description documented yet.

SIGNATURE
pipelineSetUp(self, tf, sender)
PARAMETERS
self
tf
sender
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/LiveDetection.py:65
runPipeline
No description documented yet.
SecuServe-Livenes-Module/pipeline/LiveDetection.py:74
WHAT IT DOES

No description documented yet.

SIGNATURE
runPipeline(self, img_receiver, sender)
PARAMETERS
self
img_receiver
sender
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/LiveDetection.py:74
eye_aspect_ratio
No description documented yet.
SecuServe-Livenes-Module/pipeline/LiveDetection.py:110
WHAT IT DOES

No description documented yet.

SIGNATURE
eye_aspect_ratio(self, eye)
PARAMETERS
self
eye
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/LiveDetection.py:110
faceLandmarks
No description documented yet.
SecuServe-Livenes-Module/pipeline/LiveDetection.py:122
WHAT IT DOES

No description documented yet.

SIGNATURE
faceLandmarks(self, rects, predictor, face_utils, gray, image, sender, pose)
PARAMETERS
self
rects
predictor
face_utils
gray
image
sender
pose
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/LiveDetection.py:122
eyeThresholding
No description documented yet.
SecuServe-Livenes-Module/pipeline/LiveDetection.py:172
WHAT IT DOES

No description documented yet.

SIGNATURE
eyeThresholding(self, value)
PARAMETERS
self
value
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/LiveDetection.py:172
localinfo
No description documented yet.
SecuServe-Livenes-Module/pipeline/LiveDetection.py:187
WHAT IT DOES

No description documented yet.

SIGNATURE
localinfo(self, frame, info, title)
PARAMETERS
self
frame
info
title
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/LiveDetection.py:187
detectSkeliton
No description documented yet.
SecuServe-Livenes-Module/pipeline/LiveDetection.py:199
WHAT IT DOES

No description documented yet.

SIGNATURE
detectSkeliton(self, pose, frame)
PARAMETERS
self
pose
frame
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/LiveDetection.py:199
SecuServe-Livenes-Module/pipeline/livenessModel.py · LivenessModel
2 symbols
train
No description documented yet.
SecuServe-Livenes-Module/pipeline/livenessModel.py:21
WHAT IT DOES

No description documented yet.

SIGNATURE
train(self, train_generator, val_generator)
PARAMETERS
self
train_generator
val_generator
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/livenessModel.py:21
isBlinking
@history: A string containing the history of eyes status where a '1' means that the eyes were closed and '0' open. @maxFrames: Th…
SecuServe-Livenes-Module/pipeline/livenessModel.py:58
WHAT IT DOES

@history: A string containing the history of eyes status where a '1' means that the eyes were closed and '0' open. @maxFrames: The maximal number of successive frames where an eye is closed

SIGNATURE
isBlinking(self, history, maxFrames)
PARAMETERS
self
history
maxFrames
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/livenessModel.py:58
SecuServe-Livenes-Module/pipeline/pipelineStates.py · SetupPipeLine
1 symbols
on_event
No description documented yet.
SecuServe-Livenes-Module/pipeline/pipelineStates.py:31
WHAT IT DOES

No description documented yet.

SIGNATURE
on_event(self, event, sender, tf, img_receiver)
PARAMETERS
self
event
sender
tf
img_receiver
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/pipelineStates.py:31
SecuServe-Livenes-Module/pipeline/pipelineStates.py · TrainPipeline
1 symbols
on_event
No description documented yet.
SecuServe-Livenes-Module/pipeline/pipelineStates.py:49
WHAT IT DOES

No description documented yet.

SIGNATURE
on_event(self, event, sender, tf, img_receiver)
PARAMETERS
self
event
sender
tf
img_receiver
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/pipelineStates.py:49
SecuServe-Livenes-Module/pipeline/pipelineStates.py · RunReconitionPipeLine
1 symbols
on_event
No description documented yet.
SecuServe-Livenes-Module/pipeline/pipelineStates.py:64
WHAT IT DOES

No description documented yet.

SIGNATURE
on_event(self, event, sender, tf, img_receiver)
PARAMETERS
self
event
sender
tf
img_receiver
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/pipelineStates.py:64
SecuServe-Livenes-Module/pipeline/pipelineStates.py · Idle
1 symbols
on_event
No description documented yet.
SecuServe-Livenes-Module/pipeline/pipelineStates.py:78
WHAT IT DOES

No description documented yet.

SIGNATURE
on_event(self, event, sender, receiver, poller)
PARAMETERS
self
event
sender
receiver
poller
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/pipelineStates.py:78
SecuServe-Livenes-Module/pipeline/pipelineStates.py · Error
2 symbols
__init__
No description documented yet.
SecuServe-Livenes-Module/pipeline/pipelineStates.py:93
WHAT IT DOES

No description documented yet.

SIGNATURE
__init__(self, message)
PARAMETERS
self
message
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/pipelineStates.py:93
on_event
No description documented yet.
SecuServe-Livenes-Module/pipeline/pipelineStates.py:96
WHAT IT DOES

No description documented yet.

SIGNATURE
on_event(self, event, sender)
PARAMETERS
self
event
sender
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/pipelineStates.py:96
SecuServe-Livenes-Module/pipeline/pipelineStates.py · PipeLine
3 symbols
__init__
Initialize the components.
SecuServe-Livenes-Module/pipeline/pipelineStates.py:112
WHAT IT DOES

Initialize the components.

SIGNATURE
__init__(self)
PARAMETERS
self
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/pipelineStates.py:112
on_event
This is the bread and butter of the state.State machine. Incoming events are delegated to the given state.States which then handl…
SecuServe-Livenes-Module/pipeline/pipelineStates.py:118
WHAT IT DOES

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

SIGNATURE
on_event(self, event, sender, tf, img_receiver)
PARAMETERS
self
event
sender
tf
img_receiver
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/pipelineStates.py:118
getCurrentStat
No description documented yet.
SecuServe-Livenes-Module/pipeline/pipelineStates.py:128
WHAT IT DOES

No description documented yet.

SIGNATURE
getCurrentStat(self)
PARAMETERS
self
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/pipelineStates.py:128
SecuServe-Livenes-Module/pipeline/state.py · State
5 symbols
__init__
No description documented yet.
SecuServe-Livenes-Module/pipeline/state.py:13
WHAT IT DOES

No description documented yet.

SIGNATURE
__init__(self)
PARAMETERS
self
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/state.py:13
next_state
No description documented yet.
SecuServe-Livenes-Module/pipeline/state.py:16
WHAT IT DOES

No description documented yet.

SIGNATURE
next_state(self, state)
PARAMETERS
self
state
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/state.py:16
on_event
Handle events that are delegated to this State.
SecuServe-Livenes-Module/pipeline/state.py:19
WHAT IT DOES

Handle events that are delegated to this State.

SIGNATURE
on_event(self, event)
PARAMETERS
self
event
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/state.py:19
__repr__
Leverages the __str__ method to describe the State.
SecuServe-Livenes-Module/pipeline/state.py:25
WHAT IT DOES

Leverages the __str__ method to describe the State.

SIGNATURE
__repr__(self)
PARAMETERS
self
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/state.py:25
__str__
Returns the name of the State.
SecuServe-Livenes-Module/pipeline/state.py:31
WHAT IT DOES

Returns the name of the State.

SIGNATURE
__str__(self)
PARAMETERS
self
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/state.py:31
SecuServe-Livenes-Module/pipeline/videoStreamSubscriber.py · VideoStreamSubscriber
4 symbols
__init__
No description documented yet.
SecuServe-Livenes-Module/pipeline/videoStreamSubscriber.py:11
WHAT IT DOES

No description documented yet.

SIGNATURE
__init__(self, hostname, port)
PARAMETERS
self
hostname
port
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/videoStreamSubscriber.py:11
receive
No description documented yet.
SecuServe-Livenes-Module/pipeline/videoStreamSubscriber.py:20
WHAT IT DOES

No description documented yet.

SIGNATURE
receive(self, timeout = 5.0)
PARAMETERS
self
timeout
= 5.0
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/videoStreamSubscriber.py:20
_run
No description documented yet.
SecuServe-Livenes-Module/pipeline/videoStreamSubscriber.py:26
WHAT IT DOES

No description documented yet.

SIGNATURE
_run(self)
PARAMETERS
self
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/videoStreamSubscriber.py:26
close
No description documented yet.
SecuServe-Livenes-Module/pipeline/videoStreamSubscriber.py:33
WHAT IT DOES

No description documented yet.

SIGNATURE
close(self)
PARAMETERS
self
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/videoStreamSubscriber.py:33
SecuServe-Livenes-Module/utils/pose.py · PoseDetector
2 symbols
__init__
No description documented yet.
SecuServe-Livenes-Module/utils/pose.py:14
WHAT IT DOES

No description documented yet.

SIGNATURE
__init__(self, mode = False, upBody = True, smooth = False, detectionCon = True, trackCon = 0.3)
PARAMETERS
self
mode
= False
upBody
= True
smooth
= False
detectionCon
= True
trackCon
= 0.3
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/utils/pose.py:14
findPose
No description documented yet.
SecuServe-Livenes-Module/utils/pose.py:30
WHAT IT DOES

No description documented yet.

SIGNATURE
findPose(self, img, draw = False)
PARAMETERS
self
img
draw
= False
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/utils/pose.py:30
06
BARKLY DOCS

Classes

Classes stay collapsed so large projects remain readable.

0
Parameter
No description documented yet.
0 methods
barkly_docs.py:141
No description documented yet.
No methods discovered.
FunctionInfo
No description documented yet.
2 methods
barkly_docs.py:149
No description documented yet.
qualified_name
No description documented yet.
barkly_docs.py:163
WHAT IT DOES

No description documented yet.

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

No description documented yet.

SIGNATURE
signature(self) -> str
PARAMETERS
self
RETURNS str
SOURCE barkly_docs.py:169
DECORATORS
property
ClassInfo
No description documented yet.
0 methods
barkly_docs.py:192
No description documented yet.
No methods discovered.
EndpointInfo
No description documented yet.
1 methods
barkly_docs.py:204
No description documented yet.
method_text
No description documented yet.
barkly_docs.py:219
WHAT IT DOES

No description documented yet.

SIGNATURE
method_text(self) -> str
PARAMETERS
self
RETURNS str
SOURCE barkly_docs.py:219
DECORATORS
property
ModuleInfo
No description documented yet.
0 methods
barkly_docs.py:224
No description documented yet.
No methods discovered.
PythonScanner
No description documented yet.
7 methods
barkly_docs.py:608
No description documented yet.
__init__
No description documented yet.
barkly_docs.py:609
WHAT IT DOES

No description documented yet.

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

No description documented yet.

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

No description documented yet.

SIGNATURE
scan_file(self, path: Path) -> None
PARAMETERS
self
path
Path
RETURNS None
SOURCE barkly_docs.py:624
function_node_for_class_method
No description documented yet.
barkly_docs.py:682
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:682
make_function
No description documented yet.
barkly_docs.py:697
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:697
make_class
No description documented yet.
barkly_docs.py:716
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:716
find_endpoints
No description documented yet.
barkly_docs.py:746
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:746
LiveDetection
No description documented yet.
9 methods
SecuServe-Livenes-Module/pipeline/LiveDetection.py:26
No description documented yet.
sendLifeStatus
No description documented yet.
SecuServe-Livenes-Module/pipeline/LiveDetection.py:50
WHAT IT DOES

No description documented yet.

SIGNATURE
sendLifeStatus(self, sender, Alive: bool, hasbody: bool, timesblinked: int)
PARAMETERS
self
sender
Alive
bool
hasbody
bool
timesblinked
int
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/LiveDetection.py:50
sendProgramStatus
No description documented yet.
SecuServe-Livenes-Module/pipeline/LiveDetection.py:58
WHAT IT DOES

No description documented yet.

SIGNATURE
sendProgramStatus(self, sender, status)
PARAMETERS
self
sender
status
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/LiveDetection.py:58
pipelineSetUp
No description documented yet.
SecuServe-Livenes-Module/pipeline/LiveDetection.py:65
WHAT IT DOES

No description documented yet.

SIGNATURE
pipelineSetUp(self, tf, sender)
PARAMETERS
self
tf
sender
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/LiveDetection.py:65
runPipeline
No description documented yet.
SecuServe-Livenes-Module/pipeline/LiveDetection.py:74
WHAT IT DOES

No description documented yet.

SIGNATURE
runPipeline(self, img_receiver, sender)
PARAMETERS
self
img_receiver
sender
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/LiveDetection.py:74
eye_aspect_ratio
No description documented yet.
SecuServe-Livenes-Module/pipeline/LiveDetection.py:110
WHAT IT DOES

No description documented yet.

SIGNATURE
eye_aspect_ratio(self, eye)
PARAMETERS
self
eye
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/LiveDetection.py:110
faceLandmarks
No description documented yet.
SecuServe-Livenes-Module/pipeline/LiveDetection.py:122
WHAT IT DOES

No description documented yet.

SIGNATURE
faceLandmarks(self, rects, predictor, face_utils, gray, image, sender, pose)
PARAMETERS
self
rects
predictor
face_utils
gray
image
sender
pose
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/LiveDetection.py:122
eyeThresholding
No description documented yet.
SecuServe-Livenes-Module/pipeline/LiveDetection.py:172
WHAT IT DOES

No description documented yet.

SIGNATURE
eyeThresholding(self, value)
PARAMETERS
self
value
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/LiveDetection.py:172
localinfo
No description documented yet.
SecuServe-Livenes-Module/pipeline/LiveDetection.py:187
WHAT IT DOES

No description documented yet.

SIGNATURE
localinfo(self, frame, info, title)
PARAMETERS
self
frame
info
title
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/LiveDetection.py:187
detectSkeliton
No description documented yet.
SecuServe-Livenes-Module/pipeline/LiveDetection.py:199
WHAT IT DOES

No description documented yet.

SIGNATURE
detectSkeliton(self, pose, frame)
PARAMETERS
self
pose
frame
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/LiveDetection.py:199
LivenessModel
No description documented yet.
2 methods
SecuServe-Livenes-Module/pipeline/livenessModel.py:15
No description documented yet.
train
No description documented yet.
SecuServe-Livenes-Module/pipeline/livenessModel.py:21
WHAT IT DOES

No description documented yet.

SIGNATURE
train(self, train_generator, val_generator)
PARAMETERS
self
train_generator
val_generator
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/livenessModel.py:21
isBlinking
@history: A string containing the history of eyes status where a '1' means that the eyes were closed and '0' open. @maxFrames: Th…
SecuServe-Livenes-Module/pipeline/livenessModel.py:58
WHAT IT DOES

@history: A string containing the history of eyes status where a '1' means that the eyes were closed and '0' open. @maxFrames: The maximal number of successive frames where an eye is closed

SIGNATURE
isBlinking(self, history, maxFrames)
PARAMETERS
self
history
maxFrames
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/livenessModel.py:58
States
No description documented yet.
0 methods
SecuServe-Livenes-Module/pipeline/pipelineStates.py:17
No description documented yet.
No methods discovered.
SetupPipeLine
The state.State which Sets Up Whole opencv pipeline
1 methods
SecuServe-Livenes-Module/pipeline/pipelineStates.py:26
The state.State which Sets Up Whole opencv pipeline
on_event
No description documented yet.
SecuServe-Livenes-Module/pipeline/pipelineStates.py:31
WHAT IT DOES

No description documented yet.

SIGNATURE
on_event(self, event, sender, tf, img_receiver)
PARAMETERS
self
event
sender
tf
img_receiver
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/pipelineStates.py:31
TrainPipeline
The state.State which Trains the Reconized face Models
1 methods
SecuServe-Livenes-Module/pipeline/pipelineStates.py:44
The state.State which Trains the Reconized face Models
on_event
No description documented yet.
SecuServe-Livenes-Module/pipeline/pipelineStates.py:49
WHAT IT DOES

No description documented yet.

SIGNATURE
on_event(self, event, sender, tf, img_receiver)
PARAMETERS
self
event
sender
tf
img_receiver
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/pipelineStates.py:49
RunReconitionPipeLine
The state.State which Reconizes Faces
1 methods
SecuServe-Livenes-Module/pipeline/pipelineStates.py:59
The state.State which Reconizes Faces
on_event
No description documented yet.
SecuServe-Livenes-Module/pipeline/pipelineStates.py:64
WHAT IT DOES

No description documented yet.

SIGNATURE
on_event(self, event, sender, tf, img_receiver)
PARAMETERS
self
event
sender
tf
img_receiver
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/pipelineStates.py:64
Idle
The state.State which The program waits for a face to be spotted
1 methods
SecuServe-Livenes-Module/pipeline/pipelineStates.py:73
The state.State which The program waits for a face to be spotted
on_event
No description documented yet.
SecuServe-Livenes-Module/pipeline/pipelineStates.py:78
WHAT IT DOES

No description documented yet.

SIGNATURE
on_event(self, event, sender, receiver, poller)
PARAMETERS
self
event
sender
receiver
poller
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/pipelineStates.py:78
Error
The state.State which The program waits for a face to be spotted
2 methods
SecuServe-Livenes-Module/pipeline/pipelineStates.py:86
The state.State which The program waits for a face to be spotted
__init__
No description documented yet.
SecuServe-Livenes-Module/pipeline/pipelineStates.py:93
WHAT IT DOES

No description documented yet.

SIGNATURE
__init__(self, message)
PARAMETERS
self
message
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/pipelineStates.py:93
on_event
No description documented yet.
SecuServe-Livenes-Module/pipeline/pipelineStates.py:96
WHAT IT DOES

No description documented yet.

SIGNATURE
on_event(self, event, sender)
PARAMETERS
self
event
sender
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/pipelineStates.py:96
PipeLine
A simple state.State machine that mimics the functionality of a device from a high level.
3 methods
SecuServe-Livenes-Module/pipeline/pipelineStates.py:106
A simple state.State machine that mimics the functionality of a device from a high level.
__init__
Initialize the components.
SecuServe-Livenes-Module/pipeline/pipelineStates.py:112
WHAT IT DOES

Initialize the components.

SIGNATURE
__init__(self)
PARAMETERS
self
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/pipelineStates.py:112
on_event
This is the bread and butter of the state.State machine. Incoming events are delegated to the given state.States which then handl…
SecuServe-Livenes-Module/pipeline/pipelineStates.py:118
WHAT IT DOES

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

SIGNATURE
on_event(self, event, sender, tf, img_receiver)
PARAMETERS
self
event
sender
tf
img_receiver
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/pipelineStates.py:118
getCurrentStat
No description documented yet.
SecuServe-Livenes-Module/pipeline/pipelineStates.py:128
WHAT IT DOES

No description documented yet.

SIGNATURE
getCurrentStat(self)
PARAMETERS
self
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/pipelineStates.py:128
State
We define a state object which provides some utility functions for the individual states within the state machine.
5 methods
SecuServe-Livenes-Module/pipeline/state.py:7
We define a state object which provides some utility functions for the individual states within the state machine.
__init__
No description documented yet.
SecuServe-Livenes-Module/pipeline/state.py:13
WHAT IT DOES

No description documented yet.

SIGNATURE
__init__(self)
PARAMETERS
self
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/state.py:13
next_state
No description documented yet.
SecuServe-Livenes-Module/pipeline/state.py:16
WHAT IT DOES

No description documented yet.

SIGNATURE
next_state(self, state)
PARAMETERS
self
state
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/state.py:16
on_event
Handle events that are delegated to this State.
SecuServe-Livenes-Module/pipeline/state.py:19
WHAT IT DOES

Handle events that are delegated to this State.

SIGNATURE
on_event(self, event)
PARAMETERS
self
event
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/state.py:19
__repr__
Leverages the __str__ method to describe the State.
SecuServe-Livenes-Module/pipeline/state.py:25
WHAT IT DOES

Leverages the __str__ method to describe the State.

SIGNATURE
__repr__(self)
PARAMETERS
self
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/state.py:25
__str__
Returns the name of the State.
SecuServe-Livenes-Module/pipeline/state.py:31
WHAT IT DOES

Returns the name of the State.

SIGNATURE
__str__(self)
PARAMETERS
self
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/state.py:31
VideoStreamSubscriber
No description documented yet.
4 methods
SecuServe-Livenes-Module/pipeline/videoStreamSubscriber.py:9
No description documented yet.
__init__
No description documented yet.
SecuServe-Livenes-Module/pipeline/videoStreamSubscriber.py:11
WHAT IT DOES

No description documented yet.

SIGNATURE
__init__(self, hostname, port)
PARAMETERS
self
hostname
port
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/videoStreamSubscriber.py:11
receive
No description documented yet.
SecuServe-Livenes-Module/pipeline/videoStreamSubscriber.py:20
WHAT IT DOES

No description documented yet.

SIGNATURE
receive(self, timeout = 5.0)
PARAMETERS
self
timeout
= 5.0
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/videoStreamSubscriber.py:20
_run
No description documented yet.
SecuServe-Livenes-Module/pipeline/videoStreamSubscriber.py:26
WHAT IT DOES

No description documented yet.

SIGNATURE
_run(self)
PARAMETERS
self
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/videoStreamSubscriber.py:26
close
No description documented yet.
SecuServe-Livenes-Module/pipeline/videoStreamSubscriber.py:33
WHAT IT DOES

No description documented yet.

SIGNATURE
close(self)
PARAMETERS
self
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/pipeline/videoStreamSubscriber.py:33
PoseDetector
No description documented yet.
2 methods
SecuServe-Livenes-Module/utils/pose.py:12
No description documented yet.
__init__
No description documented yet.
SecuServe-Livenes-Module/utils/pose.py:14
WHAT IT DOES

No description documented yet.

SIGNATURE
__init__(self, mode = False, upBody = True, smooth = False, detectionCon = True, trackCon = 0.3)
PARAMETERS
self
mode
= False
upBody
= True
smooth
= False
detectionCon
= True
trackCon
= 0.3
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/utils/pose.py:14
findPose
No description documented yet.
SecuServe-Livenes-Module/utils/pose.py:30
WHAT IT DOES

No description documented yet.

SIGNATURE
findPose(self, img, draw = False)
PARAMETERS
self
img
draw
= False
RETURNS Not documented
SOURCE SecuServe-Livenes-Module/utils/pose.py:30
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
SecuServe-Livenes-Module/__init__.py
0 symbols
0 imports
FUNCTIONS 0
CLASSES 0
IMPORTS 0
SecuServe-Livenes-Module/__main__.py
1 symbols
12 imports
FUNCTIONS 1
CLASSES 0
IMPORTS 12
IMPORTS
utilszmqdatetimecv2yamlnumpysyspipeline.videoStreamSubscriberpipeline.LiveDetectionpipelineutilstraceback
SecuServe-Livenes-Module/pipeline/__init__.py
0 symbols
0 imports
FUNCTIONS 0
CLASSES 0
IMPORTS 0
SecuServe-Livenes-Module/pipeline/LiveDetection.py
10 symbols
16 imports
FUNCTIONS 0
CLASSES 1
IMPORTS 16
IMPORTS
datetimeosrandomtimecv2numpysystracebackutilsdlibutilsscipy.spatialimutilsdatetimecv2.datautils.pose
SecuServe-Livenes-Module/pipeline/livenessModel.py
3 symbols
7 imports
FUNCTIONS 0
CLASSES 1
IMPORTS 7
IMPORTS
keras.modelskeras.layerskeras.layerskeras.layerskeras.layerskeras.preprocessing.imageutils
SecuServe-Livenes-Module/pipeline/pipelineStates.py
16 symbols
6 imports
FUNCTIONS 0
CLASSES 7
IMPORTS 6
IMPORTS
enumzmq.sugar.framepipeline.LiveDetectionutilspipelinedatetime
SecuServe-Livenes-Module/pipeline/state.py
6 symbols
1 imports
FUNCTIONS 0
CLASSES 1
IMPORTS 1
IMPORTS
utils
SecuServe-Livenes-Module/pipeline/videoStreamSubscriber.py
5 symbols
2 imports
FUNCTIONS 0
CLASSES 1
IMPORTS 2
IMPORTS
threadingimagezmq
SecuServe-Livenes-Module/utils/__init__.py
0 symbols
0 imports
FUNCTIONS 0
CLASSES 0
IMPORTS 0
SecuServe-Livenes-Module/utils/consoleLog.py
8 symbols
2 imports
FUNCTIONS 8
CLASSES 0
IMPORTS 2
IMPORTS
coloramadatetime
SecuServe-Livenes-Module/utils/const.py
0 symbols
1 imports
FUNCTIONS 0
CLASSES 0
IMPORTS 1
IMPORTS
configparser
SecuServe-Livenes-Module/utils/pose.py
3 symbols
5 imports
FUNCTIONS 0
CLASSES 1
IMPORTS 5
IMPORTS
cv2mediapipetimeutilstensorflow
08
BARKLY DOCS

Imports

Dependencies discovered from Python import statements.

DISCOVERED 40
SOURCE FILES 13
__future__argparseastcoloramaconfigparsercv2cv2.datadataclassesdatetimedlibenumhashlibhtmlimagezmqimutilsjsonkeras.layerskeras.modelskeras.preprocessing.imagemediapipenumpyospathlibpipelinepipeline.LiveDetectionpipeline.videoStreamSubscriberrandomscipy.spatialsubprocesssystensorflowthreadingtimetracebacktypingutilsutils.poseyamlzmqzmq.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
f707606
NEW FUNCTIONS
0
CHANGED FUNCTIONS
0
NEW CLASSES
0
CHANGED CLASSES
0
NEW ENDPOINTS
0
CHANGED ENDPOINTS
0
RECENT COMMITS
f707606|2026-09-27|Added barkly ocs
015aca5|2026-09-26|Merge pull request #1 from Barkly-Labs/dev
3404f66|2022-04-22|pushing before mods after the coding break
63836d1|2022-03-18|got live ness back
eafa0f1|2022-03-15|working on setting up reply back in the sockets
5fc6d62|2022-03-15|working on setting up push for recving socket 5002
4f1caef|2021-12-24| need to fix cuda ro process poses on the fly in tensorflow
54bec87|2021-12-23| it works again
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.