How nehakirannayak/navigation-assist works
Main Components
• Web Frontend: Represent the UI built from HTML templates (object_index.html, object_index2.html, face_index.html, face_index2.html) for user interactions.
• Flask Backend: The main server logic is in app.py, which acts as the entry point and routes requests to the appropriate functionalities.
• Object Detection Module: Represented by object_camera.py, which likely contains the VideoCamera class handling real-time object detection.
• Face Recognition Module: Represented by facecam.py, which contains the Facecamera class for live face identification and recognition.
• Data Files: Include the encod_list.data and face_list.data files as part of the persistence layer that store learned models or encodings.
• External Libraries/Technologies: Indicate dependencies (for example, OpenCV for computer vision, Flask for the web framework) as noted in requirements.txt.
Component Relationships and Interactions
• The Client (Web Browser) accesses the system via the user-friendly web interface (displayed through the HTML templates).
• Requests from the client are handled by app.py (Flask backend), which then routes them to the appropriate service modules.
• When object detection is activated, app.py interfaces with the object_camera module to retrieve a real-time video feed overlayed with detection results.
• Similarly, for face recognition functionality, app.py interacts with the facecam module.
• Both modules likely utilize the data files (encod_list.data, face_list.data) for accessing or updating stored recognition data.
Architectural Patterns and Design Principles
• Separation of Concerns: The project clearly splits responsibilities, with separate modules handling frontend, object detection, and face recognition.
• Modular Design: By isolating functionality into distinct files (app.py, object_camera.py, facecam.py), you enable easier maintenance and future enhancements (such as the planned mobile application).
• Real-time Data Processing: The design supports live video streaming integrated with computer vision algorithms.
• Extensibility: The README hints at future development for additional assistive technologies, so the design should leave clear integration points.
• Next, represent the Flask backend as the central hub managing routes and processing.
• Branch out to two parallel modules (one for object detection and one for face recognition) which the Flask app calls based on the user’s actions.
• Finally, indicate how these modules interact with local data files (for storing or retrieving recognized features).
• External dependencies or libraries (like OpenCV) used in these modules.
• Marking the "Future Development" layer where mobile applications or additional assistive technologies might interact with this foundation.