Electrophys Feature Extract Library (eFEL)

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for aurelienjaquier from gravatar.com aurelienjaquier Avatar for bbp.opensource from gravatar.com bbp.opensource Avatar for wvangeit from gravatar.com wvangeit

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU Lesser General Public License v3 (LGPLv3) (LGPLv3)
  • Author: BlueBrain Project, EPFL
  • Maintainer: Werner Van Geit
  • Tags feature, extraction, electrophysiology, BlueBrainProject
Classifiers

Project description

eFEL banner
Latest Release latest release
Documentation latest documentation
License license
Build Status actions build status
Coverage coverage
Gitter
Citation DOI

Introduction

The Electrophys Feature Extraction Library (eFEL) allows neuroscientists to automatically extract features from time series data recorded from neurons (both in vitro and in silico). Examples are the action potential width and amplitude in voltage traces recorded during whole-cell patch clamp experiments. The user of the library provides a set of traces and selects the features to be calculated. The library will then extract the requested features and return the values to the user.

The core of the library is written in C++, and a Python wrapper is included. At the moment we provide a way to automatically compile and install the library as a Python module. Instructions on how to compile the eFEL as a standalone C++ library can be found here.

How to cite

When you use this eFEL software for your research, we ask you to cite it (this includes poster presentations) by referring 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+
  • Pip (installed by default in newer versions of Python)
  • C++ compiler that can be used by pip
  • Numpy (will be installed automatically by pip)
  • The instruction below are written assuming you have access to a command shell on Linux / UNIX / MacOSX / Cygwin

Installation

The easiest way to install eFEL is to use pip

pip install efel

In case you don't have administrator access this command might fail with a permission error. In that case you could install eFEL in your home directory

pip install efel --user

Or you could use a python virtual environment

virtualenv pythonenv
. ./pythonenv/bin/activate
# If you use csh or tcsh, you should use:
# source ./pythonenv/bin/activate.csh
pip install efel

If you want to install straight from the github repository you can use

pip install git+git://github.com/BlueBrain/eFEL

Quick Start

First you need to import the module

import efel

To get a list with all the available feature names

efel.get_feature_names()

To change the spike detection threshold setting (default is -20 mV)

efel.set_setting('Threshold', -30)

For a full list of available settings, please refer to the Setting class

The python function to extract features is get_feature_values(...). Below is a short example on how to use this function. The code and example trace are available here

"""Basic example 1 for eFEL"""

import efel
import numpy

def main():
    """Main"""

    # Use numpy to read the trace data from the txt file
    data = numpy.loadtxt('example_trace1.txt')

    # Time is the first column
    time = data[:, 0]
    # Voltage is the second column
    voltage = data[:, 1]

    # Now we will construct the datastructure that will be passed to eFEL

    # A 'trace' is a dictionary
    trace1 = {}

    # Set the 'T' (=time) key of the trace
    trace1['T'] = time

    # Set the 'V' (=voltage) key of the trace
    trace1['V'] = voltage

    # Set the 'stim_start' (time at which a stimulus starts, in ms)
    # key of the trace
    # Warning: this need to be a list (with one element)
    trace1['stim_start'] = [700]

    # Set the 'stim_end' (time at which a stimulus end) key of the trace
    # Warning: this need to be a list (with one element)
    trace1['stim_end'] = [2700]

    # Multiple traces can be passed to the eFEL at the same time, so the
    # argument should be a list
    traces = [trace1]

    # set the threshold for spike detection to -20 mV
    efel.set_setting('Threshold', -20)

    # Now we pass 'traces' to the efel and ask it to calculate the feature
    # values
    traces_results = efel.get_feature_values(traces,
                                           ['AP_amplitude', 'voltage_base'])

    # The return value is a list of trace_results, every trace_results
    # corresponds to one trace in the 'traces' list above (in same order)
    for trace_results in traces_results:
        # trace_result is a dictionary, with as keys the requested features
        for feature_name, feature_values in trace_results.items():
            print("Feature %s has the following values: %s" %
                (feature_name, ', '.join([str(x) for x in feature_values])))


