Advertisement
El_Chaderino

EEG PARADOX VIEWER USER MANUAL

Jun 22nd, 2025
53
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 9.96 KB | None | 0 0
  1. # EEG Paradox Viewer - User Manual
  2.  
  3. ## Table of Contents
  4. 1. [Getting Started](#getting-started)
  5. 2. [File Operations](#file-operations)
  6. 3. [Live Screen Capture](#live-screen-capture)
  7. 4. [Navigation and Zoom](#navigation-and-zoom)
  8. 5. [Analysis Mode](#analysis-mode)
  9. 6. [Measurement Grid](#measurement-grid)
  10. 7. [Keyboard Shortcuts](#keyboard-shortcuts)
  11. 8. [Settings and Preferences](#settings-and-preferences)
  12. 9. [Troubleshooting](#troubleshooting)
  13.  
  14. ---
  15.  
  16. ## Getting Started
  17.  
  18. ### Launching the Application
  19. - Run `python eeg_paradox_viewer_v2_live.py` from the command line
  20. - The application will start with a dark theme optimized for EEG analysis
  21. - Your previous session settings will be automatically restored
  22.  
  23. ### Main Interface
  24. The application features a clean, professional interface with:
  25. - **Main Display Area**: Shows your EEG images, PDFs, or live capture
  26. - **Toolbar**: Quick access to essential functions
  27. - **Status Bar**: Shows current zoom level and file information
  28. - **Analysis Panel**: Professional annotation tools (when enabled)
  29.  
  30. ---
  31.  
  32. ## File Operations
  33.  
  34. ### Opening Files
  35. - **Images**: Supports JPG, PNG, BMP, and other common formats
  36. - **PDFs**: Full PDF support with multi-page navigation
  37. - **Method**: Click "Open File" or use `Ctrl+O`
  38.  
  39. ### PDF Navigation
  40. - **Next Page**: Click "Next" button or press `Page Down`
  41. - **Previous Page**: Click "Prev" button or press `Page Up`
  42. - **Go to Page**: Click "Go to Page" to jump to a specific page number
  43. - **Current Page Display**: Shows "Page X of Y" in the status bar
  44.  
  45. ### Exporting Views
  46. - **Export Current View**: Saves the current display as a PNG image
  47. - **Location**: Exported to the `output/` folder
  48. - **Filename**: Automatically generated with timestamp
  49.  
  50. ---
  51.  
  52. ## Live Screen Capture
  53.  
  54. ### Starting Live Capture
  55. 1. Click "Start Live Capture" button
  56. 2. Select capture source:
  57. - **Full Screen**: Captures entire monitor
  58. - **Specific Window**: Choose from list of open windows
  59. 3. Choose monitor if using multiple displays
  60. 4. Click "OK" to begin capture
  61.  
  62. ### Live Capture Features
  63. - **Real-time Display**: Updates at your monitor's refresh rate
  64. - **FPS Display**: Shows current capture frame rate
  65. - **Pause/Resume**: Click "Stop Live Capture" to pause, "Start Live Capture" to resume
  66. - **Source Change**: Can switch capture source without restarting
  67.  
  68. ### Capture Settings
  69. - **Multi-monitor Support**: Automatically detects all monitors
  70. - **Window Detection**: Lists all visible application windows
  71. - **Performance**: Optimized for smooth real-time display
  72.  
  73. ---
  74.  
  75. ## Navigation and Zoom
  76.  
  77. ### Zoom Controls
  78. - **Zoom In**: Click "+" button or press `Z`
  79. - **Zoom Out**: Click "-" button or press `X`
  80. - **Reset Zoom**: Click "100%" button or press `R`
  81. - **Mouse Wheel**: Hold `Ctrl` and scroll to zoom in/out
  82. - **Zoom Range**: 10% to 500%
  83.  
  84. ### Panning
  85. - **Mouse Drag**: Click and drag to pan around the image
  86. - **Scroll Bars**: Use horizontal/vertical scroll bars when zoomed in
  87.  
  88. ### Keyboard Navigation
  89. - **Arrow Keys**: Pan the view when zoomed in
  90. - **Home**: Return to top-left of image
  91. - **End**: Go to bottom-right of image
  92.  
  93. ---
  94.  
  95. ## Analysis Mode
  96.  
  97. ### Enabling Analysis Mode
  98. 1. Click "Toggle Analysis Mode" button
  99. 2. The interface will switch to professional analysis tools
  100. 3. Analysis overlays will become visible and interactive
  101.  
  102. ### Analysis Tools
  103.  
  104. #### Note Tool
  105. - **Purpose**: Add text annotations to specific points
  106. - **Usage**:
  107. 1. Select "Note" from analysis tools
  108. 2. Click anywhere on the image
  109. 3. Enter your annotation text
  110. 4. Click "OK"
  111. - **Display**: Green circle with your text
  112. - **Editing**: Double-click to edit existing notes
  113.  
  114. #### Ruler Tool
  115. - **Purpose**: Measure distances between points
  116. - **Usage**:
  117. 1. Select "Ruler" from analysis tools
  118. 2. Choose a color for your ruler
  119. 3. Click and drag to create the measurement line
  120. 4. Enter an optional note for the measurement
  121. 5. Release to complete
  122. - **Features**:
  123. - Custom colors for each ruler
  124. - Distance calculation in pixels
  125. - Optional text notes
  126. - Calibrated measurements (when grid is calibrated)
  127.  
  128. #### Region of Interest (ROI) Tool
  129. - **Purpose**: Highlight and annotate specific areas
  130. - **Usage**:
  131. 1. Select "ROI" from analysis tools
  132. 2. Click and drag to create a selection box
  133. 3. Enter a note describing the region
  134. 4. Release to complete
  135. - **Features**:
  136. - Resizable selection boxes
  137. - Area calculation
  138. - Text annotations
  139. - Color-coded regions
  140.  
  141. ### Managing Overlays
  142. - **Access**: Click "Manage Overlays" button
  143. - **Features**:
  144. - View all annotations in a table
  145. - Edit existing overlays
  146. - Delete individual overlays
  147. - Clear all overlays
  148. - Export overlays to file
  149. - **Table Columns**:
  150. - **Type**: Note, Ruler, or ROI
  151. - **Position**: Coordinates on the image
  152. - **Details**: Text content or measurements
  153. - **Actions**: Edit/Delete buttons
  154.  
  155. ---
  156.  
  157. ## Measurement Grid
  158.  
  159. ### Overview
  160. The Measurement Grid is a professional floating tool for precise EEG measurements.
  161.  
  162. ### Activating the Grid
  163. - Click "Toggle Measurement Grid" button
  164. - A semi-transparent grid will appear over the application
  165. - The grid can be moved and resized
  166.  
  167. ### Grid Features
  168. - **Draggable**: Click and drag to move anywhere on screen
  169. - **Resizable**: Drag edges or corners to change size
  170. - **Semi-transparent**: Won't obstruct your view
  171. - **Always on Top**: Stays visible over other applications
  172.  
  173. ### Calibration
  174. 1. Click "Calibrate" button on the grid
  175. 2. Enter your calibration values:
  176. - **X-axis**: Pixels per unit (e.g., pixels per millisecond)
  177. - **Y-axis**: Pixels per unit (e.g., pixels per microvolt)
  178. - **Units**: Choose appropriate units (ms, µV, Hz, etc.)
  179. 3. Click "OK" to apply calibration
  180.  
  181. ### Real-time Measurements
  182. - **Live Display**: Grid shows current dimensions in real-world units
  183. - **Format**: "Width × Height (calibrated units)"
  184. - **Example**: "150.2ms × 45.8µV"
  185.  
  186. ### Grid Settings
  187. - **Line Color**: Customizable grid line color
  188. - **Line Thickness**: Adjustable line width
  189. - **Opacity**: Control transparency level
  190. - **Auto-save**: Calibration settings are saved between sessions
  191.  
  192. ---
  193.  
  194. ## Keyboard Shortcuts
  195.  
  196. ### File Operations
  197. - `Ctrl+O`: Open file
  198. - `Ctrl+S`: Save current view
  199. - `Ctrl+Q`: Quit application
  200.  
  201. ### Navigation
  202. - `Z`: Zoom in
  203. - `X`: Zoom out
  204. - `R`: Reset zoom to 100%
  205. - `Page Up`: Previous page (PDFs)
  206. - `Page Down`: Next page (PDFs)
  207. - `Home`: Go to top-left
  208. - `End`: Go to bottom-right
  209. - `Ctrl + Mouse Wheel`: Zoom in/out
  210.  
  211. ### Analysis Tools
  212. - `A`: Toggle Analysis Mode
  213. - `M`: Toggle Measurement Grid
  214. - `T`: Toggle Trace Enhancement
  215. - `N`: Toggle Note Tool
  216. - `L`: Toggle Ruler Tool
  217. - `B`: Toggle ROI Tool
  218.  
  219. ### Live Capture
  220. - `L`: Toggle Live Capture
  221. - `C`: Capture single screen shot
  222.  
  223. ### View Controls
  224. - `F`: Toggle fullscreen
  225. - `Ctrl+0`: Fit to window
  226. - `Ctrl+1`: Actual size
  227.  
  228. ---
  229.  
  230. ## Settings and Preferences
  231.  
  232. ### Theme
  233. - **Dark Theme**: Optimized for EEG analysis (default)
  234. - **High Contrast**: Enhanced visibility for professional use
  235. - **Custom Colors**: Adjustable interface colors
  236.  
  237. ### Performance
  238. - **Capture Quality**: Adjustable for performance vs. quality
  239. - **Update Rate**: Configurable live capture refresh rate
  240. - **Memory Management**: Automatic cleanup of old captures
  241.  
  242. ### Session Management
  243. - **Auto-save**: Settings and overlays saved automatically
  244. - **Session Restore**: Previous state restored on startup
  245. - **Position Memory**: Window position and size remembered
  246.  
  247. ---
  248.  
  249. ## Troubleshooting
  250.  
  251. ### Common Issues
  252.  
  253. #### Application Won't Start
  254. - **Check Python Installation**: Ensure Python 3.7+ is installed
  255. - **Install Dependencies**: Run `pip install -r requirements.txt`
  256. - **Check Permissions**: Ensure write access to the application directory
  257.  
  258. #### Live Capture Not Working
  259. - **Check Dependencies**: Ensure `mss` or `Pillow` is installed
  260. - **Monitor Detection**: Verify monitor configuration
  261. - **Window Permissions**: Some applications may block capture
  262.  
  263. #### Analysis Tools Not Visible
  264. - **Enable Analysis Mode**: Click "Toggle Analysis Mode" button
  265. - **Check Zoom Level**: Tools may be hidden if zoomed out too far
  266. - **Refresh Display**: Try zooming in/out to refresh the view
  267.  
  268. #### Measurement Grid Issues
  269. - **Grid Not Visible**: Click "Toggle Measurement Grid" button
  270. - **Calibration Problems**: Reset calibration in the grid dialog
  271. - **Position Lost**: Grid position is saved automatically
  272.  
  273. #### Performance Issues
  274. - **Reduce Capture Quality**: Lower the capture resolution
  275. - **Close Other Applications**: Free up system resources
  276. - **Check Available Memory**: Ensure sufficient RAM
  277.  
  278. ### Getting Help
  279. - **Error Messages**: Check the console output for detailed error information
  280. - **Log Files**: Application logs are saved in the output directory
  281. - **Settings Reset**: Delete the settings file to restore defaults
  282.  
  283. ---
  284.  
  285. ## Professional Tips
  286.  
  287. ### EEG Analysis Workflow
  288. 1. **Load Your Data**: Open EEG images or PDFs
  289. 2. **Enable Analysis Mode**: Switch to professional tools
  290. 3. **Add Annotations**: Use notes, rulers, and ROIs to mark important features
  291. 4. **Use Measurement Grid**: For precise quantitative measurements
  292. 5. **Export Results**: Save your analysis with overlays
  293.  
  294. ### Best Practices
  295. - **Regular Saves**: Export your work frequently
  296. - **Organized Annotations**: Use consistent naming for your overlays
  297. - **Calibration**: Always calibrate the measurement grid for accurate readings
  298. - **Documentation**: Use notes to document your analysis process
  299.  
  300. ### Keyboard Efficiency
  301. - Learn the keyboard shortcuts for faster workflow
  302. - Use `Ctrl+Mouse Wheel` for quick zoom adjustments
  303. - Combine analysis tools with keyboard navigation
  304.  
  305. ---
  306.  
  307. ## Version Information
  308. - **Current Version**: 2.0 Professional Edition
  309. - **Last Updated**: 2024
  310. - **Compatibility**: Windows 10/11, Python 3.7+
  311. - **Dependencies**: PyQt5, OpenCV, PyMuPDF, mss/Pillow
  312.  
  313. For technical support or feature requests, please refer to the project documentation or contact the development team.
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement