Rework option handling in base classes

* Reworks how experiment, transpiler, backend/run, and analysis options are handled in the base classes to make it similar to how options are used by qiskit backends.

* Removes transpiled_circuits method. Transpiled circuits can now be obtained via `transpile(expr.circuits(backend), backend, **expr.transpile_options)`

Author: chriseclectic

qiskit_experiments/base_analysis.py

@@ -15,7 +15,9 @@
 
 from abc import ABC, abstractmethod
 from typing import List, Tuple
+import copy
 
+from qiskit.providers.options import Options
 from qiskit.exceptions import QiskitError
 
 from .experiment_data import ExperimentData, AnalysisResult
@@ -27,23 +29,51 @@ class BaseAnalysis(ABC):
     # Expected experiment data container for analysis
     __experiment_data__ = ExperimentData
 
-    def run(
-        self,
-        experiment_data: ExperimentData,
-        save: bool = True,
-        return_figures: bool = False,
-        **options,
-    ):
+    def __init__(self, **options):
+        """Initialize a base analysis class
+
+        Args:
+            options: kwarg options for analysis.
+        """
+        self._options = self._default_options()
+        self.set_options(**options)
+
+    @classmethod
+    def _default_options(cls) -> Options:
+        return Options()
+
+    def set_options(self, **fields):
+        """Set the analysis options.
+
+        Args:
+            fields: The fields to update the options
+        """
+        self._options.update_options(**fields)
+
+    @property
+    def options(self) -> Options:
+        """Return the analysis options.
+
+        The options of an analysis class are used to provide kwarg values for
+        the :meth:`run` method.
+        """
+        return self._options
+
+    def run(self,
+            experiment_data: ExperimentData,
+            save: bool = True,
+            return_figures: bool = False,
+            **options):
         """Run analysis and update stored ExperimentData with analysis result.
 
         Args:
             experiment_data: the experiment data to analyze.
             save: if True save analysis results and figures to the
                   :class:`ExperimentData`.
-            return_figures: if true return a pair of
-                            ``(analysis_results, figures)``,
+            return_figures: if true return a pair of ``(analysis_results, figures)``,
                             otherwise return only analysis_results.
-            options: kwarg options for analysis function.
+            options: additional analysis options. Any values set here will
+                     override the value from :meth:`options` for the current run.
 
         Returns:
             AnalysisResult: the output of the analysis that produces a
@@ -63,13 +93,19 @@ def run(
                 f"Invalid experiment data type, expected {self.__experiment_data__.__name__}"
                 f" but received {type(experiment_data).__name__}"
             )
+
+        # Get runtime analysis options
+        analysis_options = copy.copy(self.options)
+        analysis_options.update_options(**options)
+        analysis_options = analysis_options.__dict__
+
         # Run analysis
         # pylint: disable=broad-except
         try:
-            analysis_results, figures = self._run_analysis(experiment_data, **options)
+            analysis_results, figures = self._run_analysis(experiment_data, **analysis_options)
             analysis_results["success"] = True
-        except Exception:
-            analysis_results = AnalysisResult(success=False)
+        except Exception as ex:
+            analysis_results = AnalysisResult(success=False, error_message=ex)
             figures = None
 
         # Save to experiment data
@@ -88,18 +124,19 @@ def run(
 
     @abstractmethod
     def _run_analysis(
-        self, data: ExperimentData, **options
+        self, experiment_data: ExperimentData, **options
     ) -> Tuple[List[AnalysisResult], List["Figure"]]:
         """Run analysis on circuit data.
 
         Args:
             experiment_data: the experiment data to analyze.
-            options: kwarg options for analysis function.
+            options: additional options for analysis. By default the fields and
+                     values in :meth:`options` are used and any provided values
+                     can override these.
 
         Returns:
-            tuple: A pair ``(analysis_results, figures)`` where
-                   ``analysis_results`` may be a single or list of
-                   AnalysisResult objects, and ``figures`` is a list of any
-                   figures for the experiment.
+            A pair ``(analysis_results, figures)`` where ``analysis_results``
+            may be a single or list of AnalysisResult objects, and ``figures``
+            is a list of any figures for the experiment.
         """
         pass