wiki

**This is an old revision of the document!** ----

====== Overview of common functions ====== ===== Utility functions ===== ==== Utility functions common to multiple data types ==== * restrict(): restricts times in data object (iv, ts, tsd) to specific intervals ==== Utility functions associated with specific data types ==== === interval (iv) === Basics: * iv(): constructor * CheckIV(): check integrity of iv struct * SelectIV(): specify intervals to keep Simple operations: * ResizeIV(): expand or contract intervals by specified amount * InvertIV(): "flips" included intervals to non-included, and vice versa * MergeIV(): merge touching, overlapping, or nearby intervals within an iv struct Set operations: * UnionIV(): set union of iv objects * IntersectIV(): set intersect, keep only those iv1's that include a piece of iv2 * DifferenceIV(): set difference, keep only those iv1's that DO NOT include a piece of iv2 Analysis operations: * TSDtoIV(): create interval data from tsd by tresholding * MultiRaster(): see below Visualization: * PlotTSDfromIV(): display intervals defined relative to tsd === timestamps (ts) === [[https://github.com/vandermeerlab/vandermeerlab/tree/master/code-matlab/shared/datatypes/ts|ts folder on GitHub]] Basics: * [[https://github.com/vandermeerlab/vandermeerlab/blob/master/code-matlab/shared/datatypes/ts/ts.m|ts()]] constructor * CheckTS(): check integrity of ts struct * SelectTS(): specify ts data to keep. (Also performs reordering) * concatenateTS(): concatenate two ts objects Analysis operations: * getSpikeCount(): returns spike counts (number of spikes) in a nCells x 1 vector of ts input * ShuffleTS(): shuffle spikes in ts struct Visualization: * MultiRaster(): see below === timestamped data (tsd) === [[https://github.com/vandermeerlab/vandermeerlab/tree/master/code-matlab/shared/datatypes/tsd|tsd folder on GitHub]] Basics and selection: * tsd(): constructor * [[https://github.com/vandermeerlab/vandermeerlab/blob/master/code-matlab/shared/datatypes/tsd/CheckTSD.m|CheckTSD()]]: check integrity of tsd struct * getd(): get (raw) data with specified label * [[https://github.com/vandermeerlab/vandermeerlab/blob/master/code-matlab/shared/datatypes/tsd/TSD_SelectChannel.m|TSD_SelectChannel()]]: returns tsd containing only channels with labels in channel_label Merging: * [[https://github.com/vandermeerlab/vandermeerlab/blob/master/code-matlab/shared/datatypes/tsd/MergeTSD.m|MergeTSD()]]: Merge data from multiple TSDs into a single, new TSD * [[https://github.com/vandermeerlab/vandermeerlab/blob/master/code-matlab/shared/datatypes/tsd/UnionTSD.m|UnionTSD()]]: returns the union (merge) of two TSD inputs Analysis: * [[https://github.com/vandermeerlab/vandermeerlab/blob/master/code-matlab/shared/datatypes/tsd/TSD_getidx2.m|TSD_getidx2()]]: returns idxs into ts or tsd, delimited by input interval(s) * [[https://github.com/vandermeerlab/vandermeerlab/blob/master/code-matlab/shared/datatypes/tsd/TSDbyZ.m | TSDbyZ()]]: compute averages of the values in tsd_in binned by z's cfg.edge * [[https://github.com/vandermeerlab/vandermeerlab/blob/master/code-matlab/shared/datatypes/tsd/TSDbySpace.m |TSDbySpace()]]: construct 2D matrix with spatial averages of the values in tsd_in === tuning curve (tc) === ==== Low-level utility functions ==== * nearest_idx3(): ===== Visualization functions ===== * the amazing MultiRaster ([[https://github.com/vandermeerlab/vandermeerlab/blob/master/code-matlab/example_workflows/MultiRaster_usage.m|examples]]) ===== Loading/converting functions ===== ===== Analysis functions =====