User Macro Document - read_datamine

<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">P0100</th> <th nowrap width="98%">ReadDatamine</th> <th nowrap width="1%">15th June 2000</th> </tr> <tr> <td align="left" colspan="3"> <p><b>Authors:</b> Jeremy Maccelari, Visual Numerics; Andrew Dodd, IAC <b>Version:</b> 1.0 <b>Path:</b> iac_proj/rd_dmine/</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="rd_dmine.shtml" target="_top"> <img src="../../../../img/doc_umac.gif" border="0" width="30" height="30" alt="User Macro Document - read_datamine"></a> <a href="source/data_io/rd_dmine/rd_dmine.tar.gz"> <img src="../../../../img/targz.gif" border="0" width="52" height="30" alt="Archive - rd_dmine.tar.gz"></a> <a href="source/data_io/rd_dmine/rd_dmine.tar.Z"> <img src="../../../../img/tarz.gif" border="0" width="52" height="30" alt="Archive - rd_dmine.tar.Z"></a> <a href="source/data_io/rd_dmine/rd_dmine.zip"> <img src="../../../../img/zip.gif" border="0" width="52" height="30" alt="Archive - rd_dmine.zip"></a> </td> </tr> </table> <br> </td> </tr> <tr> <td>  <h1>read_datamine</h1> <h3>Synopsis</h3> <p>The read_datamine macro reads datamine (.dm) format files.</p> <p> <h4>Input Ports</h4> <table class="parameters" summary="Input Ports used by read_datamine"> <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>dir</i></td> <td width="75">string</td> <td width="425">Directory containing datamine files</td> </tr> <tr> <td width="100"><i>filenames</i></td> <td width="75">string[]</td> <td width="425">Array of datamine filenames</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h4>Parameters</h4> <table class="parameters" summary="Parameters used by read_datamine"> <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>model_as_point</i></td> <td width="75">boolean</td> <td width="300">Output points or hex boxes.</td> <td width="125">Toggle</td> </tr> <tr> <td width="100"><i>model_scale</i></td> <td width="75">float</td> <td width="300">Specifies scale of hex boxes.</td> <td width="125">Slider</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h4>Output Ports</h4> <table class="parameters" summary="Output Ports used by read_datamine"> <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_flds</i></td> <td width="75">Field[]</td> <td width="425">Array of fields read from datamine files.</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> </p> <h3>Description</h3> <p>The read_datamine macro allows a number of datamine (.dm) files to be read and outputs an array of fields containing the read data. The datamine file format was developed by Datamine International Ltd of the UK for their <a href="http://www.datamine.co.uk">Datamine</a> product. Further information on the Datamine International and their Datamine series of products can be found on their web-sites at <a href="http://www.datamine.co.uk">www.datamine.co.uk</a> or <a href="http://www.earthworks.com.au">www.earthworks.com.au</a> . Alternatively Datamine International can be contacted at the following address.</p> <p> <pre> DATAMINE International The Old Deanery Stables Cathedral Green Wells Somerset BA5 2UE UK Tel. +44 1749 670097 Fax. +44 1749 670086 <a href="mailto:info@datamine.co.uk">mailto:info@datamine.co.uk</a> </pre> </p> <p>Many thanks go to Ben Heather and Derk Erkelens of Datamine for providing the file format specification and example data files used in the development of this project.</p> <h3>Inputs</h3> <p><b><i>dir</i></b></p> <p>Name of the directory that the datamine files should be read from. The directory string should <i>not</i> end with a path separator (i.e. \ or /). The directory name can contain AVS/Express environment strings such as $XP_PATH<0>.</p> <p><b><i>filenames[]</i></b></p> <p>Array of strings containing the names of the datamine files that should be read.</p> <h3>Parameters</h3> <p><b><i>model_as_point</i></b></p> <p>Boolean parameter that specifies if 'blockmodel' type data should be output as points or as hex blocks. If the parameter is true point data will be output. This parameter is provided because datamine files can contain hundreds of thousands of blocks. Outputting these is points will greatly reduce the time taken to read and process the data.</p> <p><b><i>model_scale</i></b></p> <p>Floating point parameter that specifies how hex blocks should be scaled. A value of 1 implies that the blocks should not be scaled. If the file does not contain 'blockmodel' type data or the data is being read as points this parameter does not have any effect.</p> <h3>Outputs</h3> <p><b><i>out_flds[]</i></b></p> <p>Array of fields containing the data read from the specified datamine files. Each datamine file is read into a single field in a single element of the array. If a single field is required for visualization the extract_field macro can be used to select a single field from the array.</p> <p><b><i>out_obj</i></b></p> <p>The GDobject version of the output, suitable for direct connection to the viewer. It contains the array of fields present on the out_flds output port.</p> <h3>Utility Macros</h3> <p>The ReadDatamineFunc functional macro uses the low-level ReadDatamineCore module. This functional macro and the ReadDatamineUI user interface macro are used by the read_datamine user macro. All of these macros use the ReadDatamineParams parameter block to communicate data.</p> <p>The extract_field utility macro is also provided. This macro allows a single field to be extracted from the array of fields output by the the read_datamine macro. An example of the use of this macro can be seen in the ReadDatamineEg example application.</p> <h3>Example</h3> <p>The project includes one example application that demonstrates the use of the read_datamine macro. The ReadDatamineEg application uses the read_datamine macro to read 4 datamine format files. These are output as an array of fields. extract_field and extract_component macros are used to extract a field containing a single set of node data from this array. This field is then displayed in the normal way.</p> <h3>Files</h3> <p><i>iac_proj/rd_dmine/rd_dmods.v</i> contains the V definitions of the ReadDatamineCore module and the ReadDatamineParams parameter block.</p> <p><i>iac_proj/rd_dmine/rd_dmacs.v</i> contains the V definitions of the ReadDatamineUI UI macro, the ReadDatamineFunc functional macro, the extract_field utility macro and the read_datamine user macro.</p> <p><i>iac_proj/rd_dmine/rd_dapps.v</i> contains the V definition of the ReadDatamineEg example application.</p> <h3>Other Notes</h3> <p>The low-level ReadDatamineMods library containing the low-level ReadDatamineCore module does not specify a process. By default the <tt>express</tt> process will be used.</p> <h3>Author</h3> <p> <pre> Jeremy Maccelari, Visual Numerics </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>  </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>