Difference between revisions of "Change Waveform Colours"

From BESA® Wiki
Jump to: navigation, search
Line 2: Line 2:
 
|title = Module information
 
|title = Module information
 
|module = BESA Research Basic or higher
 
|module = BESA Research Basic or higher
|version = BESA Research 5.2 or higher
+
|version = BESA Research 6.1 or higher
 
}}
 
}}
  
 
Colours of channel waveforms and labels may be modified by changing the corresponding entry in the Montage Editor configuration file '''BesaME.cfg''', which is separately stored for each user.
 
Colours of channel waveforms and labels may be modified by changing the corresponding entry in the Montage Editor configuration file '''BesaME.cfg''', which is separately stored for each user.
  
The configuration file is located in the current user's folder, usually '''<Program folder>\System\UserDirs\<User name>\'''.  Here, ''<Program folder>'' specifies the BESA Research installation folder and ''<User name>'' is the user name which was used to log on to Windows.
+
The configuration file is located in the current user's folder, usually '''C:\Users\<User name>\Documents\BESA\<Research_X_Y>\Settings'''.  Here, ''<Research_X_Y>'' specifies the BESA Research version (I.e. Research_7_1_ and ''<User name>'' is the user name which was used to log on to Windows.
  
The colours may be set in the section '''[Colors]'''. If this section is not available, please add the '''[Colors]''' line (no quotes) at the end of the file and write the colour modifications below this line.
+
The colours may be set in the section '''[Colors]'''. If this section is not available, please add the '''[Colors]''' line (no quotes) at the end of the file and write the color modifications below this line.
 +
 
 +
Various features for various group of channels and channel subselection can be set. the convention is '''FeatureChannels_Sub'''
 +
 
 +
Following features can be used:
 +
* ColText
 +
* ColPlot
 +
* ColWave
 +
 
 +
Following Channel groups can be used:
 +
* RecordedElectrode
 +
* VirtualElectrode
 +
* InterpolatedElectrode
 +
* SingleDipole
 +
* RegionalSource
 +
* SpatialComponent
 +
* Magnetometer
 +
* Gradiometer
 +
* InterpolatedChanMEG
 +
* IntracranialChannel
 +
* PolygraficChannel
 +
* BadChannel
 +
* UnavailableElectrode
 +
* RecordedMontageChannel*
 +
* VirtualMontageChannel*
 +
* MEGMontageChannel*
 +
* UnavailableMontageChannel*
 +
* AddChanMontage
 +
 
 +
For channel groups: RecordedElectrode, VirtualElectrode, InterpolatedElectrode, SingleDipole, RegionalSource following sub selection should be added for ColWave feature:
 +
* Left
 +
* Right
 +
* Mid
 +
 
 +
For ColPlot feature following sub-selection can be added for sensors:
 +
* Selected
 +
* Highlighted (only for MontageChannel groups)
 +
* SelectedHighlighted (only for ...MontageChannel groups)
  
 
The "''ColText...''" colours specify the colours of the channel labels. The "''ColPlot...''" colours specify the colours used for display in the Montage Editor. The "''ColWave...''" colours specify the colours of the channel waveforms. It is recommended to use the same or similar colour for the 3 corresponding entries.
 
The "''ColText...''" colours specify the colours of the channel labels. The "''ColPlot...''" colours specify the colours used for display in the Montage Editor. The "''ColWave...''" colours specify the colours of the channel waveforms. It is recommended to use the same or similar colour for the 3 corresponding entries.
 +
 +
The "''...RecordedElectrode...''" indicate which type of channel should be affected. Note that there are special groups "''...MontageChannel''". For this group only ColPlor feature can be used.
 +
 +
The "''..._Left''"  sub selection indicates that only sensors located over left hemisphere will be affected by this setting. Note that this subselection can be used an is obligatory for EEG sensors and sources.
 +
 +
The "''..._Selected''" sub selection indicates colour setting for colour of highlight of channel in Montage editor (while channel is selected in channel list).
 +
 +
The "''..._Highligthed''" and "''..._SelectedHighlighted''" indicate colour setting for channel selection by mouse hover or selection respectively in Montage editor topographical view. Note that this setting is only possible for special groups "''...MontageChannel''".
  
 
The colour values are given in [RED,GREEN,BLUE] triples, each value may range from 0 (weakest intensity) to 255 (maximum intensity). For internal reasons, the "''ColText...''" and "''ColPlot...''" colours must not be deep black (000,000,000). If a black colour should be set, use a colour close to black (see line ColTextPolygraficChannel=000,000,001). The difference will not be visible.  
 
The colour values are given in [RED,GREEN,BLUE] triples, each value may range from 0 (weakest intensity) to 255 (maximum intensity). For internal reasons, the "''ColText...''" and "''ColPlot...''" colours must not be deep black (000,000,000). If a black colour should be set, use a colour close to black (see line ColTextPolygraficChannel=000,000,001). The difference will not be visible.  
Line 18: Line 63:
 
lost at program termination.
 
lost at program termination.
  
The following colour settings are available (the colour triples show the default values):
+
The example of colour settings (the colour triples show the default values):
  
 
{| class="wikitable"
 
{| class="wikitable"
 
! style="font-weight: bold;" | [Colors]
 
! style="font-weight: bold;" | [Colors]
 +
|-
 +
| ColTextRecordedElectrode=000,000,128
 +
|-
 +
| ColPlotRecordedElectrode=160,160,255
 +
|-
 +
| ColPlotRecordedElectrode_Selected=160,160,255
 +
|-
 +
| ColWaveRecordedElectrode_Left=000,000,128
 +
|-
 +
| ColWaveRecordedElectrode_Mid=000,000,000
 +
|-
 +
| ColWaveRecordedElectrode_Right=128,000,000
 +
|-
 +
| ColPlotRecordedMontageChannel=000,000,255
 +
|-
 +
| ColPlotRecordedMontageChannel_Selected=000,000,130
 +
|-
 +
| ColPlotRecordedMontageChannel_Highlighted=230,230,000
 +
|-
 +
| ColPlotRecordedMontageChannel_SelectedHilighted=215,215,000
 +
 
|-
 
|-
 
| ColTextMagnetometer=110,000,110
 
| ColTextMagnetometer=110,000,110

Revision as of 14:59, 5 May 2021

Module information
Modules BESA Research Basic or higher
Version BESA Research 6.1 or higher

Colours of channel waveforms and labels may be modified by changing the corresponding entry in the Montage Editor configuration file BesaME.cfg, which is separately stored for each user.

The configuration file is located in the current user's folder, usually C:\Users\<User name>\Documents\BESA\<Research_X_Y>\Settings. Here, <Research_X_Y> specifies the BESA Research version (I.e. Research_7_1_ and <User name> is the user name which was used to log on to Windows.

The colours may be set in the section [Colors]. If this section is not available, please add the [Colors] line (no quotes) at the end of the file and write the color modifications below this line.

Various features for various group of channels and channel subselection can be set. the convention is FeatureChannels_Sub

Following features can be used:

  • ColText
  • ColPlot
  • ColWave

Following Channel groups can be used:

  • RecordedElectrode
  • VirtualElectrode
  • InterpolatedElectrode
  • SingleDipole
  • RegionalSource
  • SpatialComponent
  • Magnetometer
  • Gradiometer
  • InterpolatedChanMEG
  • IntracranialChannel
  • PolygraficChannel
  • BadChannel
  • UnavailableElectrode
  • RecordedMontageChannel*
  • VirtualMontageChannel*
  • MEGMontageChannel*
  • UnavailableMontageChannel*
  • AddChanMontage

For channel groups: RecordedElectrode, VirtualElectrode, InterpolatedElectrode, SingleDipole, RegionalSource following sub selection should be added for ColWave feature:

  • Left
  • Right
  • Mid

For ColPlot feature following sub-selection can be added for sensors:

  • Selected
  • Highlighted (only for MontageChannel groups)
  • SelectedHighlighted (only for ...MontageChannel groups)

The "ColText..." colours specify the colours of the channel labels. The "ColPlot..." colours specify the colours used for display in the Montage Editor. The "ColWave..." colours specify the colours of the channel waveforms. It is recommended to use the same or similar colour for the 3 corresponding entries.

The "...RecordedElectrode..." indicate which type of channel should be affected. Note that there are special groups "...MontageChannel". For this group only ColPlor feature can be used.

The "..._Left" sub selection indicates that only sensors located over left hemisphere will be affected by this setting. Note that this subselection can be used an is obligatory for EEG sensors and sources.

The "..._Selected" sub selection indicates colour setting for colour of highlight of channel in Montage editor (while channel is selected in channel list).

The "..._Highligthed" and "..._SelectedHighlighted" indicate colour setting for channel selection by mouse hover or selection respectively in Montage editor topographical view. Note that this setting is only possible for special groups "...MontageChannel".

The colour values are given in [RED,GREEN,BLUE] triples, each value may range from 0 (weakest intensity) to 255 (maximum intensity). For internal reasons, the "ColText..." and "ColPlot..." colours must not be deep black (000,000,000). If a black colour should be set, use a colour close to black (see line ColTextPolygraficChannel=000,000,001). The difference will not be visible.

Note that the configuration file is written when the program is closed. So do not change it while BESA Research is open. Otherwise, your changes will be lost at program termination.

The example of colour settings (the colour triples show the default values):

[Colors]
ColTextRecordedElectrode=000,000,128
ColPlotRecordedElectrode=160,160,255
ColPlotRecordedElectrode_Selected=160,160,255
ColWaveRecordedElectrode_Left=000,000,128
ColWaveRecordedElectrode_Mid=000,000,000
ColWaveRecordedElectrode_Right=128,000,000
ColPlotRecordedMontageChannel=000,000,255
ColPlotRecordedMontageChannel_Selected=000,000,130
ColPlotRecordedMontageChannel_Highlighted=230,230,000
ColPlotRecordedMontageChannel_SelectedHilighted=215,215,000
ColTextMagnetometer=110,000,110
ColPlotMagnetometer=110,020,110
ColWaveMagnetometer=110,000,110
ColTextGradiometer=110,000,110
ColPlotGradiometer=110,020,110
ColWaveGradiometer=110,000,110
ColTextIntracranialChannel=104,050,000
ColPlotIntracranialChannel=104,050,020
ColWaveIntracranialChannel=104,050,000
ColTextPolygraficChannel=000,000,001
ColPlotPolygraficChannel=000,000,001
ColWavePolygraficChannel=000,000,000
ColTextAddChanMontage=110,000,255
ColWaveAddChanMontage=110,000,255