Variable naming convention - JaneliaSciComp/JRCLUST GitHub Wiki
JRCLUST follows the variable naming convention below.
Function names that ends with "_" (e.g.
detect_spikes_()) refer to local functions which can be locally called by other functions residing in the same .m file. For more information on the types of functions, refer to the Matlab documentation.
Variable type
- Vector: "v"
- Matrix: "m"
- Tensor: "t"
- Cell: "c"
- Struct: "S"
Data types
- character: "c"
- integer: "n"
- index: "i" (equivalent to a pointer)
- real number: "r"
postfix
- _spk: spike-indexed variable. e.g. viTime_spk, vrAmp_spk, viSite_spk, ...
- _clu: cluster-indexed variable. e.g. viSite_clu, vnSpk_clu, ...
- _site: site-indexed variable. e.g. cviSpk_site, ...
Examples
- vector of indices of the spike times: viTime_spk
- vector of indices of the center sites for each cluster: viSite_clu