AVS Modules						      ucd comp(6)

NAME
     ucd comp - select a component of UCD data across multiple modules.

SUMMARY
     Name	   ucd comp

     Type	   data

     Inputs	   ucd

     Outputs	   choice
		   string

     Parameters	   choice
		   choice

DESCRIPTION

     The ucd comp module allows a component of model,  cell or node data to
     be selected from  a  UCD  structure.  The  selected  component is made
     available  on  an  output  port.  This  output can  be used to set the
     component  parameters  of other ucd  modules via  network connections.
     This  allows  a  single  set  of  radio buttons  to control  component
     selection in a number of UCD modules within a network.

     A component of model, cell or  nodal data is to be selected.  This  is
     controlled  through a choice widget.  It is  likely that in a  network
     this parameter will be not be  modified.  Therefore,  it is envisioned
     that  the network editor  will be  used  to delete  this set  of radio
     buttons in most networks.

     The module  also  outputs  a  suitable title  string  for the selected
     component.

INPUTS

     ucd (required; ucd)
	  A UCD structure.

OUTPUTS

     component (choice)
	  The selected component.

     title (string)
	  A title  string for the chosen data  component.  It has  the form
	  'component_label (in  component_units)'.   If there  are no units
	  set the  title  is  just  'component_label'.   A compilation flag
	  controls whether or not the title is capitalised.

PARAMETERS

      data vector (choice)
	  A set of radio buttons to select if a component of model, cell or
	  node data is to be selected.

      Choice (string)
	  A title bar for the choice widget.

      choice (choice)
	  A set of radio buttons to make the component selection.

EXAMPLE

     The example network ucd_comp.net illustrates  how  the ucd comp module
     may  be used within a network  using the ucd iso module.   The network
     uses the  ucd iso module's map scalar facility.   In  the  network the
     component and value that  is used to  make the  isosurface is selected
     with the ucd legend module.   The network editor is used to physically
     replace the Node  Data radio buttons from  the ucd iso module with the
     ones from ucd legend.  The rest of the control panel for ucd legend is
     deleted.

     The  map scalar radio  buttons cause  the iso  surface  to be  colored
     according to a second data component.  However, the color scale on the
     ucd legend widget is not the same  - potentially leading to confusion.
     For this reason the color legend and label modules are  used to create
     a second legend  widget inside the  geometry viewer  window.   The ucd
     component module  is  used to simultaneously select  the component  of
     data  used for  this  scale  (via ucd minmax) and  to  control the map
     scalar widget of the ucd iso  module.  In fact, the  network editor is
     used to physically replace the Map Scalar radio buttons with the radio
     buttons from ucd comp.

     The final network  control panel only  has  two  sets of radio buttons
     even  though the modules that  make up the network have five.  One set
     controls  the component  used  to construct  the surface  and the  ucd
     legend  widget.  The other controls  the component  used to color  the
     surface and  the  color  legend  and title  within the geometry viewer
     window.  The redundant  widgets  are all  deleted  using  the  network
     editor.

	
RELATED	MODULES
     Modules that could	provide	the UCD input:

	any module that produces ucd	  	

     Modules that can process ucd comp output:

	any ucd module with a component choice
	label

     Modules that can be used instead of ucd comp:

	choice
	ucd select

Release	5			    AVS			      ucd comp(6)