Introduction

python-signal-edges (Signal Edges) is a Python package capable of filtering, extracting state levels and edges of signals with millions of samples, among other things. It is specially suited for analysis of analog signals obtained through tooling such as oscilloscopes or data recorders and hardware automation in CI/CD environments, although it is flexible enough to be used for many other different purposes.

Among others, it uses the following packages underneath:

  • Numpy, for analysis of the arrays that define the signals.

  • Scipy, for filtering of signals.

  • Matplotlib, for plotting of the signals.

It is recommended to start reading the documentation from the Signal chapter, and then move towards other chapters as functionality is required. The Frequently Asked Questions chapters covers other topics not specific to a chapter.

Note

This is the documentation for python-signal-edges, version 1.0.5.

Development

The source code for python-signal-edges is hosted at Github and related Docker images for development containers are located at DockerHub.

For details about automated tests for this release refer to the testing and coverage reports at Test Results HTML Report and Code Coverage HTML report.

License

Copyright 2023 - Diego Martínez García <dmg0345@gmail.com>

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.