if __name__ == '__main__':
    main()

The output of this example is

Feature AP_amplitude has the following values: 72.5782441262, 46.3672552618, 41.1546679158, 39.7631750953, 36.1614653031, 37.8489295737
Feature voltage_base has the following values: -75.446665721

This means that the eFEL found 5 action potentials in the voltage trace. The amplitudes of these APs are the result of the 'AP_amplitude' feature. The voltage before the start of the stimulus is measured by 'voltage_base'. Results are in mV.

Full documentation

The full documentation can be found here

Funding

This work has been partially funded by the European Union Seventh Framework Program (FP7/2007­2013) under grant agreement no. 604102 (HBP), the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 720270, 785907 (Human Brain Project SGA1/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). This project/research was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology.

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

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for aurelienjaquier from gravatar.com aurelienjaquier Avatar for bbp.opensource from gravatar.com bbp.opensource Avatar for wvangeit from gravatar.com wvangeit

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU Lesser General Public License v3 (LGPLv3) (LGPLv3)
  • Author: BlueBrain Project, EPFL
  • Maintainer: Werner Van Geit
  • Tags feature, extraction, electrophysiology, BlueBrainProject
Classifiers

Release history Release notifications | RSS feed

5.7.12

5.7.11

5.7.10

5.7.9

5.7.8

5.7.7

5.7.6

5.7.5

This version

5.7.4

5.7.3

5.7.2

5.7.1

5.7.0

5.6.29

5.6.28

5.6.27

5.6.26

5.6.25

5.6.24

5.6.23

5.6.22

5.6.21

5.6.20

5.6.19

5.6.18

5.6.17

5.6.16

5.6.15

5.6.14

5.6.13

5.6.12

5.6.11

5.6.10

5.6.9

5.6.8

5.6.7

5.6.6

5.6.5

5.6.4

5.6.3

5.6.2

5.6.1

5.5.7

5.5.6

5.5.5

5.5.4

5.5.3

5.5.2

5.5.1

5.5.0

5.4.1

5.4.0

5.3.10

5.3.9

5.3.8

5.3.7

5.3.5

5.3.4

5.3.3

5.3.2

5.3.1

5.3.0

5.2.10

5.2.9

5.2.8

5.2.7

5.2.5

5.2.4

5.2.1

5.2.0

5.1.6

5.1.5

5.1.4

5.1.3

5.1.2

5.1.1

5.1.0

5.0.7

5.0.6

5.0.5

5.0.4

5.0.1

4.3.6

4.3.5

4.3.4

4.3.0

4.2.12

4.2.10

4.2.7

4.2.5

4.2

4.1.98

4.1.95

4.1.93

4.1.91

4.1.86

4.1.84

4.1.81

4.1.78

4.1.76

4.1.73

4.1.63

4.1.61

4.1.58

4.1.56

4.1.54

4.1.49

4.1.47

4.1.40

4.1.31

4.1.23

4.1.19

4.1.14

4.1.1

4.0.50

4.0.47

4.0.44

4.0.42

4.0.40

4.0.34

4.0.32

4.0.30

4.0.26

4.0.4

3.2.4

3.2.1

3.1.100

3.1.98

3.1.96

3.1.92

3.1.90

3.1.88

3.1.82

3.1.77

3.1.75

3.1.72

3.1.70

3.1.63

3.1.60

3.1.58

3.1.56

3.1.54

3.1.52

3.1.50

3.1.46

3.1.44

3.1.42

3.1.40

3.1.39

3.1.37

3.1.10

3.0.113

3.0.103

3.0.99

3.0.93

3.0.87

3.0.84

3.0.82

3.0.80

3.0.73

3.0.72

3.0.70

3.0.68

3.0.66

3.0.62

