User Macro Document - isolabel

<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">P0058</th> <th nowrap width="98%">Isolabel</th> <th nowrap width="1%">16th August 1999</th> </tr> <tr> <td align="left" colspan="3"> <p><b>Author:</b> John Sheehan, Ian Curington, Andrew Dodd <b>Version:</b> 1.0 <b>Path:</b> iac_proj/isolabel/</p> <a href="../../mappers.shtml" target="_top"><img src="../../../../img/mapper.gif" width="58" height="30" border="0" alt="Mapper"></a> <a href="doc_mod.shtml" target="_top"> <img src="../../../../img/doc_mod.gif" border="0" width="30" height="30" alt="Module Document - Isolabel_core"></a> <a href="doc_umac.shtml" target="_top"> <img src="../../../../img/doc_umac.gif" border="0" width="30" height="30" alt="User Macro Document - isolabel"></a> <a href="source/mappers/isolabel/isolabel.tar.gz"> <img src="../../../../img/targz.gif" border="0" width="52" height="30" alt="Archive - isolabel.tar.gz"></a> <a href="source/mappers/isolabel/isolabel.tar.Z"> <img src="../../../../img/tarz.gif" border="0" width="52" height="30" alt="Archive - isolabel.tar.Z"></a> <a href="source/mappers/isolabel/isolabel.zip"> <img src="../../../../img/zip.gif" border="0" width="52" height="30" alt="Archive - isolabel.zip"></a> <a href="image_isolabel.shtml" target="_top"> <img src="../../../../img/image.gif" border="0" width="42" height="30" alt="Example Image"></a> </td> </tr> </table> <br> </td> </tr> <tr> <td>  <h1>isolabel</h1> <h3>Synopsis</h3> <p> A mapper module that adds text labels to isolines. It processes the output from the isoline module and generates a DataObject that can be directly displayed. </p> <p> <h4>Input Ports</h4> <table class="parameters" summary="Input Ports used by isolabel"> <tr> <td width="100"><b>Name</b></td> <td width="80"><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="80">Mesh + Node Data</td> <td width="425">input data used to generate labels</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h4>Parameters</h4> <table class="parameters" summary="Parameters used by isolabel"> <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>num_labels</i></td> <td width="75">int</td> <td width="300">number of labels</td> <td width="125">UIslider</td> </tr> <tr> <td width="100"><i>format</i></td> <td width="75">string</td> <td width="300">formating specification</td> <td width="125">-</td> </tr> <tr> <td width="100"><i>dec_pnts</i></td> <td width="75">int</td> <td width="300">number of decimal points</td> <td width="125">UIslider</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h4>Output Ports</h4> <table class="parameters" summary="Output Ports used by isolabel"> <tr> <td width="100"><b>Name</b></td> <td width="80"><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_mesh</i></td> <td width="80">Mesh</td> <td width="425">locations of labels</td> </tr> <tr> <td width="100"><i>out_text</i></td> <td width="80">string[]</td> <td width="425">text of labels</td> </tr> <tr> <td width="100"><i>out_obj</i></td> <td width="80">DataObject</td> <td width="425">directly renderable output object</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> </p> <h3>Description</h3> <p> The isolabel macro generates and displays text annotation labels for isoline visualizations. It connects to the field output of the isoline module and generates a Point mesh and an array of string values. The macro also generates a DataObject which can be viewed directly. In most cases it will only be necessary to use the generated DataObject. However if you wish to use the raw outputs the Point mesh contains the position of the labels while the string array contains the actual label text at each point. The number of labels output and number of decimal points displayed can both be controlled through a user interface. A text_glyph user interface is also presented so that the text display can be controlled. The module is designed to work best when used with an isoline module, however it can be used to generate text labels for any Mesh with a matching set of scalar Node data. </p> <p> The label placement algorithm is quite simple and works best in a 2D isoline context. The module subsamples the input node list at even intervals. This will generate a series of nodes that are regularly spaced throughout the input data. Provided the input nodes are distributed evenly in space the output nodes should also be evenly distributed. Although this method works acceptably in most contexts it should be noted that it is not suitable for animation. Due to the way the algorithm works the labels move around unpredictably as parameters are changed. Hence, for example, recording a moving othroslice with labels would not be possible. The display DataObject is generated by using a text_glyph module internally. A standard user interface is displayed for this module. </p> <h3>Inputs</h3> <p> <i><b>in</b></i> </p> <p> Reference to a set of Field data which should be used by the module to generate the text labels. The Field should consist of a Mesh and Node Data. Only the first set of Node data is used and that Node data must be scalar. </p> <h3>Parameters</h3> <p> <i><b>num_labels</b></i> </p> <p> A member of the Isolabel_Params parameter block group, this integer value is used to specify the number of text labels that should be generated. The UI slider component sets a maximum of 50 labels. If more labels are required the parameter can be directly modified. In theory the macro should be able to generate any number of labels. </p> <p> <i><b>format</b></i> </p> <p> A member of the Isolabel_Params parameter block group, this string value is used to specify the C style formatting specification. This sets how the Node data values should be converted into text. Normally it should not be necessary to alter this parameter and hence there is no user interface. Further details of the use of this parameter can be found in the low-level module <a href="doc_mod.shtml" target="_top">documentation</a>. </p> <p> <i><b>dec_pnts</b></i> </p> <p> A member of the Isolabel_Params parameter block group, this integer value is used to specify the number of decimal points that each text labels should have. Internally this parameter is used to generate a formatting string that is passed to the low-level module. </p> <h3>Outputs</h3> <p> <i><b>out_mesh</b></i> </p> <p> Point mesh containing the locations of each text label. If the input mesh contains any transformation data this is copied across to the output mesh. </p> <p> <i><b>out_text[]</b></i> </p> <p> String array containing the actual label text that should be displayed. </p> <p> <i><b>out_obj</b></i> </p> <p> The directly renderable output of the isolabel macro. This contains a DataObject object that can be rendered by the standard data viewers. The output object will contain the generated text labels placed at the appropriate positions. The output object is generated internally by a text_glyph module. If more control of the display is required the other outputs can be used. Alternatively the Functional macro could be used directly. </p> <h3>Utility Macros</h3> <p> The User Macro isolabel combines the Functional Macro Isolabel with the UI Macro IsolabelUI and the standard module text_glyph. The User macro also makes use of the common parameter block Isolabel_Params to tie the Functional Macro and UI macro together. </p> <h3>Example</h3> <p> Two example applications are provided, IsolabelEg1 and IsolabelEg2. These applications generate text labels for 2D and 3D isoline plots. </p> <h3>Files</h3> <p><i>iac_proj/isolabel/isl_macs.v</i> contains the V definitions of the Functional Macro Isolabel, the User macro isolabel, the UI macro IsolabelUI and the example applications IsolabelEg1 and IsolabelEg2. </p> <h3>Other Notes</h3> <p> The IsolabelMacs library inherits its process. As this library contains no procedural code, the process is not important. The modules in the low-level IsolabelMods library execute under the process specified in that library, not the process defined in the high-level library. </p> <p> Please refer to AVS documentation for more information on the isoline and text_glyph modules. This macro does not use the AG kit, and should not be confused with AGContour which also contains isoline labels. </p> <h3>Authors</h3> <p> <pre> John Sheehan, Ian Curington Advanced Visual Systems, Ltd. Hanworth Lane, Chertsey, Surrey, UK KT16 9JX </pre> </p> <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> <p> Isolabel_Params, <a href="doc_mod.shtml" target="_top">Isolabel_core</a>, Isolabel, IsolabelUI, IsolabelEg1, IsolabelEg2. </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>