User Macro Document - texture_wave

<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">P0099</th> <th nowrap width="98%">TextureWave</th> <th nowrap width="1%">14th June 2000</th> </tr> <tr> <td align="left" colspan="3"> <p><b>Authors:</b> Ian Curington, AVS Inc.; Andrew Dodd, IAC <b>Version:</b> 1.0 <b>Path:</b> iac_proj/twave/</p> <a href="../../filters.shtml" target="_top"><img src="../../../../img/filter.gif" width="44" height="30" border="0" alt="Filter"></a> <a href="twave.shtml" target="_top"> <img src="../../../../img/doc_umac.gif" border="0" width="30" height="30" alt="User Macro Document - texture_wave"></a> <a href="twavefld.shtml" target="_top"> <img src="../../../../img/doc_umac.gif" border="0" width="30" height="30" alt="User Macro Document - texture_wave_field"></a> <a href="source/filters/twave/twave.tar.gz"> <img src="../../../../img/targz.gif" border="0" width="52" height="30" alt="Archive - twave.tar.gz"></a> <a href="source/filters/twave/twave.tar.Z"> <img src="../../../../img/tarz.gif" border="0" width="52" height="30" alt="Archive - twave.tar.Z"></a> <a href="source/filters/twave/twave.zip"> <img src="../../../../img/zip.gif" border="0" width="52" height="30" alt="Archive - twave.zip"></a> <a href="image_twave.shtml" target="_top"> <img src="../../../../img/image.gif" border="0" width="42" height="30" alt="Example Image"></a> <a href="../scl2tex/doc_umac.shtml" target="_top"> <img src="../../../../img/prereq.gif" width="30" border="0" height="30" alt="Pre-requisite - Filter - Scalar2Texture"></a> </td> </tr> </table> <br> </td> </tr> <tr> <td>  <h1>texture_wave</h1> <h3>Synopsis</h3> <p>The texture_wave macro generates a moving wave-pulse function in the alpha channel of an existing ARGB image field.</p> <h4>Input Ports</h4> <table class="parameters" summary="Input Ports used by texture_wave"> <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>in_image</i></td> <td width="75">Image_ARGB</td> <td width="425">Original image to add a texture pulse to.</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h4>Parameters</h4> <table class="parameters" summary="Parameters used by texture_wave"> <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>freq_value</i></td> <td width="75">float</td> <td width="300">Frequency of pulse function</td> <td width="125">Slider</td> </tr> <tr> <td width="100"><i>phase_value</i></td> <td width="75">float</td> <td width="300">Phase of pulse function</td> <td width="125">Slider</td> </tr> <tr> <td width="100"><i>wave_mode</i></td> <td width="75">int</td> <td width="300">Type of pulse function to be generated</td> <td width="125">Radiobox</td> </tr> <tr> <td width="100"><i>min_amp</i></td> <td width="75">float</td> <td width="300">Minimum amplitude of pulse function</td> <td width="125">Slider</td> </tr> <tr> <td width="100"><i>max_amp</i></td> <td width="75">float</td> <td width="300">Maximum amplitude of pulse function</td> <td width="125">Slider</td> </tr> <tr> <td width="100"><i>contrast</i></td> <td width="75">float</td> <td width="300">Colour contrast control</td> <td width="125">Slider</td> </tr> <tr> <td width="100"><i>animate</i></td> <td width="75">int</td> <td width="300">Trigger start of phase animation</td> <td width="125">Toggle</td> </tr> <tr> <td width="100"><i>numsteps</i></td> <td width="75">int</td> <td width="300">Number of step to be used in phase animation</td> <td width="125">Slider</td> </tr> <tr> <td width="100"><i>cycle</i></td> <td width="75">int</td> <td width="300">Specifies if phase animation should cycle</td> <td width="125">Toggle</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h4>Output Ports</h4> <table class="parameters" summary="Output Ports used by texture_wave"> <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_image</i></td> <td width="75">Image_ARGB</td> <td width="425">Image with generated pulse function</td> </tr> <tr> <td width="100"><i>out_obj</i></td> <td width="75">GDobject</td> <td width="425">Directly renderable output object</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h3>Description</h3> <p>The texture_wave macro generates a pulse-wave function in the alpha channel of an existing ARGB image field. Any image source that outputs ARGB data (such as <tt>read_image</tt> can be used. The macro replaces any existing alpha channel data with a 1 dimensional wave function that varies vertically across the image. The macro allows the frequency, phase and amplitude of the wave function to be controlled. It is also able to generate a variety of wave functions. Currently these are:</p> <ul> <li><p><b>Full Sine Wave</b></p></li> <li><p><b>Cosine Squared</b></p></li> <li><p><b>Cosine Medium Pulse</b><br> 8th power of cosine function</p></li> <li><p><b>Cosine Short Pulse</b><br> 20th power of cosine function</p></li> <li><p><b>50% Square Wave</b></p></li> </ul> <p>Finally the macro allows the contrast of the RGB components in the generated image to be controlled. As well as allowing manual control of phase the macro also provides an animation facility. This automatically increments the phase of the wave function hence moving the pulse-wave through the alpha channel of the image.</p> <p>Although the generated images could be used for other purpose they are intended to be used to texture complex geometric objects. If the generated image is applied to an object that has alpha blending enabled, then the pulse-wave function will control the visibility of the UV texture space. The animation facility can also be used. This technique can lead to some very interesting visualizations that cannot be easily achieved by other means. The <a href="twavefld.shtml" target="_top">texture_wave_field</a> macro uses the <a href="../scl2tex/doc_umac.shtml" target="_top">Scalar2Texture</a> macro to texture fields with generated pulse-wave images. It should be noted that animating textures on complex fields is a graphically intensive task and for decent results good hardware texture-mapping support is essential.</p> <p>A conference paper fully describing this technique can be obtained by contacting <a href="mailto:ianc@avs.com">Ian Curington</a>; the original author of this project.</p> <h3>Inputs</h3> <p><b><i>in_image</i></b> : Image_ARGB</p> <p>Original image data that is to be used as the basis of the pulse-wave image. The field data should contain a 2D structured mesh with a 4 byte vector of node data containing the Alpha, Red, Green and Blue components of the image. This is the field format output by modules such as read_image. Any data present in the alpha channel is completely replaced by the generated wave function.</p> <h3>Parameters</h3> <p><b><i>freq_value</i></b></p> <p>Floating point parameter that specifies the frequency of the wave function. This is defined as the number of complete cycles generated in the output image.</p> <p><b><i>phase_value</i></b></p> <p>Floating point parameter that specifies the phase of the wave function. This parameter should be in the range 0 to 1, and is automatically altered when animation is enabled.</p> <p><b><i>min_amp max_amp</i></b></p> <p>Floating point parameters that specify the minimum and maximum amplitudes of the wave function. These parameters should be in the range 0 to 1. If they are outside of this range the integer portion of the parameter is ignored.</p> <p><b><i>wave_mode</i></b></p> <p>Integer parameter that specifies which type of wave function should be used to generate the output. Currently 5 functions are supported. The numbers for each of these functions are:</p> <p> <ol start=0> <li>Full Sine Wave</li> <li>Cosine Squared</li> <li>Cosine Medium Pulse</li> <li>Cosine Short Pulse</li> <li>50% Square Wave</li> </ol> </p> <p><b><i>contrast</i></b></p> <p>Floating point parameter that specifies how the contrast of the RGB components of the original image should be altered in the output image. A contrast of 1 indicates that no change should be made to the colour of the original image.</p> <p><b><i>animate cycle</i></b></p> <p>Integer parameters that control the phase animation facility of the macro. When the animate parameter is set to 1 the macro repeatedly increments the phase of the wave function. This continues until one entire cycle has been completed. If the cycle parameter is set to 0 then the animate parameter is reset to 0 and the animate stops. If the cycle parameter is set to 1 then the phase is reset to 0 and the animate continues indefinitely.</p> <p><b><i>numsteps</i></b></p> <p>Integer parameter that specifies the number of steps that are to be used whilst animating the phase of the wave function. For each entire cycle the phase will be incremented <tt>numsteps</tt> times. Therefore if the number of steps is increased the animation will become smoother but will require more powerful graphical support.</p> <h3>Outputs</h3> <p><b><i>out_image</i></b> : Image_ARGB</p> <p>Output image containing the texture image with the generated pulse-wave stored in the alpha channel. The image is output as a field with a 2D structured mesh and a 4 byte vector of node data containing the ARGB components of the image.</p> <p><b><i>out_obj</i></b></p> <p>The GDobject version of the output, suitable for direct connection to the viewer. A 2D viewer is recommended. Since the alpha channel is normally invisible, only variations in image contrast should be visible after processing. To see the wave function directly, the <tt>extract_scalar</tt> module can be used to extract the alpha channel from the image data.</p> <h3>Utility Macros</h3> <p> The TextureWaveFunc functional macro uses the low-level TextureWaveCore module. This functional macro and the TextureWaveUI user interface macro are used by the texture_wave user macro. All of these macros use the TextureWaveParams parameter block to communicate data. </p> <h3>Example</h3> <p>The project includes two example applications that demonstrates the use of the texture_wave macro. The TextureWaveEg1 application uses the texture_wave macro to generate a wave and then extract the alpha channel so that it can be displayed directly. The TextureWaveEg2 application extends this by using a graphing module to visualization the wave function. This allows the actual form of the wave to be seen much more easily.</p> <h3>Files</h3> <p><i>iac_proj/twave/tw_mods.v</i> contains the V definitions of the TextureWaveCore module and the TextureWaveParams parameter block.</p> <p><i>iac_proj/twave/tw_macs.v</i> contains the V definitions of the TextureWaveUI UI macro, the TextureWaveFunc functional macro and the texture_wave and texture_wave_field user macros.</p> <p><i>iac_proj/twave/tw_apps.v</i> contains the V definitions of the TextureWaveEg1, TextureWaveEg2, TextureWaveEg3 and TextureWaveEg4 example applications.</p> <h3>Other Notes</h3> <p>The low-level TextureWaveMods library containing the low-level TextureWaveCore module does not specify a process. By default the <tt>express</tt> process will be used.</p> <h3>Author</h3> <p> <pre> Ian Curington, Advanced Visual Systems, Inc. </pre> </p> <h3>Modifications</h3> <p> <pre> Andrew Dodd, International AVS Centre </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> <ul> <li><a href="twavefld.shtml" target="_top">texture_wave_field</a> IAC module</li> <li><a href="../scl2tex/doc_umac.shtml" target="_top">Scalar2Texture</a> IAC project</li> <li>Contact the author for a full conference paper describing this technique.</li> </ul>  </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>