Difference between revisions of "Projects:RegistrationDocumentation"

From NAMIC Wiki
Jump to: navigation, search
Line 10: Line 10:
 
*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.
 
*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==
 
==Training Video Tutorials==
[[Image:Wikipedesketch1.png|thumb|alt=A cartoon centipede reads books and types on a laptop.|The Wikipede edits ''[[Entomology]]''.|link=Main Page|Caption|frame|caption]]]
+
[[Image:TrainingMovieThumbnail.jpg|thumb|alt=A cartoon centipede reads books and types on a laptop.|The Wikipede edits ''[[Entomology]]''.|link=Main Page|Caption|frame|caption]]]
 
*These contain step by step instructions, running through each of the use-cases described above.  
 
*These contain step by step instructions, running through each of the use-cases described above.  
 
*An example of the features/character of a video tutorial is here: [[Media:VideoTutorialDemo_v1_0.mov]]
 
*An example of the features/character of a video tutorial is here: [[Media:VideoTutorialDemo_v1_0.mov]]

Revision as of 19:32, 30 September 2009

Home < Projects:RegistrationDocumentation

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).
  • 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.

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
  • Preferred formats: Slicer Wiki, maybe PDF

User Manuals

  • this documentation will discussing the main registration module functionality as a whole, focusing not on the individual controls but the main workflow.

formats: Slicer Wiki, PowerPoint.

  • 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

A cartoon centipede reads books and types on a laptop.
caption

]

  • These contain step by step instructions, running through each of the use-cases described above.
  • An example of the features/character of a video tutorial is here: Media:VideoTutorialDemo_v1_0.mov
  • video tutorials have become a popular and widespread form to document GUI interactions, particularly tutorials
  • they can have almost the quality of direct tutoring
  • 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
  • movie viewing capability is mainstream, i.e. all OS will have this capability, viewers can be downloaded for free
  • 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
  • the step by step interaction is captured unambiguously. We do not spend a lot of time and space in showing slides with screen captures.
  • 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.
  • formats: video files (quicktime, WMV, mp4 , Flash), optimized for streaming or download

Ideas for Developent Efforts

  • This will contain lists on function improvements that require develoment effort, e.g. new GUI features, but also strategic notes on data and algorithm structure
  • direct links to Reference Manual from Widget tooltips?



Meeting Minutes

  • action items & notes from meetings, TCONs and reviews

<showhide>

  • Meeting 2009-09-30 __HIDER__

<hide>

    • main effort in first few months will be building of a use case library: starting with a tree of use case scenarios (brain-non-brain, inter- vs. intramodality, MR-MR inter-contrast, inter-subject vs. intra-subject, DTI to structural. Emphasis is on applications/cases, not technology, i.e. no distinction between implementation (e.g. fiducials, cost function etc.). Whole body scenarios: PET-CT, PET-CT with follow-up to track tumor growth, image-guided therapy applications
    • aside/along with a graphic representation of this tree is a table with links to 1) the dataset, 2) the parameter settings, 3) the tutorial running the example set
    • setup a weekly meeting. Current: Wed. 9.30am . ca. 30min
    • include considerations of precision vs. speed and vs. robustness. The interactive nature of Slicer sets a ~10minute effort limit per case as a guideline
    • write up a brief spec.aim for Stuart Silverman for sharing his intra-operative data: for the NAC supplement we plan to establish a library of use cases to guide segmentation efforts. This library an associated registration strategies will be shared on the Web.
    • documentation for ARRA via a NAC website, which follows a wiki2web self-service structure. Marianna is contact for details
    • day-to-day documentation on the NAMIC wiki. Create my own Regsitration page.
    • support personnel: Casey as developer, Andy as "super-user". Twice weekly interaction with Casey is recommended.
    • Ron supports the single module/tab with all parameters + presets menu option. It is a clean design and highly expandable.
    • Ron suggests Casey touch base with J.C. (Jean Christophe Fillion Robin) also @ Kitware, who works on the QT widget issue, so that he's aware of new capabilities such as Webkit that enable displaying "live" online documentation directly in the program.

</hide> </showhide>

Links