Skip to main content

kalman_detector

GitHub CI codecov License Code style: black

A Python Implementation of a Kalman filter detector for detecting smoothly variying signals hidden in gaussian noise, such as Fast Radio Bursts (FRBs).

The detection statistic is designed to process I(f), a sequence of observed "amplitudes" (where f is an arbitrary indexed parameter), and decide between the following hypotheses:

H0: I(f) = N(f)         Pure gaussian noise
H1: I(f) = A(f) + N(f)  A(f) is a smooth gaussian process with an unknown smoothness parameter. 

Installation

The quickest way to install the package is to use pip:

pip install -U kalman_detector

Usage

from kalman_detector.main import KalmanDetector

kalman = KalmanDetector(spectrum_std)
kalman.prepare_fits(ntrials=10000)
kalman.get_significance(spectrum)

Example

An example script demonstrating how to use the Kalman detector can be found in the examples directory.

Kalman demo for FRB171003 Kalman demo for FRB171004

Efficiency

An example efficiency plot can be generates using:

python -m kalman_detector.efficiency

Citation

Please cite Kumar, Zackay & Law (2024) if you find this code useful in your research. The BibTeX entry for the paper is:

@ARTICLE{2024ApJ...960..128K,
       author = {{Kumar}, Pravir and {Zackay}, Barak and {Law}, Casey J.},
        title = "{Detecting Fast Radio Bursts with Spectral Structure Using the Continuous Forward Algorithm}",
      journal = {\apj},
     keywords = {Radio astronomy, Radio transient sources, Astronomy data analysis, Astrostatistics techniques, Interstellar scintillation, 1338, 2008, 1858, 1886, 855, Astrophysics - High Energy Astrophysical Phenomena, Astrophysics - Instrumentation and Methods for Astrophysics},
         year = 2024,
        month = jan,
       volume = {960},
       number = {2},
          eid = {128},
        pages = {128},
          doi = {10.3847/1538-4357/ad0964},
archivePrefix = {arXiv},
       eprint = {2306.07914},
 primaryClass = {astro-ph.HE},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2024ApJ...960..128K},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

Metadata

Release files for kalman-detector 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for kalman-detector 0.5.0
File Size Uploaded
kalman_detector-0.5.0.tar.gz 19.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for kalman-detector 0.5.0
File Interpreter ABI Platform
kalman_detector-0.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 35.1 kB

Release files / kalman_detector-0.5.0.tar.gz

Download URL kalman_detector-0.5.0.tar.gz
Size 19.4 kB
Tags Source
SHA-256 checksum
How to use checksums
f2c8ab7b35a875a28ee37d29f63d0efd87220b2957f21e6bae9ab6ac86fce569
BLAKE2b-256 checksum
How to use checksums
a417e2b88f3c5eac7688838f699fdf4ff85cbeef0e9a226a9e3eec75a639a067
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.0.0 CPython/3.12.3

Release files / kalman_detector-0.5.0-py3-none-any.whl

Download URL kalman_detector-0.5.0-py3-none-any.whl
Size 15.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f0d28445811302e0e6cbfb948cd3f482c5347dfd300be00d46d2f4f0dc18bcb0
BLAKE2b-256 checksum
How to use checksums
28072d2cd30401ee68e09da5a036006bd337105ab6174e22222b92ced6cc903e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.0.0 CPython/3.12.3

Release history Release notifications | RSS feed

This release

0.5.0 This release

2 release files

0.0.5

1 release file

0.0.4

1 release file

0.0.3

1 release file

0.0.2

1 release file

0.0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page