next up previous contents
Next: Structure of the SDDS Up: Definition of SDDS Protocol Previous: Definition of SDDS Protocol   Contents

Introduction

An SDDS file is referred to as a ``data set''. Each data set consists of an ASCII header describing the data that is stored in the file, followed by zero or more ``data pages'' or ``data tables'' (the former term is preferred, though the latter is used in many places). The data may be in ASCII or unformatted (i.e., ``binary''). Each data page is an instance of the structure defined by the header. That is, while the specific data may vary from page to page, the structure of the data may not.

Three types of entities may be present in each page: parameters, arrays, and columns. Each of these may contain data of a single data type, with the choices being long and short integer, single and double precision floating point, single character, and character string. The names, units, data types, and so forth of these entities are defined in the header.

Parameters are scalar entities. That is, each parameter defined in the header has a single value for each page. Each such value may be a single number or a single character string, for example.

Arrays are multidimensional entities with potentially varying numbers of elements. While there is no restriction on the number of dimensions an array may contain, this quantity is fixed throughout the file for each array. However, the size of the array may vary from page to page. Thus, a given two-dimensional array might be 2x2 in one page, 3x5 in the next, etc.

Columns are vector entities. All columns in a data set are organized into a single table, called the ``tabular data section''. Thus, all columns must contain the same number of entries, that number being the number of rows in the table. There is no restriction on how many rows the tabular data may contain, nor on the mixing of data types in the tabular data.

It is possible to design more sophisticated data protocols than SDDS, and this has in fact been done. However, the more flexible a protocol is, the more difficult it becomes to write generic programs that operate on data. Experience with SDDS has shown that there is very little data that cannot be conveniently stored in one or more SDDS files. In fact, most applications need only the parameter and tabular data facilities. Frequently, complex data is separated into several parallel files; the SDDS toolkit provides support for multifile operations that make this convenient.

The following is an example of a very simple SDDS file. Users who would prefer not to read the detailed description of the protocol in the next section may profit from using this example as a guide.

SDDS1
! This is a comment line.  The previous line is required and identifies 
! the file as SDDS.
! Define parameters: 
&parameter name=Description, type=string &end
&parameter name=xTune, type=double &end
&parameter name=yTune, type=double &end
! Define columns:
&column name=s, type=double, units=m, description="longitudinal distance" &end
&column name=betax, type=double, units=m, description="horizontal beta function" &end
&column name=betay, type=double, units=m, description="vertical beta function" &end
&column name=ElementName, type=string &end
! Declare ASCII data and end the header:
&data mode=ascii &end
! First come the parameter values for this page, in the order defined:
Twiss parameters for the APS
35.215
14.296
! Second comes the tabular data section for this page, which has
! 50 rows in this example:
50
   0.000000   14.461726    9.476181        _BEG_ 
   3.030000   15.096567   10.445020          L01 
   3.360000   15.242380   10.667547          L02 
   3.860000   17.308605    9.854735           Q1 
   3.975000   18.254680    9.419835          L11 
   4.190000   20.094943    8.640450          L12 
   4.520000   23.100813    7.529584          L13 
   5.320000   21.435972    7.949178           Q2 
   5.410000   20.278542    8.350441          L21 
   5.620000   17.705808    9.332877          L22 
   5.920000   14.341175   10.848446          L30 
   6.420000   10.719036   12.405601           Q3 
   7.120000    7.920453   12.969811          L41
  27.600000   14.461726    9.476181          L01 
! The file may end at this point, or a new page may follow.

At this point, those who are new to SDDS may wish to skip to the ManualPagesOverview in order to get a feel for the capabilities of the Toolkit. The details of SDDS protocol, the subject of the next section, are less important than what can be done with data once it is in SDDS protocol.


next up previous contents
Next: Structure of the SDDS Up: Definition of SDDS Protocol Previous: Definition of SDDS Protocol   Contents
Robert Soliday 2014-01-28