SoftwareForScience/pulsar-python

An open-source DSP library for pulsar detection.

Asteria

Introduction

Creating a free and open source framework that contains the generic algorithms and file handling for astronomical data sets. This framework will be modular. Similar to OpenCV, wherein specific modules can be added and disabled depended on the needs of a project. This framework will be implemented in Python and C++.

Installation

Requirements

* numpy
* python 3.6

Documentation

1. Getting started
   1. Example filterbank files
   2. Import
2. Filterbank tutorial
   1. Create filterbank object
   2. Read header from filterbank data
   3. Read filterbank file
   4. Select a range of data from the filterbank file
   5. Read filterbank file as stream
3. Fourier transformation tutorial
   1. DFT
      1. Parameters
      2. Example usage
   2. FFT
      1. Parameters
      2. Example usage
   3. IFFT
      1. Parameters
      2. Example usage
4. Plot tutorial
   1. PSD
      1. Parameters
      2. Returns
      3. Example usage
   2. Waterfall
      1. Construction
      2. Methods
      3. Example usage
         1. With discrete data
         2. With stream data
5. Timeseries
   1. Initialize timeseries object
   2. Retrieve timeseries
   3. Downsample timeseries
6. Clipping
   1. Clipping
   2. Filter samples
   3. Filter channels
   4. Filter individual channels
7. Dedispersion
   1. Dedisperse
   2. Find dispersion measure
   3. Find line
   4. Find estimation intensity
8. Pipeline
   1. Introduction
   2. Read rows
   3. Read n rows
   4. Read static
   5. Measure methods
9. Generating mock data
   1. Creating a filterbank file
   2. Generate signal
   3. Generate header
   4. Keyword to string
   5. Write data