Serious Health Check

[DXM123]

Description

As our project grows in complexity, it's crucial to ensure that our codebase remains maintainable and well-organized. This issue initiates a comprehensive health check of the code, identifying areas for improvement and potential refactoring. Below is an initial assessment of several key components of our codebase:

• calibration-gui.py: OK - Entry point.
• src/falcons/DeWarp/soccer_field.py: Consider Refactoring - Compact, but should really be part of a library elsewhere. Possibly integrate with MRA localization-vision / field libraries?
• src/falcons/DeWarp/warper.py: OK - Contains transformation logic.
• src/falcons/DeWarp/common.py: OK - Contains small enums for colors and other constants.
• src/falcons/DeWarp/videoinput.py: OK - Nicely implemented base class.
• src/falcons/DeWarp/widget.py: Needs Refactoring - This module is somewhat disorganized and requires cleanup.
• src/falcons/DeWarp/__init__.py: OK - Basic initialization, functions well.
• src/falcons/DeWarp/config.py: OK - Configuration handling is well implemented.
• src/falcons/DeWarp/application.py: Refactor - The load_calibration function can be removed.
• src/falcons/DeWarp/falcon_config.yaml: OK - Configuration file is functioning as expected.

Objective

The goal of this health check is to identify and address areas of the codebase that can be optimized or refactored to improve performance, readability, and scalability.

Expected Outcome

• Refactoring suggestions implemented for identified modules.
• Improved code organization and modularization.
• Documentation updates to reflect changes and improve developer understanding.
• Enhanced overall code quality with a focus on long-term maintainability.

Steps to Achieve

1. Review and Assess: Conduct a thorough review of the entire codebase, similar to the initial check, to identify any additional areas needing attention.
2. Plan Refactoring Tasks: Based on the assessment, create specific tasks for refactoring the identified modules. Consider creating separate issues for major refactoring tasks to manage them effectively.
3. Implement Changes: Execute the refactoring plans, starting with high-priority areas. Ensure to maintain functionality and compatibility with existing systems.
4. Code Review and Testing: Each refactoring change should be peer-reviewed and thoroughly tested to prevent regressions.
5. Documentation: Update the documentation to reflect any changes in the code structure or functionality.

This initiative is crucial for maintaining an effective and efficient development environment. Your feedback and participation in this process are highly valuable.

---

By addressing these initial findings and committing to regular code health checks, we aim to foster a robust, scalable, and maintainable codebase that meets our evolving needs.

[janfeitsma]

Some thoughts:

1. I would like to make a main script with an argparse interface, which then uses the refactored application from Robin
2. we need a testsuite
3. we should create an InputVideoStream class or something, which can either be live, or using a video capture file -- this is useful for the test suite and for offline development cycles

Edit: if you want, I can work on this in a branch?

[DXM123]

Please go for it. Then its also more in line with current python script execution.