more thesis

LFB-MRI · Jan 15, 2024 · 9c62ae4 · 9c62ae4
1 parent e099469
commit 9c62ae4
Show file tree

Hide file tree

Showing 38 changed files with 55 additions and 36 deletions.
diff --git a/documentation/thesis/build_out/thesis.pdf b/documentation/thesis/build_out/thesis.pdf
diff --git a/.../generated_images/border_1D_sensor_construction_with_universal_magnet_mount.png b/.../generated_images/border_1D_sensor_construction_with_universal_magnet_mount.png
diff --git a/...on/thesis/generated_images/border_1D_sensor_mechanical_3D_printed_structure.png b/...on/thesis/generated_images/border_1D_sensor_mechanical_3D_printed_structure.png
diff --git a/...tation/thesis/generated_images/border_1D_sensor_schematic_and_circuit_board.png b/...tation/thesis/generated_images/border_1D_sensor_schematic_and_circuit_board.png
diff --git a/...ges/border_3D_plot_of_an_N45_12x12x12_magnet_using_the_3D_fullsphere_sensor.png b/...ges/border_3D_plot_of_an_N45_12x12x12_magnet_using_the_3D_fullsphere_sensor.png
diff --git a/...xample_full_sphere_plot_of_an_measurement_using_the_MRPVisualisation_module.png b/...xample_full_sphere_plot_of_an_measurement_using_the_MRPVisualisation_module.png
diff --git a/...ample_hallbach_ring_magnet_with_cutouts_for_eight_cubical_permanent_magnets.png b/...ample_hallbach_ring_magnet_with_cutouts_for_eight_cubical_permanent_magnets.png
diff --git a/...implementation_using_two_Nema17_stepper_motors_in_a_polar_coordinate_system.png b/...implementation_using_two_Nema17_stepper_motors_in_a_polar_coordinate_system.png
diff --git a/...es/border_Generated_hallbach_array_with_generated_cutouts_for_eight_magnets.png b/...es/border_Generated_hallbach_array_with_generated_cutouts_for_eight_magnets.png
diff --git a/...is/generated_images/border_MRP_(+cli)_output_to_configure_a_new_measurement.png b/...is/generated_images/border_MRP_(+cli)_output_to_configure_a_new_measurement.png
diff --git a/documentation/thesis/generated_images/border_MRP_evaluation_result.png b/documentation/thesis/generated_images/border_MRP_evaluation_result.png
diff --git a/...ation/thesis/generated_images/border_MRP_library_module_high_level_overview.png b/...ation/thesis/generated_images/border_MRP_library_module_high_level_overview.png
diff --git a/...RP_library_test_results_for_different_submodules_executed_in_PyCharm_(+ide).png b/...RP_library_test_results_for_different_submodules_executed_in_PyCharm_(+ide).png
diff --git a/documentation/thesis/generated_images/border_MRPlib_COMPLETE_FLOW.png b/documentation/thesis/generated_images/border_MRPlib_COMPLETE_FLOW.png
diff --git a/documentation/thesis/generated_images/border_MRPlib_Proxy_Module.png b/documentation/thesis/generated_images/border_MRPlib_Proxy_Module.png
diff --git a/...images/border_MagneticReadoutProcessing_documentation_hosted_on_ReadTheDocs.png b/...images/border_MagneticReadoutProcessing_documentation_hosted_on_ReadTheDocs.png
diff --git a/...is/generated_images/border_MagneticReadoutProcessing_library_hosted_on_PyPi.png b/...is/generated_images/border_MagneticReadoutProcessing_library_hosted_on_PyPi.png
diff --git a/.../thesis/generated_images/border_Multi_sensor_synchronisation_wiring_example.png b/.../thesis/generated_images/border_Multi_sensor_synchronisation_wiring_example.png
diff --git a/documentation/thesis/generated_images/border_Query_opmode_using_(+cli).png b/documentation/thesis/generated_images/border_Query_opmode_using_(+cli).png
diff --git a/...mentation/thesis/generated_images/border_Query_sensors_b_value_using_(+cli).png b/...mentation/thesis/generated_images/border_Query_sensors_b_value_using_(+cli).png
diff --git a/...er_Result_step_execution_tree_from_user_defined_processing_pipeline_example.png b/...er_Result_step_execution_tree_from_user_defined_processing_pipeline_example.png
diff --git a/documentation/thesis/generated_images/border_Sensors_(+cli).png b/documentation/thesis/generated_images/border_Sensors_(+cli).png
diff --git a/...hesis/generated_images/border_Ten_numbered_test_magnets_in_separate_holders.png b/...hesis/generated_images/border_Ten_numbered_test_magnets_in_separate_holders.png
diff --git a/...mages/border_Unified_sensor_firmware_multi_sensor_synchronisation_procedure.png b/...mages/border_Unified_sensor_firmware_multi_sensor_synchronisation_procedure.png
diff --git a/...enerated_images/border_Unified_sensor_firmware_simplified_program_strucutre.png b/...enerated_images/border_Unified_sensor_firmware_simplified_program_strucutre.png
diff --git a/...d_images/border_Voltcraft_GM70_teslameter_with_custom_(+pc)_interface_board.png b/...d_images/border_Voltcraft_GM70_teslameter_with_custom_(+pc)_interface_board.png
diff --git a/...tation/thesis/generated_images/border_example_measurement_analysis_pipeline.png b/...tation/thesis/generated_images/border_example_measurement_analysis_pipeline.png
diff --git a/documentation/thesis/generated_images/border_mrp_proxy_multi.png b/documentation/thesis/generated_images/border_mrp_proxy_multi.png
diff --git a/...r_pipeline_output_files_after_running_example_pipeline_on_a_set_of_readings.png b/...r_pipeline_output_files_after_running_example_pipeline_on_a_set_of_readings.png
diff --git a/...is/tables/Sensor_capabilities_merging.csv → ...Sensor_capabilities_merging_algorithm.csv b/...is/tables/Sensor_capabilities_merging.csv → ...Sensor_capabilities_merging_algorithm.csv
diff --git a/...tables/Sensor_capabilities_merging.csv.md → ...sor_capabilities_merging_algorithm.csv.md b/...tables/Sensor_capabilities_merging.csv.md → ...sor_capabilities_merging_algorithm.csv.md
@@ -1,4 +1,4 @@
-: Sensor capabilities merging \label{Sensor_capabilities_merging.csv}
+: Sensor capabilities merging algorithm \label{Sensor_capabilities_merging_algorithm.csv}
 
 | SENSOR A  | SENSOR B  |  MERGED CAPABILITIES |  CAPABLE SENSORS ID LUT |
 | --------- | --------- | -------------------- | ----------------------- |