3.0.60

3.0.58

3.0.56

3.0.43

3.0.39

3.0.36

3.0.34

3.0.31

3.0.30

3.0.22

3.0.19

3.0.16

3.0.12

3.0.7

3.0.5

3.0.3

2.13.13

2.13.6

2.13.3

2.13.1

2.12.11

2.12.9

2.12.6

2.12.4

2.11.52

2.11.50

2.11.47

2.11.45

2.11.41

2.11.35

2.11.33

2.11.31

2.11.28

2.11.26

2.11.14

2.11.12

2.11.10

2.11.9

2.11.7

2.11.5

2.11.3

2.11.1

2.10.150

2.10.147

2.10.146

2.10.144

2.10.135

2.10.134

2.10.132

2.10.130

2.10.129

2.10.127

2.10.124

2.10.121

2.10.120

2.10.118

2.10.116

2.10.115

2.10.114

2.10.112

2.10.111

2.10.109

2.10.107

2.10.105

2.10.102

2.10.99

2.10.97

2.10.95

2.10.93

2.10.86

2.10.85

2.10.83

2.10.80

2.10.78

2.10.76

2.10.74

2.10.72

2.10.66

2.10.65

2.10.63

2.10.61

2.10.60

2.10.59

2.10.57

2.10.53

2.10.51

2.10.49

2.10.47

2.10.45

2.10.43

2.10.41

2.10.39

2.10.38

2.10.36

2.10.34

2.10.33

2.10.32

2.10.31

2.10.30

2.10.29

2.10.28

2.10.25

2.10.21

2.10.20

2.10.18

2.10.15

2.10.13

2.10.11

2.10.9

2.10.7

2.10.6

2.10.5

2.10.4

2.10.3

2.10.1

2.9.22

2.9.19

2.9.17

2.9.15

2.9.14

2.9.13

2.9.12

2.9.11

2.9.10

2.9.4

2.9.3

2.9.2

2.9.1

2.8.8

2.8.2

2.8.1

2.8

2.7.10

2.7.9

2.7.8

2.7.7

2.7.5

2.7.4

2.7.post0.dev15 pre-release

2.7.post0.dev13 pre-release

2.7.post0.dev12 pre-release

2.6.40

2.6.38

2.6.37

2.6.36

2.6.35

2.6.34

2.6.32

2.6.31

2.6.30

2.6.29

2.6.26

2.6.25

2.6.24

2.6.23

2.6.22

2.6.21

2.6.20

2.6.19

2.6.18

2.6.17

2.6.14

2.6.13

2.6.12

2.6.11

2.6.10

2.6.9

2.6.7

2.6.3

2.6.1

2.4.28

2.4.27

2.4.24

2.4.22

2.4.21

2.4.18

2.4.13

2.4.12

2.4.11

2.4.9

2.4.8

2.4.2

2.4.1

2.3.90

2.3.73

2.3.71

2.3.70

2.3.68

2.3.67

2.3.66

2.3.64

2.3.63

2.3.62

2.3.60

2.3.59

2.3.57

2.3.49

2.3.48

2.3.47

2.3.46

2.3.44

2.3.37

2.3.36

2.3.35

2.3.34

2.3.33

2.3.32

2.3.31

2.3.29

2.3.28

2.3.27

2.3.26

2.3.25

2.3.24

2.3.23

2.3.22

2.3.21

2.3.20

2.3.19

2.3.18

2.3.17

2.3.16

Download files

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

Source Distribution

efel-5.7.4.tar.gz (107.4 kB view details)

Uploaded Source

Built Distributions

efel-5.7.4-cp312-cp312-win_amd64.whl (221.5 kB view details)

Uploaded CPython 3.12 Windows x86-64

efel-5.7.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.6 MB view details)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64

efel-5.7.4-cp312-cp312-macosx_10_9_x86_64.whl (274.3 kB view details)

Uploaded CPython 3.12 macOS 10.9+ x86-64

