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.

Citation

When you use this eFEL software for your research, we ask you to cite the following publications (this includes poster presentations):

    @article{efel,
        title={eFEL},
        DOI={10.5281/zenodo.593869},
        url={https://doi.org/10.5281/zenodo.593869}
        abstractNote={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.},
        publisher={Zenodo},
        author={Ranjan, Rajnish and
                Van Geit, Werner and
                Moor, Ruben and
                Rössert, Christian and
                Riquelme, Juan Luis and
                Damart, Tanguy and
                Jaquier, Aurélien and
                Tuncel, Anil},
        year={2023},
        month={Jul}
    }

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

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]

    # 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

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

This version

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

Uploaded Source

Built Distributions

efel-5.6.18-cp312-cp312-win_amd64.whl (211.4 kB view details)

Uploaded CPython 3.12 Windows x86-64

efel-5.6.18-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.7 MB view details)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64

efel-5.6.18-cp312-cp312-macosx_10_9_x86_64.whl (263.6 kB view details)

Uploaded CPython 3.12 macOS 10.9+ x86-64

efel-5.6.18-cp311-cp311-win_amd64.whl (211.4 kB view details)

Uploaded CPython 3.11 Windows x86-64

efel-5.6.18-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.7 MB view details)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

efel-5.6.18-cp311-cp311-macosx_10_9_x86_64.whl (263.6 kB view details)

Uploaded CPython 3.11 macOS 10.9+ x86-64

efel-5.6.18-cp310-cp310-win_amd64.whl (211.4 kB view details)

Uploaded CPython 3.10 Windows x86-64

efel-5.6.18-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.7 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

efel-5.6.18-cp310-cp310-macosx_10_9_x86_64.whl (263.6 kB view details)

Uploaded CPython 3.10 macOS 10.9+ x86-64

efel-5.6.18-cp39-cp39-win_amd64.whl (211.4 kB view details)

Uploaded CPython 3.9 Windows x86-64

efel-5.6.18-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.7 MB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

efel-5.6.18-cp39-cp39-macosx_10_9_x86_64.whl (263.6 kB view details)

Uploaded CPython 3.9 macOS 10.9+ x86-64

File details

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

File metadata

  • Download URL: efel-5.6.18.tar.gz
  • Upload date:
  • Size: 102.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for efel-5.6.18.tar.gz
Algorithm Hash digest
SHA256 993f9361472116fff66e42c86e800c50c98ccbd463b2aa528ae078b325965751
MD5 62209b607fd0ce884ca484b0adb54cd2
BLAKE2b-256 84162cfb189da82d71d6b608874fa8ca0baa104e2dd489316414685066b5d3ea

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: efel-5.6.18-cp312-cp312-win_amd64.whl
  • Upload date:
  • Size: 211.4 kB
  • Tags: CPython 3.12, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for efel-5.6.18-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 abf04178362cd9aa1f59073aaa217cc7a64b0eafff34119006173eb178d1cfdd
MD5 a2aeacbc96d7967201d59bfd0e4cc06e
BLAKE2b-256 b795aef4a8dded8f7c97e12d38c1d56f259b571a8faa61c4028071eebf184fde

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for efel-5.6.18-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 11bcc65c3efcd1159b45ba1544a2f1a3cef65cb12490c3524614e8f571ce61b8
MD5 51801141ed723472997b16a6340a5ac6
BLAKE2b-256 300847cafb1cdfd6cfc2de8bcf57dbaa224a6015adaf05d09d9b9b8595e84c0b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for efel-5.6.18-cp312-cp312-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 3557d21ccad1acc6171a95e599586f56c043eb2b331e4d5fd05be7773ce3b9f4
MD5 e69b21c7bd1d6785b1aa9d8f2db4762e
BLAKE2b-256 ed889954b6f0c80b0be87859ef1b498349aecc9a49c343f2749c13bd56901fa4

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: efel-5.6.18-cp311-cp311-win_amd64.whl
  • Upload date:
  • Size: 211.4 kB
  • Tags: CPython 3.11, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for efel-5.6.18-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 24b5646622a4ed18391fff500b885c5b76f2895170a7ed80ab9edf2e33606500
MD5 00e369c1311d4e897b8e27c9d4dfc5ac
BLAKE2b-256 1e54c5cb5efa8122c406fb84c91f9284746be76fc8749091cfc93b18a731b830

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for efel-5.6.18-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 7da2878e7008fa2f88e33edbf6aabc9e80acef197551150dfd5a768330fe759f
MD5 2493b15f2843297482dea2e1965879b3
BLAKE2b-256 ee719d50e68f4793201489d161df585aa29ac9d28d9b8544d4ca6fe588ba98d0

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for efel-5.6.18-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 b40f44f57db801eb62e3ec0b0b8974ea2bf3a1b30add0cb5d3d2a58264ed9ed2
MD5 b078a5dfefcb6829a1c072e2a01b4c76
BLAKE2b-256 9457e27ff0c305f22d3d9a975c3d3ffb26ee294ad05f599dd22fc41f009bac56

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: efel-5.6.18-cp310-cp310-win_amd64.whl
  • Upload date:
  • Size: 211.4 kB
  • Tags: CPython 3.10, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for efel-5.6.18-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 fad601ae9bff8fe23d040173e386ed9ce3c3ce55cf0936152b89ca984cd2ebb6
MD5 24398947b4a2c5912dfab59f5194e9e0
BLAKE2b-256 f9499c86f83bbbdedda496a4e8f990147fe2646dc4708da671c0f11e09b8ddf6

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for efel-5.6.18-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 2be61731809b5525cd2766caeec1bcb0d09def38adc14774723504e49a7299d2
MD5 59be0bd8f4159e2ac4f39d920ea66e19
BLAKE2b-256 a59a22a6b73fbfe40ba1cb4f7934fb42a2c3b02adcdf04dd9f693f46e8b993f9

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for efel-5.6.18-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 feb307bdfe5c4b05f48c6a548517df3db88c67a3a71801a53ab9f7c143ad3437
MD5 70b0a3ef68771277a48369956211d9f9
BLAKE2b-256 925c5a183b11823dab501e135ae327554dec34f510085e9434af7bf723daf5e4

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: efel-5.6.18-cp39-cp39-win_amd64.whl
  • Upload date:
  • Size: 211.4 kB
  • Tags: CPython 3.9, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for efel-5.6.18-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 0d328a6f88a97a1888d79ff43fd71498767044971ca8ffa0974b6e2d6ea0a5d7
MD5 a14889e2a5af3831ccdc5504e4e86c13
BLAKE2b-256 070eb77e76a1b5af234768fe49650837b3ef717f0595921179370aec4ff18d0a

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for efel-5.6.18-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 25e8eaa2e606e71a86bcbc01dbeb8e951ab2e1d7bd310e334e9a95e3fb82d031
MD5 50f71c89e3952f524d1e33f985bd35bf
BLAKE2b-256 16b2152f62c1590c452a82b635a7885f7924ae5879af48e091a8702f5624c75b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for efel-5.6.18-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 2e02f9589c79cbfa28a32becc77a42c4f8680fa07519409d07ddb9bb18428c4f
MD5 d7908ab9455a3c73fa53636926be1d76
BLAKE2b-256 e5a22002f6b412858e688680a8253665e8a52802667fdc854c8f8b2c7b5c8443

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