Wiki

Clone wiki

ACID - Artefact correction in diffusion MRI / Startup modul

Using the Startup Module in the ACID-Toolbox for Data Processing

In this entry, we will explain the importance of using the startup module when working with the ACID-Toolbox for data processing. This module is essential when creating custom analysis pipelines using the Batch GUI or scripts. It helps you handle data inputs such as images, b-values, and b-vectors, set an output path, and load default values. Following these guidelines will ensure smooth functioning and maintainability of user-created analysis pipelines.

Startup Module

  • The startup module plays a critical role in processing data with our Toolbox. It is responsible for initializing the necessary configurations and setting up a proper environment for data processing. When using ACID to create custom analysis pipelines, you must include the startup module at the beginning of your script or pipeline, which will ensure that all necessary configurations and dependencies are loaded before other modules are executed. In the context of processing images, b-values, and b-vectors, the startup module is particularly crucial. It enables you to read in and manage these essential data inputs correctly. Additionally, it allows you to set an output path for processed data and load other default values, ensuring consistency across the analysis pipelines.

Input Dependencies, Output Path, and Default Values

  • For other modules in ACID that require raw data, original b-values, and b-vectors, it is important to always receive their inputs through the dependencies provided by the startup module. This approach guarantees that all modules will use the same data structures, configurations, and default values established in the startup process, resulting in a more robust and reliable custom analysis pipeline. This rule applies not only to the batch pipeline but also to any saved scripts that utilize the Toolbox for data processing. By consistently obtaining inputs via dependencies from the startup module, your custom analysis pipelines remain organized, easy to maintain, and less prone to errors. Additionally, this practice ensures that all modules use the manually set output path and the loaded default values, providing a unified location for all processed data and a consistent set of parameters.

Default Parameters

  • The startup module also plays a vital role in managing default parameters within your custom analysis pipelines. When creating a pipeline, the module can load your customized default parameters or use the system defaults when no changes have been made. This ensures that your pipeline operates with a consistent set of parameters, enhancing the overall reliability and maintainability. It is important to note that if you change the default values, you must execute the startup module function to activate the new values. This guarantees that your pipeline consistently operates with the latest default parameter settings. To preserve the original default settings as a backup, only change the local defaults in the "config/local" folder. By doing so, you can easily revert to the original defaults if needed, and maintain a clean and organized parameter management system within your custom analysis pipelines.

In summary, always use the startup module when working with the Toolbox for data processing, especially when creating custom analysis pipelines with the Batch GUI or scripts, handling images, b-values, and b-vectors, setting output paths, and loading default values. Following this best practice will help maintain a cohesive and efficient custom analysis pipeline that is easy to maintain and build upon.

Updated