1<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3//EN"> 2<HTML><HEAD> 3 <TITLE>User's Reference - CollectSeries</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="refgu031.htm"><IMG src="../images/flcgh_06.gif" width=80 height=17 border="0" alt="Previous Page"></A></TD> 31 <TD colspan=2><A href="refgu033.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="HDRCOLLECS" ></A>CollectSeries</H3> 39 <A NAME="IDX411"></A><A NAME="IDX412"></A> 40<P><STRONG>Category</STRONG> 41<P> 42<A HREF="refgu008.htm#HDRCATSTR">Structuring</A> 43<P><STRONG>Function</STRONG> 44<P> 45Collects objects into a series. 46<P><STRONG>Syntax</STRONG> 47<PRE><STRONG> 48series</STRONG> = CollectSeries(<STRONG>object, position, ...</STRONG>); 49</PRE> 50<P><STRONG>Inputs</STRONG> 51<BR> 52<TABLE BORDER> 53<TR> 54<TH ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">Name 55</TH><TH ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">Type 56</TH><TH ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">Default 57</TH><TH ALIGN="LEFT" VALIGN="TOP" WIDTH="40%">Description 58</TH></TR><TR> 59<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%"> 60<TT><STRONG>object</STRONG></TT> 61<BR></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 to be collected 64</TD></TR><TR> 65<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%"><TT><STRONG>position</STRONG></TT> 66</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">scalar 67</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%">no default 68</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="40%">series position of object 69</TD></TR><TR> 70<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%"><TT><STRONG>...</STRONG></TT> 71</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%"> 72<BR></TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="20%"> 73<BR></TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="40%">additional object-position 74pair(s) 75</TD></TR></TABLE> 76<P><STRONG>Outputs</STRONG> 77<BR> 78<TABLE BORDER> 79<TR> 80<TH ALIGN="LEFT" VALIGN="TOP" WIDTH="25%">Name 81</TH><TH ALIGN="LEFT" VALIGN="TOP" WIDTH="25%">Type 82</TH><TH ALIGN="LEFT" VALIGN="TOP" WIDTH="50%">Description 83</TH></TR><TR> 84<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="25%"><TT><STRONG>series</STRONG></TT> 85</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="25%">series 86</TD><TD ALIGN="LEFT" VALIGN="TOP" WIDTH="50%">the output series 87</TD></TR></TABLE> 88<P><STRONG>Functional Details</STRONG> 89<P> 90This module creates a series group from specified objects (e.g., a time 91series from a set of fields). 92The data and connections types of each field in the series must be 93the same. 94<TABLE CELLPADDING="3"> 95<TR VALIGN="TOP"><TD><P><B><TT><STRONG>object</STRONG></TT> 96</B></TD><TD><P>is an object to be placed in the series 97</TD></TR><TR VALIGN="TOP"><TD><P><B><TT><STRONG>position </STRONG></TT> 98</B></TD><TD><P>specifies the series position (e.g., time tag) of the preceding 99object 100</TD></TR></TABLE> 101<P> 102A single CollectSeries module can have up to 21 103<TT><STRONG>object</STRONG></TT>,<TT><STRONG>position</STRONG></TT> pairs. The 104default number of enabled parameter pairs (i.e. 105<TT><STRONG>object</STRONG></TT>,<TT><STRONG>position</STRONG></TT>) is two. 106(Tabs can be added to the module icon and removed with the appropriate 107<TT><STRONG>...Input Tab</STRONG></TT> options in the 108<TT><STRONG>Edit</STRONG></TT> pull-down menu of the VPE.) 109<P> 110The input parameters <TT><STRONG>object</STRONG></TT> and 111<TT><STRONG>position</STRONG></TT> must be paired. 112Note that items placed in a series can be selected only by ordinal 113number, not by series position. 114<P> 115A single CollectSeries module can collect up to 21 objects together 116in a group. 117The default number of enabled parameter pairs (i.e., 118<TT><STRONG>object</STRONG></TT>, <TT><STRONG>position</STRONG></TT>) 119is two. 120(Tabs can be added to the module icon and removed with the appropriate 121<TT><STRONG>...Input Tab</STRONG></TT> options in the 122<TT><STRONG>Edit</STRONG></TT> pull-down menu of 123the VPE.) 124<P><STRONG>Components</STRONG> 125<P> 126All input components are propagated to the output. 127<P><STRONG>Example Visual Programs</STRONG> 128<PRE> 129 130ManipulateGroups.net 131 132UsingCompute3.net 133UsingStreakline.net 134</PRE> 135<P><STRONG>See Also</STRONG> 136<P> 137 <A HREF="refgu011.htm#HDRAPPEND">Append</A>, 138 <A HREF="refgu029.htm#HDRCOLLECT">Collect</A>, 139 <A HREF="refgu030.htm#HDRMULTIGR">CollectMultiGrid</A>, 140 <A HREF="refgu031.htm#HDRCOLLECN">CollectNamed</A>, 141 <A HREF="refgu131.htm#HDRSELECT">Select</A>, 142 <A HREF="refgu146.htm#HDRSTACK">Stack</A> 143<A NAME="IDX413"></A> 144<A NAME="IDX414"></A> 145<A NAME="IDX415"></A> 146<A NAME="IDX416"></A> 147 <P> 148 <HR> 149 <DIV align="center"> 150 <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> 151 </DIV> 152 <DIV align="center"> 153 <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> 154 <P></P> 155 </DIV> 156 <P></P> 157 </BODY></HTML> 158
