quara.simulation.standard_qtomography_simulation_flow module

execute_simulation_case_unit(test_setting, true_object, tester_objects, empi_dists_sequences, case_index, sample_index, test_setting_index, root_dir, exec_sim_check=None, n_jobs=1, data_saving='on_memory', is_computation_time_required=True, is_detailed_results_required=False)[source]
Parameters

  • case_index (int) –

  • sample_index (int) –

  • test_setting_index (int) –

  • root_dir (str) –

  • exec_sim_check (Optional[dict]) –

  • n_jobs (int) –

  • data_saving (str) –

  • is_computation_time_required (bool) –

  • is_detailed_results_required (bool) –

Return type

quara.simulation.standard_qtomography_simulation.SimulationResult

execute_simulation_sample_unit(test_setting, generation_settings, test_setting_index, sample_index, root_dir, pdf_mode='only_ng', stream_qoperation=None, exec_sim_check=None, parallel_mode=None, data_saving='on_memory', is_computation_time_required=True, is_detailed_results_required=False)[source]
Parameters

  • pdf_mode (str) –

  • stream_qoperation (Optional[Union[int, numpy.random._generator.Generator]]) –

  • exec_sim_check (Optional[Dict[str, bool]]) –

  • parallel_mode (Optional[Dict[str, int]]) –

  • data_saving (str) –

  • is_computation_time_required (bool) –

  • is_detailed_results_required (bool) –

Return type

List[quara.simulation.standard_qtomography_simulation.SimulationResult]

execute_simulation_test_setting_unit(test_setting, test_setting_index, root_dir, exec_sim_check=None, pdf_mode='only_ng', parallel_mode=None, data_saving='on_memory', is_computation_time_required=True, is_detailed_results_required=False)[source]
Parameters

  • exec_sim_check (Optional[Dict[str, bool]]) –

  • pdf_mode (str) –

  • parallel_mode (Optional[Dict[str, int]]) –

  • data_saving (str) –

  • is_computation_time_required (bool) –

  • is_detailed_results_required (bool) –

Return type

List[quara.simulation.standard_qtomography_simulation.SimulationResult]

execute_simulation_test_settings(test_settings, root_dir, pdf_mode='only_ng', exec_sim_check=None, parallel_mode=None, data_saving='on_memory', is_computation_time_required=True, is_detailed_results_required=False)[source]

Run a simulation by specifying multiple EstimationTestSettings.

Parameters

  • test_settings (List[EstimatorTestSetting]) – List of EstimationTestSetting

  • root_dir (str) – Root folder where the results will be saved.

  • pdf_mode (str, optional) – Settings for PDF reporting of simulation results, by default “only_ng”. “all”: output all. “only_ng”: output only if the result of the simulation check is NG. “none”: do not output

  • exec_sim_check (Dict[str, bool], optional) – Items to check for simulation results, by default None. The key of the dictionary is the name of the check item (“consistency”, “mse_of_estimators”, “mse_of_empi_dists”, “physicality_violation”), and the value is whether or not to check (True/False). This check uses StandardQTomographySimulationCheck.

  • parallel_mode (Dict[str, int], optional) – Parallelization settings, by default None. For this parallelization, joblib is used. The key of the dictionary is the type of process to parallelize (“per_sample_unit”, “per_data_generation”, “per_estimator_unit”, “per_estimator_execution”), and the value is the maximum number of concurrently running jobs. This is the same parameter as n_jobs in joblib.

  • data_saving (str) –

  • is_computation_time_required (bool) –

  • is_detailed_results_required (bool) –

Returns

List of simulation results

Return type

List[SimulationResult]

re_estimate_case_unit(input_root_dir, case_index, sample_index, test_setting_index, output_root_dir, test_setting=None, exec_sim_check=None)[source]
Parameters

  • input_root_dir (str) –

  • case_index (int) –

  • sample_index (int) –

  • test_setting_index (int) –

  • output_root_dir (str) –

  • exec_sim_check (Optional[dict]) –

Return type

quara.simulation.standard_qtomography_simulation.SimulationResult

re_estimate_sample_unit(test_setting_index, sample_index, output_root_dir, input_root_dir, exec_sim_check=None, pdf_mode='only_ng')[source]
Parameters

  • exec_sim_check (Optional[dict]) –

  • pdf_mode (str) –

Return type

List[quara.simulation.standard_qtomography_simulation.SimulationResult]

re_estimate_test_setting_unit(test_setting_index, output_root_dir, input_root_dir, exec_sim_check=None, pdf_mode='only_ng')[source]
Parameters

  • exec_sim_check (Optional[dict]) –

  • pdf_mode (str) –

Return type

List[quara.simulation.standard_qtomography_simulation.SimulationResult]

re_estimate_test_settings(input_root_dir, output_root_dir, pdf_mode, exec_sim_check=None)[source]
Parameters

  • input_root_dir (str) –

  • output_root_dir (str) –

  • pdf_mode (str) –

  • exec_sim_check (Optional[dict]) –

Return type

List[quara.simulation.standard_qtomography_simulation.SimulationResult]

write_pdf_report(results, root_dir, display_items=None)[source]
Parameters
Return type

None

write_result_case_unit(sim_result, root_dir)[source]
Parameters
Return type

None

write_result_sample_unit(results, root_dir)[source]
Parameters
Return type

None

write_result_test_setting_unit(results, root_dir, test_setting_index)[source]
Parameters
Return type

None

write_results(results, dir_path)[source]
Parameters
Return type

None