Difference between revisions of "Documentation/Nightly/Modules/ScreenCapture"

From Slicer Wiki
Jump to: navigation, search
(Created page with "<noinclude>{{documentation/versioncheck}}</noinclude> <!-- ---------------------------- --> {{documentation/{{documentation/version}}/module-header}} <!-- --------------------...")
 
Line 27: Line 27:
 
Image:UltrasoundToolGuidance3dOnly.gif|Video fading between two images.
 
Image:UltrasoundToolGuidance3dOnly.gif|Video fading between two images.
 
Image:ShapeModelSequenceBrowsing3dOnly.gif|Video of rotating 3D view.
 
Image:ShapeModelSequenceBrowsing3dOnly.gif|Video of rotating 3D view.
−
Image:SequenceEditor.png|video of a time sequence in slice or 3D view (requires [[documentation/{{documentation/version}}/Extensions/Sequences|Sequences]] extension)
+
Image:SequenceEditor.png|video of a time sequence in slice or 3D view.
 
</gallery>
 
</gallery>
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Panels}}
 
{{documentation/{{documentation/version}}/module-section|Panels}}
 +
* '''Input'''
 +
** '''View to capture:''' select slice or 3D view that the content will be captured of
 +
** '''Animation mode:'''
 +
*** 3D rotation: Acquire video of a rotating 3D view (for 3D viewer only). For smooth repeated display of a 360-degree rotation it is recommended to choose 31 or 61 as "Number of images".
 +
*** slice sweep: Acquire video while going through selected range of image frames (for slice viewer only).
 +
*** slice fade: Acquire video while fading between the foreground and background image (for slice viewer only).
 +
*** sequence: Acquire video while going through items in the selected sequence browser. Requires installation of [[documentation/{{documentation/version}}/Extensions/Sequences|Sequences]] extension.
 +
* '''Output'''
 +
** '''Number of images:''' Defines how many frames are generated in the specified range. Higher number results in smoother animation but larger video file.
 +
** '''Output directory:''' Image frames or video file will be saved in this directory.
 +
** '''Video export:''' If checked then exported images are converted to a single video file in the selected format. Requires [[#setting up ffmpeg|ffmpeg]].
 +
*** H264: modern compressed video format, compatible with most contemporary video players.
 +
*** MPEG4: commonly used compressed video format, mostly compatible with older video players.
 +
*** Animated GIF: file format that provides lower quality images but allows embedding animations into webpages as simple images.
 +
* '''Advanced'''
 +
** '''ffmpeg executable:''' Path to ffmpeg executable. Requires download and installation of [[#setting up ffmpeg|ffmpeg]]. Only needed if video export is selected.
 +
** '''Video extra options:''' Options for ffmpeg that controls video format and quality. Only needed if video export is selected.
 +
** '''Image file name pattern:''' Defines image file naming pattern. %05d will be replaced by the image number (5 numbers, padded with zeros). Only needed if video export is not selected.
 +
=== Setting up ffmpeg ===
 +
FFmpeg library is not packaged with 3D Slicer due to licensing restrictions. The FFmpeg library has to be downloaded and set up only once and 3D Slicer will remember its location.
 +
* '''Windows''' setup instructions
 +
** Download ffmpeg from here: https://ffmpeg.org/download.html (click Windows icon, select a package, for example 'Download FFmpeg64-bit static')
 +
** Extract downloaded package (for example, to ''C:\Users\Public'')
 +
** Select ffmpeg.exe in Advanced section, ''fmpeg executable'' (for example, ''C:\Users\Public\ffmpeg-20160912-bc7066f-win32-static\bin\ffmpeg.exe'')
 +
* '''MacOS''' setup instructions
 +
** Install homebrew (from http://brew.sh/)
 +
** Run: "brew install ffmpeg"
 +
** Select ''/usr/local/bin/ffmpeg'' in Advanced section, ''fmpeg executable''
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Revision as of 17:34, 12 September 2016

Home < Documentation < Nightly < Modules < ScreenCapture


For the latest Slicer documentation, visit the read-the-docs.


Introduction and Acknowledgements

This work was was funded by Cancer Care Ontario and the Ontario Consortium for Adaptive Interventions in Radiation Oncology (OCAIRO).
Author: Andras Lasso, PerkLab, Queen's University
Contact: Andras Lasso, <email>lasso@queensu.ca</email>

Software Platform and Adaptive Radiotherapy Kit  

Module Description

This module is for acquiring screen capture videos of Slicer viewers. The module can capture image sequences from slice and 3D views and export them as a sequence of images or a video file.

Use Cases

  • Video showing all slices of an image volume.

  • Video fading between two images.

  • Video of rotating 3D view.

  • video of a time sequence in slice or 3D view.

Panels

  • Input
    • View to capture: select slice or 3D view that the content will be captured of
    • Animation mode:
      • 3D rotation: Acquire video of a rotating 3D view (for 3D viewer only). For smooth repeated display of a 360-degree rotation it is recommended to choose 31 or 61 as "Number of images".
      • slice sweep: Acquire video while going through selected range of image frames (for slice viewer only).
      • slice fade: Acquire video while fading between the foreground and background image (for slice viewer only).
      • sequence: Acquire video while going through items in the selected sequence browser. Requires installation of Sequences extension.
  • Output
    • Number of images: Defines how many frames are generated in the specified range. Higher number results in smoother animation but larger video file.
    • Output directory: Image frames or video file will be saved in this directory.
    • Video export: If checked then exported images are converted to a single video file in the selected format. Requires ffmpeg.
      • H264: modern compressed video format, compatible with most contemporary video players.
      • MPEG4: commonly used compressed video format, mostly compatible with older video players.
      • Animated GIF: file format that provides lower quality images but allows embedding animations into webpages as simple images.
  • Advanced
    • ffmpeg executable: Path to ffmpeg executable. Requires download and installation of ffmpeg. Only needed if video export is selected.
    • Video extra options: Options for ffmpeg that controls video format and quality. Only needed if video export is selected.
    • Image file name pattern: Defines image file naming pattern. %05d will be replaced by the image number (5 numbers, padded with zeros). Only needed if video export is not selected.

Setting up ffmpeg

FFmpeg library is not packaged with 3D Slicer due to licensing restrictions. The FFmpeg library has to be downloaded and set up only once and 3D Slicer will remember its location.

  • Windows setup instructions
    • Download ffmpeg from here: https://ffmpeg.org/download.html (click Windows icon, select a package, for example 'Download FFmpeg64-bit static')
    • Extract downloaded package (for example, to C:\Users\Public)
    • Select ffmpeg.exe in Advanced section, fmpeg executable (for example, C:\Users\Public\ffmpeg-20160912-bc7066f-win32-static\bin\ffmpeg.exe)
  • MacOS setup instructions
    • Install homebrew (from http://brew.sh/)
    • Run: "brew install ffmpeg"
    • Select /usr/local/bin/ffmpeg in Advanced section, fmpeg executable

References

Information for Developers


Retrieved from "https://www.slicer.org/w/index.php?title=Documentation/Nightly/Modules/ScreenCapture&oldid=47008"