.. Pulsar Segmentation using NeuralNets documentation master file, created by sphinx-quickstart on Fri Aug 4 15:10:19 2023. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to :pulsarsa:`PulsarSA` documentation! ============================================== Welcome to :pulsarsa:`PulsarSA`! This guide provides all the information you need to install and run the :pulsarsa:`pulsarsa` Python package. For a quick start, we recommend beginning with the Getting Started page, followed by the Examples page. For more in-depth usage, please refer to the example notebooks in the examples folder. Documentation related to the source code can be found on the Modules page. Below is a simple diagram of :pulsarsa:`PulsarSA` functionalities: .. image:: /static/PipelineImageToFilterToCCtoLabelsDetailed.png :alt: PipelineImageToFilterToCCtoLabels :width: 600px Here are the list of modules used to perform different steps in the pipeline: - **Loaders:** Data loaders and converters (a) from :pulsarsa:`PulsarDT` payload files - **Datasets:** Data sets for training, testing, and visualization (b), (c) - **Trainers:** Trainer modules (d), (e) to train CNNs (f) and (g) for segmentation and filtering - **Labellers:** Legacy vision tools (h) to label segments into different signal source types *(Pulsar, NBRFI, BBRFI)* - **Optimizers:** Optimizers (j) to find the best model parameters mix using the Tuner (i) to match the real world data Contents -------- .. grid:: 2 2 2 2 :gutter: 2 .. grid-item-card:: Getting Started :link: getting_started.html :img-top: static/animation_pipeline.gif :text-align: center :shadow: lg Learn how to install and use the library. .. grid-item-card:: Examples :link: examples.html :img-top: static/pulsar_detection_in_action.gif :text-align: center :shadow: lg See real-world examples and demos. .. grid-item-card:: Modules :link: modules.html :img-top: static/pulsarsadotpipeline.png :text-align: center :shadow: lg Explore the main modules and functions. .. grid-item-card:: Tools / Utilities :link: src.pulsarsa.tools.html :img-top: static/PipelineImageToFilterToCCtoLabelsDetailed.png :text-align: center :shadow: lg Functions for easy to use pipeline functionalities. .. toctree:: :maxdepth: 2 :caption: How to Guide :hidden: getting_started .. toctree:: :maxdepth: 1 :caption: Tutorial :hidden: examples .. toctree:: :maxdepth: 2 :caption: Reference :hidden: modules src.pulsarsa.tools Acknowledgements ---------------- We gratefully acknowledge the contributions of the following individuals and institutions: - **HTW Berlin** and **PUNCH4NFDI** for project support - **Prof. Dr. Hermann Heßling** for guidance - **Andrei Kazantsev** for valuable feedbacks and for providing real data Collaborations -------------- This project is a joint effort between: - HTW Berlin, Department of Computer Science - PUNCH4NFDI - MPIfRBonn - interTwin - DZA The code is hosted on GitLab and can be found at: `🔗 View on GitLab `_