MouseCalibrationSession

MouseCalibrationSession(
    win,
    infant_stims,
    mouse,
    audio=None,
    anim_type='zoom',
    visualization_style='lines',
    verbose=True,
)

Mouse-based calibration session for simulation mode.

This class provides a calibration interface for testing and development when no physical eye tracker is available. It simulates the calibration process using mouse position as a proxy for gaze, allowing experimenters to test calibration procedures and develop experiments without hardware.

The mouse calibration follows the same interaction pattern as Tobii calibration, collecting position samples at each calibration target and visualizing the results. This ensures consistent user experience between simulation and real data collection modes.

Methods

Name	Description
run	Main function to run the mouse-based calibration routine.

run

MouseCalibrationSession.run(calibration_points)

Main function to run the mouse-based calibration routine.

Executes the complete calibration workflow using mouse position as a proxy for gaze data. Follows the same interaction pattern as Tobii calibration to ensure consistency across modes.

Parameters

Name	Type	Description	Default
calibration_points	list of (float, float)	List of calibration points in NORMALIZED coordinates [-1, 1]. Will be converted to window units automatically.	required

Returns

Name	Type	Description
	bool	True if calibration finished successfully and was accepted by user, False if the user exits early via escape key.

# MouseCalibrationSession { #DeToX.MouseCalibrationSession }

```python
MouseCalibrationSession(
    win,
    infant_stims,
    mouse,
    audio=None,
    anim_type='zoom',
    visualization_style='lines',
    verbose=True,
)
```

Mouse-based calibration session for simulation mode.

This class provides a calibration interface for testing and development when
no physical eye tracker is available. It simulates the calibration process
using mouse position as a proxy for gaze, allowing experimenters to test
calibration procedures and develop experiments without hardware.

The mouse calibration follows the same interaction pattern as Tobii calibration,
collecting position samples at each calibration target and visualizing the
results. This ensures consistent user experience between simulation and real
data collection modes.

## Methods

| Name | Description |
| --- | --- |
| [run](#DeToX.MouseCalibrationSession.run) | Main function to run the mouse-based calibration routine. |

### run { #DeToX.MouseCalibrationSession.run }

```python
MouseCalibrationSession.run(calibration_points)
```

Main function to run the mouse-based calibration routine.

Executes the complete calibration workflow using mouse position as a
proxy for gaze data. Follows the same interaction pattern as Tobii
calibration to ensure consistency across modes.

#### Parameters {.doc-section .doc-section-parameters}

| Name               | Type                   | Description                                                                                                    | Default    |
|--------------------|------------------------|----------------------------------------------------------------------------------------------------------------|------------|
| calibration_points | list of (float, float) | List of calibration points in NORMALIZED coordinates [-1, 1]. Will be converted to window units automatically. | _required_ |

#### Returns {.doc-section .doc-section-returns}

| Name   | Type           | Description                                                                                                       |
|--------|----------------|-------------------------------------------------------------------------------------------------------------------|
|        | [bool](`bool`) | True if calibration finished successfully and was accepted by user, False if the user exits early via escape key. |