User’s Guide for SDDS Toolkit Version 5.0

M. Borland, L. Emery, H. Shang, R. Soliday
Advanced Photon Source

November 24, 2020

The Self Describing Data Sets (SDDS) file protocol is the basis for a powerful and expanding toolkit of generic programs. These programs are used for simulation postprocessing, graphics, data preparation, program interfacing, and experimental data analysis.

This document describes Version 5.0 of the SDDS commandline toolkit. Those wishing to write programs using SDDS should consult the Application Programmer’s Guide for SDDS Version 1.5[1]. The first section of the present document is shared with this reference.

This document does not describe SDDS-compliant EPICS applications, of which they are many. Some of these will be covered in a separate manual.

1 Why Use Self-Describing Files?
2 Definition of SDDS Protocol
 2.1 Introduction
 2.2 Structure of the SDDS Header
 2.3 Structure of SDDS ASCII Data Pages
 2.4 Structure of SDDS Binary Data Pages
References
3 Manual Pages Overview
 3.1 SDDS Toolkit Programs by Category
 3.2 Toolkit Program Usage Conventions
 3.3 Data for Examples
4 Manual Pages
 4.1 csv2sdds
 4.2 elegant2genesis
 4.3 hdf2sdds
 4.4 plaindata2sdds
 4.5 raw2sdds
 4.6 sdds2dpfit
 4.7 sdds2math
 4.8 sdds2plaindata
 4.9 sdds2spreadsheet
 4.10 sdds2stream
 4.11 sddsbaseline
 4.12 sddsbreak
 4.13 sddscast
 4.14 sddschanges
 4.15 sddscheck
 4.16 sddscliptails
 4.17 sddscollapse
 4.18 sddscollect
 4.19 sddscombine
 4.20 sddscongen
 4.21 sddscontour
 4.22 sddsconvert
 4.23 sddsconvolve
 4.24 sddscorrelate
 4.25 sddsderiv
 4.26 sddsderef
 4.27 sddsdigfilter
 4.28 sddsdiff
 4.29 sddsdistest
 4.30 sddsendian
 4.31 sddsenvelope
 4.32 sddseventhist
 4.33 sddsexpand
 4.34 sddsexpfit
 4.35 sddsfdfilter
 4.36 sddsfft
 4.37 sddsgenericfit
 4.38 sddsgfit
 4.39 sddshist
 4.40 sddshist2d
 4.41 sddsimageconvert
 4.42 sddsimageprofiles
 4.43 sddsinsideboundaries
 4.44 sddsinteg
 4.45 sddsinterp
 4.46 sddsinterpset
 4.47 sddsmakedataset
 4.48 sddsmatrixmult
 4.49 sddsmatrixop
 4.50 sddsmatrix2column
 4.51 sddsminterp
 4.52 sddsmpfit
 4.53 sddsmselect
 4.54 sddsmultihist
 4.55 sddsmxref
 4.56 sddsnaff
 4.57 sddsnormalize
 4.58 sddsoutlier
 4.59 sddspeakfind
 4.60 sddspfit
 4.61 sddsplot
 4.62 sddspoly
 4.63 sddsprintout
 4.64 sddsprocess
 4.65 sddspseudoinverse
 4.66 sddsquery
 4.67 sddsregroup
 4.68 sddsremoveoffsets
 4.69 sddsrowstats
 4.70 sddsrunstats
 4.71 sddssampledist
 4.72 sddsselect
 4.73 sddsseparate
 4.74 sddssequence
 4.75 sddsshift
 4.76 sddsshiftcor
 4.77 sddssinefit
 4.78 sddsslopes
 4.79 sddssmooth
 4.80 sddssort
 4.81 sddssortcolumn
 4.82 sddssplit
 4.83 sddsspotanalysis
 4.84 sddstdrpeeling
 4.85 sddstimeconvert
 4.86 sddstranspose
 4.87 sddsunwrap
 4.88 sddsvslopes
 4.89 sddsxra
 4.90 sddsxref
 4.91 sddszerofind
 4.92 SDDS Editing
 4.93 rpn Calculator Module
 4.94 SDDS Wildcard Conventions
5 Manual Pages for APS-Specific Programs
 5.1 awe2sdds
 5.2 col2sdds
 5.3 sdds2mpl
 5.4 mpl2sdds
6 Manual Pages for Synchrotron Radiation Programs
 6.1 sddssyncflux
Contents