efel-5.7.4-cp311-cp311-win_amd64.whl (221.4 kB view details)

Uploaded CPython 3.11 Windows x86-64

efel-5.7.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.6 MB view details)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

efel-5.7.4-cp311-cp311-macosx_10_9_x86_64.whl (274.1 kB view details)

Uploaded CPython 3.11 macOS 10.9+ x86-64

efel-5.7.4-cp310-cp310-win_amd64.whl (221.4 kB view details)

Uploaded CPython 3.10 Windows x86-64

efel-5.7.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.6 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

efel-5.7.4-cp310-cp310-macosx_10_9_x86_64.whl (274.1 kB view details)

Uploaded CPython 3.10 macOS 10.9+ x86-64

efel-5.7.4-cp39-cp39-win_amd64.whl (221.4 kB view details)

Uploaded CPython 3.9 Windows x86-64

efel-5.7.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.6 MB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

efel-5.7.4-cp39-cp39-macosx_10_9_x86_64.whl (274.1 kB view details)

Uploaded CPython 3.9 macOS 10.9+ x86-64

File details

Details for the file efel-5.7.4.tar.gz.

File metadata

  • Download URL: efel-5.7.4.tar.gz
  • Upload date:
  • Size: 107.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for efel-5.7.4.tar.gz
Algorithm Hash digest
SHA256 f4ff390db11f708e60c27a0fd4dc6a637ec23b94758782d7be09193af99ba913
MD5 6601533d312b1180c7fa538fc23a4de2
BLAKE2b-256 0b68dbd39d81558abc6fd0bb3265f94831a4e0b9ef80a1b956bb123fff3a7b40

See more details on using hashes here.

Provenance

File details

Details for the file efel-5.7.4-cp312-cp312-win_amd64.whl.

File metadata

  • Download URL: efel-5.7.4-cp312-cp312-win_amd64.whl
  • Upload date:
  • Size: 221.5 kB
  • Tags: CPython 3.12, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for efel-5.7.4-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 901a4e8449054993970c1331a1dd3a94943c4f4e8c71db8d3cbd267aa771d6e4
MD5 0b6e22dc5f7e5e5c458dbcdaaef3fc9b
BLAKE2b-256 e23cbe7637ce6451b1e1c7340d7b3b404f124db094951cbb300482a27f560c40

See more details on using hashes here.

Provenance

File details

Details for the file efel-5.7.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for efel-5.7.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 718bad59f71c683af3083d854387df43486f5f7f3a51169af7a3b743dc97f661
MD5 bd4eeedfcde94b2cb6d8da1f7dbe95af
BLAKE2b-256 ffbdd94352c76da1ba5ac85476559ff9faf6e4ba8334b7f0eba730ccbd542220

See more details on using hashes here.

Provenance

File details

Details for the file efel-5.7.4-cp312-cp312-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for efel-5.7.4-cp312-cp312-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 8c8749b4b9e8bc188894d8ab60851a0513a16564d3a0a4eb958478c449ee12d6
MD5 e0c06f1ec8c499c2cbef10e21efe22e1
BLAKE2b-256 b1bc868d56ef4ca8d1f9319cfa3f52c069d8132f6fb867188dc958623745b26e

See more details on using hashes here.

Provenance

File details

Details for the file efel-5.7.4-cp311-cp311-win_amd64.whl.

File metadata

  • Download URL: efel-5.7.4-cp311-cp311-win_amd64.whl
  • Upload date:
  • Size: 221.4 kB
  • Tags: CPython 3.11, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for efel-5.7.4-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 a7fd15f3baa8e48d66963a674aff2ddef166ed04fc0679d5fb8740ad7f966083
MD5 bd05581ec2145af7c901e1aa631d384f
BLAKE2b-256 9538b7ef75279a9dce66b32c3be8a1f27426d5ef50a2f692dfa97aa3b5f4a4da

See more details on using hashes here.

