diff --git a/README.md b/README.md index 2db8f629844a6d673266f568d4bbd26ffb5acf85..bb9adb6d9c63e8632b64862a223b49152d789f6b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ # Ion trap image analysis This project is focused on extracting information from images of an ion trap. + + +- app.py: Starts image analysis in a background thread and creates a web app at port 5000. + +- calibrate.py: Run this script to calibrate the distance factor used for dark ions detection. Run preferably when there are no dark ions present. + + +To change the region of interest where the image analysis takes place, either: + +- Edit the top-left and bottom-right coordinates of the region of interest manually under settings.py --> REGION + +- Run: python -c "from tools import new_region; new_region()". This will open a matplotlib figure with an image of the trapped-ions. The user should click on the top-left and bottom-right coordinates.