FRBGui Documentation

Welcome to FRBGui’s documentation. FRBGui is a graphical user interface for measuring spectro-temporal properties of Fast Radio Bursts (FRBs) from their waterfalls using 2D autocorrelation functions (ACF). It can be used to split bursts with multiple components, change the dispersion measure (DM), add noise filters, and other preparation tasks before measurement. FRBGui is built with the Dear PyGui interface library.

Click here for a video demo of FRBGui.

Please visit Overview and Installation to get started.

Introduction

• Overview & Installation
  • Features
  • Installation
  • Usage
  • Burst Format
  • Acknowledgements
  • Publications
  • Attributions

Tutorials

• 1. Preparing Data
  • 1.1. Reading PSRFITS (.fits)
  • 1.2. Reading Filterbank (.fil)
• 2. Measuring FRBs
  • 2.1. Measurement Properties
  • 2.2. Cleanup (Background Subtraction)
  • 2.3. Performing Measurements
  • 2.4. Reviewing Measurements
  • 2.5. Manual Initial Fit Guess
  • 2.6. Downsampling an FRB
  • 2.7. Mask Ranges
  • 2.8. Burst Splitting
  • 2.9. Saving and Exporting Results

Documentation

• Scripting
  • frbgui module
  • driftrate module
  • driftlaw module

Reference

• Output CSVs
• 2D Autocorrelation Method