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()

Note that the extra-cellular features, the bpap_attenuation feature and the check_ais_initiation feature are not listed above because they have to be used in a special way, as described here for extra-cellular features, here for bpap_attenuation feature and here for check_ais_initiation feature.

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

This version

5.7.12

5.7.11

5.7.10

5.7.9

5.7.8

5.7.7

5.7.6

5.7.5

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.12.tar.gz (108.8 kB view details)

Uploaded Source

Built Distributions

efel-5.7.12-cp312-cp312-win_amd64.whl (223.1 kB view details)

Uploaded CPython 3.12 Windows x86-64

efel-5.7.12-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.12-cp312-cp312-macosx_10_13_x86_64.whl (274.5 kB view details)

Uploaded CPython 3.12 macOS 10.13+ x86-64

efel-5.7.12-cp311-cp311-win_amd64.whl (223.1 kB view details)

Uploaded CPython 3.11 Windows x86-64

efel-5.7.12-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.12-cp311-cp311-macosx_10_9_x86_64.whl (275.6 kB view details)

Uploaded CPython 3.11 macOS 10.9+ x86-64

efel-5.7.12-cp310-cp310-win_amd64.whl (223.1 kB view details)

Uploaded CPython 3.10 Windows x86-64

efel-5.7.12-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.12-cp310-cp310-macosx_10_9_x86_64.whl (275.6 kB view details)

Uploaded CPython 3.10 macOS 10.9+ x86-64

efel-5.7.12-cp39-cp39-win_amd64.whl (223.1 kB view details)

Uploaded CPython 3.9 Windows x86-64

efel-5.7.12-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.12-cp39-cp39-macosx_10_9_x86_64.whl (275.6 kB view details)

Uploaded CPython 3.9 macOS 10.9+ x86-64

File details

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

File metadata

  • Download URL: efel-5.7.12.tar.gz
  • Upload date:
  • Size: 108.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for efel-5.7.12.tar.gz
Algorithm Hash digest
SHA256 1321d2bd819ae5a89115493b00600676d471136fd143f5055ec4072fcf55dae2
MD5 1056af6f00525d6661b81d2c10947464
BLAKE2b-256 407a2460f39c050920c04543f89dababc3713035ac11a96e4333dddb66d09ed0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: efel-5.7.12-cp312-cp312-win_amd64.whl
  • Upload date:
  • Size: 223.1 kB
  • Tags: CPython 3.12, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for efel-5.7.12-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 5fe77f00b5f85fcac94c8d6394f0984549871d1ad6e9d0de5d4b07160e06f300
MD5 6e1c9005e04f2829f28cf16fcc8169c4
BLAKE2b-256 21ecab816f56e8c75a70d109f151ba5224dbe87398846a12f1a51f290d66d36c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for efel-5.7.12-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 ffe6f886890f3e5f1ef9d16e850627ba34ed83a29846c420c85b164f2b041c6a
MD5 5a7fb33a21b3613165bccd78e351a4b8
BLAKE2b-256 af4473be3dabd09456dddfcb0500bf1a4ade49cb52974617d88110ccb7e694ef

See more details on using hashes here.

File details

Details for the file efel-5.7.12-cp312-cp312-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for efel-5.7.12-cp312-cp312-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 bd95a4e319a6b2028f55849e966c6402c5158bbfcef39313bf46b9b3bae8d926
MD5 b8bb255b263ca6da406a4ed2d16aec08
BLAKE2b-256 c55b85cef2217bcc3eb864efb551e6fd2bfd040f6397ff71e7edf63d995442e9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: efel-5.7.12-cp311-cp311-win_amd64.whl
  • Upload date:
  • Size: 223.1 kB
  • Tags: CPython 3.11, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for efel-5.7.12-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 494387372ffeecbccec18974b2d180292515ff7857d3a3542a68962826dbfc27
MD5 cea2d1f4ee48ed05376a34db8793b4ea
BLAKE2b-256 cb634c2be0d23c85c585ce50a4bda024d8b98f8f7c7a54e5f965828a307c65ba

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for efel-5.7.12-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 b72f5abb140e066d96966011c76344853a2607bd9c095f95da835fdb04d44984
MD5 9628cd346b8de3108d9fa32ebcdf93f2
BLAKE2b-256 49d118b753ae21aaf1cac8a95adcf8ba8512c1f25f3783d14f454f063d4ae907

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for efel-5.7.12-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 ff620d328e810b1e1b5ea613fab40785b0a8631d297daf01b772b24babb04a11
MD5 cf11b02db774562aa7759e6304634a62
BLAKE2b-256 aa966c41fa5a194b46e049206730affbc25e016ec542cda269a519147ad7af34

See more details on using hashes here.

File details

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

File metadata

  • Download URL: efel-5.7.12-cp310-cp310-win_amd64.whl
  • Upload date:
  • Size: 223.1 kB
  • Tags: CPython 3.10, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for efel-5.7.12-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 265be2d15e3f9d9342c1d9aa09c4d2e8d504c4d5269f3852f7f63fbafe42ce71
MD5 38ada036cfd9d8b74b3a7d1d4f74743f
BLAKE2b-256 7099f9b250d44e1ff0ba56b2750e659dd718921ffa1114cd760fbe70bad1f85a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for efel-5.7.12-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 c63c09c364822627ef5121619ada2b667a1f99374f00cf1501b3d58ce54c0d5e
MD5 2396b8e93f9c18356a921eb515d57367
BLAKE2b-256 e6e21a11a70e8260918471eda06b74551ddb6d4ec76fc75862c5c025c7d645b3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for efel-5.7.12-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 9dc16d9732d1b7aa98e0b7a187d99e18fa018d62d2d821ff6caf017042480ca3
MD5 f5fbcd8b668b8650226d57d2d5594abd
BLAKE2b-256 f57a0f0bcc1d81cf6943ca7ea880ea6847462f6d0950035df82348fffca101df

See more details on using hashes here.

File details

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

File metadata

  • Download URL: efel-5.7.12-cp39-cp39-win_amd64.whl
  • Upload date:
  • Size: 223.1 kB
  • Tags: CPython 3.9, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for efel-5.7.12-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 0d689df0470437475d8d28dcf23743b2bbb67aa1bbcc42e0a783ca318279c77a
MD5 b9bf1f2721998b13b9aa5b401059c431
BLAKE2b-256 220ee0eeb1988e3ec0f0d4b3b2bb0ab59c54a0f61c1480bd0eb9d7efdfd8319c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for efel-5.7.12-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 6a4e5f9df5a35dbc63148f7710d9eb5cc7cfdaf21620678665d0d2f259cbec7f
MD5 aa4badcca9fab289e9893561d7a64c73
BLAKE2b-256 19d600ad9ed33054ce0284d187e2300267181ba34822c44f2273ef163efe24da

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for efel-5.7.12-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 c61f37dba2d883b9e4ace9e7d937155bd9e5609599c2039da08f6c65e9e451b6
MD5 7a59d796571c501aa38ff764a3f2b597
BLAKE2b-256 dceb693c8bd66818f48962700b121e2d04c89f9c35d8712f75296d215983db6a

See more details on using hashes here.

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