OMERO.movie
===========

A short decription on how to create movies from OMERO.

Creating a movie from OMERO
---------------------------

OMERO provides a script to make Mpeg or Quicktime movies from any image in the
server. These movies are created by a script called :file:`Make_Movie.py`,
having a number of options, including: selecting a range of Z,T planes, the
channels to display, and more (see below). The movie can also show information
overlayed on the image: z-section, scale bar and timing.

The movie resulting from the script will automatically be uploaded to the server
and become a file attachment to the source image.

Viewing the movie
-----------------

The make movie script allows you to save the movie in two different
formats, a DivX-encoded AVI and QuickTime movie. To view the AVI you may
need to install a DivX codec from `DivX <https://www.divx.com/>`_. It
should be noted that the DivX AVI is normally 1/3 to 1/10 the size of
the QuickTime movie.

Installing the make movie script
--------------------------------

The make movie script currently uses the `mencoder <http://www.mplayerhq.hu/design7/dload.html>`_ utility to
encode the movies, this command should be in the path of the
computer (icegrid node) running the script.

There are macports, rpms and debs available for installing mencoder.

Make movie also uses Pillow_ and `numpy <https://www.scipy.org/install.html>`_.

Make movie command arguments
----------------------------

A detailed list of the commands accepted by the script are:

-  imageId: This id of the image to create the movie from
-  output: The name of the output file, without the extension
-  zStart: The starting z-section to create the movie from
-  zEnd: The final z-section
-  tStart: The starting timepoint to create the movie
-  tEnd: The final timepoint.
-  channels: The list of channels to use in the movie (index, from 0)
-  splitView: Should we show the split view in the movie (not available yet)
-  showTime: Show the average time of the aquisition of the channels in the frame.
-  showPlaneInfo: Show the time and z-section of the current frame.
-  fps: The number of frames per second of the movie
-  scalebar: The scalebar size in microns, if <=0 will not show scale bar.
-  format: The format of the movie to be created currently supports 'video/mpeg', 'video/quicktime'
-  overlayColour: The colour of the overlays, scalebar, time, as int(RGB)
-  fileAnnotation: The fileAnnotation id of the uploaded movie. (return value from script)