docs/documentation.rst
Documentation
#################
This part of the documentation details the complete ``neurokit`` for python API.
Biosignal Processing
=====================
bio_process
---------------
.. autofunction:: neurokit.bio_process
ecg_process
---------------
.. autofunction:: neurokit.ecg_process
ecg_preprocess
---------------
.. autofunction:: neurokit.ecg_preprocess
ecg_hrv
-----------------
.. autofunction:: neurokit.ecg_hrv
ecg_rsa
-----------------
.. autofunction:: neurokit.ecg_rsa
ecg_simulate
-----------------
.. autofunction:: neurokit.ecg_simulate
rsp_process
---------------
.. autofunction:: neurokit.rsp_process
eda_process
---------------
.. autofunction:: neurokit.eda_process
eda_scr
---------------
.. autofunction:: neurokit.eda_scr
emg_process
---------------
.. autofunction:: neurokit.emg_process
bio_EventRelated
-----------------
.. autofunction:: neurokit.bio_EventRelated
read_acqknowledge
--------------------
.. autofunction:: neurokit.read_acqknowledge
EEG
=====================
eeg_add_channel
--------------------
.. autofunction:: neurokit.eeg_add_channel
eeg_select_channels
--------------------
.. autofunction:: neurokit.eeg_select_channels
eeg_select_electrodes
-----------------------
.. autofunction:: neurokit.eeg_select_electrodes
eeg_create_mne_events
-------------------------
.. autofunction:: neurokit.eeg_create_mne_events
eeg_add_events
-------------------------
.. autofunction:: neurokit.eeg_add_events
eeg_complexity
-------------------------
.. autofunction:: neurokit.eeg_complexity
eeg_erp
-------------------------
.. autofunction:: neurokit.eeg_erp
plot_eeg_erp
-------------------------
.. autofunction:: neurokit.plot_eeg_erp
plot_eeg_erp_topo
-------------------------
.. autofunction:: neurokit.plot_eeg_erp_topo
Signal
=====================
find_events
---------------
.. autofunction:: neurokit.find_events
plot_events_in_signal
-----------------------------------
.. autofunction:: neurokit.plot_events_in_signal
create_epochs
---------------
.. autofunction:: neurokit.create_epochs
complexity
--------------------
.. autofunction:: neurokit.complexity
Statistics
=====================
mad
---------------
.. autofunction:: neurokit.mad
z_score
---------------
.. autofunction:: neurokit.z_score
find_outliers
---------------
.. autofunction:: neurokit.find_outliers
normal_range
---------------
.. autofunction:: neurokit.normal_range
Routines
=====================
compute_dprime
---------------
.. autofunction:: neurokit.compute_dprime
compute_BMI
---------------
.. autofunction:: neurokit.compute_BMI
compute_interoceptive_accuracy
---------------------------------
.. autofunction:: neurokit.compute_interoceptive_accuracy
staircase
---------------------------------
.. autofunction:: neurokit.staircase
Plot
=====================
plot_polarbar
---------------
.. autofunction:: neurokit.plot_polarbar
Miscellaneous
=====================
find_following_duplicates
----------------------
.. autofunction:: neurokit.find_following_duplicates
find_closest_in_list
----------------------
.. autofunction:: neurokit.find_closest_in_list
Time
----------------------
.. autoclass:: neurokit.Time
Data
=====================
find_creation_date
----------------------
.. autofunction:: neurokit.find_creation_date
save_nk_object
----------------------
.. autofunction:: neurokit.save_nk_object
read_nk_object
----------------------
.. autofunction:: neurokit.read_nk_object