API Reference#

This page documents the public API exposed by calibrain and the workflow entrypoints used by the current pipeline. Internal helpers are intentionally not listed here unless they define a stable data contract.

Top-level public API#

`LeadfieldBuilder`	Simulates leadfield matrices based on a configuration dictionary.
`SourceSimulator`	Simulate synthetic source coefficients for three settings:
`SensorSimulator`	Simulates synthetic sensor-level measurements from source-level activity.
`SourceEstimator`
`UncertaintyEstimator`	Uncertainty estimator for fixed- and free-orientation source estimates.
`UncertaintyCalibrator`	Uncertainty Calibrator
`MetricEvaluator`	Evaluator aligned with the updated UncertaintyEstimator.
`Visualizer`
`DataGenerator`
`gamma_map_sflex`
`gamma_lambda_map_sflex`	Unified sFLEX + gamma-lambda MAP.
`BMN`	BMN estimate with optional sLORETA normalization.
`BMN_joint`	BMN estimate with optional sLORETA normalization and optional adaptive common-noise learning.

Top-level public API

Workflow entrypoints#

`workflows.data_generation.run_data_generation`
`workflows.aggregation.aggregate_posteriors`
`workflows.calibration.run_calibration`
`workflows.calibration.build_uncertainty_components`
`workflows.plot_paper_calibration_figures.main`

Workflow entrypoints

Data model helpers#

`run_manifest.ManifestRow`	Typed view of a single manifest CSV row.
`run_manifest.load_manifest_csv`
`run_manifest.summaries_from_manifest`
`calibration_dataset.PosteriorSummary`	Container describing a saved posterior summary file and metadata.
`calibration_dataset.load_posterior_summary`	Load a single posterior summary file produced by the data-generation workflow.
`calibration_dataset.filter_summaries_by_metadata`
`calibration_dataset.concatenate_summaries`
`calibration_storage.save_calibration_record`	Persist calibration payload alongside metadata in JSON format.
`calibration_storage.load_calibration_record`
`calibration_storage.iter_calibration_records`
`calibration_storage.stack_empirical_curves`

Data model helpers

Metric and utility helpers#

`metric_evaluation.get_subset_source_rr`	Get subset-aligned source coordinates for EMD and other source-space metrics.
`uncertainty_estimation.lift_reduced_sources_to_3d`	Lift reduced coordinates back to the retained local 3D source basis.
`utils.get_data_path`	Get the path to CaliBrain data directory.
`utils.load_config`	Load the configuration from a YAML file.
`utils.load_python_config`	Execute a Python config file and return its CONFIG dict.

Metric and utility helpers