Difference between revisions of "Documentation/Nightly/Extensions/lapdMouseBrowser"

From Slicer Wiki
Jump to: navigation, search
(added collaborators)
(added screenshots)
Line 26: Line 26:
 
The [https://lapdmouse.iibi.uiowa.edu Lung Anatomy + Particle Deposition Mouse Archive] (lapdMouse) is a collection of anatomic mouse lung models with aerosol deposition measurements to facilitate modeling and computational toxicology. More detailed information about the available datasets and data files can be found on https://lapdmouse.iibi.uiowa.edu.
 
The [https://lapdmouse.iibi.uiowa.edu Lung Anatomy + Particle Deposition Mouse Archive] (lapdMouse) is a collection of anatomic mouse lung models with aerosol deposition measurements to facilitate modeling and computational toxicology. More detailed information about the available datasets and data files can be found on https://lapdmouse.iibi.uiowa.edu.
  
'''lapdMouseBrowser''' is an extension for 3D Slicer to download and visualize files from the [https://lapdmouse.iibi.uiowa.edu lapdMouse] data archive. It allows the user to browse through the datasets in the [https://lapdmouse.iibi.uiowa.edu lapdMouse] archive, download them to the local drive, and load them in 3D Slicer. Advantages include:
+
'''lapdMouseBrowser''' is an extension for 3D Slicer to access and visualize files from the [https://lapdmouse.iibi.uiowa.edu lapdMouse] data archive. It allows the user to browse through the datasets in the [https://lapdmouse.iibi.uiowa.edu lapdMouse] archive, download them to the local drive, and load them in 3D Slicer. Advantages include:
  
 
* Visualize [https://lapdmouse.iibi.uiowa.edu lapdMouse] files not natively supported by 3D Slicer:
 
* Visualize [https://lapdmouse.iibi.uiowa.edu lapdMouse] files not natively supported by 3D Slicer:
Line 36: Line 36:
 
** Labelmaps (lungs, lobes, near acini, airway segments)
 
** Labelmaps (lungs, lobes, near acini, airway segments)
 
** Mesh models (airway segments, airway wall deposition)
 
** Mesh models (airway segments, airway wall deposition)
 +
 +
[[File:LapdMouseDBBrowserWindow.png|500px|lapdMouseBrowser main window]]
 +
[[File:LapdMouseStandardFiles.png|500px|Loaded standard file selection]]
 +
[[File:LapdMouseNearAciniTree.png|300px|Visualized airway tree structure and near acini compartment deposition]]
 +
  
 
{{documentation/{{documentation/version}}/module-section|Specify a local storage folder}}
 
{{documentation/{{documentation/version}}/module-section|Specify a local storage folder}}
 +
[[File:LadpMouseDBBrowserModule.png|thumb|400px|lapdMouseDBBrowser Module]]
 +
'''lapdMouseBrowser''' stores downloaded files in folder ''./lapdMouse'' by default. If you want to change the default storage directory, close the lapdMouse Data Archive Browser window, change the ''Storage Folder'' using the '''lapdMouseBrowser''' 's 3D Slicer module panel (panel on left side of 3D Slicer main window) and reopen the lapdMouse Data Archive Browse window by clicking ''Show browser''.
  
'''lapdMouseBrowser''' stores downloaded files in folder ''./lapdMouse'' by default. If you want to change the default storage directory, close the lapdMouse Data Archive Browser window, change the ''Storage Folder'' using the '''lapdMouseBrowser''' 's 3D Slicer module panel (panel on left side of 3D Slicer main window) and reopen the lapdMouse Data Archive Browse window by clicking ''Show browser''.
 
  
 
{{documentation/{{documentation/version}}/module-section|Download and visualize a standard set of files}}
 
{{documentation/{{documentation/version}}/module-section|Download and visualize a standard set of files}}
Line 68: Line 74:
 
an outline of the lung lobes. The visualization parameters and displayed models
 
an outline of the lung lobes. The visualization parameters and displayed models
 
can then be modified using 3D Slicer's standard functionality.
 
can then be modified using 3D Slicer's standard functionality.
 +
 +
[[File:LapdMouseDBBrowserWindow.png|500px|lapdMouseBrowser main window]]
 +
[[File:LapdMouseStandardFiles.png|500px|Loaded standard file selection]]
  
 
{{documentation/{{documentation/version}}/module-section|Download and visualize a custom set of files}}
 
{{documentation/{{documentation/version}}/module-section|Download and visualize a custom set of files}}
 +
[[File:LapdMouseNearAciniTree.png|300px|thumb|Visualized airway tree structure and near acini compartment deposition]]
  
 
If you want to download additional (or other) files for a dataset, select the
 
If you want to download additional (or other) files for a dataset, select the
Line 76: Line 86:
 
the files and ask the user to confirm the download. After download, they get can
 
the files and ask the user to confirm the download. After download, they get can
 
get loaded in 3D Slicer using ''load selected files''.
 
get loaded in 3D Slicer using ''load selected files''.
 +
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Revision as of 16:08, 4 December 2018

Home < Documentation < Nightly < Extensions < lapdMouseBrowser


For the latest Slicer documentation, visit the read-the-docs.


Introduction and Acknowledgements

Acknowledgments: The lapdMouse Browser was funded in part by NIH grant R01 ES023863
Authors: Christian Bauer (University of Iowa)
Contributors: Reinhard Beichel (University of Iowa), Melissa Krueger (University of Washington), Robb Glenny (University of Washington)
Contact: <email>lapdmouse@iibi.uiowa.edu</email>

The University of Iowa (UIowa)  

Extension Description

The Lung Anatomy + Particle Deposition Mouse Archive (lapdMouse) is a collection of anatomic mouse lung models with aerosol deposition measurements to facilitate modeling and computational toxicology. More detailed information about the available datasets and data files can be found on https://lapdmouse.iibi.uiowa.edu.

lapdMouseBrowser is an extension for 3D Slicer to access and visualize files from the lapdMouse data archive. It allows the user to browse through the datasets in the lapdMouse archive, download them to the local drive, and load them in 3D Slicer. Advantages include:

  • Visualize lapdMouse files not natively supported by 3D Slicer:
    • airway tree structure with branch labeling
    • aerosol deposition measurements
  • Download and visualize a set of commonly used files ("standard file selection") with a single click.
  • Pre-configured with suitable visualization parameters and color lookup tables for:
    • Volumetric images (aerosol and autofluorescent image data)
    • Labelmaps (lungs, lobes, near acini, airway segments)
    • Mesh models (airway segments, airway wall deposition)

lapdMouseBrowser main window Loaded standard file selection Visualized airway tree structure and near acini compartment deposition


Specify a local storage folder

lapdMouseDBBrowser Module

lapdMouseBrowser stores downloaded files in folder ./lapdMouse by default. If you want to change the default storage directory, close the lapdMouse Data Archive Browser window, change the Storage Folder using the lapdMouseBrowser 's 3D Slicer module panel (panel on left side of 3D Slicer main window) and reopen the lapdMouse Data Archive Browse window by clicking Show browser.


Download and visualize a standard set of files

In the lapdMouse Data Archive Browser window select on the left side the dataset you want to load. Then on the right side click load standard file selection in Slicer.

The "standard" file selection includes files commonly used:

  • AerosolSub4.mha (aerosol deposition image volume)
  • AutofluorescentSub4.mha (autofluorescent image volume showing anatomical structures)
  • Lobes.nrrd (Labelmap for lung lobes)
  • AirwayOutlets.vtk (Airway mesh with label assigned to outlets)
  • AirwayWallDeposition.vtk (aerosol deposition measurements near the airway wall)

If the files have not yet been downloaded, lapdMouseBrowser will display the total size of the files and ask the user to confirm the download. Note: Some files in the data archive such as full resolution volumetric images are several GB in size. Depending on your internet speed, the download might take several minutes. Files that are available on the local hard drive have a different status icon and will not have to be downloaded again.

Once the files are locally available, they will be loaded into 3D Slicer with suitable color lookup tables and default visualization parameters (e.g. gray-value window). After loading the standard files, 3D Slicer displays the aerosol deposition image and the airway wall deposition measurements mesh, and an outline of the lung lobes. The visualization parameters and displayed models can then be modified using 3D Slicer's standard functionality.

lapdMouseBrowser main window Loaded standard file selection

Download and visualize a custom set of files

Visualized airway tree structure and near acini compartment deposition

If you want to download additional (or other) files for a dataset, select the file names from the list (use Ctrl-key to select multiple at once), and click download selected files. lapdMouseBrowser will display the total size of the files and ask the user to confirm the download. After download, they get can get loaded in 3D Slicer using load selected files.


Information for Developers