quara.simulation.standard_qtomography_simulation_report module

export_report(path, simulation_results, keep_tmp_files=False, display_items=None)[source]

Output a PDF report with simulation settings and results.

Parameters
  • path (str) – pdf file path.

  • estimation_results_list (List[List[) – List containing a list of estimated results for each simulation.

  • simulation_settings (List[StandardQTomographySimulationSetting]) – Settings for each simulation.

  • check_results (List[CheckResult]) – CheckResults for each simulation. If SimulationCheck has already been executed, giving the result to this argument will reduce the processing time to generate the report. If not specified, SimulationCheck will be executed during report generation. See the documentation for the StandardQTomographySimulationCheck class to see what SimulationCheck does.

  • keep_tmp_files (bool, optional) – [description], by default False

  • show_physicality_violation_check (bool, optional) – [description], by default True

  • simulation_results (List[quara.simulation.standard_qtomography_simulation.SimulationResult]) –

  • display_items (Optional[dict]) –

export_report_from_index(input_root_dir, test_setting_index, sample_index, output_path, case_index=None, display_items=None)[source]
Parameters
  • input_root_dir (str) –

  • test_setting_index (int) –

  • sample_index (int) –

  • output_path (str) –

  • case_index (Optional[int]) –

  • display_items (Optional[dict]) –

Return type

None

generate_case_table(case_name_list, qtomography_list, estimator_list)[source]
Parameters
  • case_name_list (List[str]) –

  • qtomography_list (List[QTomography]) –

  • estimator_list (List[Estimator]) –

generate_computation_time_of_estimators_div(estimation_results_list, simulation_settings)[source]
Parameters
Return type

str

generate_computation_time_of_estimators_graph(estimation_results_list, simulation_settings)[source]
Parameters
Return type

str

generate_computation_time_of_estimators_table(estimation_results_list, simulation_settings, unit='sec')[source]
Parameters

unit (str) –

Return type

str

generate_computation_time_table(estimation_results_list)[source]
Parameters

estimation_results_list (List[List[quara.protocol.qtomography.estimator.EstimationResult]]) –

Return type

pandas.core.frame.DataFrame

generate_condition_table(qtomography_list, n_rep, num_data, seed)[source]
Parameters
  • qtomography_list (List[QTomography]) –

  • n_rep (int) –

  • num_data (List[int]) –

  • seed (Optional[int]) –

Return type

str

generate_consistency_check_table(simulation_results)[source]
Parameters

simulation_results (List[quara.simulation.standard_qtomography_simulation.SimulationResult]) –

generate_eigenvalues_div(estimation_results, num_data, case_id, true_object)[source]
Parameters
generate_empi_dist_mse_div(simulation_result, true_object)[source]
Parameters
Return type

str

generate_fig_list_list_div(estimation_results, num_data, case_id, fig_type, make_graphs_func, col_n=2, **kwargs)[source]
Parameters
generate_figs_div(func, **kwargs)[source]
generate_mse_analytical_div(estimation_results_list, true_object, estimator_list, num_data, qtomography_list)[source]
Parameters
Return type

str

generate_physicality_violation_test_div(estimation_results_list, case_name_list, true_object, num_data)[source]
Parameters
  • estimation_results_list (List[List[EstimationResult]]) –

  • case_name_list (List[str]) –

  • true_object (QOperation) –

  • num_data (List[int]) –

generate_sum_eigenvalues_div(estimation_results, num_data, case_id, true_object)[source]
Parameters
generate_sum_vecs_div(estimation_results, num_data, case_id, true_object, col_n)[source]
Parameters
generate_tolerance_table_div()[source]
Return type

pandas.core.frame.DataFrame

generate_trace_div(estimation_results, num_data, case_id)[source]
Parameters
setup_display_items(display_items)[source]
Parameters

display_items (dict) –

Return type

dict