Page MenuHomePhabricator

Document segmentation properties
Closed, ResolvedPublic

Description

To work on this bug you will have to branch from/merge into
bug-8203-provide-module-documentation

What should (at least) be done:
Add the following folders to the module.
If no module fits add it to an appropriate bundle.

Modules/YourModuleName/Documentation/doxygen/
for any files describing how to interact with the module as a developer

Modules/YourModuleName/Documentation/UserManual/
for any files describing how to interact with the module as a user

and the file
Modules/YourModuleName/Documentation/doxygen/DiffusionImagingProperties.dox

A template of the property page including some of what should be explained therein:

/**
\page SegmentationPropertiesPage The Segmentation Properties

TODO
binary - Toggle whether the image is treated as a binary/segmentation image
binaryimage.hoveringannotationcolor - seems to be used by some interactors for
changing colors when the mouse hovers over an object.
binaryimage.hoveringcolor - seems to be used by some interactors for
changing colors when the mouse hovers over an object.
binaryimage.selectedannotationcolor - ???
binaryimage.selectedcolor - The color the surface is rendered in 2D while
selected
segmentation - only used for information whether it is a segmentation or not
outline binary - Toggle whether the segmentation is drawn as an outline (on) or
solid (off)
outline width - width of the outline
showVolume - Toggle whether the volume of the segmentation is shown in the 2D
views

*/

Additionally you will need to add your page to
\MITK\Documentation\Doxygen\Modules.dox
as a subpage by as demonstrated by
\subpage PropertiesPage

Related Objects

StatusAssignedTask
ResolvedNone
ResolvedNone
ResolvedNone

Event Timeline

The file should of course be named something like
Modules/YourModuleName/Documentation/doxygen/SegmentationProperties.dox

Christian and I started documenting today.

I believe Stefan and i finished that but i haven't got the branch, Stefan should have it maybe ;-) .

Stefan, how is the Status of your work on this bug?

[a2ac79]: Merge branch 'bug-8214-document-segmentation-properties'

Merged commits:

2011-09-07 15:43:57 Caspar Goch [d9cec9]
Added segmentation property page