API Reference
=============

.. toctree::
   :maxdepth: 2
   :hidden:

   benchmark/Benchmark
   source_simulation/SourceSimulator
   leadfield_builder/LeadfieldBuilder
   sensor_simulation/SensorSimulator
   source_estimation/SourceEstimator
   uncertainty_estimation/UncertaintyEstimator
   metric_evaluation/MetricEvaluator
   visualization/Visualizer
   utils/utils

This section provides the auto-generated API documentation for the CaliBrain library.

Source Simulation
-----------------

.. automodule:: calibrain.source_simulation
   :members:
   :undoc-members:
   :show-inheritance:

Leadfield Simulation
--------------------

.. automodule:: calibrain.leadfield_builder
   :members:
   :undoc-members:
   :show-inheritance:

Sensor Simulation
-----------------

.. automodule:: calibrain.sensor_simulation
   :members:
   :undoc-members:
   :show-inheritance:

Source Estimation
------------------

.. automodule:: calibrain.source_estimation
   :members:
   :undoc-members:
   :show-inheritance:

Uncertainty Estimation
----------------------

.. automodule:: calibrain.uncertainty_estimation
   :members:
   :undoc-members:
   :show-inheritance:

Metric Evaluation
-----------------

.. automodule:: calibrain.metric_evaluation
   :members:
   :undoc-members:
   :show-inheritance:

Visualization
-------------

.. automodule:: calibrain.visualization
   :members:
   :undoc-members:
   :show-inheritance:

Utilities
---------

.. automodule:: calibrain.utils
   :members:
   :undoc-members:
   :show-inheritance:

Benchmarking
----------------

.. automodule:: calibrain.benchmark
   :members:
   :undoc-members: