Support

General Interest Multi-Region Job Folder Structure
General Interest

Information in this article applies to:

  • uScope Navigator V4.5 and Later

Article ID: NGN1197 — Created: 21 Aug 2019 — Reviewed: 1 Sep 2020

Summary

uScope Navigator v4.5 has updated the folder structure of Multi-Region scans so that multiple regions are stored in the specified job folder. Previous versions of uScope Navigator created separate job folders for each region within a scan.

The change to the folder structure for multi-region scans accommodates a new deep zoom image viewer that supports viewing all scanned regions from a single viewer page.

More Information

uScope Navigator v4.5 and later store a multi-region scan as follows:

C:\Images
      Multi-Region-JobName
         JobInfo.xml
         Region01
            uS-Overview.jpg
            uS-Key.jpg
            uS-ScanInfo.xml
            uS-XxxxYyyy.(jpg|png)
            DZCombine.xml
         Region02
            (same as Region01 above)
         Region03
            (same as Region01 above)
         DeepZoom-unfiltered
            DZDirInfo.xml
            MIDZ.html
            Region01
               MIDZ.html
               uS-Overview.jpg
               uS-Key.jpg
               DZThumbnail.jpg
               DZThumbnail_sq.jpg
               DZInfo.xml
               DZViewer.xml
               DZOutput.xml
               DZOutput_files
                  (Deep Zoom Pyramid Files)
            Region02
               (same as Region01 above)
            Region03
               (same as Region01 above)
         EasyZoom (New in v4.5)
            (EasyZoom (SZI) Images)
         SVS (New in v4.5)
            (SVS Images)
         Exports (New in v4.5)
            (Deep Zoom Exported ROI Images)

Job Folder

When you create a new multi-region job <Multi-Region-JobName>, all files for that job are stored in <ImagesFolder>\<Multi-Region-JobName>\. The following files and folders are created in each job folder:

  • JobInfo.xml
    This XML file contains information about the job.
  • Region?? Folders
    These folders contain the field images and scan data files for each selected region.
  • DeepZoom-??? Folders
    These folders contain deep zoom image sets created by the uScope Navigator application. The suffix is the name of the filter used to create the deep zoom image. If no filter is used, the suffix is "unfiltered".
  • SVS Folder
    This folder contains the SVS images for each region.
  • EasyZoom Folder
    This folder contains the EasyZoom (SZI) images for each region.
  • Exports Folder
    This folder contains ROI (region of interest) image files exported from the Deep Zoom image viewer.

Region?? Folders

Each region is stored in a separate folder. After scanning, each region folder contains the following files:

  • uS-Overview.jpg
    This image file is the overview image of the whole slide. It is captured by the overview camera as a single, high-definition image. The scanned region of interest is outlined in green.
  • uS-Key.jpg
    This image file is a composite of the individual fields. It is not full image resolution. it is only intended to be a guide to associating a particular field to a position in the scanned region.
  • uS-ScanInfo.xml
    This XML file contains information about the scan.
  • uS-XxxxYyyy.(jpg|png)
    These files are the individual fields captured while scanning the region of interest. Each image is saved in standard definition (960x540) or high definition (1920x1080) format. Images are saved as JPG (lossy, compressed) or as PNG (lossless, compressed) depending on scan settings.
  • DZCombine.xml
    This XML file contains image overlap adjustment data required to properly stitch field images into a seamless mosaic.

DeepZoom-??? Folders

Each time you create deep zoom images (with different filter settings) a new folder is created with the name DeepZoom followed by the selected filter. The folder is named DeepZoom-unfiltered if no filter is applied. The deep zoom folders contain the following files:

  • MIDZ.html
    This file is the deep zoom image viewer HTML file. It supports viewing single-region scans as well as multi-region/angle/layer scans.
  • DZDirInfo.xml
    This XML file is the multi-scan directory information file that is required by MIDZ.html to figure out how to open a multi-region/angle/layer scanned image.
  • Region?? Folders
    These folders contain the deep zoom images for each region.

DeepZoom Region?? Folders

These folders contain the deep zoom images for each region. They contain the following files:

  • MIDZ.html
    This file is the deep zoom image viewer HTML file. It supports viewing single-region scans as well as multi-region/angle/layer scans. Launching the viewer from this folder allows you to view this region only.
  • uS-Overview.jpg
    This is the image of the slide (minus the label) from the overview camera. The region scanned is outlined in green.
  • uS-Key.jpg
    This is an image of the region scanned (after it has been stitched). It is not a full-sized image.
  • DZThumbnail.jpg
    This image is a 3:2 (1800x1200) image of the constrained uS-Key.jpg image.
  • DZThumbnail_sq.jpg
    This image is a cropped square image (240x240) of the DZThumbnail.jpg image.
  • DZInfo.xml
    This XML file contains information about each scan. Information from this file is extracted by the deep zoom image viewer and used to create the info popup and to calculate image scale.
  • DZViewer.xml
    This XML file contains filter information for the deep zoom image viewer.
  • DZOutput.xml
    This XML file is required by the deep zoom image viewer. If you plan to use another deep zoom image viewer, you need only this file and the DZOutput_files folder.
  • DZOutput_files Folder
    This folder contains the deep zoom image pyramid that contains the individual tiles associated with each level of the deep zoom pyramid.

Related Articles

Rate This Article
Contact Microscopes International or speak with your local distributor.
Credits Terms of Use Privacy Policy
Copyright © 2024 Microscopes International, LLC. All rights reserved.