Changelog¶

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

1.1.0¶

Introduced decoding support for contrast-based and deconvolution-based encoders, enabling signal reconstruction workflows.
Improved return format consistency by removing implicit flattening of outputs across decoding functions.
Clarified argument order and improved API consistency in decoding-related functions.
General documentation style improvements and cleanup.
Removed unnecessary argument initializations to simplify internal logic.

Renamed filtering and encoding packages to filters and encoders for improved consistency and shorter import paths.
Renamed burst encoding to burst coding to shorten the module path and align with conventional terminology.
Renamed the global-referenced phase encoding and Poisson encoding functions for clarity and consistency.
Enhanced FilterBank to enforce 2D signal processing, improve filter coefficient selection, and expand test coverage on center frequencies.
Added automatic signal scaling and normalization to several encoding algorithms.
Added FIR filter support to the BSA encoder along with updated parameters and documentation.
Extended codemeta.json with auto-updating version, download link, and date fields.
Added a PyPI-compatible README with updated logo and layout.

Fixed the SF algorithm timestep calculation.
Fixed the MW algorithm implementation.
Fixed the HSA issue affecting spike generation correctness.
Fixed the TBR output by replacing variation prepend with append to match the original algorithm setup.
Fixed the codemeta.json version identifier.

Refactored and expanded documentation for TBR, BSA, HSA, SF, MW, ZCSF, burst coding, phase encoding, Poisson encoding, and contrast-based algorithms, including pseudocode and improved descriptions.
Renamed documentation paths to reflect the new filters and encoders module structure.
Clarified descriptions for global-referenced encoding algorithms and filter sections.

Introduced a new FilterBank class that allows users to create and apply filter banks (e.g., Gammatone, Butterworth) to decompose input signals into multiple frequency channels.
Enhanced documentation with additional examples and usage guidelines for the new filtering capabilities.

Added multiple features encoding for every encoding method, allowing users to encode multiple features simultaneously.

Fix bug in the phase_encoding function that caused incorrect spike generation under certain conditions. This was due to an erron on how bits were unpacked.