spykeutils-0.4.1/ 0000755 0001750 0001750 00000000000 12262547774 012076 5 ustar rob rob spykeutils-0.4.1/CHANGELOG.rst 0000644 0001750 0001750 00000004023 12262547774 014116 0 ustar rob rob Version 0.4.1
-------------
* Faster caching for Neo lazy loading.
* Faster correlogram calculation.
Version 0.4.0
-------------
* Correlogram plot supports new square plot matrix mode and count per second
in addition to per segment.
* New options in spike waveform plot.
* DataProvider objects support transparent lazy loading for compatible IOs
(currently only Hdf5IO).
* DataProvider can be forced to use a certain IO instead of automatically
determining it by file extension.
* Load parameters for IOs can be specified in DataProvider.
* IO class, IO parameters and IO plugins are saved in selections and properly
used in startplugin.py
* Qt implementation of ProgressBar available in plot.helper (moved from
Spyke Viewer).
* Loading support for IO plugins (moved from Spyke Viewer).
Version 0.3.0
-------------
* Added implementations for various spike train metrics.
* Added generation functions for poisson spike trains
* Added tools module with various utility functions, e.g. binning
spike trains or removing objects from Neo hierarchies.
* Added explained variance function to spike sorting quality assessment.
* Improved legends for plots involving colored lines.
* Plots now have a minimum size and scroll bars appear if the plots would
become too small.
* Renamed plot.ISI to plot.isi for consistency
Version 0.2.1
-------------
* Added "Home" and "Pan" tools for plots (useful when no middle mouse button
is available).
* Changed default grid in plots to show only major grid.
* Added a method to DataProvider for refreshing views after object hierarchy
changed.
* New parameter for DataProvider AnalogSignal methods: AnalogSignalArrays can
be automatically converted and returned.
* Significantly improved speed of spike density estimation and optimal kernel
size calculation.
* Spike sorting quality assessment using gaussian clusters is now possible
without prewhitening spikes or providing prewhitened means.
* Renamed "spyke-plugin" script to "spykeplugin"
Version 0.2.0
-------------
Initial documented public release.
spykeutils-0.4.1/README.rst 0000644 0001750 0001750 00000001404 12262547774 013564 0 ustar rob rob Overview
========
.. image:: https://secure.travis-ci.org/rproepp/spykeutils.png?branch=develop
:target: https://travis-ci.org/rproepp/spykeutils
Based on the `Neo `_ framework, spykeutils
is a Python library for analyzing and plotting data from neurophysiological
recordings. It can be used by itself or in conjunction with Spyke Viewer,
a multi-platform GUI application for navigating electrophysiological datasets.
For more information, see the documentation at
http://spykeutils.readthedocs.org
spykeutils was created by Robert Pröpper at the Neural Information
Processing Group (TU Berlin), supported by the Research Training Group
GRK 1589/1.
Dependencies
============
* Python 2.7
* scipy
* neo
* Optional: guiqwt for plots spykeutils-0.4.1/LICENSE 0000644 0001750 0001750 00000002735 12262547774 013112 0 ustar rob rob Copyright (c) 2012, Robert Pröpper and conbtributors.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the author nor the names of the contributors may be
used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. spykeutils-0.4.1/doc/ 0000755 0001750 0001750 00000000000 12262547774 012643 5 ustar rob rob spykeutils-0.4.1/doc/source/ 0000755 0001750 0001750 00000000000 12262547774 014143 5 ustar rob rob spykeutils-0.4.1/doc/source/requirements.txt 0000644 0001750 0001750 00000000023 12262547774 017422 0 ustar rob rob quantities
neo
mock spykeutils-0.4.1/doc/source/changelog.rst 0000644 0001750 0001750 00000000065 12262547774 016625 0 ustar rob rob Changelog
=========
.. include:: ../../CHANGELOG.rst spykeutils-0.4.1/doc/source/index.rst 0000644 0001750 0001750 00000001331 12262547774 016002 0 ustar rob rob Welcome to the documentation of spykeutils!
===========================================
Based on the `Neo `_ framework,
spykeutils is a Python library for analyzing and plotting neurophysiological
data. It can be used by itself or in conjunction with
`Spyke Viewer `_, a
multi-platform GUI application for navigating electrophysiological datasets.
A mailinglist for discussion and support is available at
https://groups.google.com/d/forum/spyke-viewer
Contents:
.. toctree::
:maxdepth: 2
intro
examples
apidoc/spykeutils
changelog
acknowledgements
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
spykeutils-0.4.1/doc/source/conf.py 0000644 0001750 0001750 00000022077 12262547774 015452 0 ustar rob rob # -*- coding: utf-8 -*-
#
# spykeutils documentation build configuration file, created by
# sphinx-quickstart on Mon Jul 30 16:54:09 2012.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath(
os.path.join(os.pardir, os.pardir)))
# -- Mocking modules for Read the Docs compatibility ---------------------------
try:
import neo
import scipy
import PyQt4
import guiqwt
except ImportError:
from mock import MagicMock
MOCK_MODULES = ['tables', 'guiqwt', 'guiqwt.builder',
'guiqwt.baseplot', 'guiqwt.plot', 'guiqwt.curve',
'guiqwt.image', 'guiqwt.tools', 'guiqwt.signals',
'guiqwt.config', 'guiqwt.events', 'guiqwt.shapes',
'PyQt4', 'PyQt4.QtCore', 'PyQt4.QtGui',
'guidata', 'guidata.configtools', 'guidata.qthelpers']
for mod_name in MOCK_MODULES:
sys.modules[mod_name] = MagicMock()
# Needed for spykeutils.plot.Dialog.PlotDialog
class QDialog:
pass
class PlotManager:
pass
sys.modules['PyQt4.QtGui'].QDialog = QDialog
sys.modules['guiqwt.plot'].PlotManager = PlotManager
# Needed for spykeutils.plot.guiqwt_tools
class CommandTool:
pass
class InteractiveTool:
pass
sys.modules['guiqwt.tools'].CommandTool = CommandTool
sys.modules['guiqwt.tools'].InteractiveTool = InteractiveTool
import spykeutils
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
'sphinx.ext.intersphinx', 'sphinx.ext.coverage',
'sphinx.ext.pngmath', 'sphinx.ext.pngmath',
'sphinx.ext.ifconfig', 'sphinx.ext.viewcode']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'spykeutils'
copyright = u'2012, Robert Pröpper'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = spykeutils.__version__.rsplit('.', 1)[0]
# The full version, including alpha/beta/rc tags.
release = spykeutils.__version__
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
add_module_names = False
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# " v documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon = 'icon.ico'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'spykeutilsdoc'
# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'spykeutils.tex', u'spykeutils Documentation',
u'Robert Pröpper', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Add additional features ---------------------------------------------------
def setup(app):
app.add_javascript('copybutton.js')
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'spykeutils', u'spykeutils Documentation',
[u'Robert Pröpper'], 1)
]
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'python': ('http://docs.python.org/', None),
'neo': ('http://neo.readthedocs.org/en/latest/', None),
'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None),
'quantities': ('http://packages.python.org/quantities/', None),
'guiqwt': ('http://packages.python.org/guiqwt/', None),
'guidata': ('http://packages.python.org/guidata/', None),
'sklearn': ('http://scikit-learn.org/stable/', None)}
spykeutils-0.4.1/doc/source/acknowledgements.rst 0000644 0001750 0001750 00000000516 12262547774 020231 0 ustar rob rob Acknowledgements
================
spykeutils was created by Robert Pröpper [1]_, supported by the Research
Training Group GRK 1589/1. Jan Gosmann [2]_ contributed and tested the
spike train metric implementations.
.. [1] Neural Information Processing Group, TU Berlin
.. [2] Bernstein Center for Computational Neuroscience, Berlin
spykeutils-0.4.1/doc/source/static/ 0000755 0001750 0001750 00000000000 12262547774 015432 5 ustar rob rob spykeutils-0.4.1/doc/source/static/copybutton.js 0000644 0001750 0001750 00000004631 12262547774 020202 0 ustar rob rob $(document).ready(function() {
/* Add a [>>>] button on the top-right corner of code samples to hide
* the >>> and ... prompts and the output and thus make the code
* copyable. */
var div = $('.highlight-python .highlight,' +
'.highlight-python3 .highlight')
var pre = div.find('pre');
// get the styles from the current theme
pre.parent().parent().css('position', 'relative');
var hide_text = 'Hide the prompts and output';
var show_text = 'Show the prompts and output';
var border_width = pre.css('border-top-width');
var border_style = pre.css('border-top-style');
var border_color = pre.css('border-top-color');
var button_styles = {
'cursor':'pointer', 'position': 'absolute', 'top': '0', 'right': '0',
'border-color': border_color, 'border-style': border_style,
'border-width': border_width, 'color': border_color, 'text-size': '75%',
'font-family': 'monospace', 'padding-left': '0.2em', 'padding-right': '0.2em'
}
// create and add the button to all the code blocks that contain >>>
div.each(function(index) {
var jthis = $(this);
if (jthis.find('.gp').length > 0) {
var button = $('>>>');
button.css(button_styles)
button.attr('title', hide_text);
jthis.prepend(button);
}
// tracebacks (.gt) contain bare text elements that need to be
// wrapped in a span to work with .nextUntil() (see later)
jthis.find('pre:has(.gt)').contents().filter(function() {
return ((this.nodeType == 3) && (this.data.trim().length > 0));
}).wrap('');
});
// define the behavior of the button when it's clicked
$('.copybutton').toggle(
function() {
var button = $(this);
button.parent().find('.go, .gp, .gt').hide();
button.next('pre').find('.gt').nextUntil('.gp, .go').css('visibility', 'hidden');
button.css('text-decoration', 'line-through');
button.attr('title', show_text);
},
function() {
var button = $(this);
button.parent().find('.go, .gp, .gt').show();
button.next('pre').find('.gt').nextUntil('.gp, .go').css('visibility', 'visible');
button.css('text-decoration', 'none');
button.attr('title', hide_text);
});
});
spykeutils-0.4.1/doc/source/static/icon.ico 0000644 0001750 0001750 00000012466 12262547774 017067 0 ustar rob rob h &