Metadata-Version: 1.1
Name: fir
Version: 0.0.dev2
Summary: Finite Impulse Response package for time series analysis.
Home-page: http://tknapen.github.io/FIRDeconvolution
Author: Tomas Knapen
Author-email: tknapen@gmail.com
License: The MIT License (MIT)
Download-URL: https://github.com/tknapen/FIRDeconvolution
Description: # FIRDeconvolution
        FIRDeconvolution is a python class that performs finite impulse response fitting on time series data, in order to estimate event-related signals. 
        
        
        Example use cases are fMRI and pupil size analysis. The package performs the linear least squares analysis using numpy.linalg as a backend, but can switch between different backends, such as statsmodels (which is implemented). For very collinear design matrices ridge regression is implemented through the sklearn RidgeCV function. Bootstrap estimates of error regions are implemented through residual reshuffling. 
        
        
        It is possible to add covariates to the events to estimate not just the impulse response function, but also correlation timecourses with secondary variables. Furthermore, one can add the duration each event should have in the designmatrix, for designs in which the durations of the events vary. 
        
        
        In neuroscience, the inspection of the event-related signals such as those estimated by FIRDeconvolution is essential for a thorough understanding of one's data. Researchers may overlook essential patterns in their data when blindly running GLM analyses without looking at the impulse response shapes. 
        
        
        The test notebook explains how the package can be used for data analysis, by creating toy signals and then using FIRDeconvolution to fit the impulse response functions from the toy data. 
        
        
        ## Dependencies
        numpy, scipy, matplotlib, statsmodels, sklearn
        
        TODO
        - temporal autocorrelation correction
        
        
        
        
        
        
        
        
        
        
Platform: any
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
