User Macro Document - read_gocad

<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">P0020</th> <th nowrap width="98%">ReadGocad</th> <th nowrap width="1%">10th June 1998</th> </tr> <tr> <td align="left" colspan="3"> <p><b>Author:</b> Justin Greenhalgh and Federico Gamba <b>Version:</b> 1.1 <b>Path:</b> iac_proj/rdgocad/</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 - ReadGocad"></a> <a href="doc_umac.shtml" target="_top"> <img src="../../../../img/doc_umac.gif" border="0" width="30" height="30" alt="User Macro Document - read_gocad"></a> <a href="source/data_io/rdgocad/rdgocad.tar.gz"> <img src="../../../../img/targz.gif" border="0" width="52" height="30" alt="Archive - rdgocad.tar.gz"></a> <a href="source/data_io/rdgocad/rdgocad.tar.Z"> <img src="../../../../img/tarz.gif" border="0" width="52" height="30" alt="Archive - rdgocad.tar.Z"></a> <a href="source/data_io/rdgocad/rdgocad.zip"> <img src="../../../../img/zip.gif" border="0" width="52" height="30" alt="Archive - rdgocad.zip"></a> </td> </tr> </table> <br> </td> </tr> <tr> <td>  <h1>gocad</h1> <h3>Synopsis</h3> <p> Imports and scales data from a GOCAD file along the x, y and z axes. </p> <hr> <p> <h4>Input Ports</h4> <table class="parameters" summary="Input Ports used by read_gocad"> <tr> <td width="125"><i>none</i></td> </tr> </table> <h4>Parameters</h4> <table class="parameters" summary="Parameters used by read_gocad"> <tr> <td width="125"><i>x</i></td> <td width="150">float</td> <td width="300">x axis, scaling value</td> </tr> <tr> <td width="125"><i>y</i></td> <td width="150">float</td> <td width="300">y axis, scaling value</td> </tr> <tr> <td width="125"><i>z</i></td> <td width="150">float</td> <td width="300">z axis, scaling value</td> </tr> <tr> <td width="125"><i>scale</i></td> <td width="150">boolean</td> <td width="300">scaling on/off</td> </tr> <tr> <td width="125"><i>file_name</i></td> <td width="150">string</td> <td width="300">GOCAD file name</td> </tr> </table> <h4>Output Ports</h4> <table class="parameters" summary="Output Ports used by read_gocad"> <tr> <td width="125"><i>out_mesh</i></td> <td width="170">Xform+Cells+Grid</td> <td width="300">Scaled data from GOCAD file</td> </tr> <tr> <td width="125"><i>out_obj</i></td> <td width="170">DefaultObject</td> <td width="300">output for 2D or 3D Uviewer</td> </tr> </table> </p> <h3>Description</h3> <p> gocad is a data import reader module for the GOCAD (ASCII) file format. The GOCAD application models, edits, and describes 3D geologic structures, containing horizon surfaces, faults, and wells. The GOCAD application is authored by a group in Nancy, France. Gocad reads the contents of one GOCAD file, which can then be sent to a Uviewer for interactive viewing via a UI Macro. </p> <h3>Input Ports</h3> <p> <i><b>none</b></i> </p> <h3>Parameters</h3> <p> <i><b>x, y and z</b></i> </p> <p> Members of the GocadParams parameter block group, these float values are used to scale the image. </p> <p> <i><b>scale</b></i> </p> <p> A member of the GocadParams parameter block group, this boolean value is used to switch scaling on or off. </p> <p> <i><b>file_name</b></i> </p> <p> A member of the GocadParams parameter block group, this string contains the input file name. GOCAD files have the extension ".tsurf". </p> <h3>Output Ports</h3> <p> <i><b>out_mesh</b></i> </p> <p> Scaled (if enabled) data from GOCAD file, in the form of Xform+Cells+Grid. </p> <p> <i><b>out_obj</b></i> </p> <p> Output suitable for use with 2D and 3D Uviewer. This DataObject is generated from the data present in the out_mesh output. </p> <h3>Utility Macros</h3> <p> The User Macro read_gocad combines the macro Gocad (which uses the low-level <a href="doc_mod.shtml" target="_top">ReadGocad</a> module) with the UI Macro GocadUI via the common parameter block GocadUI. </p> <h3>Example</h3> <p> An example application ReadGocadEg is provided, which uses the file worldmap.tsurf, to display a picture of the world. </p> <h3>Files</h3> <p> <I>iac_proj/rdgocad/goc_macs.v</I> contains the Functional Macro Gocad, the User Macro read_gocad, the UI Macro GocadUI and the Example Application ReadGocadEg. </p> <h3>Other Notes</h3> <p> The GocadMacs library inherits its process. As this library contains no procedural code, the process is not important. The low-level ReadGOCAD module, executes under the process specified in its library, not the process defined in the high-level library. </p> <h3>Authors</h3> <p> <pre> AVS5 version Ian Curington, AVS/UNIRAS Ltd. Ported to Express by Justin Greenhalgh Manchester Visualization Centre Manchester Computing University of Manchester Oxford Road Manchester UK M13 9PL </pre> </p> <h3>See Also</h3> <p> GocadParams, <a href="doc_mod.shtml" target="_top">ReadGOCAD</a>, Gocad and GocadUI. </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>