Skip to main content

Ctrl+K

You are viewing CaliBrain v1.0.0 documentation

CaliBrain

Installation
Documentation
API Reference
Development

GitHub

Installation
Documentation
API Reference
Development

GitHub

Section Navigation

calibrain.LeadfieldBuilder
calibrain.SourceSimulator
calibrain.SensorSimulator
calibrain.SourceEstimator
calibrain.UncertaintyEstimator
calibrain.UncertaintyCalibrator
calibrain.MetricEvaluator
calibrain.Visualizer
calibrain.DataGenerator
calibrain.gamma_map_sflex
calibrain.gamma_lambda_map_sflex
calibrain.BMN
calibrain.BMN_joint

Top-level public API

calibrain.LeadfieldBuilder
calibrain.SourceSimulator
calibrain.SensorSimulator
calibrain.SourceEstimator
calibrain.UncertaintyEstimator
calibrain.UncertaintyCalibrator
calibrain.MetricEvaluator
calibrain.Visualizer
calibrain.DataGenerator
calibrain.gamma_map_sflex
calibrain.gamma_lambda_map_sflex
calibrain.BMN
calibrain.BMN_joint

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

Workflow entrypoints

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

calibrain.run_manifest.ManifestRow
calibrain.run_manifest.load_manifest_csv
calibrain.run_manifest.summaries_from_manifest
calibrain.calibration_dataset.PosteriorSummary
calibrain.calibration_dataset.load_posterior_summary
calibrain.calibration_dataset.filter_summaries_by_metadata
calibrain.calibration_dataset.concatenate_summaries
calibrain.calibration_storage.save_calibration_record
calibrain.calibration_storage.load_calibration_record
calibrain.calibration_storage.iter_calibration_records
calibrain.calibration_storage.stack_empirical_curves

Data model helpers

calibrain.run_manifest.ManifestRow
calibrain.run_manifest.load_manifest_csv
calibrain.run_manifest.summaries_from_manifest
calibrain.calibration_dataset.PosteriorSummary
calibrain.calibration_dataset.load_posterior_summary
calibrain.calibration_dataset.filter_summaries_by_metadata
calibrain.calibration_dataset.concatenate_summaries
calibrain.calibration_storage.save_calibration_record
calibrain.calibration_storage.load_calibration_record
calibrain.calibration_storage.iter_calibration_records
calibrain.calibration_storage.stack_empirical_curves

calibrain.metric_evaluation.get_subset_source_rr
calibrain.uncertainty_estimation.lift_reduced_sources_to_3d
calibrain.utils.get_data_path
calibrain.utils.load_config
calibrain.utils.load_python_config

Metric and utility helpers

calibrain.metric_evaluation.get_subset_source_rr
calibrain.uncertainty_estimation.lift_reduced_sources_to_3d
calibrain.utils.get_data_path
calibrain.utils.load_config
calibrain.utils.load_python_config

API Reference
calibrain.workflows.calibration.run_calibration

calibrain.workflows.calibration.run_calibration#

calibrain.workflows.calibration.run_calibration(config)[source]#

Return type:: Path

previous

calibrain.workflows.aggregation.aggregate_posteriors

next

calibrain.workflows.calibration.build_uncertainty_components

On this page

run_calibration()

© Copyright 2025, Mohammad Orabe, Ismail Huseynov, Srikantan Nagarajan, Stefan Haufe.

Created using Sphinx 9.0.4.

Built with the PyData Sphinx Theme 0.17.1.