User Macro Document - cfd_range

<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">P0007</th> <th nowrap width="98%">CFDRange</th> <th nowrap width="1%">27th November 1998</th> </tr> <tr> <td align="left" colspan="3"> <p><b>Author:</b> Ian Curington <b>Version:</b> 1.0 <b>Path:</b> iac_proj/cfdrange/</p> <a href="../../filters.shtml" target="_top"><img src="../../../../img/filter.gif" width="44" height="30" border="0" alt="Filter"></a> <a href="doc_mod.shtml" target="_top"> <img src="../../../../img/doc_mod.gif" border="0" width="30" height="30" alt="Module Document - CFDRangeNodeData"></a> <a href="doc_umac.shtml" target="_top"> <img src="../../../../img/doc_umac.gif" border="0" width="30" height="30" alt="User Macro Document - cfd_range"></a> <a href="source/filters/cfdrange/cfdrange.tar.gz"> <img src="../../../../img/targz.gif" border="0" width="52" height="30" alt="Archive - cfdrange.tar.gz"></a> <a href="source/filters/cfdrange/cfdrange.tar.Z"> <img src="../../../../img/tarz.gif" border="0" width="52" height="30" alt="Archive - cfdrange.tar.Z"></a> <a href="source/filters/cfdrange/cfdrange.zip"> <img src="../../../../img/zip.gif" border="0" width="52" height="30" alt="Archive - cfdrange.zip"></a> </td> </tr> </table> <br> </td> </tr> <tr> <td>  <h1>cfd_range</h1> <h3>Synopsis</h3> <p> The cfd_range User Macro processes multi-block data, setting the min/max elements of each block to either the true global values or to user-defined values. </p> <h4>Input 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>&in</i></td> <td width="75">Node_Data[]</td> <td width="425">Input multi-block array</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h4>Parameters</h4> <p> The following lists all of the parameters found in the parameter block _NAME_Params, which are accessed by the module _NAMELL_ and the UI Macro _NAMEUI_. </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>min</i></td> <td width="75">double</td> <td width="300">user range min value</td> <td width="125">Min</td> </tr> <tr> <td width="100"><i>max</i></td> <td width="75">double</td> <td width="300">user range max value</td> <td width="125">Max</td> </tr> <tr> <td width="100"><i>lock_mode</i></td> <td width="75">int</td> <td width="300">set range mode toggle</td> <td width="125">Lock to User Range</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">Node_Data[]</td> <td width="425">Output multi-block array</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h3>Description</h3> <p> The cfd_range User Macro is a true multi-block module, the C code takes an array of blocks in and out. Actually, the output is CONNECTED to the input in V, so this is a pure reference pass-through module. It modifies the data inplace. </p> <p> If locked mode is off, it scans ALL the data in ALL the blocks, and finds each data component range. It then SETS the min/max subelement in EACH block to be this value, to force global consistancy. The first data element in the first component is shown on the user-interface. </p> <p> If lock mode is on, then the user type-in values on the interface or parameter block are used to force this range on all data components. This is likely to work best on just a single component, and is intended to have extract_component_ARR upstream. </p> <h3>Input Ports</h3> <p> <i><b>&in</b></i> </p> <p> The input mult-block array of NodeData. </p> <h3>Parameters</h3> <p> <i><b>&CFDRangeParams</b></i> </p> <p> Reference to the parameter block, which contains real instances of the min, max and lock_mode parameters. </p> <p> <i><b>min</b></i> </p> <p> User-defined min value for data if lock_mode is on. </p> <p> <i><b>max</b></i> </p> <p> User-defined max value for data if lock_mode is on. </p> <p> <i><b>lock_mode</b></i> </p> <p> Toggle the lock_mode. If on, the min/max values of the multi-block data is set to the user-defined values. If off, the true global value from the input blocks is used. </p> <h3>Output Ports</h3> <p> <i><b>out</b></i> </p> <p> The output multi-block node data array with the min/max subelements set accordingly. </p> <h3>Utility Macros</h3> <p> The user interface is provided in the CFDRangeUI macro, and this is combined with the low-level <a href="doc_mod.shtml" target="_top">CFDRangeNodeData</a> module to form the User Macro cfd_range. </p> <h3>Example</h3> <p> An example application is not provided. </p> <h3>Files</h3> <p> <i>iac_proj/cfdrange_/cfdrmacs.v</i> contains the cfd_range User Macro and the CFDRangeUI UI Macro V definitions. </p> <h3>Other Notes</h3> <p> The CFDRangeMacs library inherits its process. As this library contains no procedural code, the process is not important. The low-level CFDRangeNodeData module, executes under the process specified in its library, not the process defined in the high-level library. </p> <h3>Authors</h3> <p> <pre> Ian Curington </pre> </p> <h3>Modifications</h3> <p> <pre> Paul G. Lever </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> CFDRangeParams, CFDRangeUI, CFDRangeNodeData </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>