Skip to content

Changes

Page history
adlofts created page: contributing authored by Andrew Lofts's avatar Andrew Lofts
Hide whitespace changes
Inline Side-by-side
manual-vised-edit.md
View page @ c4514aeb
......@@ -34,7 +34,7 @@ ve_eegplot and ve_edit function both contain different common actions you may wa
| 'qcf' | ? | Flags a channel |
| 'sm' | ? | Selects a mark |
| 'awm' | 'name_of mark' | Creates a mark on the data selected by the winrej |
| 'rwm' | ? | Removes a mark on the data selected by the winrej |
| 'rwm' | 'name_of mark' | Removes a mark on the data selected by the winrej if the name of the marks is set as pop_select then you will get a pop up selection on each use.|
| 'apm' | 'name_of_mark' | Applies a mark to the whole page window |
| 'rpm' | ? | Removes a mark from the whole page window |
| 'pf' | ? | Moves 1 page forward, based on the time displayed |
......@@ -53,21 +53,22 @@ Once you have input all of the keystokes that you want to be editing with you sh
***
You can change these fields by typing or by clicking the `| ... |` button and using the selection tool.
**1.** Channels to display in the window. In this field you can select what channels you would like to display in the pop up window. You can also use the *number of channels to display* option and use the side scroll bar to navigate the window.
**1.** Channels to display in the window. In this field you can select what channels you would like to display in the pop up scroll data window. Alternatively you can also use the *number of channels to display* option in the main config fields and use the side scroll bar to navigate the window.
**2.** Events to display. This will filter which events will be displayed on the scroll data.
**3.** Marks types to include in rejection. This section contains the marks types that you will be rejecting when you click the *Update EEG Structure button*. By default this field contains *manual* marks.
**4.** At the top right there is a drop down selection between EEG and ICA data types. The marking system works the same way in ICA components mode.
**4.** At the top right there is a drop down selection between EEG and ICA data types. The marking system works the same way in ICA components mode, where instead of displaying the scroll data it will display the components data.
# Editing Marks Visually
When you click the `| Ok |`button at the bottom of the interface it should bring you a scroll plot of your data that is set up the way you specified in the configuration. If you get an error in the matlab command window, make sure you have [set up you default renderer](https://git.sharcnet.ca/bucanl_eeglab_extensions/vised_marks/wikis/home#set-up-figure-renderer) correctly.
Marks can either be in the time (y - axis) or in the channels (x - axis) depending on what functions you are using.
* If you are selecting a channel you will see the whole channel get selected. In the case of a removal this will remove the whole channel from the data.
* If you are selecting using the winrej tool or in the time axis you will be selecting a particular time but also be selecting all of the channels. **The vertical location of the color indicator on the screen does not matter**, as it is applied to all of the channels during the selected time frame. If you scroll up and down through the channels you will see that the color marks do not move. In the case of doing a removal you will be deleting all of the channel data during that time. The collapsed data will then have a boundary in it accounting for the missing time.
* If you are selecting using the winrej tool or in the time axis you will be selecting a particular time but also be selecting all of the channels. In the case of doing a removal you will be deleting all of the channel data during that time frame, the missing time will then be indicated by a boundary event.
**Please Note, the vertical location of the color indicator on the screen does not matter**, as it is applied to all of the channels during the selected time frame. If you scroll up and down through the channels you will see that the color marks do not move. In the case of doing a removal you will be deleting all of the channel data during that time. The collapsed data will then have a boundary in it accounting for the missing time.
# Adding a Mark
To start add marks use the winrej tool **and** hover your mouse over the selected data and try start using the hotkeys you have assigned.
In the example below a ***awm*** mark was created called ***custom_mark*** by using the string:
To start adding marks use the winrej tool **and** hover your mouse over the selected data and try using one of the hotkeys you have assigned.
In the example below a ***awm*** mark named ***custom_mark*** was added by using the *key select command* string:
```matlab
m,ve_edit('awm','custom_mark')
......@@ -76,13 +77,13 @@ m,ve_edit('awm','custom_mark')
![newmarkinfo](/uploads/269ba078587b070793123ce01dca1b75/newmarkinfo.png)
It should already be populated with most of the information you provided. Make sure you select a color for the mark to be. You can either type in the RGB or you can click the `| |` button and select from a pallet. once you finish with this pop up you should see the mark appear.
It should already be populated with most of the information you provided. Make sure you select a color for the mark to by typing in the RGB or by clicking the `| |` button and selecting from a color pallet. Once you have finished with this pop up you should see the mark appear on top of the data.
![markworked](/uploads/a29d9850c6469a5c54e339b07af3b5fe/markworked.png)
In this example the navy blue mark called *custom_mark* (see the name on the right side of the window), was added where the winrej highlighted from approximately 84 to 87 seconds.
In this example the navy blue *custom_mark* (see the name on the right side of the window) that we created above, was added to the area where the winrej had highlighted from approximately 84 to 87 seconds.
# Removing a Mark
The process to remove a mark is very similar. Start by using the winrej tool to select and area where you would like to remove a mark keep you mouse hovered over the selection on press your remove key. In the example below part of the navy blue mark called *custom_mark* will be removed with the ***rwm*** command specified to remove ***custom_mark*** by using the string:
The process to remove a mark is very similar. Start by using the winrej tool to select the area where you would like to remove a mark. Make sure to keep your mouse hovered over that selection when pressing your designated remove key. In the example below part of the navy blue mark called *custom_mark* will be removed with the ***rwm*** command specified to remove ***custom_mark*** by using the string:
```matlab
M,ve_edit('rwm','custom_mark')
......@@ -92,13 +93,13 @@ or
```matlab
M,ve_edit('rwm','pop_select')
```
No pop ups will appear in the first case as the marks to be removed is specified. In the second case a pop up will appear where you can select any off the existing marks, making it a more well rounded but slower hotkey.
No pop ups will appear in the first case as the marks to be removed was specified to remove *custom_mark*. In the second case a pop up will appear as you will be able to select any off the existing marks, making it a more versatile but less efficient hotkey command.
![removeworked](/uploads/0bec655c6120884a52da115a2fc132c9/removeworked.png)
# Defaults
If you leave the function ve_edit() blank then on your keystroke will give you this popup to create an action.
![newremovepopup](/uploads/5cd95b0b25d6cea9453645a2b3d26125/newremovepopup.png)
From this interface you can either make an **event** or **toggle a channel**.
From this interface you can either make an **event** or a **toggle a channel** command.
**Event**
* Make sure the *Edit events:* button is selected.
......@@ -108,12 +109,16 @@ From this interface you can either make an **event** or **toggle a channel**.
**Channel**
* Make sure the *Toggle channel marks status* button is selected
* Select the mark designation, manual is the default, but you can also make this the same as other channel marks.
* Select the mark designation, *manual* type is the default, but you can also make this the same as other channel marks.
* Select the channel you wish to apply this to.
* Click `| Ok |`.
* You should see the channel you selected is now highlighted with the designated marks color.
# Completing the Session
Once you have marked the data as you would like you will need to click the `| Update EEG Structure |` button at the bottom right of the window. What this does is it will take the marks that you have added and convert them to the structure EEG.marks, this will essentially save your changes so that next time the data is loaded you will see your marks.
Additionally and even more importantly clicking the `| Update EEG Structure |` button will delete any data that you have marked for rejection. These marks were specified in the *Marks types to include in rejection* part of the config file and by default contains all marks under the *manual* name. This method is great for manually removing messy or unwanted sections from the data.
***
[ :house: **Return to Main Page**](https://git.sharcnet.ca/bucanl_eeglab_extensions/vised_marks/wikis/home)
......