User Macro Document - imagePlayer

<table cellspacing="0" cellpadding="0"> <tr height="150"> <td align="left"><img src="../../../../img/logo.gif" alt="IAC logo"></img></td> <td width="100%" rowspan="2" align="left" valign="center"> <table cellspacing="0" cellpadding="0"> <tr> <td> <table class="navigate_doc" width="100%" border="0" align="center"> <tr bgcolor="c6c6e0" align="center"> <th nowrap width="1%" height="32">P0039</th> <th nowrap width="98%">AVSImagePlayer</th> <th nowrap width="1%">26th January 1999</th> </tr> <tr> <td align="left" colspan="3"> <p><b>Author:</b> Fernand Alcatrao <b>Version:</b> 1.0 <b>Path:</b> iac_proj/ximg_ply/</p> <a href="../../data_io.shtml" target="_top"><img src="../../../../img/data_io.gif" width="60" height="30" border="0" alt="Data IO"></a> <a href="doc_mod.shtml" target="_top"> <img src="../../../../img/doc_mod.gif" border="0" width="30" height="30" alt="Module Document - AVSImagePlayer"></a> <a href="doc_umac.shtml" target="_top"> <img src="../../../../img/doc_umac.gif" border="0" width="30" height="30" alt="User Macro Document - imagePlayer"></a> <a href="source/data_io/ximg_ply/ximg_ply.tar.gz"> <img src="../../../../img/targz.gif" border="0" width="52" height="30" alt="Archive - ximg_ply.tar.gz"></a> <a href="source/data_io/ximg_ply/ximg_ply.tar.Z"> <img src="../../../../img/tarz.gif" border="0" width="52" height="30" alt="Archive - ximg_ply.tar.Z"></a> <a href="source/data_io/ximg_ply/ximg_ply.zip"> <img src="../../../../img/zip.gif" border="0" width="52" height="30" alt="Archive - ximg_ply.zip"></a> </td> </tr> </table> <br> </td> </tr> <tr> <td>  <h1>imagePlayer</h1> <h3>Synopsis</h3> <p> Animates a number of AVS x format image files stored in memory or on disk. </p> <p> <h4>Parameters</h4> <p> The following lists all of the parameters found in the parameter block ImagePlayerParams, which are accessed by the module AVSImagePlayer and the UI Macro ImagePlayerUI. </p> <table class="parameters"> <tr> <td width="100"><b>Name</b></td> <td width="75"><b>Type</b></td> <td width="300"><b>Description</b></td> <td width="125"><b>UI Control</b></td> </tr> <tr> <td colspan="4"><hr></td> </tr> <tr> <td width="100"><i>file_format</i></td> <td width="75">string</td> <td width="300">filename specification</td> <td width="125"><tt>File Format</tt></td> </tr> <tr> <td width="100"><i>nb_images</i></td> <td width="75">int</td> <td width="300">total number of images</td> <td width="125"><tt>Number of Images</tt></td> </tr> <tr> <td width="100"><i>first_image</i></td> <td width="75">int</td> <td width="300">first index number</td> <td width="125"><tt>First Image</tt></td> </tr> <tr> <td width="100"><i>step</i></td> <td width="75">int</td> <td width="300">value of loop increment</td> <td width="125"><tt>Step</tt></td> </tr> <tr> <td width="100"><i>access_mode</i></td> <td width="75">int</td> <td width="300">memory or disk access</td> <td width="125"><tt>Access Mode</tt></td> </tr> <tr> <td width="100"><i>run_mode</i></td> <td width="75">int</td> <td width="300">forward, backwards or cycle control</td> <td width="125"><tt>Run Mode</tt></td> </tr> <tr> <td width="100"><i>fps</i></td> <td width="75">float</td> <td width="300">animation rate in frames per second</td> <td width="125"><tt>Frames per sec</tt></td> </tr> <tr> <td width="100"><i>nsec_before</i></td> <td width="75">int</td> <td width="300">secs before animation is restarted</td> <td width="125"><tt>Nsec Before</tt></td> </tr> <tr> <td width="100"><i>nsec_after</i></td> <td width="75">int</td> <td width="300">secs before animation returns to first frame</td> <td width="125"><tt>Nsec After</tt></td> </tr> <tr> <td width="100"><i>count</i></td> <td width="75">int</td> <td width="300">index number of current image</td> <td width="125"><tt>Image Number</tt> slider</td> </tr> <tr> <td width="100"><i>real_fps</i></td> <td width="75">string</td> <td width="300">actual animation rate</td> <td width="125"><tt>Real Frame/s</tt> label</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h4>Output Ports</h4> <table class="parameters"> <tr> <td width="100"><b>Name</b></td> <td width="75"><b>Type</b></td> <td width="425"><b>Description</b></td> </tr> <tr> <td colspan="4"><hr></td> </tr> <tr> <td width="100"><i>out</i></td> <td width="75">field data</td> <td width="425">currently displayed image data</td> </tr> <tr> <td width="100"><i>obj</i></td> <td width="75">DataObject</td> <td width="425">directly renderable object</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h3>Description</h3> <p> The imagePlayer macro is a high level user macro that is able to read in image files in the AVS x format and then animate them either from memory or by loading each image as it is required. The image filenames are specified by using a C-style format-string and a number of parameters. The module is also able to control the rate at which the images are animated, whether the animation runs forward or backwards and whether the animation cycles continously. All of these functions are controllable through a User Interface. The images are output as both a uniform mesh with colours represented by node data, and a renderable DataObject that is generated from the uniform mesh. </p> <h3>Parameters</h3> <p> <i><b>ImagePlayerParams.file_format</b></i> </p> <p> A member of the ImagePlayerParams parameter block group, this string value is used to specify the filename formatting string that is used to load the sequence of image files. This is down by using a C-style formatting expression to generate indexed filenames. </p> <p> Therefore setting <TT>file_format</TT> to <TT>"Imag%d.x"</TT> will generate filenames of the form <TT>"Image0.x"</TT> with no leading characters; whilst setting the parameter to <TT>"Image%04d.x"</TT> will generate filenames which are padded with zeros to be 8 characters long (i.e. <TT>"Imag0001.x"</TT>). More information can be found in any C reference book. </p> <p> <i><b>ImagePlayerParams.nb_images</b></i> </p> <p> A member of the ImagePlayerParams parameter block group, this int value specifies the total number of images that are to be animated. The animation will stop or repeat as appropriate when this many frames have been displayed. </p> <p> <i><b>ImagePlayerParams.first_image</b></i> </p> <p> A member of the ImagePlayerParams parameter block group, this int value specifies the index number of the first image to be animated. </p> <p> <i><b>ImagePlayerParams.step</b></i> </p> <p> A member of the ImagePlayerParams parameter block group, this int value specifies the value that the index number should be incremented by during each iteration of the animation loop. </p> <p> <i><b>ImagePlayerParams.access_mode</b></i> </p> <p> A member of the ImagePlayerParams parameter block group, this int value specifies whether images should be animated from memory or from disk. Setting the parameter to 0 specifies that each image should be read from disk immediately before it is displayed. Setting the parameter to 1 specifies that all the images should be loaded into memory before the animation begins and displayed directly from memory. </p> <p> <i><b>ImagePlayerParams.run_mode</b></i> </p> <p> A member of the ImagePlayerParams parameter block group, this int value specifies how the animation should be performed. There are four possible values for this parameter:- </p> <dl compact> <dt>0 <dd>Play forwards until last frame is reached <dt>1 <dd>Play forwards continously, cycling to start when last frame is reached <dt>2 <dd>Play backwards until first frame is reached <dt>3 <dd>Play backwards continously, cycling to end when first frame is reached </dl> <p> <i><b>ImagePlayerParams.fps</b></i> </p> <p> A member of the ImagePlayerParams parameter block group, this float value specifies the rate at which the animation should run in frames per second. This is the intended animation rate. If the system is unable to achieve this rate then the animation will run at a lower rate. </p> <p> <i><b>ImagePlayerParams.nsec_before</b></i> </p> <p> A member of the ImagePlayerParams parameter block group, this int value specifies the number of seconds that the animation should wait at the starting frame before the animation is restarted. This parameter only applies when the animation is cycling. </p> <p> <i><b>ImagePlayerParams.nsec_after</b></i> </p> <p> A member of the ImagePlayerParams parameter block group, this int value specifies the number of seconds that the animation should wait at the ending frame before the animation returns to the starting frame. This parameter only applies when the animation is cycling. </p> <p> <i><b>ImagePlayerParams.count</b></i> </p> <p> A member of the ImagePlayerParams parameter block group, this int value specifies the index number of the currently displayed image. Setting this parameter will cause the currently displayed image to change immediately. </p> <p> <i><b>ImagePlayerParams.real_fps</b></i> </p> <p> A member of the ImagePlayerParams parameter block group, this string value displays the number of frames per second that the animation is actually running at. The parameter is intended for display only and to ease display the number of frames per second is included along with an appropriate message by the module. </p> <h3>Output Ports</h3> <p> <i><b>out</b></i> </p> <p> The currently displayed image output as Field data. The image is represented by a uniform mesh. The colour of each pixel is represented by a vector of length 4 (i.e. alpha, red, green, blue) at each node data point. </p> <p> <i><b>obj</b></i> </p> <p> The directly renderable output field of the AVSImagePlayer module. This contains a DataObject object that can be rendered by the standard data viewers. The DataObject is generated directly from the field data created from the currently displayed image. </p> <h3>Utility Macros</h3> <p> The low-level AVSImagePlayer module is used in the User Macro imagePlayer. Additionally, this macro also uses the ImagePlayerParams parameter block group object, as does the ImagePlayerUI UI Macro. </p> <h3>Example</h3> <p> An example application AVSImagePlayerEg is provided, which uses the animation module to display a sequence of images generated for a Meteorological Office presentation on global warming. </p> <h3>Files</h3> <p> <i>iac_proj/ximg_ply/iplymacs.v</i> contains the imagePlayer User Macro, the ImagePlayerUI UI Macro, and the example application AVSImagePlayerEg V definitions. </p> <h3>Other Notes</h3> <p> The AVSImagePlayerMacs library inherits its process. As this library contains no procedural code, the process is not important. The low-level AVSImagePlayer module, executes under the process specified in its library, not the process defined in the high-level library. </p> <h3>Authors</h3> <p> <pre> Fernand Alcatrao </pre> </p> <h3>Modifications</h3> <p> <pre> Andrew Dodd </pre> </p> <h3>Contact</h3> <p> <pre> International AVS Centre Manchester Visualization Centre Manchester Computing University of Manchester Oxford Road Manchester United Kingdom M13 9PL </pre> </p> <h3>See Also</h3> <p> ImagePlayerParams, ImagePlayerUI and AVSImagePlayer. </p>  </td> </tr> </table> </td> </tr> <tr height="100%"> <td class="sideLink" width="25%" align="left" valign="top" nowrap="nowrap"> <p><a href="../../../../general/index.shtml" target="_top">General Information</a></p> <p><a href="../../../../repository/index.shtml" target="_top">Repositories</a></p> <p class="sideLinkLevel2"><a href="../../../new/index.shtml" target="_top">  New Releases</a></p> <p class="sideLinkLevel2"><a href="../../../download/index.shtml" target="_top">  Download</a></p> <p class="sideLinkLevel2"><a href="../../../submit/index.shtml" target="_top">  Submit</a></p> <p class="sideLinkLevel2"><a href="../../../pfiles/index.shtml" target="_top">  Project Files</a></p> <p class="sideLinkLevel2"><a href="../../../avs5/index.shtml" target="_top">  AVS5</a></p> <p class="sideLinkLevel2"><a href="../../../express/index.shtml" target="_top">  AVS/Express</a></p> <p class="sideLinkLevel3"><a href="../../atoz.shtml" target="_top">    A to Z</a></p> <p class="sideLinkLevel3"><a href="../../number.shtml" target="_top">    Project #</a></p> <p></p> <p class="sideLinkLevel3"><a href="../../data_io.shtml" target="_top">    Data IO</a></p> <p class="sideLinkLevel3"><a href="../../filters.shtml" target="_top">    Filters</a></p> <p class="sideLinkLevel3"><a href="../../mappers.shtml" target="_top">    Mappers</a></p> <p class="sideLinkLevel3"><a href="../../misc.shtml" target="_top">    Miscellaneous</a></p> <p class="sideLinkLevel3"><a href="../../special.shtml" target="_top">    Special Projects</a></p> <p class="sideLinkLevel2"><a href="../../../pog/index.shtml" target="_top">  Project Guidelines</a></p> <p><a href="../../../../usergroup/index.shtml" target="_top">User Group</a></p> <p><a href="../../../../training/index.shtml" target="_top">Training Materials</a></p> </td> </tr> </table> <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="c6c6e0"> <tr> <td><img src="../../../../img/foot1.gif" alt="IAC" width="155" height="25"></td> <td width="100%"> Last Updated:  26th November 2002 </td> </tr> </table>