Image submission plug-in

From MIPAV
Revision as of 21:06, 9 July 2013 by Olga Vovk (Talk | contribs)

Jump to: navigation, search

This page is a stub.

Things that need revision:

  1. Screenshots
  2. Links
  3. General info

Introduction

The Image Submission Package Creation tool, which is available via MIPAV Image Submission plug-in is used to submit imaging data to - the BRICS data dictionary.

Uploading imaging data to the BRICS data dictionary

TBD.

Write a short outline that explains how to upload data to the BRICS data dictionary. Explain why do we need to create the submission package and why use the Validation tool.

MIPAV Image Submission plug-in

MIPAV Image Submission plug-in is designed to help researches to upload the image submission package into the database. The BRICS image submission package includes the brain image file and the queryable meta data that describe the image.

The plug-in supports all file formats supported by MIPAV including processed and unprocessed brain images in DICOM format.

If you are using different file format (not supported by MIPAV), please contact MIPAV support.

System requirements

A recent version of Java Runtime Environment (JRE) is required to run the plug-in.

Running the Image Submission plug-in

  1. Run the Image Submission Package Creation tool. To run the plug-in form MIPAV, go to Plug-ins> Generic> FITBIR Image.
  2. The main plug-in window appears.
  3. In the main window, use the corresponding buttons to add the image file(s) and appropriate metadata files (such as a CSV file and the form structure) that create the submission package.
    • To upload a CSV file, use the Load CSV File button.
    • To upload the corresponding form structure use the Add Form Structure button.
      The Image Submission Package Creating plug-in - the main window unpopulated with data
  1. The plug-in window will be populated with the uploaded data.
  2. Make sure that all required fields are filled out. The required fields appear in red. If some of required fields are empty, the form structure appears as not completed.
  3. To manually enter the missing image information, press Edit Data Elements. In order to complete the submission package, the following information is required:
    1. The patient/subject information - GUID, a patient/subject age, a study site name, and a visit date;
    2. Image information including - imaging study date and time, imaging file name, imaging file itself, imaging file format and modality.
  4. After all required information is completed, press Save.
  5. Select the output directory which would be used by the Validation tool to store temporary files and validation logs.
  6. Press Generate Files. This will generate the submission package.

Note: If the Image Submission plug-in does not appear in the menu, you might need to install the plug-in. If the installed plug-in did not appear in the MIPAV menu under Plug-ins> Generic, restart MIPAV.

Note: Depending on the form structure required data may vary. Refer to Required information for more information.

Required information

The following information is required for all submissions:

  1. The patient/subject information including - GUID, a patient/subject age, a study site name, and a visit date;
  2. The image information including - imaging study date and time, imaging file name, imaging file itself, imaging file format and modality.

Submission package

The submission package includes:

  • The compressed brain image in chosen format.
  • A JPG file that can be used as a thumbnail to preview the image in the database.
  • A CSV file with the meta-data from the image. The data should match a queryable form structure.


What should be done next?

Use the Validation Tool to validate the submission package.

The Validation tool can be accessed using this link - TBD.