Skip to content

Latest commit

 

History

History
57 lines (48 loc) · 5.46 KB

Neuroviz.md

File metadata and controls

57 lines (48 loc) · 5.46 KB

Neuroviz.ini configuration file

Provided is an overview of the different sections that can be tweaked to alter the functionality of the application. Altering the scene and/or interators will also write to this file, so the settings could be overwritten!

[Gui]

  • Preload = Bool contains the boolean value that indicates whether all scenes should be loaded at startup (True) or at runtime (False).
  • PyFileName = /Relative/Path/To/PyFile.py contains the relative path (str) to the Python file that is to be generated when recompiling the UI from Qt Designer.
  • UiClassName = ClassName contains the name (str) of the MainWindow class that is generated in Qt Designer.
  • UiFileName = /Relative/Path/To/UiFile.py contains the relative path (str) to the UI file that is to be recompiled when updating the UI from Qt Designer.

[Logging]

  • Enabled = Bool contains the boolean value that indicates whether logging should be enabled or disabled.
  • LogToConsole = Bool contains the boolean value that indicates whether logging to a console should be enabled or disabled.
  • LogToConsoleFormat = LogFormat contains the formatting style (str) when logging to a console.
  • LogToFile = Bool contains the boolean value that indicates whether logging to a file should be enabled or disabled.
  • LogToFileFormat = LogFormat contains the formatting style (str) when logging to a file.
  • LogToFileName= LogFileName contains (a relative path to) the filename (str) in which to log when logging to a file is enabled.
  • ModulesToLog = Module1Name->Level1, Module2Name->Level2 contains a list of the names (str) of the modules to be logged and the minimum level for each of them. Possible levels are "Debug", "Info", "Warning", "Error" and "Critical" (str).

[BasicScene]

  • ActiveContour = NameOfContour contains the name (str) (as specified in ContourValues) of the active contour.
  • ContourSmoothings = Name1->Radius/StdDev/Iters/PassBand/Angle, Name2->Radius/StdDev/Iters/PassBand/Angle contains a list of names (str) (as specified in ContourValues) of the contours along with their smoothing parameters. Radius (int) and StdDev (float) are used in the Gaussian smoothing, Iters (int), PassBand (float) and Angle (float) are used in the windowed sinc filtering.
  • ContourValues = Name1->Value1, Name2->Value2 contains a list of names (str) of the contours along with their isosurface value (int), which is the greyscale value that will be used to generate contour.
  • FileName = /Relative/Path/To/VTK/File contains the relative path (str) to the volumetric data in VTK file format.
  • InteractionStyle = NameOfInteractionStyle contains the current interaction style (str). Can be set to "Opacity", "Interactive" or "Automatic".
  • Opacity = Value contains the current opacity value (float) between 0.0 and 1.0.

[SagittalCut], [CoronalCut], [TransverseCut]

  • Checked = Bool contains the current state (bool) of the slider.
  • Max = Value contains the maximum value (int) of the slider.
  • Min = Value contains the minimum value (int) of the slider.
  • Text = SomeText contains the label (str) of the slider.
  • Value = Value contains the current value (int) of the slider.

[EEGScene]

  • ContourSmoothing =Radius/StdDev/Iters/PassBand/Angle contains the smoothing parameters for the contour. Radius (int) and StdDev (float) are used in the Gaussian smoothing, Iters (int), PassBand (float) and Angle (float) are used in the windowed sinc filtering.
  • ContourValue = Value contains the isosurface value (int), which is the greyscale value that will be used to generate contour.
  • ElectrodeChoices = Value1, Value2 contains a list of values (float) between 0.0 and 1.0 from which the electrode values can choose.
  • FileName = /Relative/Path/To/VTK/File contains the relative path (str) to the volumetric data in VTK file format.
  • NSamples = Value contains the last 'Value' number of samples (int) that need to be shown in the XY charts when animations are enabled.

[Animations]

  • Checked = Bool contains the current state (bool) of the animations.
  • Max = Value contains the maximum value (int) of the animation period in ms.
  • Min = Value contains the minimum value (int) of the animation period in ms.
  • Text = SomeText contains the label (str) of the animation checkbox.
  • Value = Value contains the current value (int) of the animation period in ms.

[DSASceneAndInteractor]

  • DataSetName = /Relative/Path/To/Datasets*/ contains a relative path (str) to the folder containing the datasets. Uses a placeholder * to match any following characters.
  • HueConstant = Value contains the value (float) that will be multiplied to the current hue.
  • HueMultiplier = Value contains the value (float) that will be subtracted from the current hue.
  • ValueMultiplier = Value contains the value (float) that will be multiplied with the current value.

[DSAScene]

  • FileName = /Relative/Path/To/Dataset/*.png contains a relative path (str) to a backup dataset in case the datasets could not automatically be fetched. Uses a placeholder * to match any following characters.