Difference between revisions of "Projects:RegistrationDocumentation"

From NAMIC Wiki
Jump to: navigation, search
(Created page with 'Suggested are 4 classes of documentation support: #Reference Manual, discussing each feature/parameter/button in detail. Preferred formats: Slicer Wiki, maybe PDF #User Manuals,…')
 
m (Text replacement - "http://www.slicer.org/slicerWiki/index.php/" to "https://www.slicer.org/wiki/")
 
(143 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
Suggested are 4 classes of documentation support:
+
[[Category:Registration]]
−
#Reference Manual, discussing each feature/parameter/button in detail. Preferred formats: Slicer Wiki, maybe PDF
+
[[Projects:ARRASuplements|Back to ARRA main page]]
−
#User Manuals, discussing the main functionality from a case-point of view, formats: Slicer Wiki, PowerPoint.
+
==Use Case Library==
−
#Background Tutorials, explaining the basics of registration, formats: PowerPoint
+
*'''[[Projects:RegistrationDocumentation:UseCaseInventory| Registration Case Library ]]'''
−
#Training Video Tutorials, formats: video files (quicktime, WMV, mp4 , Flash), optimized for streaming or download
+
*'''[[Projects:RegistrationDocumentation:UseCaseAdvertisement|Use Case Sharing Advertisment Page]]'''
 +
*[[Projects:RegistrationDocumentation:UseCaseInventoryNotes|Notes & concepts about the Registration Case Library]]
  
−
==Training Video Tutorials==
+
== Development Efforts ==
−
*An example of the features/character of a video tutorial is here: [[Media:VideoTutorialDemo_v1_0.mov]]
+
*Slicer4: '''[[Projects:RegistrationDocumentation:Developer4|Notes & feedbacl for GUI and algorithm implementation. Testing Summaries]]'''
−
*video tutorials have become a popular and widespread form to document GUI interactions, particularly tutorials
+
*Slicer3: [[Projects:RegistrationDocumentation:Developer|Notes & ideas for GUI and algorithm implementation. Discussion platform with the developer group]]
−
* they can have almost  the quality of direct tutoring
+
*[[Projects:RegistrationDocumentation:RegEval_Anisotropy|'''Effects of Voxel Anisotropy and Intensity-Inhomogeneity on Image-Based 3D Registration''' ]]
−
*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:Benchmarking|'''Benchmarking''']]
−
*movie viewing capability is mainstream, i.e. all OS will have this capability, viewers can be downloaded for free
+
*[[Projects:RegistrationDocumentation:ParameterTesting|Parameter Exploration]]
−
*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
+
*[[Projects:RegistrationDocumentation:Evaluation|Result Evaluation & Visualization]]
−
*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:RegistrationImprovement|Kitware Wiki on developer efforts]]
−
*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
 
−
*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.
 
  
 +
==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
 +
*'''[[Projects:RegistrationDocumentation:ReferenceManual|Draft Registration Reference Manual]]'''
  
−
== Ideas Linked to Developent Efforts ==
+
==User Manuals & Tutorials==
−
* direct links to Reference Manual from Widget tooltips?
+
*[https://www.slicer.org/wiki/Slicer3:Registration#Registration_in_3D_Slicer|'''Main Registration Portal Page''']
 +
*[[Media:NCIGT2010_RegistrBreakout_Slides_v3_1.ppt|'''Registration Basics, Registration Tools & User Support in Slicer''' (Powerpoint, 14MB)]]
 +
*[https://www.slicer.org/wiki/Slicer-3-6-FAQ '''FAQ & Cookbooks''']
 +
*The user manual will contain a systematic overview of registration functionality within 3DSlicer. formats: Slicer Wiki, PowerPoint.
 +
**[[Projects:RegistrationDocumentation:UserManual|Draft Registration User Manual]]
 +
**[[Projects:RegistrationDocumentation:DocumentationResources|notes and documentation resources]]
 +
*Tutorials will be case oriented and always demonstrate a particular task or feature
 +
**[[Projects:RegistrationDocumentation:VideoTutorials|Video Tutorials: showcase of specific workflow]]
 +
**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.
 +
 
 +
== 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:
 +
**any questions/concerns are welcome on the slicer user mailing list: mailto:slicer-users@bwh.harvard.edu
 +
**particular questions/concerns re. these pages or Registration Documentation drop a line to  mailto:meier@bwh.harvard.edu
 +
----
 +
 
 +
== 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
 +
 
 +
=== Bundled Registration and Tests ===
 +
* http://www.na-mic.org/Wiki/index.php/Projects:DBP2:Harvard:Registration_Documentation
 +
* http://www.na-mic.org/Wiki/index.php/MeningiomaMRIRegistrationStudy#Limitations_of_the_Slicer_registration_tools
 +
* [http://www.na-mic.org/Wiki/index.php/Vervet_MRI_registration Vervet head MRI atlas-to-subject registration]
 +
* [http://www.na-mic.org/Wiki/index.php/MeningiomaMRIRegistrationStudy Head MRI registration between different timepoints (human subjects, changing pathology present)]
 +
* [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"