pygsti.reportΒΆ

Gate Set Tomography Reporting Python Package

Functions

besttxtcolor(x, cmap, norm) Determinining function for whether text should be white or black
blank_boxplot(xvals, yvals, ...[, xlabel, ...]) Create only the outline of a color box plot.
chi2_boxplot(xvals, yvals, ...[, xlabel, ...]) Create a color box plot of chi^2 values.
chi2_matrix(gateString, dataset, gateset, strs) Computes the chi^2 matrix for a base gatestring.
choi_eigenvalue_barplot(evals[, errbars, ...]) Creates a bar plot showing the real parts of each of the eigenvalues given.
color_boxplot(plt_data, cmapFactory[, ...]) Create a color box plot.
compute_dataset_qty(qtyname, dataset[, ...]) Compute the named “Dataset” quantity.
compute_dataset_qtys(qtynames, dataset[, ...]) Compute the named “Dataset” quantities.
compute_gateset_dataset_qty(qtyname, ...[, ...]) Compute the named “GateSet & Dataset” quantity.
compute_gateset_dataset_qtys(qtynames, ...) Compute the named “GateSet & Dataset” quantities.
compute_gateset_gateset_qty(qtyname, ...[, ...]) Compute the named “GateSet vs.
compute_gateset_gateset_qtys(qtynames, ...) Compute the named “GateSet vs.
compute_gateset_qty(qtyname, gateset[, ...]) Compute the named “GateSet” quantity.
compute_gateset_qtys(qtynames, gateset[, ...]) Compute the named “GateSet” quantities.
count_matrix(gateString, dataset, spamlabel, ...) Computes spamLabel’s count matrix for a base gatestring.
direct2x_comp_boxplot(xvals, yvals, ...[, ...]) Create a box plot indicating how well the Direct-X estimates of string s
direct_chi2_boxplot(xvals, yvals, ...[, ...]) Create a color box plot of Direct-X chi^2 values.
direct_chi2_matrix(sigma, dataset, ...[, ...]) Computes the Direct-X chi^2 matrix for a base gatestring sigma.
direct_deviation_boxplot(xvals, yvals, ...) Create a box plot showing the difference in max-fidelity-with-unitary between gateset’s estimate for each base gate string and the Direct-X estimate.
direct_lgst_gateset(gateStringToEstimate, ...) Constructs a gateset of LGST estimates for target gates and gateStringToEstimate.
direct_lgst_gatesets(gateStrings, dataset, ...) Constructs a dictionary with keys == gate strings and values == Direct-LGST GateSets.
direct_logl_boxplot(xvals, yvals, ...[, ...]) Create a color box plot of Direct-X log-likelihood values.
direct_logl_matrix(sigma, dataset, ...[, ...]) Computes the Direct-X log-likelihood matrix, containing the values of 2*( log(L)_upperbound - log(L) ) for a base gatestring sigma.
direct_mc2gst_gateset(gateStringToEstimate, ...) Constructs a gateset of LSGST estimates for target gates and gateStringToEstimate.
direct_mc2gst_gatesets(gateStrings, dataset, ...) Constructs a dictionary with keys == gate strings and values == Direct-LSGST GateSets.
direct_mlgst_gateset(gateStringToEstimate, ...) Constructs a gateset of MLEGST estimates for target gates and gateStringToEstimate.
direct_mlgst_gatesets(gateStrings, dataset, ...) Constructs a dictionary with keys == gate strings and values == Direct-MLEGST GateSets.
focused_mc2gst_gateset(gateStringToEstimate, ...) Constructs a gateset containing a single LSGST estimate of gateStringToEstimate.
focused_mc2gst_gatesets(gateStrings, ...[, ...]) Constructs a dictionary with keys == gate strings and values == Focused-LSGST GateSets.
frequency_matrix(gateString, dataset, ...[, ...]) Computes spamLabel’s frequency matrix for a base gatestring.
gate_matrix_boxplot(gateMatrix[, size, m, ...]) Creates a color box plot of a gate matrix using a diverging color map.
gate_matrix_errgen_boxplot(gateMatrix, ...) Creates a color box plot of a the error generator of a gate matrix.
gateset_with_lgst_gatestring_estimates(...) Constructs a gateset that contains LGST estimates for gateStringsToEstimate.
generate_boxplot(xvals, yvals, ...[, ...]) Creates a view of nested box plot data (i.e.
get_blank_table() Create a blank table as a placeholder.
get_chi2_confidence_region(gateset, dataset, ...) Constructs a ConfidenceRegion given a gateset and dataset using the Chi2 Hessian.
get_chi2_progress_table(Ls, gatesetsByL, ...) Create a table showing how Chi2 changes with GST iteration.
get_dataset_overview_table(dataset, target) Create a table overviewing a data set.
get_gates_vs_target_angles_table(gateset, ...) Create a table comparing a gateset to a target gateset.
get_gates_vs_target_err_gen_boxes_table(...) Create a table of gate error generators, where each is shown as grid of boxes.
get_gates_vs_target_err_gen_table(gateset, ...) Create a table listing the error generators obtained by comparing a gateset’s gates to a target gateset.
get_gates_vs_target_table(gateset, targetGateset) Create a table comparing a gateset’s gates to a target gateset.
get_gateset_choi_eigenval_table(gateset, ...) Create a table for the Choi matrices of a gateset’s gates.
get_gateset_choi_table(gateset[, ...]) Create a table for the Choi matrices of a gateset’s gates.
get_gateset_closest_unitary_table(gateset[, ...]) Create a table for gateset that contains closest-unitary gates.
get_gateset_decomp_table(gateset[, ...]) Create table for decomposing a gateset’s gates.
get_gateset_eigenval_table(gateset, ...[, ...]) Create table which lists and plots the eigenvalues of a gateset’s gates.
get_gateset_gate_boxes_table(gateset, ...[, ...]) Create a table for a gateset’s gates, where each gate is a grid of boxes.
get_gateset_gates_table(gateset[, ...]) Create a table for gateset’s gates.
get_gateset_relative_eigenval_table(gateset, ...) Create table which lists and plots the relative eigenvalues of a gateset’s gates.
get_gateset_rotn_axis_table(gateset[, ...]) Create a table of the angle between a gate rotation axes for
get_gateset_spam_parameters_table(gateset[, ...]) Create a table for gateset’s “SPAM parameters”, that is, the dot products of prep-vectors and effect-vectors.
get_gateset_spam_table(gateset[, ...]) Create a table for gateset’s SPAM vectors.
get_gatestring_multi_table(gsLists, titles) Creates an N-column table enumerating a N-1 lists of gate strings.
get_gatestring_table(gsList, title[, nCols]) Creates a 2*nCols-column table enumerating a list of gate strings.
get_gaugeopt_params_table(gaugeOptArgs) Create a table displaying a list of gauge optimzation parameters.
get_logl_confidence_region(gateset, dataset, ...) Constructs a ConfidenceRegion given a gateset and dataset using the log-likelihood Hessian.
get_logl_progress_table(Ls, gatesetsByL, ...) Create a table showing how the log-likelihood changes with GST iteration.
get_spam_vs_target_table(gateset, targetGateset) Create a table comparing a gateset’s SPAM operations to a target gateset.
get_transition(N[, eps]) Computes the transition point for the LinLogNorm class.
get_unitary_gateset_gates_table(gateset[, ...]) Create a table for gateset’s gates assuming they’re unitary.
gof_boxplot_keyplot(strs[, xlabel, ylabel, ...]) Create a color box plot of chi^2 values.
logl_boxplot(xvals, yvals, ...[, xlabel, ...]) Create a color box plot of log-likelihood values.
logl_matrix(gateString, dataset, gateset, strs) Computes the log-likelihood matrix of 2*( log(L)_upperbound - log(L) ) values for a base gatestring.
make_linear_cmap(start_color, final_color[, ...]) Make a color map that simply linearly interpolates between a start color and final color in RGB(A) space.
nested_color_boxplot(plt_data_list_of_lists, ...) Create a color box plot.
pauliprod_hamiltonian_boxplot(gate, targetGate) Creates a color box plot showing the projection of the error generator of gateMatrix onto each of the Pauli or Pauli-product Hamiltonian generators.
polar_eigenval_plot(gate, targetGate[, ...]) Creates a color box plot of a the error generator of a gate matrix.
probability_matrix(gateString, gateset, ...) Computes spamLabel’s probability matrix for a base gatestring.
small_eigval_err_rate(sigma, dataset, ...) Compute per-gate error rate.
small_eigval_err_rate_boxplot(xvals, yvals, ...) Create a color box plot of per-gate error rates.
splice_cmaps(cmaps[, name, splice_points]) Take a list of cmaps and create a new cmap that joins them at specified points.
total_count_matrix(gateString, dataset, strs) Computes the total count matrix for a base gatestring.
whack_a_chi2_mole_boxplot(gatestringToWhack, ...) Create a box plot indicating how the chi^2 would change if the chi^2 of one base gate string blocks were forced to be smaller (“whacked”).
whack_a_logl_mole_boxplot(gatestringToWhack, ...) Create a box plot indicating how the log-likelihood would change if the log(L) of one base gate string blocks were forced to be smaller (“whacked”).

Classes

LinLogNorm([trans, vmin, vmax, clip])
MidPointNorm([midpoint, vmin, vmax, clip]) A class for normalizing data which takes on positive and negative values.
ReportableQty(value[, errbar]) Encapsulates a computed quantity and possibly its error bars, primarily for use in reports.
Results([templatePath, latexCmd]) Encapsulates a set of GST results.
StdColormapFactory(kind[, vmin, vmax, ...]) Class used to create a standard GST colormap.