Loader class for rBCBG results (in respective files)

class analyseur.rbcbg.loader.CommonLoader(full_filepath=' ')

This is the parent class for LoadRates

• Instantiated with the full file path

  • sets atrributes: full_filepath, filename

• Contains instance method get_region_name()

---

get_region_name(nucleus)

Returns region name for respective nucleus name for which the firing rates are in the file.

Nuclei	Region name
[“CSN”, “PTN”, “CTX_E”, “CTX_I”]	“cortex”
[“FSI”, “STN”, “GPe”, “GPiSNr”]	“bg”
[“TRN”, “TH”]	“thalamus”

---

class analyseur.rbcbg.loader.LoadRates(full_filepath=' ')

Loads the csv file containing firing rates for all the neurons in a particular nucleus and returns the firing rates (average across all channels) and associated time in seconds by calling get_mean_rates().

Methods	Argument
extract_nucleus_name()	no arguments (access instantiated attribute)
extract_modelID()	no arguments (access instantiated attribute)
extract_percentage()	no arguments (access instantiated attribute)
get_rates()	no arguments (access instantiated attribute)
get_mean_rates()	no arguments (access instantiated attribute)

Use Cases

1. Pre-requisites

1.1. Import Modules and Instantiate

from analyseur.rbcbg.loader import LoadRates

loadFR = LoadRates("GPiSNr_model_9_percent_0.csv")

2. Cases

2.1. Load file and get the firing rates

t_sec, rates_Hz = loadFR.get_rates()
t_sec, rates_Hz = loadFR.get_mean_rates()

2.2. Extract the nucleus name

nuc = loadFR.extract_nucleus_name()

2.3. Extract the model ID

modelID = loadFR.extract_modelID()

2.4. Extract the disinhibition percentage

pc = loadFR.extract_percentage()

---

extract_modelID()

Extracts <ID> name from <nucleus>_model_<ID>_percent_<value>.csv

---

extract_nucleus_name()

Extracts <nucleus> name from <nucleus>_model_<ID>_percent_<value>.csv

---

extract_percentage()

Extracts <value> name from <nucleus>_model_<ID>_percent_<value>.csv

---

get_mean_rates()

Returns the average (across all neurons/channels) firing rate and its corresponding time stamps (in seconds) recorded with a sampling period of 1 ms.

---

get_rates()

Returns the recorded firing rates (Hz) and its corresponding time stamps (in seconds) recorded with a sampling period of 1 ms.

---