Giter Club home page Giter Club logo

kilosortwrapper's Introduction

KilosortWrapper

Allows you to load Kilosort from a .xml and a .dat file compatible with Neurosuite.

Installation

Download and add the KilosortWrapper directory to your Matlab path. Also add subdirectories chanMaps and ConfigurationFiles to your Matlab path.

Settings

Most settings are defined in the KilosortConfiguration.m file. Some general settings are defined in the KilosortWrapper file, including:

  • basepath: Raw data folder
  • basename: Basename of the raw data folder (e.g., continuous in OpenEphys)
  • GPU_id
  • procPath: Path to the intermediate processing folder (expected to be located on SSD)
  • createSubdirectory: Allows you to save the output files from Kilosort to a sub directory (labeled by data and time)
  • performAutoCluster: Allows you to perform autoclustering of the Kilosort autput (currently put on hold)
  • config: You can supply a config version input to use another config file (configuration files should be stored in the ConfigurationFiles folder)
  • acqBoard: Differentiate between acquisition boards (currently supports only OpenEphys)
  • probe: Differentiate between Neuropixels and other probes

Features

Skip channels: To skip dead channels, synchronize the anatomical groups and the spike groups in Neuroscope and remove the dead channels in the spike groups. The synchronization is necessary for maintaining the correct waveform layout in Phy.

Define probe layouts: The wrapper now supports probes with staggered, poly3 and poly5 probe layouts. Open your xml file and define your probe layout in the Notes field (General information). Kilosort assumes a staggered probe layout without any input.

CreateSubdirectory: Allows you to save the output files from Kilosort to a sub directory (labeled by data and time).

Outputs

The Kilosort wrapper allows you to save the output in Neurosuite and Phy compatible files.

Phy

Neurosuite (Kilosort2Neurosuite)

Creates all classical files used in the Neurosuite format. For this the dat file is filtered, waveforms are extracted and global PCA features are calculated.

Please use below DOI for citing the KiloSortWrapper

DOI

Cite as

Peter C. Petersen, Brendon Watson, & Adrien Peyrache. (2020, January 10). petersenpeter/KilosortWrapper: KiloSortWrapper (Version 1.0). Zenodo. http://doi.org/10.5281/zenodo.3604165

Note that the DOI above links to the old version. This repository contains the new version that runs Kilosort 2.5 and 3. It has been adapted to run Kilosort 2.5 and 3 by Martynas Dervinis ([email protected])

kilosortwrapper's People

Contributors

apeyrache avatar brendonw1 avatar dervinism avatar petersenpeter avatar

Watchers

 avatar

Forkers

petersen-lab

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.