-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Glenn Jocher <[email protected]>
- Loading branch information
1 parent
decf36e
commit 68ffef3
Showing
1 changed file
with
66 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,84 @@ | ||
| <img src="https://storage.googleapis.com/ultralytics/UltralyticsLogoName1000×676.png" width="200"> | ||
| <br> | ||
| <img src="https://raw.githubusercontent.com/ultralytics/assets/main/logo/Ultralytics_Logotype_Original.svg" width="320"> | ||
|
|
||
| # Introduction | ||
| # 🚀 Introduction | ||
|
|
||
| This directory contains software developed by Ultralytics LLC. For more information on Ultralytics projects please visit: | ||
| http://www.ultralytics.com/projects | ||
| Welcome to the official repository for the analysis of gamma scatter interactions on LYSO crystals, backed by Ultralytics' innovative approach to data-driven research in particle physics! | ||
|
|
||
| # Description | ||
| ## 📜 Description | ||
|
|
||
| The https://github.com/ultralytics/petsys repo contains analysis of gamma scatters on LYSO crystals coupled to SiPMs. This data was collected at PETSYS labs in Lisbon, Portugal in 2017. This code performs energy calibration and timing resolution analysis of the data. | ||
| In our pursuit of advancing the realm of particle detection and imaging technology, we've gathered a unique dataset from PETSYS electronics in Lisbon, Portugal. The [Ultralytics PETSYS repo](https://github.com/ultralytics/petsys) is dedicated to the meticulous analysis of gamma scatter phenomenon on LYSO crystals paired with Silicon Photomultipliers (SiPMs). The data, collected in 2017, serves as a foundation for our algorithms that conduct energy calibration and evaluate the timing resolution of these intricate detection systems. | ||
|
|
||
| # Requirements | ||
| ## 📦 Requirements | ||
|
|
||
| [MATLAB](https://www.mathworks.com/products/matlab.html) >= 2018a with a common functions repo `$ git clone https://github.com/ultralytics/functions-matlab` added to the MATLAB path `>> addpath(genpath('/functions-matlab'))` and the following toolboxes: | ||
| Before you dive into the world of scintillation and photo-detection, you'll need to arm yourself with a few tools. Ensure you have [MATLAB](https://www.mathworks.com/products/matlab.html) version 2018a or higher at your disposal. Additionally, you'll need a set of MATLAB toolboxes geared toward statistical and signal processing. Here's how to get started: | ||
|
|
||
| - Clone our common functions repository using the command: | ||
| ```bash | ||
| $ git clone https://github.com/ultralytics/functions-matlab | ||
| ``` | ||
|
|
||
| - Integrate the repository into your MATLAB environment: | ||
| ```matlab | ||
| >> addpath(genpath('/functions-matlab')) | ||
| ``` | ||
|
|
||
| Ensure the following MATLAB toolboxes are also installed: | ||
| - `Statistics and Machine Learning Toolbox` | ||
| - `Signal Processing Toolbox` | ||
|
|
||
| # Running | ||
| Let's gear up for some high-fidelity analysis! | ||
|
|
||
| ## 🏃♀️ Running the Code | ||
|
|
||
| Starting the analysis is as straightforward as a MATLAB command. Simply type the following into your MATLAB console and watch the magic happen: | ||
|
|
||
| From MATLAB: `>> testSingles` | ||
| ```matlab | ||
| >> testSingles % This script kicks off the analysis on the gamma scatter dataset | ||
| ``` | ||
|
|
||
| Enjoy the graphical outputs and insights generated by the script—like this stunning visualization: | ||
|
|
||
| <img src="https://github.com/ultralytics/petsys/blob/master/results.png"> | ||
|
|
||
| # Citation | ||
| ## 📑 Citation | ||
|
|
||
| If this dataset and our analysis tools facilitate your research or pique your interest in advanced gamma scatter analysis, please cite our work using the DOI provided below: | ||
|
|
||
| [](https://zenodo.org/badge/latestdoi/133869433) | ||
|
|
||
| # Contact | ||
| ## 🤝 Contribute | ||
|
|
||
| We welcome contributions from the community! Whether you're fixing bugs, adding new features, or improving documentation, your input is invaluable. Take a look at our [Contributing Guide](https://docs.ultralytics.com/help/contributing) to get started. Also, we'd love to hear about your experience with Ultralytics products. Please consider filling out our [Survey](https://ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A huge 🙏 and thank you to all of our contributors! | ||
|
|
||
| <!-- Ultralytics contributors --> | ||
| <a href="https://github.com/ultralytics/yolov5/graphs/contributors"> | ||
| <img width="100%" src="https://github.com/ultralytics/assets/raw/main/im/image-contributors.png" alt="Ultralytics open-source contributors"></a> | ||
|
|
||
| ## ©️ License | ||
|
|
||
| Ultralytics is excited to offer two different licensing options to meet your needs: | ||
|
|
||
| - **AGPL-3.0 License**: Perfect for students and hobbyists, this [OSI-approved](https://opensource.org/licenses/) open-source license encourages collaborative learning and knowledge sharing. Please refer to the [LICENSE](https://github.com/ultralytics/ultralytics/blob/main/LICENSE) file for detailed terms. | ||
| - **Enterprise License**: Ideal for commercial use, this license allows for the integration of Ultralytics software and AI models into commercial products without the open-source requirements of AGPL-3.0. For use cases that involve commercial applications, please contact us via [Ultralytics Licensing](https://ultralytics.com/license). | ||
|
|
||
| ## 📬 Contact Us | ||
|
|
||
| For bug reports, feature requests, and contributions, head to [GitHub Issues](https://github.com/ultralytics/velocity/issues). For questions and discussions about this project and other Ultralytics endeavors, join us on [Discord](https://ultralytics.com/discord)! | ||
|
|
||
| Issues should be raised directly in the repository. For additional questions or comments please email Glenn Jocher at [email protected] or visit us at https://contact.ultralytics.com. | ||
| <br> | ||
| <div align="center"> | ||
| <a href="https://github.com/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-github.png" width="3%" alt="Ultralytics GitHub"></a> | ||
| <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space"> | ||
| <a href="https://www.linkedin.com/company/ultralytics/"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-linkedin.png" width="3%" alt="Ultralytics LinkedIn"></a> | ||
| <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space"> | ||
| <a href="https://twitter.com/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-twitter.png" width="3%" alt="Ultralytics Twitter"></a> | ||
| <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space"> | ||
| <a href="https://youtube.com/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-youtube.png" width="3%" alt="Ultralytics YouTube"></a> | ||
| <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space"> | ||
| <a href="https://www.tiktok.com/@ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-tiktok.png" width="3%" alt="Ultralytics TikTok"></a> | ||
| <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space"> | ||
| <a href="https://www.instagram.com/ultralytics/"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-instagram.png" width="3%" alt="Ultralytics Instagram"></a> | ||
| <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space"> | ||
| <a href="https://ultralytics.com/discord"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-discord.png" width="3%" alt="Ultralytics Discord"></a> | ||
| </div> |