1<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3//EN"> 2<HTML><HEAD> 3 <TITLE>User's Reference - Integer</TITLE> 4 <META HTTP-EQUIV="keywords" CONTENT="GRAPHICS VISUALIZATION VISUAL PROGRAM DATA 5MINING"> 6 <meta http-equiv="content-type" content="text/html;charset=ISO-8859-1"> 7</HEAD><BODY BGCOLOR="#FFFFFF" link="#00004b" vlink="#4b004b"> 8 <TABLE width=510 border=0 cellpadding=0 cellspacing=0> 9 <TR> 10 <TD><IMG src="../images/spacer.gif" width=80 height=1></TD> 11 <TD><IMG src="../images/spacer.gif" width=49 height=1></TD> 12 <TD><IMG src="../images/spacer.gif" width=24 height=1></TD> 13 <TD><IMG src="../images/spacer.gif" width=100 height=1></TD> 14 <TD><IMG src="../images/spacer.gif" width=3 height=1></TD> 15 <TD><IMG src="../images/spacer.gif" width=127 height=1></TD> 16 <TD><IMG src="../images/spacer.gif" width=6 height=1></TD> 17 <TD><IMG src="../images/spacer.gif" width=50 height=1></TD> 18 <TD><IMG src="../images/spacer.gif" width=71 height=1></TD> 19 </TR> 20 <TR> 21 <TD colspan=9><IMG src="../images/flcgh_01.gif" width=510 height=24 alt="OpenDX - Documentation"></TD> 22 </TR> 23 <TR> 24 <TD colspan=2><A href="../allguide.htm"><IMG src="../images/flcgh_02.gif" width=129 height=25 border="0" alt="Full Contents"></A></TD> 25 <TD colspan=3><A href="../qikguide.htm"><IMG src="../images/flcgh_03.gif" width=127 height=25 border="0" alt="QuickStart Guide"></A></TD> 26 <TD><A href="../usrguide.htm"><IMG src="../images/flcgh_04.gif" width=127 height=25 border="0" alt="User's Guide"></A></TD> 27 <TD colspan=3><B><A href="../refguide.htm"><IMG src="../images/flcgh_05d.gif" width=127 height=25 border="0" alt="User's Reference"></A></B></TD> 28 </TR> 29 <TR> 30 <TD><A href="refgu077.htm"><IMG src="../images/flcgh_06.gif" width=80 height=17 border="0" alt="Previous Page"></A></TD> 31 <TD colspan=2><A href="refgu079.htm"><IMG src="../images/flcgh_07.gif" width=73 height=17 border="0" alt="Next Page"></A></TD> 32 <TD><A href="../refguide.htm"><IMG src="../images/flcgh_08.gif" width=100 height=17 border="0" alt="Table of Contents"></A></TD> 33 <TD colspan=3><A href="refgu009.htm"><IMG src="../images/flcgh_09.gif" width=136 height=17 border="0" alt="Partial Table of Contents"></A></TD> 34 <TD><A href="refgu175.htm"><IMG src="../images/flcgh_10.gif" width=50 height=17 border="0" alt="Index"></A></TD> 35 <TD><A href="../srchindx.htm"><IMG src="../images/flcgh_11.gif" width=71 height=17 border="0" alt="Search"></A></TD> 36 </TR> 37 </TABLE> 38 <H3><A name="HDRINTEGER" ></A>Integer</H3> 39 <A NAME="IDX556"></A><A NAME="IDX557"></A> 40<P><STRONG>Category</STRONG> 41<P> 42<A HREF="refgu008.htm#HDRCATINT">Interactor</A> 43<A NAME="IDX558"></A> 44<P><STRONG>Function</STRONG> 45<P> 46Generates an integer within a specified range of values. 47<P><STRONG>Syntax</STRONG> 48<P> 49Available only through the user interface. 50<P> 51<P><STRONG>Inputs</STRONG> 52<BR> 53<TABLE BORDER> 54<TR> 55<TH ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">Name 56</TH><TH ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">Type 57</TH><TH ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">Default 58</TH><TH ALIGN="LEFT" VALIGN="TOP" WIDTH="40%">Description 59</TH></TR><TR> 60<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%"><TT><STRONG>data</STRONG></TT> 61</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">object 62</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">no default 63</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="40%">object from which interactor 64attributes can be derived 65 66</TD></TR><TR> 67<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%"><TT><STRONG>refresh</STRONG></TT> 68</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">flag 69</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">0 70</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="40%">reset the interactor 71 72</TD></TR><TR> 73<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%"><TT><STRONG>min</STRONG></TT> 74</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">integer 75</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">minimum data value 76</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="40%">minimum output integer 77</TD></TR><TR> 78<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%"><TT><STRONG>max</STRONG></TT> 79</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">integer 80</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">maximum data value 81</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="40%">maximum output integer 82</TD></TR><TR> 83<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%"><TT><STRONG>delta</STRONG></TT> 84</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">scalar 85</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">input dependent 86</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="40%">increment between successive 87integer outputs 88</TD></TR><TR> 89<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%"><TT><STRONG>method</STRONG></TT> 90</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">string 91</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">input dependent 92</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="40%">defines interpretation of delta 93input 94</TD></TR> 95 <tr> 96 <td align="LEFT" valign="TOP" width="20%"><B><TT><STRONG>start</STRONG></TT></B></td> 97 <td align="LEFT" valign="TOP" width="20%">string</td> 98 <td align="LEFT" valign="TOP" width="20%">"midpoint"</td> 99 <td align="LEFT" valign="TOP" width="40%">describes how the default output should be calculated</td> 100 </tr> 101 <TR> 102<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%"><TT><STRONG>label</STRONG></TT> 103</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">string 104</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">"Integer" 105</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="40%">global name applied to interactor 106stand-ins 107</TD></TR></TABLE> 108<P><STRONG>Outputs</STRONG> 109<BR> 110<TABLE BORDER> 111<TR> 112<TH ALIGN="LEFT" VALIGN="TOP" WIDTH="25%">Name 113</TH><TH ALIGN="LEFT" VALIGN="TOP" WIDTH="25%">Type 114</TH><TH ALIGN="LEFT" VALIGN="TOP" WIDTH="50%">Description 115</TH></TR><TR> 116<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="25%"><TT><STRONG>output</STRONG></TT> 117</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="25%">integer 118</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%">interactor output 119</TD></TR></TABLE> 120<P><STRONG>Functional Details</STRONG> 121<P> 122This interactor provides incremental control of various functions in 123a visual program (e.g., the number of contour lines currently 124displayed on an isosurface in the Image window). 125The integer range over which the module acts is governed by its 126attributes (e.g., minimum, maximum, and delta), which in turn 127are either (1) specified by the parameter values in its 128<TT><STRONG>Set Attributes...</STRONG></TT> dialog box or 129(2) determined from input to the module (e.g, 130a data field). 131In the second case, the interactor is said to be "data driven." 132<P> 133<P><B>Note: </B>The interactor is invoked by double-clicking on its icon in the 134VPE window. 135Its configuration dialog box is accessed from the 136<TT><STRONG>Edit</STRONG></TT> pull-down menu in 137the same window. 138<TABLE CELLPADDING="3"> 139<TR VALIGN="TOP"><TD><P><B><TT><STRONG>data</STRONG></TT> 140</B></TD><TD><P>is the object (usually a data field) from which the interactor 141can 142derive any or all of the minimum, maximum, and delta attributes 143when the corresponding input tabs are up. 144 145</TD></TR><TR VALIGN="TOP"><TD><P><B><TT><STRONG>refresh</STRONG></TT> 146</B></TD><TD><P>resets the interactor so that the output is computed from the 147current 148input. If <TT><STRONG>refresh</STRONG></TT> = 0 (the default), the output 149is recomputed only if the current output does not lie within the range 150of the current <TT><STRONG>data</STRONG></TT>. The default for the output of the interactor is defined by the start parameter.</TD></TR><TR VALIGN="TOP"><TD><P><B><TT><STRONG>min</STRONG></TT> 151 and <TT><STRONG>max</STRONG></TT> 152</B></TD><TD><P>specify the minimum and maximum values of the interactor's 153integer output. 154If set, these values override those implied by <TT><STRONG>data</STRONG></TT>. 155<P> 156If neither <TT><STRONG>min</STRONG></TT> nor <TT><STRONG>data</STRONG></TT> is 157specified, the interactor uses the minimum set in the 158<TT><STRONG>Set Attributes...</STRONG></TT> dialog box. 159<P> 160If neither <TT><STRONG>max</STRONG></TT> nor <TT><STRONG>data</STRONG></TT> is 161specified, the interactor uses the maximum set in the 162<TT><STRONG>Set Attributes...</STRONG></TT> dialog box. 163</TD></TR><TR VALIGN="TOP"><TD><P><B><TT><STRONG>delta</STRONG></TT> 164</B></TD><TD><P>specifies a scalar value as a factor for calculating the 165increment 166between successive outputs over the specified range. 167The actual value depends on the interpretation specified by 168<TT><STRONG>method</STRONG></TT> (see below). 169</TD></TR><TR VALIGN="TOP"><TD><P><B><TT><STRONG>method</STRONG></TT> 170</B></TD><TD><P>specifies the interpretation of <TT><STRONG>delta</STRONG></TT>: 171<UL COMPACT> 172<LI>"rounded": the increment (<TT><STRONG>max</STRONG></TT> - 173<TT><STRONG>min</STRONG></TT>) × <TT><STRONG>delta</STRONG></TT> is 174rounded to a "nice" number. 175The spacing between successive values will approximate the interval 176specified by <TT><STRONG>delta</STRONG></TT>. 177(For example, the default value of 0.01 specifies an interval of 1/100 178of the specified range.) 179<LI>"relative": the interpretation is the same as for 180"rounded," but the increment is <I>not</I> 181rounded. 182<LI>"absolute": <TT><STRONG>delta</STRONG></TT> is the absolute value 183of the interval. 184(If <TT><STRONG>delta</STRONG></TT> has not been specified, its default 185is 1.) 186<P> 187The default value for <TT><STRONG>method</STRONG></TT> depends on other input. 188The default is: 189<UL COMPACT> 190<LI>"rounded" if <TT><STRONG>data</STRONG></TT> is specified 191<I>or</I> if both <TT><STRONG>min</STRONG></TT> and 192<TT><STRONG>max</STRONG></TT> are specified. 193<LI>"absolute" in all other cases. 194</UL> 195</UL> 196</TD></TR> 197 <tr valign="TOP"> 198 <td><b><tt><strong>start</strong></tt></b></td> 199 <td>specifies how the default output should be calculated. Can be "minimum", "midpoint" or "maximum" (midpoint sets the value to the midpoint between min and max.)</td> 200 </tr> 201 <TR VALIGN="TOP"><TD><P><B><TT><STRONG>label</STRONG></TT> 202</B></TD><TD><P>is the global label of all instances of the corresponding 203interactor 204stand-in. 205An interactor instance's local label (set from the Control Panel) 206overrides a global label. 207By default, the global label is set by the user interface. 208</TD></TR></TABLE> 209<P><STRONG>Example Visual Programs</STRONG> 210<P> 211Many example visual programs use Integer interactors. 212An example program that uses a data-driven integer interactor is 213<TT>WindVorticity.net</TT> 214<P><STRONG>See Also</STRONG> 215<P> 216 <A HREF="refgu079.htm#HDRINTEGEL">IntegerList</A>, 217 <A HREF="refgu127.htm#HDRSCALAR">Scalar</A>, 218 <A HREF="refgu128.htm#HDRSCALARL">ScalarList</A>, 219 <A HREF="refgu169.htm#HDRVECTOR">Vector</A>, 220 <A HREF="refgu170.htm#HDRVECTORL">VectorList</A> 221 <P> 222 <HR> 223 <DIV align="center"> 224 <P><A href="../allguide.htm"><IMG src="../images/foot-fc.gif" width="94" height="18" border="0" alt="Full Contents"></A> <A href="../qikguide.htm"><IMG src="../images/foot-qs.gif" width="94" height="18" border="0" alt="QuickStart Guide"></A> <A href="../usrguide.htm"><IMG src="../images/foot-ug.gif" width="94" height="18" border="0" alt="User's Guide"></A> <A href="../refguide.htm"><IMG src="../images/foot-ur.gif" width="94" height="18" border="0" alt="User's Reference"></A></P> 225 </DIV> 226 <DIV align="center"> 227 <P><FONT size="-1">[ <A href="http://www.research.ibm.com/dx">OpenDX Home at IBM</A> | <A href="http://www.opendx.org/">OpenDX.org</A> ] </FONT></P> 228 <P></P> 229 </DIV> 230 <P></P> 231 </BODY></HTML> 232
