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

This version

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

Uploaded Source

Built Distributions

efel-5.7.11-cp312-cp312-win_amd64.whl (223.0 kB view details)

Uploaded CPython 3.12 Windows x86-64

efel-5.7.11-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.11-cp312-cp312-macosx_10_13_x86_64.whl (274.4 kB view details)

Uploaded CPython 3.12 macOS 10.13+ x86-64

efel-5.7.11-cp311-cp311-win_amd64.whl (223.0 kB view details)

Uploaded CPython 3.11 Windows x86-64

efel-5.7.11-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.11-cp311-cp311-macosx_10_9_x86_64.whl (275.4 kB view details)

Uploaded CPython 3.11 macOS 10.9+ x86-64

efel-5.7.11-cp310-cp310-win_amd64.whl (223.0 kB view details)

Uploaded CPython 3.10 Windows x86-64

efel-5.7.11-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.11-cp310-cp310-macosx_10_9_x86_64.whl (275.4 kB view details)

Uploaded CPython 3.10 macOS 10.9+ x86-64

efel-5.7.11-cp39-cp39-win_amd64.whl (223.0 kB view details)

Uploaded CPython 3.9 Windows x86-64

efel-5.7.11-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.11-cp39-cp39-macosx_10_9_x86_64.whl (275.4 kB view details)

Uploaded CPython 3.9 macOS 10.9+ x86-64

File details

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

File metadata

  • Download URL: efel-5.7.11.tar.gz
  • Upload date:
  • Size: 108.5 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.11.tar.gz
Algorithm Hash digest
SHA256 6ff3b4681fb0d27f24ee782484434581894f6a1de920c021698ad78bc5caa5da
MD5 ccca915a75e435eb9af7523dbf04d0e6
BLAKE2b-256 97fef9d0f03b81951c38ed77c9c11e791a666b757fa435e2e84652a91b929c07

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: efel-5.7.11-cp312-cp312-win_amd64.whl
  • Upload date:
  • Size: 223.0 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.11-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 3a051b6018c2d612b9796960723c3bf911488d688cb50d753da6e7d405e6e2a6
MD5 d4a95b64e311c912964fed1198ee028f
BLAKE2b-256 26df5c483708e2dc5e0dea70483312aa46307b862e3038f48e25dac3f0433e4f

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for efel-5.7.11-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 59a3437d12d7cc5ec7d8008e6d62e1e63e37fb6d476ba4129518155042286690
MD5 c3169642676c9d09fd0edc0daff782ab
BLAKE2b-256 0e157ccecedd2e2a576b5cf7279a0e6819030c82691fb1599795eb610c8b7202

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for efel-5.7.11-cp312-cp312-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 3d349582c8a0896379664a2e292afc82ec88ab9953f674d343282ef4643e7906
MD5 44e2e8c829965baec29f73fcf0eb6ced
BLAKE2b-256 3b1e15b7f1a6ffe90739e290d44aa63b4697221c4ee8690eb7c04482737fd9a5

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: efel-5.7.11-cp311-cp311-win_amd64.whl
  • Upload date:
  • Size: 223.0 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.11-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 2dbde46f3fed956e8e52cccbd4e2047d41b06235438dd6aaba21bec2a2c2845a
MD5 2627f69f5238254f2df5626dffe02c10
BLAKE2b-256 30457c0dcf418524624f18ff6a5aca1fa49ec32e13784afb11a5773cfbe35bc5

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for efel-5.7.11-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 74b5a4028fc50f769381b6fc0d4f4149249106e5fe2819d433d35342e0dac9de
MD5 b525f1d87ef99bc239c8f304b7f515c2
BLAKE2b-256 b53860b7e38d8d2e3ff8a8ec5dae48b256fd78add4086f842d19927bb865f1cf

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for efel-5.7.11-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 d1a6e186c052004039c5a5145cb76f087b656076ebec511ede64f0467f7ec4cd
MD5 f245a61e463178d87d76859d59f38892
BLAKE2b-256 a66ec8b444f7118b9851f2a0b2d230960fe697286222673de97b284837e7c710

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: efel-5.7.11-cp310-cp310-win_amd64.whl
  • Upload date:
  • Size: 223.0 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.11-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 4eb91021430ba88c7e36a20fc268dc9b13db9a5076c6b1d86ad1aded44ee705b
MD5 fff11ce53adf25cd56feb90756aa46e7
BLAKE2b-256 32d7b78a9122854c51f3c3ae3deaeb813b3505bab0db158b196acab061f38fa8

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for efel-5.7.11-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 1ff45cd921a9be9100640c9214705d4764ed3d95db9ffc0eb79a958334b8827b
MD5 2810d62c80028f676f06f332747adb78
BLAKE2b-256 a4d920d8d1be8f074c20976fcc38ac696482650bdcc737927b982c120f157674

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for efel-5.7.11-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 fe8630e0b6d43644ff0ac92d89cd79c5d941647b1d6f8f6f6938fc41da00ba48
MD5 c63ac36b8df7b37ee62740bb41cec55a
BLAKE2b-256 c42ed48a91727d9a7311f70277a4d44940134ca28668f78b05171b6b49fe2ad4

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: efel-5.7.11-cp39-cp39-win_amd64.whl
  • Upload date:
  • Size: 223.0 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.11-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 f268c405f3391d18b169c94f9401d722e33b331c80ec83c78d0864b37dd0a617
MD5 132c974e1e9c2538004ccbfa5e57d1a5
BLAKE2b-256 c755d2f80f9e998dfa25665906c06f555acfa407e9563aab2250ff698b4f69c9

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for efel-5.7.11-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 cfdd484fe0548b237a01a055e5d4cc2aa816723df776d2b53c707bb1ce809b5d
MD5 5d789f52dc91bb2eed6bfb014bab36f0
BLAKE2b-256 54716d8902c68c5d9b43e5fef608bbadb5496b9a6ac27dc7f88ec9d1e3a6003b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for efel-5.7.11-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 6b33284b32cd795f2fdd97bfa8d7fe3aa6547331508953926775d287f0f7bc6e
MD5 4aa948934e4245f586731032c776b3c3
BLAKE2b-256 733bd83472c316fe78fdc60d328bb0059864918d1375d50b7d11bd36dcafc56d

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