Documentation

Introduction to Visbrain

• 1. Presentation
  • 1.1. Quick description
  • 1.2. Structure
• 2. Installation options
  • 2.1. Dependencies
  • 2.2. Optional dependencies
  • 2.3. Regular installation
  • 2.4. Develop mode
  • 2.5. Update visbrain

Visbrain's objects

• 1. Objects
  • 1.1. Description
    • 1.1.1. Import objects
    • 1.1.2. Object definition
    • 1.1.3. Embedded objects to create a complex scene
  • 1.2. Complete object tutorial

[Brain] visualize EEG/MEG/Intracranial data, connectivity in a standard MNI 3D brain

• 1. Brain
  • 1.1. Main features
  • 1.2. Import and use Brain
  • 1.3. GUI description
    • 1.3.1. Components
    • 1.3.2. Settings panel tabs
    • 1.3.3. Shortcuts
  • 1.4. MNI templates
  • 1.5. Sources
    • 1.5.1. Cortical projection and repartition
    • 1.5.2. Connect sources
    • 1.5.3. Attach time-series and/or pictures
  • 1.6. Volume
    • 1.6.1. Cross-sections
    • 1.6.2. Region Of Interest (ROI)
  • 1.7. Colorbar control
  • 1.8. Examples
    • 1.8.1. Examples using visbrain.gui.Brain

[Sleep] visualize polysomnographic data and hypnogram edition

• 1. Sleep
  • 1.1. Main features
  • 1.2. Import and use sleep
  • 1.3. GUI description
    • 1.3.1. Components
    • 1.3.2. Settings panel tabs
    • 1.3.3. Shortcuts
    • 1.3.4. Video
  • 1.4. Supported files and format
    • 1.4.1. Data files
  • 1.5. Hypnogram
    • 1.5.1. User-defined vigilance states configuration
    • 1.5.2. Supported hypnogram formats
    • 1.5.3. Save hypnogram
  • 1.6. Load your files
    • 1.6.1. Load file from the GUI
    • 1.6.2. Load file from path
    • 1.6.3. Load file using MNE-Python
    • 1.6.4. Load file from raw data
  • 1.7. Time-frequency
  • 1.8. Hypnogram scoring
    • 1.8.1. Scoring table
    • 1.8.2. Navigation
    • 1.8.3. Scoring with the mouse
  • 1.9. Apply semi-automatic detection
    • 1.9.1. Spindles detection
    • 1.9.2. Peaks detection
  • 1.10. Use your own detections in Sleep
    • 1.10.1. Prototype of the function
    • 1.10.2. Function output
    • 1.10.3. Replace Sleep detection
  • 1.11. Load and save the GUI configuration
  • 1.12. Import, add and save annotations
    • 1.12.1. Import annotations
    • 1.12.2. Add new annotations
    • 1.12.3. Save annotations
  • 1.13. Examples
    • 1.13.1. Examples using visbrain.gui.Sleep

[SIGNAL] data-mining module for time-series inspection

• 1. Signal
  • 1.1. GUI Description
  • 1.2. Main features
  • 1.3. Import and use Signal
  • 1.4. Shortcuts
  • 1.5. Examples
    • 1.5.1. Examples using visbrain.gui.Signal

[FIGURE] figure-layout for high-quality publication-like figures

• 1. Figure
  • 1.1. Description
  • 1.2. Example