diff --git a/documentation/thesis/thesis.pdf b/documentation/thesis/thesis.pdf
diff --git a/documentation/thesis/thesis_abstract.md b/documentation/thesis/thesis_abstract.md
@@ -1,9 +1,21 @@
 A large number of magnets are used in the construction of low-field MRI equipment on the basis of permanent magnets.
 The magnetic properties of these magnets must be similar to a certain degree in order to achieve a homogeneous B0 field, which is necessary for many setups.
-Due to the complex manufacturing process of neodymium magnets, the different properties, i.e. the direction of magnetisation, can deviate from each other. This affects the homogeneity of the field.
-A passive shimming process is typically used to adjust the field afterwards. This is complex and time-consuming and requires manual corrections to the magnets used.
-To avoid this process, magnets can be systematically measured in advance. Data acquisition, storage and subsequent analysis play an important role in this methodology.
+
+Due to the complex manufacturing process of neodymium magnets, the different properties, i.e. the direction of magnetisation, can deviate from each other.
+This affects the homogeneity of the field.
+
+
+A passive shimming process is typically used to adjust the field afterwards.
+This is complex and time-consuming and requires manual corrections to the magnets used.
+To avoid this process, magnets can be systematically measured in advance.
+Data acquisition, storage and subsequent analysis play an important role in this methodology.
+
+
 Several existing open source solutions implement individual parts, but do not provide a complete data processing pipeline from acquisition to analysis, and their data storage formats are not compatible with each other.
