Metadata-Version: 2.4
Name: scitex-dsp
Version: 0.1.5
Summary: Digital signal processing (PAC, Hilbert, Wavelet, filters, demo signals, …) — standalone module from the SciTeX ecosystem
Author-email: Yusuke Watanabe <ywatanabe@scitex.ai>
License-Expression: AGPL-3.0-only
Project-URL: Homepage, https://github.com/ywatanabe1989/scitex-dsp
Project-URL: Repository, https://github.com/ywatanabe1989/scitex-dsp
Project-URL: Documentation, https://scitex-dsp.readthedocs.io
Keywords: scitex,dsp,signal-processing,pytorch,pac
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: torch
Requires-Dist: xarray
Requires-Dist: scitex-decorators>=0.1.1
Requires-Dist: scitex-gen>=0.1.3
Requires-Dist: scitex-nn>=0.1.2
Provides-Extra: audio
Requires-Dist: sounddevice; extra == "audio"
Provides-Extra: pac
Requires-Dist: tensorpac; extra == "pac"
Provides-Extra: dev
Requires-Dist: joblib; extra == "dev"
Requires-Dist: scitex; extra == "dev"
Requires-Dist: flask; extra == "dev"
Requires-Dist: tensorpac; extra == "dev"
Requires-Dist: sounddevice; extra == "dev"
Requires-Dist: ripple_detection; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=7.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=2.0; extra == "docs"
Requires-Dist: myst-parser>=2.0; extra == "docs"
Provides-Extra: all
Requires-Dist: scitex-dsp[audio]; extra == "all"
Requires-Dist: scitex-dsp[pac]; extra == "all"
Dynamic: license-file

# scitex-dsp

<!-- scitex-badges:start -->
[![PyPI](https://img.shields.io/pypi/v/scitex-dsp.svg)](https://pypi.org/project/scitex-dsp/)
[![Python](https://img.shields.io/pypi/pyversions/scitex-dsp.svg)](https://pypi.org/project/scitex-dsp/)
[![Tests](https://github.com/ywatanabe1989/scitex-dsp/actions/workflows/test.yml/badge.svg)](https://github.com/ywatanabe1989/scitex-dsp/actions/workflows/test.yml)
[![Install Test](https://github.com/ywatanabe1989/scitex-dsp/actions/workflows/install-test.yml/badge.svg)](https://github.com/ywatanabe1989/scitex-dsp/actions/workflows/install-test.yml)
[![Coverage](https://codecov.io/gh/ywatanabe1989/scitex-dsp/graph/badge.svg)](https://codecov.io/gh/ywatanabe1989/scitex-dsp)
[![Docs](https://readthedocs.org/projects/scitex-dsp/badge/?version=latest)](https://scitex-dsp.readthedocs.io/en/latest/)
[![License: AGPL v3](https://img.shields.io/badge/license-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
<!-- scitex-badges:end -->


Digital signal processing utilities (PAC, Hilbert, Wavelet, filters, resampling, demo signals, …) extracted from the [SciTeX](https://github.com/ywatanabe1989/scitex-python) ecosystem as a standalone package.

## Install

```bash
pip install scitex-dsp
```

## API

```python
import scitex_dsp as dsp

xx, tt, fs = dsp.demo_sig(sig_type="chirp", fs=1024)
psd, ff = dsp.psd(xx, fs)
xf = dsp.filt.bandpass(xx, fs, bands=[[8, 12]])
hp = dsp.hilbert(xx)
pac, freqs_pha, freqs_amp = dsp.pac(xx, fs, ...)
```

## Status

Standalone fork of `scitex.dsp`. The umbrella package's `scitex.dsp` import path
is preserved via a `sys.modules`-alias bridge.

Decoupling notes:
- `scitex.{decorators,gen,nn}` → `scitex_*` direct imports.
- `scitex.io.load_configs` deferred via `try/except` with `CONFIG = {}` fallback
  (only used in `_demo_sig.py` module-init).
- `scitex.dsp.utils` and `scitex.dsp._demo_sig` are intra-package — rewritten as
  `scitex_dsp.utils` / `scitex_dsp._demo_sig`.
- Example `if __name__ == "__main__"` blocks still reference the umbrella
  (`scitex.session`, `scitex.io`, `scitex.plt`) — they only run when the
  umbrella is installed.

## License

AGPL-3.0-only.
