Skip to main content

Algorithms and scripts for analyzing recordings of electric fish waveforms.

Project description

Build Status codecov

thunderfish

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

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 tools for analysing both wavefish and pulsefish EODs.

Documentation

Git Repository

Software

The thunderfish package provides the following software:

  • fishfinder: Browse EOD recordings and detect EOD frequencyies on the fly.
  • thunderfish: Automatically detect and analyze all EOD waveforms in a short recording and generate a summary plot and data tables. Read documentation.
  • collectfish: Collect data generated by thunderfish. Read documentation.
  • eodexplorer: View and explore properties of EOD waveforms. Read documentation.

Algorithms

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

Input/output

  • configfile.py: Configuration file with help texts for analysis parameter.
  • consoleinput.py: User input from console.
  • dataloader.py: Load time-series data from files.
  • tabledata.py: Read and write tables with a rich hierarchical header including units and formats.

Basic data analysis

  • eventdetection.py: Detect and hande peaks and troughs as well as threshold crossings in data arrays.
  • powerspectrum.py: Compute and plot powerspectra and spectrograms for a given minimum frequency resolution.
  • voronoi.py: Analyse Voronoi diagrams based on scipy.spatial.
  • multivariateexplorer.py: Simple GUI for viewing and exploring multivariate data.

EOD analysis

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

EOD simulations

  • fakefish.py: Simulate EOD waveforms.
  • efield.py: Simulations of spatial electric fields.
  • fishshapes.py: 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-1.9.2.tar.gz (203.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

thunderfish-1.9.2-py3-none-any.whl (225.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: thunderfish-1.9.2.tar.gz
  • Upload date:
  • Size: 203.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.6.9

File hashes

Hashes for thunderfish-1.9.2.tar.gz
Algorithm Hash digest
SHA256 c94b24aeb8d6f9b445e3f10bfb9dd54f8367371c4ee81ecd672f2f1bec2fcd6a
MD5 5e9ee8ffcbd78d09bf114a1d5f171c19
BLAKE2b-256 ed4a6233626563da73e900aeb6fc09d24c0d7daa368f7971408df89c267620d5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: thunderfish-1.9.2-py3-none-any.whl
  • Upload date:
  • Size: 225.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.6.9

File hashes

Hashes for thunderfish-1.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a83eb356a93a17626686f9bb2e3375bb97a2eaac789fe953be56f5a2344eaf49
MD5 fab022f30a66caad7a7c3ce9b89a0e81
BLAKE2b-256 baac9d963e627306654094d3d756e9539a51fb708ddf855ec7716b9b4663ace2

See more details on using hashes here.

Supported by

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