-For this use case, the MagneticReadoutProcessing library has been created. It implements all important aspects of acquisition, storage and analysis, and each intermediate step can be customised by the user without having to create everything from scratch, thus encouraging exchange between different user groups.
+
+
+For this use case, the MagneticReadoutProcessing library has been created in this work.
+It implements all important aspects of acquisition, storage and analysis, and each intermediate step can be customised by the user without having to create everything from scratch, thus encouraging exchange between different user groups.
+
 Complete documentation, tutorials and tests enable users to use and adapt the framework as quickly as possible. 
 The framework was used to characterise different magnets, which requires integrating magnetic field sensors.
diff --git a/documentation/thesis/thesis_abstract.tex b/documentation/thesis/thesis_abstract.tex
@@ -1,23 +1,30 @@
 A large number of magnets are used in the construction of low-field MRI
 equipment on the basis of permanent magnets. The magnetic properties of
 these magnets must be similar to a certain degree in order to achieve a
-homogeneous B0 field, which is necessary for many setups. Due to the
-complex manufacturing process of neodymium magnets, the different
-properties, i.e.~the direction of magnetisation, can deviate from each
-other. This affects the homogeneity of the field. A passive shimming
-process is typically used to adjust the field afterwards. This is
-complex and time-consuming and requires manual corrections to the
-magnets used. To avoid this process, magnets can be systematically
-measured in advance. Data acquisition, storage and subsequent analysis
-play an important role in this methodology. Several existing open source
-solutions implement individual parts, but do not provide a complete data
-processing pipeline from acquisition to analysis, and their data storage
-formats are not compatible with each other. For this use case, the
-MagneticReadoutProcessing library has been created. It implements all
-important aspects of acquisition, storage and analysis, and each
-intermediate step can be customised by the user without having to create
-everything from scratch, thus encouraging exchange between different
-user groups. Complete documentation, tutorials and tests enable users to
-use and adapt the framework as quickly as possible. The framework was
-used to characterise different magnets, which requires integrating
-magnetic field sensors.
+homogeneous B0 field, which is necessary for many setups.
+
+Due to the complex manufacturing process of neodymium magnets, the
+different properties, i.e.~the direction of magnetisation, can deviate
+from each other. This affects the homogeneity of the field.
+
+A passive shimming process is typically used to adjust the field
+afterwards. This is complex and time-consuming and requires manual
+corrections to the magnets used. To avoid this process, magnets can be
+systematically measured in advance. Data acquisition, storage and
+subsequent analysis play an important role in this methodology.
+
+Several existing open source solutions implement individual parts, but
+do not provide a complete data processing pipeline from acquisition to
+analysis, and their data storage formats are not compatible with each
+other.
+
+For this use case, the MagneticReadoutProcessing library has been
+created in this work. It implements all important aspects of
+acquisition, storage and analysis, and each intermediate step can be
+customised by the user without having to create everything from scratch,
+thus encouraging exchange between different user groups.
+
+Complete documentation, tutorials and tests enable users to use and
+adapt the framework as quickly as possible. The framework was used to
+characterise different magnets, which requires integrating magnetic
+field sensors.
diff --git a/documentation/thesis/thesis_document.md b/documentation/thesis/thesis_document.md
@@ -771,12 +771,12 @@ This makes it possible to address a sensor directly using its (+uuid).
 
 #### Merging the sensor capabilities
 
-%%Sensor_capabilities_merging.csv%%
+%%Sensor_capabilities_merging_algorithm.csv%%
 
 When using sensors with different capabilites, these must be combined.
 These are used to select the appropriate measurement mode for a measurement.
 For this purpose, the `info` command of each sensor is queried.
