This project aims to address a real-world clinical challenge by developing a reliable, accessible system for automatically detecting posture, with a focus on helping scoliosis patients maintain proper posture during X-ray imaging.

X-ray images of scoliosis patients are only useful for diagnosis if the patient stands upright during the procedure. The system's primary use case is supporting scoliosis patients in maintaining or correcting a straight posture while an X-ray image is being taken.

The system is designed to assist patients before or during the imaging process. Patients can view themselves on a separate monitor connected to the HPR system. The system provides real-time visual feedback in the form of guiding lines to help patients adjust and align their posture as needed.

This README is intended for users such as doctors and medical professionals who want to understand how to use the system effectively. If you are a developer looking to contribute or extend the project, please refer to the separate README4DEV.md for technical documentation and setup instructions.

This project is open source, meaning its source code is publicly available free of charge and can be viewed and used and updated by anyone. Open source software promotes transparency, collaboration and adaptability, making it possible for developers and organizations to review how the system works, customize it for specific needs or contribute improvements.

You are free to use this software in both clinical and non-clinical environments under the terms of its license. Please refer to the LICENSE file in this repository for details.

To help you get started, we have created a detailed step-by-step guide available on our setup page. Below is a general overview of the setup process:

1. What You’ll Need & Where to Get It

   A list of required components such as a Raspberry Pi, camera module, monitor, and mounting accessories, including links to suggested online retailers.

2. Installing the Software on the Raspberry Pi

   Instructions on how to flash the operating system, install necessary dependencies, and run the Hip Posture Recognition software.

3. Hardware Setup

   Guidance on assembling the hardware: connecting the camera, positioning the screen, and ensuring everything is securely mounted for clinical use.

4. FAQ

   Common questions and troubleshooting tips are included at the end of the guide.

Feel free to reach out if you encounter any problems or have questions about using the system. Open an issue in this GitHub repository to do so.

To do so, click on the "Issues" tab at the top of the repository page and select "New Issue". Describe your question or problem in as much detail as possible so that we can help you efficiently.

We also recommend checking the FAQ page first, as it covers common questions and troubleshooting tips that may answer your questions.

In addition to reporting problems, you’re welcome to use GitHub Issues to share feedback, suggestions for improvements, and requests for new features. Your input helps us improve the system.

We appreciate your feedback and will respond as quickly as possible.

Contributions to this project are very welcome! If you would like to fix a bug, add a new feature, or submit code changes, please follow these steps:

1. Fork the repository and create a new branch for your changes.

2. Ensure your code is tested.

3. Open a pull request with a clear description of your changes and the reasoning behind them.

For larger changes, it is recommended that you open an issue first to discuss your ideas with the maintainers.

Thank you for your interest in the Hip Posture Recognition Project. We hope this tool helps you assess posture and prepare for X-ray imaging more effectively. Whether you are using the tool in a clinical setting or contributing to its development, your involvement is greatly appreciated.

If you have any questions, feedback, or ideas for improvement, please don't hesitate to reach out. Together, we can improve this system.