Provenance

File details

Details for the file efel-5.7.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for efel-5.7.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 85a64b98b72f96c9283015348b07cf4f71f53ddfb2411712515875088cbac35e
MD5 72081f7a4ddff37c19965032edc1c0db
BLAKE2b-256 0189c94b0810f078168227ba0b4d72c9e33b5402c3faf1a893889ce21645bd4b

See more details on using hashes here.

Provenance

File details

Details for the file efel-5.7.4-cp311-cp311-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for efel-5.7.4-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 1b252940a53cf6df21d5ebc122cf03652efcc5e5f10eb2cafe6e93afcbb925da
MD5 0e5b2cf63293b50761ba521020859020
BLAKE2b-256 fbb11ca0c509e958e4ae45df35c7ded6aed7625f332d5abd75b1e9b2b8ccfddc

See more details on using hashes here.

Provenance

File details

Details for the file efel-5.7.4-cp310-cp310-win_amd64.whl.

File metadata

  • Download URL: efel-5.7.4-cp310-cp310-win_amd64.whl
  • Upload date:
  • Size: 221.4 kB
  • Tags: CPython 3.10, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for efel-5.7.4-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 22d79d82f6f1c2574e957aea1d72a96548ce12697cb1c016ce39e6b8426e9f56
MD5 b5fee8e50805bf635b3f419f7c7df40e
BLAKE2b-256 9af8b1970b26260bcabf48c52d13f356ee02af060d5f894cc4621aeef1128533

See more details on using hashes here.

Provenance

File details

Details for the file efel-5.7.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for efel-5.7.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 e2cd26d0b9276399052717462d98049dc5fc7f62240550ca76c1b7fa61541058
MD5 38b1b338f481db59372cd2b04e644e33
BLAKE2b-256 9ac9b3f1dca6864fd5ed4a7eafbb60b2f185d2d16d9bd4fb1b8e1771d16bc200

See more details on using hashes here.

Provenance

File details

Details for the file efel-5.7.4-cp310-cp310-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for efel-5.7.4-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 7a1357a3c3cbbfafad3f5e8831b8e0a0ba9289261494b62e471043d412fb914e
MD5 67ee691efd6b1faa5b29bfa46c657e96
BLAKE2b-256 51b2acf557c9acd72b5f7b6e55e93275ef7f3edff579deecfde18e574228a2fe

See more details on using hashes here.

Provenance

File details

Details for the file efel-5.7.4-cp39-cp39-win_amd64.whl.

File metadata

  • Download URL: efel-5.7.4-cp39-cp39-win_amd64.whl
  • Upload date:
  • Size: 221.4 kB
  • Tags: CPython 3.9, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for efel-5.7.4-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 0fbc2970a2cc5c8882b68979ab6636e495eb92c82856e43d52d51b3e42a97f10
MD5 e1893f058b6a56607e1491221d0c1367
BLAKE2b-256 2bbf910e9c6d1734b99145abd989f40b901e63a2d82ef8e10443f34639b4e82e

See more details on using hashes here.

Provenance

File details

Details for the file efel-5.7.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for efel-5.7.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 c9a9b45e3c89755a8b2f3597040d20404b2e898616600e0aa0df8e83c7b80e64
MD5 535c843e98327c79e5d9aff51c80614e
BLAKE2b-256 8a06a0a22ac72a40c1c7a2ba517c271dc6e29c71c059bd836fd936efa2c58a8a

See more details on using hashes here.

Provenance

File details

Details for the file efel-5.7.4-cp39-cp39-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for efel-5.7.4-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 df107e6694db8d70db946393d1af34df983bf4c97b7f6f6af109996b6ed45949
MD5 c3cb3d2c6b27826f8540321906b7c58a
BLAKE2b-256 b0c3488bd85cdbd3a529977875d02c4e091503e7f4a72a39040519854c78bf84

See more details on using hashes here.

Provenance

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