Difference between revisions of "Image submission plug-in"

Supported image formats

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

The most recent version of Java Runtime Environment (JRE) (6 or 7) is required in order to run the Image Submission Package Creation tool.

Running the Image Submission Package Creation tool

The main window unpopulated with data

The Choose CSV File window

The Preview Image box displaying the image thumbnail and the main window displaying a list of CSV files

The Edit Data Elements window with required fields highlighted in red

Using a CSV file

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 Load CSV File button to add the image file(s) and metadata file(s) (in CSV format) needed to create the submission package.
4. In the Choose CSV file window that appears, select the CSV file for upload and press Open. Use the navigation buttons to navigate to the folder where you store your CSV files.
5. The CSV file appears in the main plug-in window in the Form Structure Name table. The corresponding image file appears in the Preview box. Note that in some cases the CSV appears as not completed (Status Completed is set to No). This means that some essential information is missing and you need to add this information manually.
6. In order to add the missing information, press Add Form Structure. The Choose Form Structure dialog box appears listing the form structures available from the BRICS data dictionary.
7. Select the corresponding form structure and press Add.
8. The Edit Data Elements window appears populated with i) the data elements from the selected form structure and ii) with metadata from the CSV file.
9. Review this information. Make sure that all required fields are filled in.
10. Manually enter the missing image information. The required fields appear in red. If some of required fields are empty, the submission package will fail validation.
11. Upload the image file manually (if needed). Navigate to the Imaging File Name field and use the Browse button to select the file. The image thumbnail appears in the Preview box and the information from the file header populates into the corresponding fields. Refer to Using information from the file header for more info.
12. When all required information is entered, press Save.
13. In the main plug-in window, select the output directory which would be used by the Validation tool to store temporary files, validation logs and submission packages.
14. Press Generate Files. This will generate the submission package. The output log message appears in the OutputLog window and submission package appears in the output directory.

Using a form structure

1. Run the Image Submission Package Creation tool.
2. The main plug-in window appears.
3. Upload the corresponding form structure from the data dictionary, use the Add Form Structure button. The Choose Form Structure window appears displaying the form structures available from the BRICS data dictionary. Select the form structure and press Add.
4. The Edit Data Elements window appears populated with the data elements from the selected form structure.
5. To include the image file in the submission package, navigate to the Imaging File Name field and use the Browse button to select the file. The image thumbnail appears in the Preview box and the information from the file header appears the corresponding fields. Refer to Using information from the file header for more info.
6. Review the information entered in the previous step. Make sure that all required fields (appear in red) are filled in. If some of required fields are empty, the form structure status will appear as not completed and the submission package fails validation.
7. Manually enter the missing information. In order to complete the submission package, the following information is required: i) the patient/subject information including GUID, a patient/subject age, a study site name, and a visit date and ii) the image information including - the imaging study date and time, the imaging file name, the imaging file itself, imaging file format and modality. See also Required image information.
8. After all required fields have been filled in, press Save. Note that depending on the form structure required data may vary. Refer to Required image information for more info.
9. Specify the output directory which would be used by the Validation tool to store temporary files, validation logs and submission packages.
10. Press Generate Files. This will generate the submission package. The output log message appears in the OutputLog window and submission package appears in the output directory.

Using information from the file header

1. If you need to manually upload image files, navigate to the Imaging File Name field and use the Browse button to select the file.
2. The information from the file header will be automatically populated into the Edit Date Elements window.
3. The image preview appears in the Preview box in the main plug-in window.

Output log

When generating of the submission package is complete, the log message appears in the Output Log window. The message list all brain image files and CSV files added to the submission package. It also displays the path(s) to the directory where the submission package(s) is stored.

Preview Image box

The Preview Image box displays a thumbnail for an uploaded image.

In order to have a better preview, you can change Window and Level settings.

• Settings for Window can be adjusted from 0.1 to 10,
• Settings for Level can be adjusted -255 to 255.

Error messages

	This error message appears when the information in the image file header does not match the information from the corresponding CSV file. You can choose to either use the information from the file header or from the CSV file. The better solution, though, would be to review your CSV file first and make sure it matches the image header information, and then to re-upload the updated CSV file.
	This error message appears when the CSV file points to the image file that does not exist or its name was misspelled. The solution is to review your CSV file and fix the image file name.

Required image 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.

What should be done next?

Use the Validation Tool to re-validate the submission package. The Validation tool can be accessed using this link - TBD.

MIPAV notes

• If you run the Image Submission Package Creation tool through MIPAV as a plug-in and it does not appear under Plugins > Generic in the Main menu, you might consider installing the plug-in. If the installed plug-in did not appear in the MIPAV menu under Plug-ins> Generic> FITBIRImage, restart MIPAV.