spykingcircus_utils module

spykingcircus_utils.get_channel_groups_from_spykingcircus_probefile(probe_filepath)

Get the channel group from Spyking Circus probe file

Parameters:
probe_filepath : str

Path of the probe file

Returns:
chan_grp_list : list

Channel group list

spykingcircus_utils.get_templates_from_spykingcircus_file(spykingcircus_result_dirpath, filename, unit_pos, gain=4)

Get the templates (shapes) for a specific unit. Designed for tetrode recordings, this return the template of the unit on each wire of the tetrode. It requires the .basis.hdf5, .templates.hdf5 and the .clusters.hdf5 files from Spyking Circus.

Parameters:
spykingcircus_result_dirpath : str

Path where the Spyking-Circus files are stored

filename : str

Base name of the Spyking-Circus results, without the extension

unit_pos : int

Number of the unit

gain : float (default: 4)

Gain of the acquisition device - For Blackrock, set the gain to 4

Returns:
r_temp_i_tetrode : array

Unit’s template on each wire of the tetrode

spykingcircus_utils.get_unit_preferred_electrode(spykingcircus_dirpath, results_filename)

Get the preferred electrode for all units. Reads the clusters Spyking Circus file.

Parameters:
spykingcircus_dirpath : str

Path of the Spyking Circus results directory

results_filename : str
Returns:
pref_el : array

Preferred electrode for all units