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.0.0.tar.gz (217.6 kB view hashes)

Uploaded Source

Built Distribution

thunderfish-2.0.0-py3-none-any.whl (208.2 kB view hashes)

Uploaded Python 3

Supported by

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