src.tools.source_estimation package

Submodules

src.tools.source_estimation.source_estimation_controller module

Source Estimation Controller

class src.tools.source_estimation.source_estimation_controller.sourceEstimationController(number_of_epochs, event_values, event_ids, tmin, tmax, title=None)

Bases: tools.source_estimation.source_estimation_listener.sourceEstimationListener

additional_parameters_clicked()

Create a new window for specifying some additional parameters for the computation of the source estimation.

additional_parameters_information(export_path)

Retrieve the exportation path for the source estimation data computed. :param export_path: Path where the source estimation data will be stored. :type export_path: str

cancel_button_clicked()

Close the window.

confirm_button_clicked(source_estimation_method, save_data, load_data, epochs_method, trials_selected, tmin, tmax, n_jobs)

Close the window and send the information to the main controller. :param source_estimation_method: The method used to compute the source estimation :type source_estimation_method: str :param save_data: Boolean telling if the data computed must be saved into files. :type save_data: bool :param load_data: Boolean telling if the data used for the computation can be read from computer files. :type load_data: bool :param epochs_method: On what data the source estimation will be computed. Can be three values : - “single trial” : Compute the source estimation on a single trial that is precised. - “evoked” : Compute the source estimation on the average of all the signals. - “averaged” : Compute the source estimation on every trial, and then compute the average of them. :type: str :param trials_selected: The indexes of the trials selected for the computation :type trials_selected: list of int :param tmin: Start time of the epoch or raw file :type tmin: float :param tmax: End time of the epoch or raw file :type tmax: float :param n_jobs: Number of processes used to compute the source estimation :type n_jobs: int

get_elements_selected(elements_selected, element_type)

Get the elements selected by the user in the multiple elements’ selector. :param elements_selected: Elements selected in the multiple elements’ selector. :type elements_selected: list of str :param element_type: Type of the element selected, used in case multiple element selector windows can be open in a window. Can thus distinguish the returned elements. :type element_type: str

plot_source_estimation(source_estimation_data)

Send the information to the view for plotting the source estimation. :param source_estimation_data: The source estimation’s data. :type source_estimation_data: MNE.SourceEstimation

set_listener(listener)

Set the main listener so that the controller is able to communicate with the main controller. :param listener: main listener :type listener: mainController

src.tools.source_estimation.source_estimation_listener module

Source estimation listener

class src.tools.source_estimation.source_estimation_listener.sourceEstimationListener

Bases: abc.ABC

Listener doing the connection between the controller and the view for computing the source estimation on the dataset. It retrieves the information from the view to send it to the controller.

additional_parameters_clicked()

additional_parameters_information(export_path)

cancel_button_clicked()

confirm_button_clicked(source_estimation_method, save_data, load_data, epochs_method, trials_selected, tmin, tmax, n_jobs)

get_elements_selected(elements_selected, element_type)

src.tools.source_estimation.source_estimation_view module

Source estimation view

class src.tools.source_estimation.source_estimation_view.sourceEstimationView(number_of_epochs, event_values, event_ids, tmin, tmax, title=None)

Bases: PyQt5.QtWidgets.QWidget

cancel_source_estimation_trigger()

Send the information to the controller that the computation is cancelled.

confirm_source_estimation_trigger()

Retrieve the parameters and send the information to the controller.

data_exportation_trigger()

Open a new window asking for the path for the exportation of the source estimation computation data/

get_epochs_trial_average_method()

get_save_load_button_checked()

Get the values of the save and load buttons. :return: save_data: True if the data must be saved. Otherwise, False. load_data: True if the data must be loaded. Otherwise, False. :rtype: boolean, boolean

plot_source_estimation(source_estimation_data)

Plot the source estimation. :param source_estimation_data: The source estimation’s data. :type source_estimation_data: MNE.SourceEstimation

set_listener(listener)

Set the listener to the controller. :param listener: Listener to the controller. :type listener: sourceEstimationController

set_trials_selected(elements_selected, element_type)

Set the channels selected in the multiple selector window. :param elements_selected: Trials or Events selected. :type elements_selected: list of str :param element_type: Type of the element selected, used in case multiple element selector windows can be open in a window. Can thus distinguish the returned elements. :type element_type: str

slider_value_changed_trigger()

Change the value of the slider displayed on the window when the actual slider is moved.

trial_selection_events_trigger()

Open the multiple selector window. The user can select the events he wants the source estimation to be computed on.

trial_selection_indexes_trigger()

Open the multiple selector window. The user can select the trials indexes he wants the source estimation to be computed on.

Module contents