User Macro Document - Excavate_Brick

<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">P0154</th> <th nowrap width="98%">Excavate_Brick</th> <th nowrap width="1%">13th July 2001</th> </tr> <tr> <td align="left" colspan="3"> <p><b>Authors:</b> Dave Goughnour, AVS; Ma YingLiang, MVC <b>Version:</b> 1.0 <b>Path:</b> iac_proj/exbrk/</p> <a href="../../mappers.shtml" target="_top"><img src="../../../../img/mapper.gif" width="58" height="30" border="0" alt="Mapper"></a> <a href="exbrk.shtml" target="_top"> <img src="../../../../img/doc_umac.gif" border="0" width="30" height="30" alt="User Macro Document - Excavate_Brick"></a> <a href="source/mappers/exbrk/exbrk.tar.gz"> <img src="../../../../img/targz.gif" border="0" width="52" height="30" alt="Archive - exbrk.tar.gz"></a> <a href="source/mappers/exbrk/exbrk.tar.Z"> <img src="../../../../img/tarz.gif" border="0" width="52" height="30" alt="Archive - exbrk.tar.Z"></a> <a href="source/mappers/exbrk/exbrk.zip"> <img src="../../../../img/zip.gif" border="0" width="52" height="30" alt="Archive - exbrk.zip"></a> </td> </tr> </table> <br> </td> </tr> <tr> <td>  <h1>Excavate_Brick</h1> <h3>Synopsis</h3> <p> Excavate a quadrant in a 3D volume by setting all voxels to 0. </p> <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>Input_Field</i></td> <td width="75">Mesh+Data</td> <td width="425">input field</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> </p> <p> <h4>Parameters</h4> <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>X</i></td> <td width="75">int</td> <td width="300">x-coordinate of the slice plane</td> <td width="125">Slider</td> </tr> <tr> <td width="100"><i>Y</i></td> <td width="75">int</td> <td width="300">y-coordinate of the slice plane</td> <td width="125">Slider</td> </tr> <tr> <td width="100"><i>Z</i></td> <td width="75">int</td> <td width="300">z-coordinate of the slice plane</td> <td width="125">Slider</td> </tr> <tr> <td width="100"><i>belowX</i></td> <td width="75">boolean</td> <td width="300">set the slice plane to positive or negative value along X axis. </td> <td width="125">Toggle</td> </tr> <tr> <td width="100"><i>belowY</i></td> <td width="75">boolean</td> <td width="300">set the slice plane to positive or negative value along Y axis. </td> <td width="125">Toggle</td> </tr> <tr> <td width="100"><i>belowZ</i></td> <td width="75">boolean</td> <td width="300">set the slice plane to positive or negative value along Z axis. </td> <td width="125">Toggle</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> </p> <p> <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">Mesh+Data</td> <td width="425">output field of 3D volume.</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> </p> <h3>Description</h3> <p> Excavate_Brick is a technique for visualizing 3D field data. This module removes a retangular subvolume from a 3D field. The subvolume is defined by an X,Y and slice plane. The internal structure of a 3D field can be revealed using this module. </p> <p> The macro includes a user interface. The X,Y,Z and belowX, belowY, belowZ can be controlled from the user interface panel to define the position of the subvolume. </p> <p> Note: This module only works for 3D field data. </p> <h4>Inputs</h4> <p> <i><b>Input_field</b></i> </p> <p> Reference to the 3D input field. </p> <h4>Parameters</h4> <p> <i><b>X;Y;Z</b></i> </p> <p> the X, Y and Z position of the slice plane to define the location of 3D subvolume. </p> <p> <i><b>belowX; belowY; belowZ</b></i> </p> <p> set the slice plane to positive or negative value along X,Y and Z axis. </p> <h4>Outputs</h4> <p> <i><b>out</b></i> </p> <p> The output field of the Excavate_Brick macro is a new 3D field data with parts of the data set to zero. </p> <h3>Utility Modules</h3> <p> The User Macro ExcavateBrick makes use of the Functional Macro ExcavateBrickFunc and the UI Macro ExcavateBrickUI. </p> <h3>Example</h3> <p> An example application ExcavateBrickEg is provided, which uses the AVS/Express sample data file hydrogen.fld, to display a 3D volume. </p> <h3>Files</h3> <p><i>iac_proj/exbrk/exb_mods.v</i> contains the V definitions of the ExcavateBrickParams parameter block and the ExcavateBrick module.</p> <p><i>iac_proj/exbrk/exb_macs.v</i> contains the V definitions of the ExcavateBrickFunc Functional Macro, the ExcavateBrickUI User Interface Macro, and the Excavate_Brick User Macro. </p> <p><i>iac_proj/exbrk/exb_apps.v</i> contains the V definition of the example application ExcavateBrickEg.</p> <h3>Author</h3> <p> <pre> Dave Goughnour Advanced Visual Systems, Inc. </pre> </p> <h3>Modifications</h3> <p> <pre> MA YingLiang Manchester Visualization 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> excavate_brick3D </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>