diff --git a/Documentation/Doxygen/2-UserManual/MITKPluginManualsList.dox b/Documentation/Doxygen/2-UserManual/MITKPluginManualsList.dox index b567c4c83e..2d6f39b202 100644 --- a/Documentation/Doxygen/2-UserManual/MITKPluginManualsList.dox +++ b/Documentation/Doxygen/2-UserManual/MITKPluginManualsList.dox @@ -1,84 +1,84 @@ /** \page PluginListPage MITK Plugin Manuals The plugins and bundles provide much of the extended functionality of MITK. Each encapsulates a solution to a problem and associated features. This way one can easily assemble the necessary capabilites for a workflow without adding a lot of bloat, by combining plugins as needed. \subpage PluginListGeneralPage \subpage PluginListSpecificPage */ diff --git a/Plugins/org.mitk.gui.qt.moviemaker/documentation/UserManual/QmitkMovieMaker.dox b/Plugins/org.mitk.gui.qt.moviemaker/documentation/UserManual/QmitkMovieMaker.dox index 0d7bcb3f5f..2cbc42acca 100644 --- a/Plugins/org.mitk.gui.qt.moviemaker/documentation/UserManual/QmitkMovieMaker.dox +++ b/Plugins/org.mitk.gui.qt.moviemaker/documentation/UserManual/QmitkMovieMaker.dox @@ -1,64 +1,64 @@ /** \page org_mitk_views_moviemaker The Movie Maker -\imageMacro{video-camera.svg,"Icon of the Movie Maker Plugin.",2.00} +\imageMacro{moviemakericon_black.svg,"Icon of the Movie Maker Plugin.",2.00} \tableofcontents \section org_mitk_views_moviemakerOverview Overview The Movie Maker View allows you to create basic animations of your scene and to record them to video files. Individual animations are arranged in a timeline and can be played back sequential or in parallel. The Movie Maker View uses the external FFmpeg command line utility to write compressed video files. You have to manually install FFmpeg and set the corresponding path in "External Programs" in the MITK Workbench Preferences (Ctrl+P) in order to record your movies to video files. \imageMacro{QmitkMovieMaker_Preferences.png,"The External Programs preferences page.",12.00} \section org_mitk_views_moviemakerUsage Usage \imageMacro{QmitkMovieMaker_MovieMakerView.png,"The Movie Maker View.",16.00} To create a movie you have to add an animation to the timeline by clicking the "Add animation" button. You can choose between the available types of animations, e.g., Orbit or Slice. The timeline surrounding bottons allow you to arrange, remove, or add further animations to your movie. Each animation can be set to either begin with the previous animation, i.e., run in parallel, or to start after the previous animation, i.e., run sequential. In combination with delays, rather complex animation arrangements are possible. To set animation specific parameters, select the corresponding animation in the timeline first. You can play back, pause and stop your movie with the according controls at the bottom of the Movie Maker View. Click the "Record" button to finally record your movie to a video file with the specified number of frames per second. You have to choose the render window which you want to record. \subsection org_mitk_views_moviemakerOrbitUsage Orbit Animation The Orbit animation rotates the camera in the 3D window around the scene. Align the camera directly in the 3D window and enter the number of degrees for the orbitting. If you are planning to have a specific view in the middle of your movie you can play the movie and pause it at the specific frame of interest. Adjust the camera in the 3D window and restart the animation. \imageMacro{QmitkMovieMaker_Orbit.png,"The Orbit animation.",12.00} \subsection org_mitk_views_moviemakerSliceUsage Slice Animation The Slice animation slices through an image. You can choose the image plane (axial, sagittal, or coronal), as well as the start and end points of the slicing. Use the image navigator in the bottom left of the Workbench to get an idea of the desired values. Check "Reverse" in order to slice from the higher slice number to the lower slice number. \imageMacro{QmitkMovieMaker_Slice.png,"The Slice animation.",12.00} \subsection org_mitk_views_moviemakerTimeUsage Time Animation The Time animation steps through the individual time steps of the current scene. You can specify the range of the animated time steps. Use the image navigator in the bottom left of the Workbench to get an idea of the desired values. Check "Reverse" in order to step from later time steps to previous time steps. \imageMacro{QmitkMovieMaker_Time.gif,"The Time animation.",12.00} */ diff --git a/Plugins/org.mitk.gui.qt.moviemaker/documentation/UserManual/QmitkMovieMaker_Icon.png b/Plugins/org.mitk.gui.qt.moviemaker/documentation/UserManual/QmitkMovieMaker_Icon.png deleted file mode 100644 index e7751d99a6..0000000000 Binary files a/Plugins/org.mitk.gui.qt.moviemaker/documentation/UserManual/QmitkMovieMaker_Icon.png and /dev/null differ diff --git a/Plugins/org.mitk.gui.qt.moviemaker/documentation/UserManual/video-camera.svg b/Plugins/org.mitk.gui.qt.moviemaker/documentation/UserManual/moviemakericon_black.svg similarity index 100% rename from Plugins/org.mitk.gui.qt.moviemaker/documentation/UserManual/video-camera.svg rename to Plugins/org.mitk.gui.qt.moviemaker/documentation/UserManual/moviemakericon_black.svg diff --git a/Plugins/org.mitk.gui.qt.properties/documentation/UserManual/PropertiesView.dox b/Plugins/org.mitk.gui.qt.properties/documentation/UserManual/PropertiesView.dox index e22620785d..2b4644144a 100644 --- a/Plugins/org.mitk.gui.qt.properties/documentation/UserManual/PropertiesView.dox +++ b/Plugins/org.mitk.gui.qt.properties/documentation/UserManual/PropertiesView.dox @@ -1,57 +1,57 @@ /** \page org_mitk_views_properties The Properties \imageMacro{icon.svg,"Icon of the Properties View.",2.00} \tableofcontents \section org_mitk_views_propertiesOverview Overview The Properties View allows you to inspect and change properties of a selected data node and its attached data. This View is only for advanced users and developers, as it is easy to alter the program state in unexpected ways. It can be considered as a complete exposure of parts of the backend that are usually supposed to be accessed only through dedicated frontend components like the color or opacity widgets in the context menu of a data node in the Data Manager View. \section org_mitk_views_propertiesUsage Usage \imageMacro{view.png,"The Properties View.",12.00} \subsection org_mitk_views_propertiesUsagePropertyListTypes Property list types After you selected a data node, the Property View allows you to switch between several property lists that are attached to the selected data node and its actual data. By default, you see the common data node property list. There are two types of property lists: data node property lists and data property lists. Data node property lists consist of properties that the application attaches mainly for rendering settings. They are not intrinsically part of the actual data and are only persisted when saving the MITK scene as a whole. A typical example of such a property is "visible", which decides if the data should be rendered or hidden. The common data node property list is applied to all render windows but there are also render window specific data node property lists. Any property that is found in both the common list and a render window specific list is overriden by the latter one. For example, if you want to hide an image only in the 3d render window but show it in all other render windows, you check "visible" in the common list, add the same property to the 3d render window specific list, and uncheck it there. There is only a single data property list. It represents the true metadata of the selected data like DICOM tags of a DICOM image. When saving specific data, most data properties are written to the data file, as long as the selected file format supports metadata. A popular example is the NRRD image format that allows to save custom key value pairs in text format in the file header. Not all data properties are meant for persistence, though. -To check if a certain data property will be written to a metadata-enabled file format, click on in the properties tree view and check if there is a save icon at the bottom in the additional property info box. +To check if a certain data property will be written to a metadata-enabled file format, click on it in the properties tree view and check if there is a save icon at the bottom in the additional property info box. \subsection org_mitk_views_propertiesUsageFilter Filter Property lists can be quite large and complex, shown as a tree structure in the Properties View. To quickly find properties of interest you can use the filter text box, which will filter the properties while you type. \subsection org_mitk_views_propertiesUsageEditProperties Edit properties Most property value types like numbers, strings, boolean values, or colors can be edited by either clicking or double-clicking in the Value column. For example, to edit color properties, double-click on the colored Value cell. You can either enter a color by name like "yellow", in hex notation like "#ffff00" (or abbreviated "#ff0"), or click on the "..." button to open a color picker dialog. \subsection org_mitk_views_propertiesUsagePropertyInfos Additional property information Some properties have additional information attached like a description, aliases, or a persistence flag. This information is shown at the bottom of the Properties View. When no additional information is available, the additional property info box is hidden. */