API tools faq
paste
Advertisement
El_Chaderino

EEG PARADOX VIEWER USER MANUAL

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