TubeTK/Design Discussions

Introduction

Tubetk has adopted MIDAS to store testing and algorithm validation dataset. For this purpose, we have created a dedicated tubetk MIDAS community

In the tubetk community, we have two main types of folders

1. 'Input data folder': Where all input data for testing will be stored
2. 'Baseline dataset folder': These are individual folders that will be used to store the baseline images for tests in each "module"/CLI application in slicer.

How to add a new tubetk test

1. If the input data is not already in Midas,
   1. Upload the data to the "Data" folder
   2. Download the key file and store it in the MIDAS_KEYS directory at the top level of tubetk source code tree
2. Add baseline dataset for the new test ( if your test is a regression testing )
   1. Upload the dataset in the appropriate CLI or module folder. If your test is part of a new "module" or CLI, first add a folder to MIDAS and then upload the dataset
   2. Download the key file for the baseline image and store it in the MIDAS_KEYS directory.
3. Modify cmake list files in the Testing directory to "add" unit tests to use the data from MIDAS.
4. Use MIDAS_FETCH_ONLY macro, if you would like to fetch the dataset but not use it directly in the test
5. Use MIDAS_DIRECTORY, if you would like to specify a whole directory as an input command line argument to your test

MIDAS macro

The following are the main MIDAS cmake macro that will be used when adding a test

1. MIDAS_ADD_TEST
2. MIDAS_TGZ
3. MIDAS_FETCH ONLY
4. MIDAS_DIRECTORY