diff --git a/source/User-Manual/Plugins/Mean-Spike-Rate.rst b/source/User-Manual/Plugins/Mean-Spike-Rate.rst new file mode 100644 index 0000000..9672de8 --- /dev/null +++ b/source/User-Manual/Plugins/Mean-Spike-Rate.rst @@ -0,0 +1,40 @@ +.. _meanspikerate: +.. role:: raw-html-m2r(raw) + :format: html + +##################### +Mean Spike Rate +##################### + +.. image:: ../../_static/images/plugins/meanspikerate/meanspikerate.png + :alt: Annotated Mean Spike Rate editor + +.. csv-table:: Estimates the mean spike rate across time and channels. Uses an exponentially weighted moving average to estimate a temporal mean (with adjustable time constant), and averages the rate across selected spike channels (electrodes). Outputs the resulting rate onto a selected continuous channel (overwriting its contents). + :widths: 18, 80 + + "*Plugin Type*", "Filter" + "*Platforms*", "Windows, Mac, Linux" + "*Built in?*", "No" + "*Key Developers*", "Ethan Blackwood" + "*Source Code*", "https://github.com/open-ephys-plugins/mean-spike-rate" + +Installing and upgrading +########################### + +The Mean Spike Rate plugin is not included by default in the Open Ephys GUI. To install, use **ctrl-P** or **⌘P** to access the Plugin Installer, browse to the "Mean Spike Rate" plugin, and click the "Install" button. + +The Plugin Installer also allows you to upgrade to the latest version of this plugin, if it's already installed. + + +Plugin configuration +###################### + +The plugin editor allows the user to set the following parameters: + +- **Active Spike Channels:** The spike channels to include in the mean spike rate calculation. + +- **Inactive Spike Channels:** The spike channels to exclude from the mean spike rate calculation. + +- **Output:** The continuous channel to output the mean spike rate onto. The mean spike rate will overwrite the contents of this channel. + +- **Time Constant** (ms): The time constant of the exponentially weighted moving average used to estimate the mean spike rate. \ No newline at end of file diff --git a/source/User-Manual/Plugins/index.rst b/source/User-Manual/Plugins/index.rst index 0ed7a8a..89d841b 100644 --- a/source/User-Manual/Plugins/index.rst +++ b/source/User-Manual/Plugins/index.rst @@ -22,7 +22,7 @@ Officially supported Source plugins: :ref:`acquisitionboard`, :ref:`oefpgaacquis **Filters** alter the data in some way, either by modifying the continuous data or adding TTL events, broadcast messages, or spikes to the event buffer. -Officially supported Filter plugins: :ref:`bandpassfilter`, :ref:`channelmap`, :ref:`cnnripple`, :ref:`commonaveragereference`, :ref:`crossingdetector`, :ref:`matlabinterface`, :ref:`multibandintegrator`, :ref:`networkevents`, :ref:`neuropixelscar`, :ref:`oscevents`, :ref:`phasecalculator`, :ref:`phasedetector`, :ref:`rippledetector`, :ref:`spikedetector`, :ref:`spikesorter`, :ref:`trackingplugin`, :ref:`ttlpanels`, :ref:`virtualreference` +Officially supported Filter plugins: :ref:`bandpassfilter`, :ref:`channelmap`, :ref:`cnnripple`, :ref:`commonaveragereference`, :ref:`crossingdetector`, :ref:`matlabinterface`, :ref:`meanspikerate`, :ref:`multibandintegrator`, :ref:`networkevents`, :ref:`neuropixelscar`, :ref:`oscevents`, :ref:`phasecalculator`, :ref:`phasedetector`, :ref:`rippledetector`, :ref:`spikedetector`, :ref:`spikesorter`, :ref:`trackingplugin`, :ref:`ttlpanels`, :ref:`virtualreference` **Sinks** send data to an external source, such as a display, stimulator, etc., without altering the underlying data streams. Data should pass through Sinks unchanged. @@ -143,6 +143,7 @@ To remove a plugin, simply click the "Uninstall" button. This will delete the pl LFP-Viewer LSL-Inlet MATLAB-Interface + Mean-Spike-Rate Merger Multiband-Integrator Network-Events @@ -180,4 +181,4 @@ To remove a plugin, simply click the "Uninstall" button. This will delete the pl :format: html -.. _Open Ephys Plugins GitHub Account: https://github.com/open-ephys-plugins \ No newline at end of file +.. _Open Ephys Plugins GitHub Account: https://github.com/open-ephys-plugins diff --git a/source/_static/images/plugins/meanspikerate/meanspikerate.png b/source/_static/images/plugins/meanspikerate/meanspikerate.png new file mode 100644 index 0000000..2ab8df5 Binary files /dev/null and b/source/_static/images/plugins/meanspikerate/meanspikerate.png differ