v0.1.2

CaliBrain v0.1.2 – Major Refactor, Unit Consistency, new Inverse Solver and Evaluation Metrics

This release introduces a complete codebase refactor, improved physical unit handling, and an expanded evaluation framework. This version simplifies the API, improves simulation realism, and adds extensive tools for uncertainty and accuracy analysis.

---

Highlights

New Features

• Modular class-based architecture:
  • SourceSimulator, SensorSimulator, MetricEvaluator, Visualizer
• Added new evaluation metrics:
  • Uncertainty: mean_posterior_std
  • Calibration: mean_calibration_error, max_underconfidence_deviation, max_overconfidence_deviation, mean_absolute_deviation, mean_signed_deviation
  • Spatial Accuracy: emd, jaccard_error, mse
  • Detection Performance: euclidean_distance, f1, accuracy
• Integrated eLORETA as a distributed inverse solution
• Unit-aware plotting with auto-scaled labels for EEG, MEG, and source signals
• Comprehensive tutorials and example notebooks
• Fully restructured and expanded documentation

Improvements

• Refactored simulation pipeline for clarity and modularity
• Improved ERP waveform generation and parameter handling
• Leadfield projection now supports channel filtering and orientation types

Bug Fixes

• Resolved inconsistent unit usage across simulation pipeline (#18):
  • Converted source dipole values from nAm to Am
  • Standardized EEG/MEG output to SI units (V, T)
  • Visualizations now infer appropriate scale (e.g., microvolts, femtotesla)

What's Changed

• Feat: Integrate Real Subject Leadfields by @orabe in #9
• Enhance UncertaintyEstimator class by @orabe in #11
• Spatial cv by @AliHashemi-ai in #14
• All Metrics by @IsmailHuseynov in #13
• Implement Calibration and Uncertainty Metrics for Inverse Solver by @orabe in #15
• Implement Multiple Top-Level Seeds for Benchmark Generalization by @orabe in #16
• Add Alpha-SNR-Based Noise Model for Sensor Signal Simulation by @orabe in #17
• Major Refactor and Feature Expansion of CaliBrain Framework by @orabe in #19

Full Changelog: v0.1.1...v0.1.2