User Macro Document - Combine_Datasets_To_HSV ####PAGE_TITLE#### Combine_Datasets_To_RGB

<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">P0086</th> <th nowrap width="98%">CombineData</th> <th nowrap width="1%">17th April 2000</th> </tr> <tr> <td align="left" colspan="3"> <p><b>Authors:</b> Mark Lambert, AVS Inc.; Andrew Dodd, IAC <b>Version:</b> 1.0 <b>Path:</b> iac_proj/combdata/</p> <a href="../../filters.shtml" target="_top"><img src="../../../../img/filter.gif" width="44" height="30" border="0" alt="Filter"></a> <a href="combdata.shtml" target="_top"> <img src="../../../../img/doc_umac.gif" border="0" width="30" height="30" alt="User Macro Document - Combine_Datasets_To_HSV & Combine_Datasets_To_RGB"></a> <a href="source/filters/combdata/combdata.tar.gz"> <img src="../../../../img/targz.gif" border="0" width="52" height="30" alt="Archive - combdata.tar.gz"></a> <a href="source/filters/combdata/combdata.tar.Z"> <img src="../../../../img/tarz.gif" border="0" width="52" height="30" alt="Archive - combdata.tar.Z"></a> <a href="source/filters/combdata/combdata.zip"> <img src="../../../../img/zip.gif" border="0" width="52" height="30" alt="Archive - combdata.zip"></a> <a href="image_comb_hsv.shtml" target="_top"> <img src="../../../../img/image.gif" border="0" width="42" height="30" alt="Example Image"></a> <a href="image_comb_rgb.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>CombineData</h1> <h3>Synopsis</h3> <p>The macros provided in this project allow 3 sets of node data to be combined together so that colours can be generated using either the RGB or HSV colour models.</p> <p> <h4>Input Ports</h4> <table class="parameters" summary="Input Ports used by Combine_Datasets_To_HSV & Combine_Datasets_To_RGB"> <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_fld</i></td> <td width="75">Field</td> <td width="425">original field containing node data to be mapped.</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h4>Parameters</h4> <table class="parameters" summary="Parameters used by Combine_Datasets_To_HSV & Combine_Datasets_To_RGB"> <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>comp0</i></td> <td width="75">int</td> <td width="300">specifies red/hue node data component</td> <td width="125">Radio Box</td> </tr> <tr> <td width="100"><i>comp1</i></td> <td width="75">int</td> <td width="300">specifies blue/saturation node data component</td> <td width="125">Radio Box</td> </tr> <tr> <td width="100"><i>comp2</i></td> <td width="75">int</td> <td width="300">specifies green/value node data component</td> <td width="125">Radio Box</td> </tr> <tr> <td width="100"><i>constant0on<br>constant1on<br>constant2on</i></td> <td width="75">int</td> <td width="300">specifies whether to use a constant colour value</td> <td width="125">Toggle</td> </tr> <tr> <td width="100"><i>constant0val<br>constant1val<br>constant2val</i></td> <td width="75">float</td> <td width="300">specifies constant colour value to use</td> <td width="125">Slider</td> </tr> <tr> <td width="100"><i>invert0on<br>invert1on<br>invert2on</i></td> <td width="75">int</td> <td width="300">specifies whether to invert the input data</td> <td width="125">Toggle</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h4>Output Ports</h4> <table class="parameters" summary="Output Ports used by Combine_Datasets_To_HSV & Combine_Datasets_To_RGB"> <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_fld</i></td> <td width="75">Field</td> <td width="425">modified field containing colour node data.</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 CombineData project allows the user to directly generate a colour node data component by combining together other node data components using either the RGB or HSV colour models. Two user macros are provided that allow this to be done. The <tt>Combine_Datasets_To_RGB</tt> macro converts 3 node data components into values for Red, Green and Blue and generates another node data component containing colour data. Similarly the <tt>Combine_Datasets_To_HSV</tt> macro converts 3 node data components into values for Hue, Saturation and Value and generates another node data component containing colour data.</p> <p>Both macros normalize the input node data components before converting them into colour values. Both macros also provide a user interface so that the node data component to be used for each colour component can be choose. The user interface also allows the user to specify if the input data should be inverted or whether a constant value should be used for a colour component.</p> <p>Internally the user macros use two low-level modules that contain the C++ code necessary to perform the conversion between data values and colour values. The user interface macros, functional macros and user macros used by this project are built up by defining macros for the HSV colour model and then modifying them to create macros for the RGB colour model.</p> <h3>Inputs</h3> <p><b><i>in_fld</i></b></p> <p>Input field that is to be coloured using node data components. The field should contain at least one set of node data. The node data can be of any type and the colouring is not dependent upon the structure of the mesh.</p> <h3>Parameters</h3> <p><b><i>comp0</i></b></p> <p> Specifies which set of node data should be used for the first colour data component. This component is either the red component or the hue component depending upon which colour model is used. Before being converted into colour values the selected node data is normalized so that all values lie between 0 and 1. </p> <p><b><i>comp1</i></b></p> <p> Specifies which set of node data should be used for the second colour data component. This component is either the blue component or the saturation component depending upon which colour model is used. Before being converted into colour values the selected node data is normalized so that all values lie between 0 and 1. </p> <p><b><i>comp2</i></b></p> <p> Specifies which set of node data should be used for the third colour data component. This component is either the green component or the value component depending upon which colour model is used. Before being converted into colour values the selected node data is normalized so that all values lie between 0 and 1. </p> <p><b><i>constant0on constant1on constant2on</i></b></p> <p> If these parameters are not zero they specify that a constant value should be used for the appropriate component of the colour data. The constant value to be used is specified by the <tt>constant0val</tt>, <tt>constant1val</tt> and <tt>constant2val</tt> parameters. </p> <p><b><i>constant0val constant1val constant2val</i></b></p> <p> These floating point parameters specify the constant values that should be used instead of node data if the appropriate parameter is set (i.e. <tt>constant0on</tt>, <tt>constant1on</tt> or <tt>constant2on</tt>) The value of these parameters should be between 0 and 1. If the appropriate <tt>constant?on</tt> parameter is not set these parameters have no effect. </p> <p><b><i>invert0on invert1on invert2on</i></b></p> <p> If these parameters are not zero they specify that the normalized node data for the appropriate component should be inverted before it is used to calculate colour data. </p> <h3>Outputs</h3> <p><b><i>out_fld</i></b></p> <p>Output Field data containing both the original node data components and the colour node data component has been generated. </p> <p><b><i>out_obj</i></b></p> <p>The GDobject version of the output, suitable for direct connection to the viewer. AVS/Express will by default display this Object with the colours specified in the colour node data component.</p> <h3>Utility Macros</h3> <p>The CombineData project makes use of three utility macros. <tt>CMBD_extract_data_array</tt> allows a node data component to be extracted with out the need for a user interface. <tt>DVadd_node_data</tt> allows a set of colour node data to be added to an existing set of field data. <tt>CMBD_ComponentBox</tt> creates a UI panel containing the controls necessary for a single component of colour.</p> <p>The CombineDataParams parameter block is also used by all of the User Interface, Functional and User macros.</p> <h3>Example</h3> <p>The CombineDataEg example application is provided with this project. This application demonstrates how node data can be combined using either colour model. A block of data containing 3 node data components is read and an orthoslice is taken of the data. This orthoslice is then coloured by both the <tt>Combine_Datasets_To_RGB</tt> and <tt>Combine_Datasets_To_HSV</tt> macros and the results displayed in two separate windows.</p> <h3>Files</h3> <p><i>iac_proj/combdata/cmbdmods.v</i> contains the V definitions of the DVcombine_data_to_HSV, DVcombine_data_to_RGB and DVadd_node_data low-level modules, the CMBD_extract_data_array utility module and the CombineDataParams parameter block.</p> <p><i>iac_proj/combdata/cmbdmacs.v</i> contains the V definitions of the UI component CMBD_ComponentBox, the User Interface macros Combine_Datasets_To_HSV_UI and Combine_Datasets_To_RGB_UI, the functional macros Combine_Datasets_To_HSV_Func and Combine_Datasets_To_RGB_Func, the user macros Combine_Datasets_To_HSV and Combine_Datasets_To_RGB and the example application CombineDataEg.</p> <h3>Other Notes</h3> <p>The low-level CombineDataMods library containing the module does not specify a process. By default the <tt>express</tt> process will be used.</p> <h3>Authors</h3> <p> <pre> Mark Lambert Advanced Visual Systems, Inc. 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> N/A </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>