Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add multi-group curve analysis #824

Merged
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions qiskit_experiments/curve_analysis/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -467,6 +467,7 @@ def _create_analysis_results(self, fit_data, quality, **metadata):

BaseCurveAnalysis
CurveAnalysis
MultiGroupCurveAnalysis

Data Classes
============
Expand Down Expand Up @@ -548,6 +549,7 @@ def _create_analysis_results(self, fit_data, quality, **metadata):
"""
from .base_curve_analysis import BaseCurveAnalysis
from .curve_analysis import CurveAnalysis
from .grouped_curve_analysis import MultiGroupCurveAnalysis
from .curve_data import (
CurveData,
CurveFitResult,
Expand Down
10 changes: 6 additions & 4 deletions qiskit_experiments/curve_analysis/base_curve_analysis.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,8 @@ class BaseCurveAnalysis(BaseAnalysis, ABC):

.. rubric:: _create_analysis_results

This method to creates analysis results for important fit parameters
This method creates analysis results for important fit parameters
that might be defined by analysis options ``result_parameters``.
In addition, another entry for all fit parameters is created when
the analysis option ``return_fit_parameters`` is ``True``.

.. rubric:: _create_curve_data

Expand Down Expand Up @@ -391,13 +389,16 @@ def _run_curve_fit(
self,
curve_data: CurveData,
models: List[lmfit.Model],
init_guesses: Dict[str, float],
) -> CurveFitResult:
"""Perform curve fitting on given data collection and fit models.

Args:
curve_data: Formatted data to fit.
models: A list of LMFIT models that are used to build a cost function
for the LMFIT minimizer.
init_guesses: Dictionary of fit parameter initial guesses keyed on the
fit parameter name.

Returns:
The best fitting outcome with minimum reduced chi-squared value.
Expand All @@ -419,10 +420,11 @@ def _run_curve_fit(

default_fit_opt = FitOptions(
parameters=unite_parameter_names,
default_p0=self.options.p0,
default_p0=init_guesses,
default_bounds=self.options.bounds,
**self.options.lmfit_options,
)

# Bind fixed parameters if not empty
if self.options.fixed_parameters:
fixed_parameters = {
Expand Down
7 changes: 4 additions & 3 deletions qiskit_experiments/curve_analysis/curve_analysis.py
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,7 @@ def _run_analysis(
fit_data = self._run_curve_fit(
curve_data=formatted_data,
models=self._models,
init_guesses=self.options.p0,
)

if fit_data.success:
Expand All @@ -201,15 +202,15 @@ def _run_analysis(
quality = "bad"

if self.options.return_fit_parameters:
# Store fit status entry regardless of success.
# Store fit status overview entry regardless of success.
# This is sometime useful when debugging the fitting code.
fit_parameters = AnalysisResultData(
overview = AnalysisResultData(
name=PARAMS_ENTRY_PREFIX + self.__class__.__name__,
value=fit_data,
quality=quality,
extra=self.options.extra,
)
analysis_results.append(fit_parameters)
analysis_results.append(overview)

# Create figure and result data
if fit_data.success:
Expand Down
Loading