Skip to content

Commit 439cf81

Browse files
committed
update PACTools
1 parent 3ba68f2 commit 439cf81

File tree

1 file changed

+10
-23
lines changed

1 file changed

+10
-23
lines changed

plugins/PACTools/index.md

+10-23
Original file line numberDiff line numberDiff line change
@@ -77,20 +77,16 @@ The function pop_pac.m provides the front-end interface for the toolbox it also
7777
### Plug-in setup
7878
PACTools is a plugin to EEGLAB. Thus, its installation can be done directly from the EEGLAB plug-in manager (In the EEGLAB GUI see: File -> Manage EEGLAB extensions).
7979
An alternative way is by downloading PACTools files to the user's local computer. Then, copying the folder with all the files to the EEGLAB folder located in *../eeglab/plugins/* and then restart EEGLAB. The toolbox can be located under the menu *Tools* in EEGLAB (see figure below).
80-
<center>
81-
<img src="doc/img/eeglab_toolbox_menu.jpg" alt="drawing" width="400"/>
82-
</center>
80+
81+
![image](https://github.com/user-attachments/assets/2cb685bd-9c6c-4935-aa0c-c39402d928a4)
8382

8483
### Graphical user interface
8584
In its current version, the toolbox provide basic function to compute and visualize PAC that can be executed either from command line calls or from graphical user interfaces (GUI) created for these ends. Acces to GUI can be done from the EEGLAB GUI through *Tools > PAC Tools*. Here we will be given the option to *Estimate PAC* or *Visualize PAC*.
8685

8786
#### Computing PAC with pop_pac
8887
To invoke the GUI to compute PAC from the EEGLAB GUI, click the menu *Tools > PAC Tools > Estimate PAC*, otherwise, you can launch the GUI from the MATLAB command windows by typing `EEG = pop_pac(EEG)` (see figure below). Here we assume that the user has already loaded the EEG set where the PAC wants to be computed on.
89-
90-
<center>
91-
<img style="float: center;" src="doc/img/pop_pac_gui2.jpg" width="600"/>
92-
<end>
93-
</center>
88+
89+
![image](https://github.com/user-attachments/assets/9f6c95cf-002c-4895-88ec-a4b25c474dd3)
9490

9591
The GUI is divided into five parts designated by the labels: **Data type**, **PAC Method**, **Optional inputs**, **Significance testing** and **Compute on NSG** .
9692
In the first section (**Data type**), the type of data used for PAC computation can be chosen between channel data (*Channels*) or ICA decomposed data (*Components*).
@@ -108,10 +104,9 @@ Finally, three buttons lay at the bottom of the GUI designated to launch the hel
108104

109105
#### Visualizing PAC with pop_plotpac
110106
Once PAC is computed using *pop_pac.m*, the results are stored in the EEG structure (see details in the next section). Visualization of the results can be done by invoking the function *pop_plotpac* from the command line (`pop_plotpac(EEG)`)or from the EEGLAB menu as *Tools > PAC Tools > Visualize PAC* (see figure below).
111-
<center>
112-
<img style="float: center;" src="doc/img/pop_plotpac_gui2.jpg" width="600"/>
113-
<end>
114-
</center>
107+
108+
![image](https://github.com/user-attachments/assets/7d340eed-d694-4dec-a8f2-2abc8a93a3ed)
109+
115110
The GUI of poc_pacplot comprises four major sections(depicted in the figure above).
116111
Section A : In this section the user can get a quick glimpse of the parameters used for the computation of PAC stored in the current EEG set.
117112
Section B: Display all the channel/components pairs for which PAC has been computed. The first element of the pair corresponds to the stream used to compute the instantaneous Phase, while the second element corresponds to the one used for the instantaneous Amplitude.
@@ -197,16 +192,11 @@ Note: In this sample code, we assume the current directory to be the folder cont
197192

198193
This dataset contains a simulated PAC signal where the instantaneous phase at 8Hz and the instantaneous amplitude at 60Hz are coupled during two segments of the signal (see figure below).
199194

200-
<center>
201-
<img src="doc/img/fig_sim_signal_1trial.jpg" alt="drawing" width="600"/>
202-
</center>
195+
![image](https://github.com/user-attachments/assets/253d0a6c-620e-4328-b8d1-ea7e0637f7e1)
203196

204197
After loading the dataset, we proceed to compute PAC with PACTools by using *pop_pac* GUI. To launch the GUI, select *Tools > PAC Tools > Estimate PAC* in the main EEGLAB GUI. Alternatively, you can use `EEG = pop_pac(EEG)` from the MATLAB command windows. Here we compute PAC using the Mean Vector Length Modulation Index method (*mvlmi*) between 10 phase frequencies in the range [4 15]Hz and 20 amplitude frequencies in the range [30 100]Hz. To perform this computation, set *pop_pac* GUI as shown in the figure below, and click **Ok**.
205198

206-
<center>
207-
<img style="float: center;" src="doc/img/demo1_pop_pac2.jpg" width="600"/>
208-
<end>
209-
</center>
199+
![image](https://github.com/user-attachments/assets/f2dbe558-8096-4062-b828-67e5f8b8a6c8)
210200

211201
The equivalent command line call to perform this computation can be retreived with the command `eegh`. In this case will return in it last entry:
212202

@@ -251,10 +241,7 @@ and
251241
#### Visualization
252242
To visualize the PAC values computed previously we use the *pop_plotpac* GUI (click *Tools > PAC Tools > Visualize PAC*). From the *pop_plotpac* GUI we select the channel pair and the measure to visualize, then proceed to plot PAC results using the enabled plots in section D of the GUI. The figure below shows the plots generated for the Instantaneous MIPAC (*instmipac*) from each of the plotting options available for this measure: *Comodulogram*, *Temporal comodulogram* and *Freq.-time PAC*. We used default plotting options here, but users are encouraged to explore how the different plotting parameter options modify the visualization.
253243

254-
<center>
255-
<img style="float: center;" src="doc/img/pop_plotpac_demo.jpg" width="1000"/>
256-
<end>
257-
</center>
244+
![image](https://github.com/user-attachments/assets/ed4dd87d-9d9f-4c26-ada4-41be78a910f0)
258245

259246
### Contributions and feedback
260247
This is an open-source project on constant development. Please, contact the authors at [email protected] for contributions. The use of the issue tracker is encouraged.

0 commit comments

Comments
 (0)