pysampled 1.0.0__tar.gz

pysampled-1.0.0/.gitignore

@@ -0,0 +1,164 @@
+.vscode/*
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+airPLS.py

pysampled-1.0.0/.readthedocs.yaml

@@ -0,0 +1,29 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+  - pdf
+  - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

pysampled-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Praneeth Namburi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

pysampled-1.0.0/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.1
+Name: pysampled
+Version: 1.0.0
+Summary: :py:mod:`pysampled` provides tools for working with uniformly sampled (time series) data.
+Author-email: Praneeth Namburi <praneeth.namburi@gmail.com>
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Scientific/Engineering
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: scikit-learn
+Requires-Dist: matplotlib
+Requires-Dist: numpy ; extra == "minimal"
+Requires-Dist: scipy ; extra == "minimal"
+Project-URL: Home, https://github.com/praneethnamburi/pysampled
+Provides-Extra: minimal
+
+# pysampled
+
+[![src](https://img.shields.io/badge/src-github-blue)](https://github.com/praneethnamburi/pysampled)
+[![PyPI - Version](https://img.shields.io/pypi/v/pysampled.svg?logo=pypi&label=PyPI&logoColor=gold)](https://pypi.org/project/pysampled/)
+[![Documentation Status](https://readthedocs.org/projects/pysampled/badge/?version=latest)](https://pysampled.readthedocs.io)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/praneethnamburi/pysampled/main/LICENSE)
+
+*A toolkit for working with uniformly sampled time series data.*
+
+`pysampled` streamlines the exploration of time series data and the development of signal processing pipelines. It enables researchers and engineers to analyze time series data—including audio signals and physiological data—efficiently and intuitively. With its user-friendly interface and well-documented examples, the package makes signal processing accessible for both basic manipulations and analyses like filtering, resampling, trend extraction, and spectral analysis.
+
+## Installation
+
+**1. Installing from PyPI (Recommended)**
+
+```sh
+pip install pysampled && download-airpls
+```
+
+You can optionally use `pip install pysampled[minimal]` to skip installing scikit-learn and matplotlib.
+
+> *Note:* The `download-airpls` command is defined in `pyproject.toml` and ensures that the required `airPLS.py` file is properly downloaded. More information on airPLS [here](https://github.com/zmzhang/airPLS/tree/master).
+
+
+
+**2. Installing from the GitHub Repository**
+
+```sh
+pip install git+https://github.com/praneethnamburi/pysampled.git && download-airpls
+```
+
+Alternatively, you can clone the repository locally and set up your environment using the `requirements.yml` file. If you do this, download `airPLS.py` manually from [here](https://github.com/zmzhang/airPLS/tree/master) and add it to the `pysampled` folder inside the cloned repository.
+
+```sh
+git clone https://github.com/praneethnamburi/pysampled.git
+cd pysampled
+conda env create -n pysampled -f requirements.yml
+```
+
+
+## Quickstart
+
+```python
+import pysampled as sampled
+
+# Generate a 10 Hz signal sampled at 100 Hz. Sum of three sine waves (1, 3, and 5 Hz).
+sig = sampled.generate_signal("three_sine_waves")[:5.0] 
+
+# Only keep first 5 seconds of the signal
+sig = sig[:5.0]
+
+# visualize the signal, before and after applying a bandpass filter between 2 and 4 Hz
+sampled.plot([sig, sig.bandpass(2, 4)])
+```
+
+
+## License
+
+This project is licensed under the MIT License. See the `LICENSE` file for details.
+
+
+## Contact
+
+[Praneeth Namburi](https://praneethnamburi.com)
+
+Project Link: [https://github.com/praneethnamburi/pysampled](https://github.com/praneethnamburi/pysampled)
+
+
+## Acknowledgments
+
+This tool was developed as part of the ImmersionToolbox initiative at the [MIT.nano Immersion Lab](https://immersion.mit.edu). Thanks to NCSOFT for supporting this initiative.
+

pysampled-1.0.0/README.md

@@ -0,0 +1,71 @@
+# pysampled
+
+[![src](https://img.shields.io/badge/src-github-blue)](https://github.com/praneethnamburi/pysampled)
+[![PyPI - Version](https://img.shields.io/pypi/v/pysampled.svg?logo=pypi&label=PyPI&logoColor=gold)](https://pypi.org/project/pysampled/)
+[![Documentation Status](https://readthedocs.org/projects/pysampled/badge/?version=latest)](https://pysampled.readthedocs.io)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/praneethnamburi/pysampled/main/LICENSE)
+
+*A toolkit for working with uniformly sampled time series data.*
+
+`pysampled` streamlines the exploration of time series data and the development of signal processing pipelines. It enables researchers and engineers to analyze time series data—including audio signals and physiological data—efficiently and intuitively. With its user-friendly interface and well-documented examples, the package makes signal processing accessible for both basic manipulations and analyses like filtering, resampling, trend extraction, and spectral analysis.
+
+## Installation
+
+**1. Installing from PyPI (Recommended)**
+
+```sh
+pip install pysampled && download-airpls
+```
+
+You can optionally use `pip install pysampled[minimal]` to skip installing scikit-learn and matplotlib.
+
+> *Note:* The `download-airpls` command is defined in `pyproject.toml` and ensures that the required `airPLS.py` file is properly downloaded. More information on airPLS [here](https://github.com/zmzhang/airPLS/tree/master).
+
+
+
+**2. Installing from the GitHub Repository**
+
+```sh
+pip install git+https://github.com/praneethnamburi/pysampled.git && download-airpls
+```
+
+Alternatively, you can clone the repository locally and set up your environment using the `requirements.yml` file. If you do this, download `airPLS.py` manually from [here](https://github.com/zmzhang/airPLS/tree/master) and add it to the `pysampled` folder inside the cloned repository.
+
+```sh
+git clone https://github.com/praneethnamburi/pysampled.git
+cd pysampled
+conda env create -n pysampled -f requirements.yml
+```
+
+
+## Quickstart
+
+```python
+import pysampled as sampled
+
+# Generate a 10 Hz signal sampled at 100 Hz. Sum of three sine waves (1, 3, and 5 Hz).
+sig = sampled.generate_signal("three_sine_waves")[:5.0] 
+
+# Only keep first 5 seconds of the signal
+sig = sig[:5.0]
+
+# visualize the signal, before and after applying a bandpass filter between 2 and 4 Hz
+sampled.plot([sig, sig.bandpass(2, 4)])
+```
+
+
+## License
+
+This project is licensed under the MIT License. See the `LICENSE` file for details.
+
+
+## Contact
+
+[Praneeth Namburi](https://praneethnamburi.com)
+
+Project Link: [https://github.com/praneethnamburi/pysampled](https://github.com/praneethnamburi/pysampled)
+
+
+## Acknowledgments
+
+This tool was developed as part of the ImmersionToolbox initiative at the [MIT.nano Immersion Lab](https://immersion.mit.edu). Thanks to NCSOFT for supporting this initiative.

pysampled-1.0.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

pysampled-1.0.0/docs/api.md

@@ -0,0 +1,12 @@
+# API Reference
+
+```{eval-rst}
+.. automodule:: pysampled
+    :members:
+    :special-members:
+
+.. automodule:: pysampled.core
+    :members:
+    :undoc-members:
+    :special-members: __getitem__, __call__
+```

pysampled-1.0.0/docs/conf.py

@@ -0,0 +1,61 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath("../pysampled"))
+
+from pysampled.__version__ import __version__
+
+project = "pysampled"
+copyright = "2025, Praneeth Namburi"
+author = "Praneeth Namburi"
+version = __version__
+release = __version__
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "myst_parser",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.duration",
+    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.napoleon",  # if you are using Google or NumPy style docstrings
+    "sphinxcontrib.youtube",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+html_theme_options = {
+    "collapse_navigation": False,
+}
+html_static_path = []
+
+napoleon_use_param = True  # Show parameter types in the description instead of the signature
+napoleon_use_rtype = True  # Show return type in the description instead of the signature
+
+autodoc_member_order = "bysource"
+autodoc_default_options = {"ignore-module-all": True}
+napoleon_use_ivar = True
+# autodoc_typehints_format = "short"  # Reduces lengthy type hints to their short forms
+autodoc_typehints = "description"  # Moves type hints to the parameter descriptions
+
+from sphinx.ext.autodoc import between
+
+
+def setup(app):
+    # Register a sphinx.ext.autodoc.between listener to ignore everything
+    # between lines that contain the word IGNORE
+    app.connect("autodoc-process-docstring", between("^.*IGNORE.*$", exclude=True))
+    return app

pysampled-1.0.0/docs/examples.md

@@ -0,0 +1,107 @@
+# Examples
+
+This section demonstrates various use cases of the `pysampled` package with visual examples. Each example showcases a specific functionality, and includes plots generated directly from the code. In the plots, the x-axis represents time (in seconds).
+
+## 1 - One-liner
+The following example computes the magnitude of a 3-axis accelerometer signal, thresholds the signal, and vidualizes the first two seconds of the result.
+
+```python
+(sampled.generate_signal("accelerometer").magnitude() > 1.4)[:2.].plot()
+```
+
+**Plot Output:**
+
+```{eval-rst}
+.. image:: _static/example_1_plot.png
+   :alt: Accelerometer Magnitude Threshold Plot
+```
+
+---
+
+## 2 - Compute and Visualize Accelerometer Magnitude
+
+A different implementation of example 1.
+
+```python
+acc = sampled.generate_signal("accelerometer")[2.5:6.] # 2.5 to 6 s
+ax = sampled.plot([acc.magnitude(), acc.magnitude() > 1.4])
+```
+
+**Plot Output:**
+
+```{eval-rst}
+.. image:: _static/example_2_plot.png
+   :alt: Accelerometer Magnitude Threshold Plot
+```
+
+---
+
+## Example 3 - Magnitude Calculation with Smoothing
+
+In this example, we compute the magnitude, remove the DC offset, and apply a moving average filter.
+
+```python
+acc = sampled.generate_signal("accelerometer")
+sampled.plot([
+    acc.magnitude(),
+    acc.magnitude().shift_baseline(),
+    acc.magnitude().shift_baseline().smooth(0.16)
+])
+```
+
+**Plot Output:**
+
+```{eval-rst}
+.. image:: _static/example_3_plot.png
+   :alt: Magnitude Calculation with Smoothing Plot
+```
+
+---
+
+## Example 4 - Removing Noise and Interpolating
+
+This example generates white noise data, removes data in specified ranges, and interpolates the result.
+
+```python
+wn = sampled.generate_signal("white_noise")
+sampled.plot([
+    wn,
+    wn.remove_and_interpolate([[0.5, 1], [4, 4.2]])
+])
+```
+
+**Plot Output:**
+
+```{eval-rst}
+.. image:: _static/example_4_plot.png
+   :alt: Noise Removal and Interpolation Plot
+```
+
+---
+
+## Example 5 - Visualizing the Power spectral density
+
+In this example, we generate white noise data, apply a low-pass filter, and visualize both signals in the frequency domain.
+
+```python
+import matplotlib.pyplot as plt
+wn = sampled.generate_signal("white_noise")
+wn_lowpass = wn.lowpass(4)
+
+figure, (ax1, ax2) = plt.subplots(2, 1)
+sampled.plot([wn, wn_lowpass], ax=ax1)
+ax1.set_xlabel("Time (s)")
+
+sampled.plot([wn.psd_as_sampled(), wn_lowpass.psd_as_sampled()], ax=ax2)
+ax2.set_xlabel("Frequency (Hz)")
+figure.tight_layout()
+plt.draw()
+```
+
+**Plot Output:**
+
+```{eval-rst}
+.. image:: _static/example_5_plot.png
+   :alt: Fourier Transform Plot
+```
+

pysampled-1.0.0/docs/index.md

@@ -0,0 +1,14 @@
+% pyfilemanager documentation master file, created by
+% sphinx-quickstart on Tue Jan 23 10:31:39 2024.
+% You can adapt this file completely to your liking, but it should at least
+% contain the root `toctree` directive.
+
+```{include} ../README.md
+:relative-images:
+```
+
+```{toctree}
+:hidden:
+examples
+api
+```

pysampled-1.0.0/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

pysampled-1.0.0/docs/requirements.txt

@@ -0,0 +1,4 @@
+sphinx==6.2.1
+sphinx-rtd-theme==2.0.0
+myst-parser==1.0.0
+sphinxcontrib-youtube==1.4.1