Metadata-Version: 1.2
Name: pyEDFlib
Version: 0.1.22
Summary: library to read/write EDF+/BDF+ files
Home-page: https://github.com/holgern/pyedflib
Author: Holger Nahrstaedt
Author-email: nahrstaedt@gmail.com
Maintainer: Holger Nahrstaedt
Maintainer-email: nahrstaedt@gmail.com
License: BSD
Description: pyEDFlib
        ========
        
        .. contents::
        
        .. image:: https://codecov.io/gh/holgern/pyedflib/branch/master/graph/badge.svg
          :target: https://codecov.io/gh/holgern/pyedflib
        
        .. image:: https://travis-ci.com/holgern/pyedflib.svg?branch=master
            :target: https://travis-ci.com/holgern/pyedflib
            
        .. image:: https://ci.appveyor.com/api/projects/status/49wwigslgtj288q1?svg=true
          :target: https://ci.appveyor.com/project/holger80/pyedflib
          
        .. image:: https://readthedocs.org/projects/pyedflib/badge/?version=latest
          :target: http://pyedflib.readthedocs.org/en/latest/?badge=latest
        
        .. image:: https://api.codacy.com/project/badge/Grade/a80bc8bdb6a342be83b9d03138bfd078    
            :target: https://www.codacy.com/app/holgern/pyedflib?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=holgern/pyedflib&amp;utm_campaign=Badge_Grade
        
        .. image:: https://anaconda.org/conda-forge/pyedflib/badges/installer/conda.svg   
            :target: https://conda.anaconda.org/conda-forge  
          
        .. image:: https://anaconda.org/conda-forge/pyedflib/badges/version.svg   
            :target: https://anaconda.org/conda-forge/pyedflib 
          
        .. image:: https://anaconda.org/conda-forge/pyedflib/badges/downloads.svg   
            :target: https://anaconda.org/conda-forge/pyedflib 
        
        What is pyEDFlib
        ----------------
        pyEDFlib is a python library to read/write EDF+/BDF+ files based on EDFlib.
        
        EDF means `European Data Format`_ and was firstly published `Kemp1992`_.
        In 2003, an improved version of the file protokoll named EDF+ has been published and can be found at `Kemp2003`_.
        
        The EDF/EDF+ format saves all data with 16 Bit. A version which saves all data with 24 Bit,
        was introduces by the compony `BioSemi`_.
        
        The definition of the EDF/EDF+/BDF/BDF+ format can be found under `edfplus.info`_.
        
        This python toolbox is a fork of the `toolbox from Christopher Lee-Messer`_
        and uses the `EDFlib`_ from Teunis van Beelen.
        The EDFlib is able to read and write EDF/EDF+/BDF/BDF+ files.
        
        Documentation
        -------------
        
        Documentation is available online at http://pyedflib.readthedocs.org.
        
        Installation
        ------------
        
        pyEDFlib can be used with `Python`_ >=3.5. It depends on the `Numpy`_ package.
        To use the newest source code from git, you have to download the source code.
        You need a C compiler and a recent version of `Cython`_. Go then to the source directory and type::
        
            python setup.py build
            python setup.py install
        
        There are binary wheels which can be installed by (use pip3 when available)::
        
            pip install pyEDFlib
        
        Users of the Anaconda_ Python distribution can directly obtain pre-built
        Windows, Intel Linux or macOS / OSX binaries from the conda-forge channel.
        This can be done via::
        
            conda install -c conda-forge pyedflib
        
        
        The most recent *development* version can be found on GitHub at
        https://github.com/holgern/pyedflib.
        
        The latest release, including source and binary packages for Linux,
        macOS and Windows, is available for download from the `Python Package Index`_.
        You can find source releases at the `Releases Page`_.
        
        
        Highlevel interface
        -------------------
        
        pyEDFlib includes an highlevel interface for easy access to read and write edf files.
        Additionally functionality as anonymizing, dropping or renaming channels can be found there.
        
        .. code-block:: Python
        
            from pyedflib import highlevel
        
            # write an edf file
            signals = np.random.rand(5, 256*300)*200 # 5 minutes of random signal
            channel_names = ['ch1', 'ch2', 'ch3', 'ch4', 'ch5']
            signal_headers = highlevel.make_signal_headers(channel_names, sample_rate=256)
            header = highlevel.make_header(patientname='patient_x', gender='Female')
            highlevel.write_edf('edf_file.edf', signals, signal_headers, header)
        	    
            # read an edf file
            signals, signal_headers, header = highlevel.read_edf('edf_file.edf')
            print(signal_headers[0]['sample_rate']) # prints 256
        
            # drop a channel from the file or anonymize edf
            highlevel.drop_channels('edf_file.edf', to_drop=['ch2', 'ch4'])
            highlevel.anonymize_edf('edf_file.edf', new_file='anonymized.edf'
        	                         to_remove=['patientname', 'birthdate'],
        	                         new_values=['anonymized', ''])
            # check if the two files have the same content
            highlevel.compare_edf('edf_file.edf', 'anonymized.edf')
            # change polarity of certain channels 
            highlevel.change_polarity('file.edf', channels=[1,3])
            # rename channels within a file
            highlevel.rename_channels('file.edf', mapping={'C3-M1':'C3'})
        
        
        License
        -------
        
        pyEDFlib is a free Open Source software released under the BSD 2-clause license.
        
          
        Releases can be cited via Zenodo.
        
        .. image:: https://zenodo.org/badge/42585968.svg
           :target: https://zenodo.org/badge/latestdoi/42585968
          
        .. _Cython: http://cython.org/
        .. _Anaconda: https://www.continuum.io
        .. _GitHub: https://github.com/holgern/pyedflib
        .. _GitHub Issues: https://github.com/holgern/pyedflib/issues
        .. _Numpy: http://www.numpy.org
        .. _Python: http://python.org/
        .. _Python Package Index: http://pypi.python.org/pypi/pyEDFlib/
        .. _Releases Page: https://github.com/holgern/pyedflib/releases
        .. _edfplus.info: http://www.edfplus.info/
        .. _European Data Format: http://www.edfplus.info/
        .. _Kemp2003: https://www.ncbi.nlm.nih.gov/pubmed/12948806?dopt=Citation
        .. _Kemp1992: https://www.ncbi.nlm.nih.gov/pubmed/1374708?dopt=Abstract
        .. _BioSemi: http://www.biosemi.com/faq/file_format.htm
        .. _toolbox from Christopher Lee-Messer: https://bitbucket.org/cleemesser/python-edf/
        .. _EDFlib: http://www.teuniz.net/edflib/
Keywords: EDFlib,European data format,EDF,BDF,EDF+,BDF+
Platform: Windows
Platform: Linux
Platform: Solaris
Platform: Mac OS-X
Platform: Unix
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: C
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries :: Python Modules
