|
|
| Line 21: |
Line 21: |
| | {{documentation/{{documentation/version}}/module-section|Module Description}} | | {{documentation/{{documentation/version}}/module-section|Module Description}} |
| | This module is used to "paint" a model with data from an image volume in Slicer. This calls vtkProbeFilter internally, which will probe (interpolate) a value from the image volume at every point location (vertex) of the model. This module works in "world space" so it handles the coordinate systems of the model (known as RAS) and volume (internally stored in an array with "ijk" coordinates in Slicer terminology). | | This module is used to "paint" a model with data from an image volume in Slicer. This calls vtkProbeFilter internally, which will probe (interpolate) a value from the image volume at every point location (vertex) of the model. This module works in "world space" so it handles the coordinate systems of the model (known as RAS) and volume (internally stored in an array with "ijk" coordinates in Slicer terminology). |
| − |
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − | <!-- THE FOLLOWING SHOULD BE REMOVED FOR YOUR OWN MODULE DOCUMENTATION -->
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − | If you are documenting a CLI, the description should be extracted from the corresponding XML description. This could be done automatically using the following wiki template:<pre>{{documentation/{{documentation/version}}/module-description|xmlurl=http://path/to/YOURMODULE.xml }}</pre>
| |
| − |
| |
| − | If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:
| |
| − | <pre>{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}</pre>
| |
| − |
| |
| − | Using this later template, the final syntax would be:
| |
| − | <pre>{{documentation/{{documentation/version}}/module-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − |
| |
| | | | |
| | <!-- ---------------------------- --> | | <!-- ---------------------------- --> |
| Line 41: |
Line 26: |
| | Most frequently used for these scenarios: | | Most frequently used for these scenarios: |
| | | | |
| − | * Use Case 1: | + | * Use Case 1: Visualize data from any volume (e.g. T2 MRI) on the surface of a model (e.g. a tumor surface) |
| − | * Use Case 2:
| + | * Use Case 2: Sample data onto a model for later quantitative analysis, perhaps in another program, such as sampling FA/T2/etc. onto a model of fiber tracts |
| − | | |
| − | <!-- ---------------------------- -->
| |
| − | {{documentation/{{documentation/version}}/module-section|Tutorials}}
| |
| − | Links to tutorials that use this module
| |
| − | | |
| − | <!-- ---------------------------- -->
| |
| − | {{documentation/{{documentation/version}}/module-section|Panels and their use}}
| |
| − | | |
| − | A list of all the panels in the interface, their features, what they mean, and how to use them. For instance:
| |
| − | | |
| − | {|style="width: 100%"
| |
| − | |
| |
| − | * Input panel1:
| |
| − | ** First input
| |
| − | ** Second input
| |
| − | * Parameters panel:
| |
| − | ** First parameter
| |
| − | ** Second parameter
| |
| − | * Output panel:
| |
| − | ** First output
| |
| − | ** Second output
| |
| − | * Viewing panel:
| |
| − | | align="right" |
| |
| − | [[Image:screenshotBlankNotOptional.png|thumb|280px|Name of panel 1]]
| |
| − | |-
| |
| − | |
| |
| − | * Input panel2: | |
| − | ** First input
| |
| − | ** Second input
| |
| − | * Parameters panel:
| |
| − | ** First parameter
| |
| − | ** Second parameter
| |
| − | * Output panel:
| |
| − | ** First output
| |
| − | ** Second output
| |
| − | * Viewing panel:
| |
| − | | align="right" |
| |
| − | [[Image:screenshotBlankNotOptional.png|thumb|280px|Name of panel 2]]
| |
| − | |}
| |
| − | | |
| − | <!-- ---------------------------- -->
| |
| − | {{documentation/{{documentation/version}}/module-section|Similar Modules}}
| |
| − | * Point to other modules that have similar functionality
| |
| − | | |
| − | <!-- ---------------------------- -->
| |
| − | {{documentation/{{documentation/version}}/module-section|References}}
| |
| − | Publications related to this module go here. Links to pdfs would be useful.
| |
| − | For extensions: link to the source code repository and additional documentation
| |
| − | | |
| − | <!-- ---------------------------- -->
| |
| − | {{documentation/{{documentation/version}}/module-section|Information for Developers}}
| |
| − | {{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}
| |
| − | | |
| − | | |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − | <!-- THE FOLLOWING SHOULD BE REMOVED FOR YOUR OWN MODULE DOCUMENTATION -->
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − | {{note}}The section above is generated using the following wiki code:
| |
| − | <pre>
| |
| − | {{documentation/{{documentation/version}}/module-section|Information for Developers}}
| |
| − | {{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}
| |
| − | </pre>
| |
| − | | |
| − | If you are documenting a CLI, the category should be extracted from the corresponding XML description. This could be done automatically using the following wiki template:<pre>{{documentation/{{documentation/version}}/module-category|xmlurl=http://path/to/YOURMODULENAME.xml }}</pre>
| |
| − | | |
| − | If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:
| |
| − | <pre>{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}</pre>
| |
| − | | |
| − | Using this later template, the final syntax would be:
| |
| − | <pre>{{documentation/{{documentation/version}}/module-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| | | | |
| | | | |
