Skip to content

ElsevierSoftwareX/SOFTX-D-24-00528

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

⭐ Star Dynasmile on GitHub — it motivates us a lot!

Share Share Share Share Share

Table of Contents

🚀 Features highlight

Dynasmile is a Python-based AI-driven dynamic smile analysis tool for dental research. It uses computer vision techniques to analyze smile process. As a dental application, it features:

  • Smile intensity estimation: Dynasmile automatically analyzes the smile intensity across different frames of the video. It plots the smile intensity, which helps the dentist to locate the frame where the smile reaches its peak.

  • Landmark detecion and display: Dynasmile detects dentofacial landmarks on patients' faces and overlays the result to the selected frame, providing a user-friendly interface for dental specialists.

  • Low cost: Dynasmile do not rely on local graphical card. The special architecture of this software relies on EC2 server, which can be rent at low cost and used at any time.

🎓 Functionality

Dynasmile processes the video uploaded by the user. It performs smile analysis on the selected frame, which includes detection of 13 dentofacial landmarks and performing 8 smile measurements.

For convenience, all the information is provided in the tables below:

Dentofacial landmarks

Number Landmark name
1 Subnasale
2 Inferior upper lip border
3 Superior lower lip border
4 Right outer canthus
5 Left outer canthus
6 Right outer smile commissure
7 Left outer smile sommissure
8 Soft tissue nasion
9 Soft tissue pogonion
10 Incisor edge
11 Left upper cuspid tip
12 Right upper cuspid tip
13 Cervical part of incisor
In total 13 landmarks

Smile measurements

Number Measurement name
1 Intercommissure width
2 Interlabial gap
3 Gingival display
4 Philtrum height
5 Transverse symmetry
6 Vertical symmetry
7 Dental angulation
8 Canthus and smile commissure deviation
In total 8 measurements

📝 How to Install

Important

This program relies on AWS EC2 GPU web instance to run, if you are new to EC2, please refer to this website https://aws.amazon.com/ec2/getting-started/

Dependency: Using our pre-configured EC2 instance

Important

Since our computing resource is limited, the instance might be temporarily stopped anytime.

# Ensure Git is installed
# Visit https://git-scm.com to download and install console Git if not already installed
# Clone the repository to local computer
git clone https://github.com/dentistfrankchen/dynasmile.git

# Navigate to the project directory(.../dynasmile-master)
cd Path/to/dynasmile-master

# Activate the virtual environment
.\venv\Scripts\activate

# Install the requirements for the local interface.
pip install -r requirements.txt

📚 How to run the program

Step 1: Start main.py and connect to the EC2 instance.

# Open Command Prompt.

# Assuming you have activated the virtual environment.

# You can start the main interface now.
python .\client\software\main.py

Step 2: Wait for the main.py to connect to EC2 instance.

During this process, the mian.py will open command prompt windows to automatically connect to the EC2 instance.

Then you need to wait for the connection. Please do not close the windows of command prompt.

When the connection is finished, the mian interface would pop up.

Step 3: Use the interface to conduct smile analysis.

  1. Upload a video by clicking Drag and Drop panel.
  2. The program then uploads the video, displaying the process through the progress bar.
  3. When the progress bar reaches 100 percent, frame with greatest smile intensity will be automatically displayed.
  4. The landmarks and measurements will be automatically displayed.
  5. The user clicks the 'Save csv' button, and the coordinates of the landmarks as well as the measurements will be saved in CSV files.

For a real-time view, here's a video for how to run this program:

guideorunning.mp4

🤝 Feedback and Contributions

We've made a lot of effort to implement many aspects of dynamic smile analysis in this software. However, the development journey doesn't end now, and your feedback is crucial for our further improvement.

Important

Whether you have feedback on improvements, have encountered any bugs, or have suggestions for features, we cannot wait to hear from you. Your insights help us get our software more robust and user-friendly.

Please feel free to contribute by submitting an issue. Each contribution helps us get better and improve.

We appreciate your kindly support and look forward to build our product even better with your help!

📃 License

This product is distributed under Apache license.

For non-commercial use, this product is available for free.

🗨️ Contacts

For more details about our products, services, or any general information regarding the Amazon EC2 server, feel free to contact us. We are here to provide needed support and answer any questions you have. Below are the best ways to contact our team:

We look forward to assisting you and keeping your experience with our applicaion being enjoyable!

Back to top

About

An AI-powered tool for smile analysis.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 99.2%
  • Other 0.8%