Difference between revisions of "Projects:RegistrationDocumentation"

From NAMIC Wiki
Jump to: navigation, search
m (Text replacement - "http://www.slicer.org/slicerWiki/index.php/" to "https://www.slicer.org/wiki/")
 
(102 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
[[Category:Registration]]
 
[[Projects:ARRASuplements|Back to ARRA main page]]
 
[[Projects:ARRASuplements|Back to ARRA main page]]
 
==Use Case Library==
 
==Use Case Library==
−
*this will contain a list of the most common scenarios encountered for Slicer Registration. Each case will contain a dataset, a parameter set, a guided tutorial with example result. The hierarchy will be represented graphically as a tree and as a list with links to the abovementioned data. The library will be as exhaustive as possible, containin brain and non-brain, different modalities (MRI, CT, PET/SPECT).
+
*'''[[Projects:RegistrationDocumentation:UseCaseInventory| Registration Case Library ]]'''
−
*considered is also a list of troubleshooting cases, i.e. a list of the most common sources of registration failure, again complete with dataset, tutorial and remedy.
+
*'''[[Projects:RegistrationDocumentation:UseCaseAdvertisement|Use Case Sharing Advertisment Page]]'''
−
*the organization of a use case hierarchy can be accomplished in several ways. The main categories are listed below. Not all combinations exist or are equally common occurrences. For example, a different-timepoint/contrast distinction is not necessary for inter-subject registration.
+
*[[Projects:RegistrationDocumentation:UseCaseInventoryNotes|Notes & concepts about the Registration Case Library]]
−
**'''ORGAN''': Brain, Head&Neck, Thorax, Abdomen&Pelvis, Limbs, WholeBody
+
 
−
**'''SUBJECT''': intra-subject, inter-subject
+
== Development Efforts ==
−
**'''CONTENT''': same_TimeOrContent, different_TimeOrContent
+
*Slicer4: '''[[Projects:RegistrationDocumentation:Developer4|Notes & feedbacl for GUI and algorithm implementation. Testing Summaries]]'''
−
**'''MODALITY''': intra-modality, inter-modality
+
*Slicer3: [[Projects:RegistrationDocumentation:Developer|Notes & ideas for GUI and algorithm implementation. Discussion platform with the developer group]]
−
**'''CONTRAST''': same_Contrast, different_Contrast
+
*[[Projects:RegistrationDocumentation:RegEval_Anisotropy|'''Effects of Voxel Anisotropy and Intensity-Inhomogeneity on Image-Based 3D Registration''' ]]
−
***MR, CT, PET+SPECT, US
+
*[[Projects:RegistrationDocumentation:Benchmarking|'''Benchmarking''']]
−
***T1, T2, PD, T2s, DTI, MRPerfusion
+
*[[Projects:RegistrationDocumentation:ParameterTesting|Parameter Exploration]]
−
**'''VIEW''': same_View, different_View
+
*[[Projects:RegistrationDocumentation:Evaluation|Result Evaluation & Visualization]]
−
*Depending on grouping this leads to trees with 80-1080 entries. Two example hierarchies based on the above distinctions, formatted as directory trees are here: (download and browse using your file browser)
+
*[[Projects:RegistrationImprovement|Kitware Wiki on developer efforts]]
−
*the '''VIEW''' distinction arises from commonly occurring problems of co-registering sets acquired with different slice orientation. The basics of dealing with axis orientation is already integrated into the algorithm, but further details remain: basically different_view implies a possibly high voxel size ratio (i.e. different voxel sizes if one image acquired axial the other coronal). Actions/Parameter settings are with multi-resolution settings, blurring and special checking of the axis orientation (vox2ras) meta-data. If, for example,voxel size ratio is close to [1 1 1] we need not do anything different other than resample based on vox2ras.
 
−
*'''User-populated content''' The exploding # of combinations makes a successful top-down approach difficult. More effective to organize bottom-up, i.e. have user invited content, which we organize into a growing tree. We could make call to the user community for submitting datasets and registration problems: e.g.
 
−
  "if you have an interesting registration problem that is not yet covered in our library,
 
−
  send us your case: we will register it and post it.
 
−
  You get a free registration, the user community get a new example case. Everybody wins."
 
  
 
==Reference Manual==
 
==Reference Manual==
−
*This will contain detailed descriptions of each parameter and each control element within the slicer registration module. The description should help the user understand what exactly that function/parameter does and if/how useful it will be for their specific registration problem
+
*The reference manual will be organized by submodules and contain detailed descriptions of each parameter and each control element within the slicer registration module. The description should help the user understand what exactly that function/parameter does and if/how useful it will be for their specific registration problem.
−
*Preferred formats:  Slicer Wiki, maybe PDF
+
* Each entry will have one short description (that could also serve as tooltip) and one longer, more technical explanation.
−
==User Manuals==
+
* links to journal articles for in depth algorithm info
−
*this documentation will discussing the main registration module functionality as a whole, focusing not on the individual controls but the main workflow.
+
*Preferred formats:  Slicer Wiki, maybe PDF, cross-linking required
−
formats: Slicer Wiki, PowerPoint.
+
*'''[[Projects:RegistrationDocumentation:ReferenceManual|Draft Registration Reference Manual]]'''
−
*Also included in this category are Background Tutorials, explaining the basics of registration, formats: PowerPoint. Minimal understanding of the inner workings of a registration optimization algorithm is essential to understand and judge the results obtained and obtainable.
 
−
==Training Video Tutorials==
 
  
−
[[Image:TrainingMovieThumbnail.jpg|thumb|frame| [[Media:VideoTutorialDemo_v1_0.mov|Training Movie Demo (1min)]]]]
+
==User Manuals & Tutorials==
−
*These movies contain step by step instructions, running through each of the use-cases described above.  
+
*[https://www.slicer.org/wiki/Slicer3:Registration#Registration_in_3D_Slicer|'''Main Registration Portal Page''']
−
*An example of the features/character of a video tutorial is here: [[Media:VideoTutorialDemo_v1_0.mov]]
+
*[[Media:NCIGT2010_RegistrBreakout_Slides_v3_1.ppt|'''Registration Basics, Registration Tools & User Support in Slicer''' (Powerpoint, 14MB)]]
−
*video tutorials have become a popular and widespread form to document GUI interactions, particularly tutorials
+
*[https://www.slicer.org/wiki/Slicer-3-6-FAQ '''FAQ & Cookbooks''']
−
* they can have almost  the quality of direct tutoring
+
*The user manual will contain a systematic overview of registration functionality within 3DSlicer. formats: Slicer Wiki, PowerPoint.  
−
*they are compact in length and filesize (because the changes are local and small over time, MPEG compression is very effective with little quality loss), which makes them ideal for online distribution
+
**[[Projects:RegistrationDocumentation:UserManual|Draft Registration User Manual]]
−
*movie viewing capability is mainstream, i.e. all OS will have this capability, viewers can be downloaded for free
+
**[[Projects:RegistrationDocumentation:DocumentationResources|notes and documentation resources]]
−
*the audio track can provide main instructions, motivation, commentary and an abundance of detail information at the right juncture, something very difficult to provide in other formats without overloading a tutorial
+
*Tutorials will be case oriented and always demonstrate a particular task or feature
−
*the step by step interaction is captured unambiguously. We do not spend a lot of time and space in showing slides with screen captures.
+
**[[Projects:RegistrationDocumentation:VideoTutorials|Video Tutorials: showcase of specific workflow]]
−
*since they are easy to make and great software is inexpensive, potential use even for developer communication can be considered, e.g. to document complex bugs
+
**Background Tutorials, explaining the basics of registration, formats: PowerPoint. Minimal understanding of the inner workings of a registration optimization algorithm is essential to understand and judge the results obtained and obtainable.
−
*they have a low usage threshold, i.e. users are more inclined to watch a video than to dig through a power point presentation
 
−
*they are not all that useful for reference or main documentation material, e.g. a tutorial on main registration concepts is probably still better in PPT.
 
−
*formats: video files (quicktime, WMV, mp4 , Flash), optimized for streaming or download
 
  
−
== Ideas for Developers ==
+
== Contact ==
−
This will contain lists of ideas for GUI and function addition/improvements.
+
*if there is anything you think would be of help to the 3DSlicer registration user, be that documentation, examples or features, we'd love to hear about it:
−
*'''Parameter Presets:''' To navigate the jungle of parameter settings and avoid complex GUI design efforts, all parameters are listed and controllable via a preset dropdown menu. The menu can then be labeled by use cases i.e. combinations of MR-MR, same contrast, inter-subject, inter-modality, fast, precise etc. Parameter sets can be saved to files and shared. Each preset becomes a menu entry. This will enable building a library of presets that can be shared among users also.
+
**any questions/concerns are welcome on the slicer user mailing list: mailto:slicer-users@bwh.harvard.edu
−
*'''Recursive DOF hierarchy:''' Both multi-resolution and the sequence of calls with increasing DOF could be implemented as a single recursive scheme. The caller provides an array of DOF and a matching array of resolution levels, which is processed by recursive calls with the first/last element taken from the list. A simulation Matlab program and example is  here: [[Projects:RegistrationImprovement:RecursiveScheme]]
+
**particular questions/concerns re. these pages or Registration Documentation drop a line to mailto:meier@bwh.harvard.edu
−
:The GUI can list the many combination as a single list of checkboxes for increasing DOF. The full list would be 3,6,7,9,12,b . The checked boxes provide the input string for the recursive call. [[Media:DOFHierarchy_GUI.jpg‎ ]]
+
----
−
*'''Tooltip link:'''direct links to Reference Manual from Widget tooltips? Can the static text or widget itself launch a link to the Reference manual entry on the Documentation Wiki? That would enable a one-click answer to "What does this button do?"
 
−
*'''Affine SVD:''' decomposition of affine into the 4 3DOF components: translation, rotation, scaling, shearing. Can an SVD do this for 12DOF vs. 3 DOF? Having values that relate directly to geometry can help greatly in evaluating and adjusting results. E.g. user can tell visually which of the 3 rotations is most out of alignment. Checking the result rotation angles already provides a quick check and valuable info about where things went awry if solution is suboptimal. Also enables to decouple individual elements, i.e. extract the shear component etc. The current "Transforms" module already does this for translation & rotation, but the scale and shear portions are missing.
 
−
*'''Offline WIKI''': can the documentation WIKI be downloaded and used offline, e.g. for laptop users?
 
  
 +
== Links ==
 +
*[[Downloads|Data links]]
 +
*[https://www.predict-hd.net huntington data]
  
 +
*[[ITK_Registration_Optimization|Register Images Reference Material]]
  
−
----
+
*[[Events:Registration_Summit_August_2009|Registration Summit Aug'09]]
 +
*[[2009_Summer_Project_Week_Slicer3_registration]]
 +
*[https://www.slicer.org/wiki/Documentation-3.5 Slicer Documentation 3.5]
 +
*[http://na-mic.org/Mantis/my_view_page.php|Slicer Bug Tracker]
 +
*[[AHM_2010]]
 +
*[[2010_Winter_Project_Week_RegistrationCaseLibrary|AHM 2010 Project Week: Registration Case Library Project Page]]
 +
*[https://www.slicer.org/wiki/Slicer3:Slicer3Brand#3D_Slicer_Visual_Communication_Guide Slicer Logo & Communication Guide]
 +
*NAMIC registration:
 +
*Contact: Dominik Meier : mailto:meier@bwh.harvard.edu
  
−
== Links ==
+
=== Bundled Registration and Tests ===
−
*Developer efforts (Kitware): [[Projects:RegistrationImprovement]]
+
* http://www.na-mic.org/Wiki/index.php/Projects:DBP2:Harvard:Registration_Documentation
−
*Slicer Wiki: [http://www.slicer.org/slicerWiki/index.php/Documentation-3.5]
+
* http://www.na-mic.org/Wiki/index.php/MeningiomaMRIRegistrationStudy#Limitations_of_the_Slicer_registration_tools
−
*Slicer Bug Tracker: [http://na-mic.org/Mantis/my_view_page.php]
+
* [http://www.na-mic.org/Wiki/index.php/Vervet_MRI_registration Vervet head MRI atlas-to-subject registration]
−
*NAMIC registration:
+
* [http://www.na-mic.org/Wiki/index.php/MeningiomaMRIRegistrationStudy Head MRI registration between different timepoints (human subjects, changing pathology present)]
−
*Contact: Dominik Meier : meier@bwh.harvard.edu
+
* [https://www.slicer.org/wiki/Slicer3:Registration Side by side comparisons in slicer2 and slicer3 with data and images]
 +
* http://mindboggle.info/papers/index.php
 +
*testing on the Vanderbuild database: [http://www.insight-journal.org/RIRE/ RIRE]
 +
* [[ITK_Registration_Optimization#Algorithmic_Requirements_and_Use_Cases|ITK Registration Optimization Sets]]
 +
*[[DTI-non-rigid]]
 +
*[[Projects:DBP2:Harvard:Registration_Documentation:Compare#Case_to_case_registration]]

Latest revision as of 17:41, 10 July 2017

Home < Projects:RegistrationDocumentation

Back to ARRA main page

Use Case Library

Development Efforts

Reference Manual

  • The reference manual will be organized by submodules and contain detailed descriptions of each parameter and each control element within the slicer registration module. The description should help the user understand what exactly that function/parameter does and if/how useful it will be for their specific registration problem.
  • Each entry will have one short description (that could also serve as tooltip) and one longer, more technical explanation.
  • links to journal articles for in depth algorithm info
  • Preferred formats: Slicer Wiki, maybe PDF, cross-linking required
  • Draft Registration Reference Manual

User Manuals & Tutorials

Contact

  • if there is anything you think would be of help to the 3DSlicer registration user, be that documentation, examples or features, we'd love to hear about it:

Links

Bundled Registration and Tests

Retrieved from "https://www.na-mic.org/w/index.php?title=Projects:RegistrationDocumentation&oldid=97327"