Skip to main content

Algorithms and scripts for analyzing recordings of electric fish waveforms.

Project description

license tests codecov PyPI version downloads contributors commits

ThunderFish

Algorithms and programs for analysing electric field recordings of weakly electric fish.

Documentation | API Reference

Weakly electric fish generate an electric organ discharge (EOD). In wave-type fish the EOD resembles a sinewave of a specific frequency and with higher harmonics. In pulse-type fish EODs have a distinct waveform and are separated in time. The thunderfish package provides algorithms and tools for analysing both wavefish and pulsefish EODs.

thunderfish

Installation

ThunderFish is available from PyPi. Simply run:

pip install thunderfish

This should also install:

Software

The thunderfish package provides the following software:

Algorithms

The following modules provide the algorithms for analyzing EOD recordings. Look into the modules for more information.

Input/output

EOD analysis

  • bestwindow: Select the region within a recording with the most stable signal of largest amplitude that is not clipped.
  • checkpulse: Check whether a pulse-type or a wave-type weakly electric fish is present in a recording.
  • consistentfishes: Create a list of EOD frequencies with fishes present in all provided fish lists.
  • eodanalysis: Analyse EOD waveforms.
  • harmonics: Extract and analyze harmonic frequencies from power spectra.
  • pulses: Extract and cluster EOD waverforms of pulse-type electric fish.

EOD simulations

  • fakefish: Simulate EOD waveforms.
  • efield: Simulations of spatial electric fields.
  • fishshapes: Manipulate and plot fish outlines.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

thunderfish-2.1.0.tar.gz (233.1 kB view details)

Uploaded Source

Built Distribution

thunderfish-2.1.0-py3-none-any.whl (223.0 kB view details)

Uploaded Python 3

File details

Details for the file thunderfish-2.1.0.tar.gz.

File metadata

  • Download URL: thunderfish-2.1.0.tar.gz
  • Upload date:
  • Size: 233.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.3

File hashes

Hashes for thunderfish-2.1.0.tar.gz
Algorithm Hash digest
SHA256 8fc2cf1d8c4e93e9703f238f773d42c12f4f601c4ae4ccb678a59e5aff39607a
MD5 c1e50cc1d1e8c0f3c1ed3e8a3073d7cf
BLAKE2b-256 8973b4d695fb0a159addeecdfec9c628522a86a4f9394a9120194143637c53bf

See more details on using hashes here.

File details

Details for the file thunderfish-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: thunderfish-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 223.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.3

File hashes

Hashes for thunderfish-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ba6d94cd0b6cc2a9831ae6e584205e7aca393cce49719c06aa40ca9e950509fd
MD5 4ee323c535a2ebba85ee32674695a8e4
BLAKE2b-256 086d68ba65462f0c5940dbaec17c799b07730b175a40cb4dfdbb00448bb4c489

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page