-This information is added to the previously created (+lut). Duplicate entries are summarized (see Table \ref{Sensor_capabilities_merging.csv}) and returned to the host when the `info` \ref{lst:mtsc} command is received over network.
+This information is added to the previously created (+lut). Duplicate entries are summarized (see Table \ref{Sensor_capabilities_merging_algorithm.csv}) and returned to the host when the `info` \ref{lst:mtsc} command is received over network.
 
 ```bash {#lst:mtsc caption="MRPproxy REST enpoiint query examples"}
 # QUERY Network-Proxy capabilities

diff --git a/documentation/thesis/thesis_document.tex b/documentation/thesis/thesis_document.tex
@@ -1601,8 +1601,8 @@ \subsubsection{Merging the sensor
 capabilities}\label{merging-the-sensor-capabilities}}
 
 \begin{longtable}[]{@{}llll@{}}
-\caption{Sensor capabilities merging
-\label{Sensor_capabilities_merging.csv}}\tabularnewline
+\caption{Sensor capabilities merging algorithm
+\label{Sensor_capabilities_merging_algorithm.csv}}\tabularnewline
 \toprule
 SENSOR A & SENSOR B & MERGED CAPABILITIES & CAPABLE SENSORS ID
 LUT\tabularnewline
@@ -1625,9 +1625,9 @@ \subsubsection{Merging the sensor
 measurement. For this purpose, the \passthrough{\lstinline!info!}
 command of each sensor is queried. This information is added to the
 previously created \gls{lut}. Duplicate entries are summarized (see
-Table \ref{Sensor_capabilities_merging.csv}) and returned to the host
-when the \passthrough{\lstinline!info!} \ref{lst:mtsc} command is
-received over network.
+Table \ref{Sensor_capabilities_merging_algorithm.csv}) and returned to
+the host when the \passthrough{\lstinline!info!} \ref{lst:mtsc} command
+is received over network.
 
 \begin{lstlisting}[language=bash, caption={MRPproxy REST enpoiint query examples}, label=lst:mtsc]
 # QUERY Network-Proxy capabilities

diff --git a/documentation/thesis/thesis_document_tmp.md b/documentation/thesis/thesis_document_tmp.md
@@ -821,7 +821,7 @@ This makes it possible to address a sensor directly using its (+uuid).
 
 #### Merging the sensor capabilities
 
-: Sensor capabilities merging \label{Sensor_capabilities_merging.csv}
+: Sensor capabilities merging algorithm \label{Sensor_capabilities_merging_algorithm.csv}
 
 | SENSOR A  | SENSOR B  |  MERGED CAPABILITIES |  CAPABLE SENSORS ID LUT |
 | --------- | --------- | -------------------- | ----------------------- |
@@ -833,7 +833,7 @@ This makes it possible to address a sensor directly using its (+uuid).
 When using sensors with different capabilites, these must be combined.
 These are used to select the appropriate measurement mode for a measurement.
 For this purpose, the `info` command of each sensor is queried.
-This information is added to the previously created (+lut). Duplicate entries are summarized (see Table \ref{Sensor_capabilities_merging.csv}) and returned to the host when the `info` \ref{lst:mtsc} command is received over network.
+This information is added to the previously created (+lut). Duplicate entries are summarized (see Table \ref{Sensor_capabilities_merging_algorithm.csv}) and returned to the host when the `info` \ref{lst:mtsc} command is received over network.
 
 ```bash {#lst:mtsc caption="MRPproxy REST enpoiint query examples"}
 # QUERY Network-Proxy capabilities

diff --git a/documentation/thesis/thesis_document_tmp.md.listings b/documentation/thesis/thesis_document_tmp.md.listings
@@ -821,7 +821,7 @@ This makes it possible to address a sensor directly using its (+uuid).
 
 #### Merging the sensor capabilities
 
-: Sensor capabilities merging \label{Sensor_capabilities_merging.csv}
+: Sensor capabilities merging algorithm \label{Sensor_capabilities_merging_algorithm.csv}
 
 | SENSOR A  | SENSOR B  |  MERGED CAPABILITIES |  CAPABLE SENSORS ID LUT |
 | --------- | --------- | -------------------- | ----------------------- |
@@ -833,7 +833,7 @@ This makes it possible to address a sensor directly using its (+uuid).
 When using sensors with different capabilites, these must be combined.
 These are used to select the appropriate measurement mode for a measurement.
 For this purpose, the `info` command of each sensor is queried.
-This information is added to the previously created (+lut). Duplicate entries are summarized (see Table \ref{Sensor_capabilities_merging.csv}) and returned to the host when the `info` \ref{lst:mtsc} command is received over network.
+This information is added to the previously created (+lut). Duplicate entries are summarized (see Table \ref{Sensor_capabilities_merging_algorithm.csv}) and returned to the host when the `info` \ref{lst:mtsc} command is received over network.
 
 ~~~ { .bash  #lst:mtsc caption="MRPproxy REST enpoiint query examples" }
 # QUERY Network-Proxy capabilities