scnc
/
qiskit-documentation
mirror of https://github.com/Qiskit/documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
qiskit-documentation/docs/api/qiskit/0.26/qiskit.ignis.characterizati...

236 lines
9.6 KiB
Plaintext
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: AmpCalFitter
description: API reference for qiskit.ignis.characterization.AmpCalFitter
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.ignis.characterization.AmpCalFitter
---
# qiskit.ignis.characterization.AmpCalFitter
<Class id="qiskit.ignis.characterization.AmpCalFitter" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/characterization/gates/fitters.py" signature="AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)" modifiers="class">
Amplitude error fitter
See BaseFitter \_\_init\_\_
### \_\_init\_\_
<Function id="qiskit.ignis.characterization.AmpCalFitter.__init__" signature="__init__(backend_result, xdata, qubits, fit_p0, fit_bounds)">
See BaseFitter \_\_init\_\_
</Function>
## Methods
| | |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
| [`__init__`](#qiskit.ignis.characterization.AmpCalFitter.__init__ "qiskit.ignis.characterization.AmpCalFitter.__init__")(backend\_result, xdata, qubits, …) | See BaseFitter \_\_init\_\_ |
| [`add_data`](#qiskit.ignis.characterization.AmpCalFitter.add_data "qiskit.ignis.characterization.AmpCalFitter.add_data")(results\[, recalc, refit]) | Add new execution results to previous execution results |
| [`angle_err`](#qiskit.ignis.characterization.AmpCalFitter.angle_err "qiskit.ignis.characterization.AmpCalFitter.angle_err")(\[qind]) | Return the gate angle error |
| [`fit_data`](#qiskit.ignis.characterization.AmpCalFitter.fit_data "qiskit.ignis.characterization.AmpCalFitter.fit_data")(\[qid, p0, bounds, series]) | Fit the curve. |
| [`guess_params`](#qiskit.ignis.characterization.AmpCalFitter.guess_params "qiskit.ignis.characterization.AmpCalFitter.guess_params")(\[qind]) | Guess fit parameters for the amp cal |
| [`plot`](#qiskit.ignis.characterization.AmpCalFitter.plot "qiskit.ignis.characterization.AmpCalFitter.plot")(qind\[, series, ax, show\_plot]) | Plot err data. |
## Attributes
| | |
| --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| [`backend_result`](#qiskit.ignis.characterization.AmpCalFitter.backend_result "qiskit.ignis.characterization.AmpCalFitter.backend_result") | Return the execution results |
| [`description`](#qiskit.ignis.characterization.AmpCalFitter.description "qiskit.ignis.characterization.AmpCalFitter.description") | Return the fitter’s purpose, e.g. |
| [`fit_fun`](#qiskit.ignis.characterization.AmpCalFitter.fit_fun "qiskit.ignis.characterization.AmpCalFitter.fit_fun") | Return the function used in the fit, e.g. |
| [`measured_qubits`](#qiskit.ignis.characterization.AmpCalFitter.measured_qubits "qiskit.ignis.characterization.AmpCalFitter.measured_qubits") | Return the indices of the qubits to be characterized |
| [`params`](#qiskit.ignis.characterization.AmpCalFitter.params "qiskit.ignis.characterization.AmpCalFitter.params") | Return the fit function parameters that were calculated by curve\_fit |
| [`params_err`](#qiskit.ignis.characterization.AmpCalFitter.params_err "qiskit.ignis.characterization.AmpCalFitter.params_err") | Return the error of the fit function parameters |
| [`series`](#qiskit.ignis.characterization.AmpCalFitter.series "qiskit.ignis.characterization.AmpCalFitter.series") | Return the list of series for the data |
| [`xdata`](#qiskit.ignis.characterization.AmpCalFitter.xdata "qiskit.ignis.characterization.AmpCalFitter.xdata") | Return the data points on the x-axis, the independenet parameter which is fit against |
| [`ydata`](#qiskit.ignis.characterization.AmpCalFitter.ydata "qiskit.ignis.characterization.AmpCalFitter.ydata") | Return the data points on the y-axis |
### add\_data
<Function id="qiskit.ignis.characterization.AmpCalFitter.add_data" signature="add_data(results, recalc=True, refit=True)">
Add new execution results to previous execution results
**Parameters**
* **results** (`Union`\[`Result`, `List`\[`Result`]]) – new execution results
* **recalc** (`bool`) – whether tp recalculate the data
* **refit** (`bool`) – whether to refit the data
</Function>
### angle\_err
<Function id="qiskit.ignis.characterization.AmpCalFitter.angle_err" signature="angle_err(qind=- 1)">
Return the gate angle error
**Parameters**
**qind** (*int*) – qubit index to return (-1 return all)
**Returns**
a list of errors
**Return type**
list
</Function>
### backend\_result
<Attribute id="qiskit.ignis.characterization.AmpCalFitter.backend_result">
Return the execution results
**Return type**
`Union`\[`Result`, `List`\[`Result`]]
</Attribute>
### description
<Attribute id="qiskit.ignis.characterization.AmpCalFitter.description">
Return the fitter’s purpose, e.g. ‘T1’
**Return type**
`str`
</Attribute>
### fit\_data
<Function id="qiskit.ignis.characterization.AmpCalFitter.fit_data" signature="fit_data(qid=- 1, p0=None, bounds=None, series=None)">
Fit the curve.
Compute self.\_params and self.\_params\_err
**Parameters**
* **qid** (`int`) – qubit for fitting. If -1 fit for all the qubits
* **p0** (`Optional`\[`List`\[`float`]]) – initial guess, equivalent to p0 in scipy.optimize
* **bounds** (`Optional`\[`Tuple`\[`List`\[`float`], `List`\[`float`]]]) – bounds, equivalent to bounds in scipy.optimize
* **series** (`Optional`\[`str`]) – series to fit (if None fit all)
</Function>
### fit\_fun
<Attribute id="qiskit.ignis.characterization.AmpCalFitter.fit_fun">
Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun
**Return type**
`Callable`
</Attribute>
### guess\_params
<Function id="qiskit.ignis.characterization.AmpCalFitter.guess_params" signature="guess_params(qind=0)">
Guess fit parameters for the amp cal
**Parameters**
**qind** (*int*) – qubit index to guess fit parameters for
**Returns**
List of fit guess parameters \[thetaerr, offset]
**Return type**
list
</Function>
### measured\_qubits
<Attribute id="qiskit.ignis.characterization.AmpCalFitter.measured_qubits">
Return the indices of the qubits to be characterized
**Return type**
`List`\[`int`]
</Attribute>
### params
<Attribute id="qiskit.ignis.characterization.AmpCalFitter.params">
Return the fit function parameters that were calculated by curve\_fit
**Return type**
`List`\[`float`]
</Attribute>
### params\_err
<Attribute id="qiskit.ignis.characterization.AmpCalFitter.params_err">
Return the error of the fit function parameters
**Return type**
`List`\[`float`]
</Attribute>
### plot
<Function id="qiskit.ignis.characterization.AmpCalFitter.plot" signature="plot(qind, series='0', ax=None, show_plot=False)">
Plot err data.
**Parameters**
* **qind** (*int*) – qubit index to plot
* **series** (*str*) – the series to plot
* **ax** (*Axes*) – plot axes
* **show\_plot** (*bool*) – call plt.show()
**Returns**
The axes object
**Return type**
Axes
**Raises**
**ImportError** – if matplotlib is not installed
</Function>
### series
<Attribute id="qiskit.ignis.characterization.AmpCalFitter.series">
Return the list of series for the data
**Return type**
`Optional`\[`List`\[`str`]]
</Attribute>
### xdata
<Attribute id="qiskit.ignis.characterization.AmpCalFitter.xdata">
Return the data points on the x-axis, the independenet parameter which is fit against
**Return type**
`Union`\[`List`\[`float`], `array`]
</Attribute>
### ydata
<Attribute id="qiskit.ignis.characterization.AmpCalFitter.ydata">
Return the data points on the y-axis
The data points are returning in the form of a list of dictionaries:
> * **ydata\[i]\[‘mean’] is a list, where item**
>
> no. j is the probability of success of qubit i for a circuit that lasts xdata\[j].
>
> * **ydata\[i]\[‘std’] is a list, where ydata\[‘std’]\[j] is the**
>
> standard deviation of the success of qubit i.
**Return type**
`List`\[`Dict`]
</Attribute>
</Class>
Reference in New Issue View Git Blame Copy Permalink