Skip to main content

Blue Brain Python E-feature extraction

Project description

banner


BluePyEfe: Blue Brain Python E-feature extraction

Latest Release

latest release

Documentation

latest documentation

License

license

Build Status

Actions build status

Coverage

coverage

Citation

DOI

Gitter

gitter

Introduction

BluePyEfe aims at easing the process of reading experimental recordings and extracting batches of electrical features from these recordings. To do so, it combines trace reading functions and features extraction functions from the eFel library.

BluePyEfe outputs protocols and features files in the format used by BluePyOpt for neuron electrical model building.

How to cite

If you use this repository in your work, please refer to the “Cite this repository” button at the top of the repository page to get various citation formats, including APA and BibTeX.

For detailed citation information, please refer to the CITATION.cff file.

Requirements

  • Python 3.9+

  • eFEL eFeature Extraction Library (automatically installed by pip)

  • Numpy (automatically installed by pip)

  • Scipy (automatically installed by pip)

  • Neo (automatically installed by pip)

  • The instruction below are written assuming you have access to a command shell on Linux / UNIX / MacOSX / Cygwin

Installation

To install BluePyEfe, run:

pip install bluepyefe

Quick Start and Operating Principle

For a hands-on introduction to BluePyEfe, have a look at the notebook examples/example_of_extraction.ipynb

The goal of the present package is to extract meaningful electrophysiological features (e-features) from voltage time series. The e-features considered in the present package are the one implemented in the eFEL python library. See this pdf for a list of available e-features.

The present package makes one major assumption: E-features are more meaningful if they are coming from a set of traces rather than a single trace. And they are even more meaningful if these traces come from different cells of the same cellular type. This assumption dictates the organisation of the package and has several consequences:

The efeatures extracted through the package will always be averaged over the trace considered. For example, the AP_amplitude will be an average over all the action potentials present in a trace. If you wish to work on an AP by AP basis, please consider using the eFEL library directly.

A large part of the present software is therefore dedicated to averaging the features across set of “equivalent” recordings. To be able to average e-features across different cells in a meaningful way, an equivalence must be established between the traces coming from these different cells. It would not make sense to average the mean firing frequency obtain cell A on a 1s long step protocol with the one obtain for cell B on a ramp protocol that lasts for 500ms. We chose to define recordings as equivalent based on two criteria: (1) They have the same name and (2) they are of the same amplitude when the amplitude is expressed as a percentage of the rheobase of the cell.

A pseudo-code for the main function of the package (bluepyefe.extract.extract_efeatures) could look as follows:

  1. Load the data to memory by reading all the files containing the traces

  2. Extract the required e-features for all the traces

  3. Compute the rheobases of the cells based on one or several protocols

  4. Use these rheobases to associate to each protocol an amplitude expressed in % of the rheobase

  5. Compute the mean and standard deviations for the e-features across traces having the same amplitude

  6. Save the results and plot the traces and e-features

Each of these steps are parametrized by a number of settings, therefore we recommend that you read carefully the docstring of the function.

Coming from the legacy version

The legacy version (v0.4*) is moved to the legacy branch. Changes introduced in v2.0.0 are listed in the CHANGELOG.rst. That is the only file you need to look at for the changes as the future changes will also be noted there.

Funding

This work has been partially funded by the European Union Seventh Framework Program (FP7/2007­2013) under grant agreement no. 604102 (HBP), and by the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreements No. 720270 (Human Brain Project SGA1) and No. 785907 (Human Brain Project SGA2) and by the EBRAINS research infrastructure, funded from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 945539 (Human Brain Project SGA3).

Copyright (c) 2016-2024 Blue Brain Project/EPFL

Copyright (c) 2025 Open Brain Institute

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

bluepyefe-2.3.45.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

bluepyefe-2.3.45-py3-none-any.whl (65.8 kB view details)

Uploaded Python 3

File details

Details for the file bluepyefe-2.3.45.tar.gz.

File metadata

  • Download URL: bluepyefe-2.3.45.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for bluepyefe-2.3.45.tar.gz
Algorithm Hash digest
SHA256 0194caa959c5ef58d46e57f07665d78de3bcd6ae39736722bd6fb707bf30170e
MD5 8ef001988da7a66bc5242cee27ccca3a
BLAKE2b-256 e1e9d43136f1cae6549409e9df56e9b715df6298ed864270abbbdea4d1dc75e9

See more details on using hashes here.

Provenance

The following attestation bundles were made for bluepyefe-2.3.45.tar.gz:

Publisher: build.yml on openbraininstitute/BluePyEfe

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bluepyefe-2.3.45-py3-none-any.whl.

File metadata

  • Download URL: bluepyefe-2.3.45-py3-none-any.whl
  • Upload date:
  • Size: 65.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for bluepyefe-2.3.45-py3-none-any.whl
Algorithm Hash digest
SHA256 32ae6cd6f80ae7effc0a4b45bbda9feacc6016d3edc733172d581df1f7ab641b
MD5 b485518933309fb65af9d9dea10cd007
BLAKE2b-256 501aab899dbfacb146891345bc6a3375ef8d5bb8df64432306b3a62745e60364

See more details on using hashes here.

Provenance

The following attestation bundles were made for bluepyefe-2.3.45-py3-none-any.whl:

Publisher: build.yml on openbraininstitute/BluePyEfe

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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