API Reference#

sigpyproc#

base

Base classes for manipulating frequency-major order pulsar data.

block

Block classes for handling 2D data blocks.

foldedcube

Classes for handling folded data cubes.

fourierseries

Classes for handling 1D Fourier series data.

header

Header class for handling observation metadata.

params

Dispersion related parameters and functions.

readers

Classes for reading filterbank and PSRFITS data.

timeseries

Classes for handling 1D time series data.

utils

Utility functions for sigpyproc.

sigpyproc.core#

filters

Matched filter class for pulse detection in 1D time series data.

kernels

Numba kernel functions for the core of sigpyproc.

rfi

RFI masking functions.

stats

Statistical functions for computing moments of data.

sigpyproc.io#

bits

Bit packing and unpacking functions.

fbh5

Sigproc-style HDF5 header parsing.

fileio

File I/O base class and readers/writers.

pfits

PSRFITS header and data reading.

rescale

Rescaling of streaming data to zero mean and unit variance.

sigproc

Sigproc-style header parsing and editing.

sigpyproc.simulation#

furby

Furby class for generating mock FRB signals.

sigpyproc.viz#

styles

Plotting styles for sigpyproc.