clean up

Author: pellet

eegnb/experiments/BlockExperiment.py

@@ -15,15 +15,15 @@
 
 class BlockExperiment(BaseExperiment, ABC):
     """
-    Extended experiment class that inherits from BaseExperiment to provide block-based functionality.
+    Inherits from BaseExperiment to provide block-based functionality.
     
-    This class is designed for experiments that need to run multiple blocks, with each block
-    having its own instructions and duration. It loads stimulus only once and reuses it across blocks.
+    This class is designed for experiments that need to run as multiple blocks.
+    Each block has its own instructions and duration. It loads all stimuli at once, then re/uses it across blocks.
     """
 
     def __init__(self, exp_name, block_duration, eeg, save_fn, block_trial_size, n_blocks, iti: float, soa: float, jitter: float,
                  use_vr=False, use_fullscr=True, stereoscopic=False):
-        """ Initializer for the Block Experiment Class
+        """ Initializer for the BlockExperiment Class
 
         Args:
             exp_name (str): Name of the experiment
@@ -41,11 +41,11 @@ def __init__(self, exp_name, block_duration, eeg, save_fn, block_trial_size, n_b
         # Calculate total trials for the base class
         total_trials = block_trial_size * n_blocks
 
-        # Initialize the base experiment with total trials
+        # Initialize BaseExperiment with total trials
         # Pass None for duration if block_duration is None to ignore time spent in instructions
         super().__init__(exp_name, block_duration, eeg, save_fn, total_trials, iti, soa, jitter, use_vr, use_fullscr, stereoscopic)
 
-        # Store block-specific parameters
+        # Block-specific parameters
         self.block_duration = block_duration
         self.block_trial_size = block_trial_size
         self.n_blocks = n_blocks

eegnb/experiments/visual_vep/pattern_reversal_vep.py

@@ -69,8 +69,9 @@ def create_vr_checkerboard(intensity_checks):
 
     def load_stimulus(self) -> Dict[str, Any]:
         # Frame rate, in Hz
-        # GetActualFrameRate() crashes in psychxr due to 'EndFrame called before BeginFrame'
+        # TODO: Fix - Rift.GetActualFrameRate() crashes in psychxr due to 'EndFrame called before BeginFrame'
         actual_frame_rate = np.round(self.window.displayRefreshRate if self.use_vr else self.window.getActualFrameRate())
+
         # Ensure the expected frame rate matches and is divisable by the stimulus rate(soa)
         assert actual_frame_rate % self.soa == 0, f"Expected frame rate divisable by stimulus rate: {self.soa}, but got {actual_frame_rate} Hz"
         assert self.display_refresh_rate == actual_frame_rate, f"Expected frame rate {self.display_refresh_rate} Hz, but got {actual_frame_rate} Hz"