User’s Guide for SDDS Toolkit Version 5.0

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

August 29, 2025

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 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 hpif2sdds
 4.5 image2sdds
 4.6 lba2sdds
 4.7 plaindata2sdds
 4.8 raw2sdds
 4.9 sdds2dfft
 4.10 sdds2dinterpolate
 4.11 sdds2dpfit
 4.12 sdds2headlessdata
 4.13 sdds2math
 4.14 sdds2plaindata
 4.15 sdds2spreadsheet
 4.16 sdds2stream
 4.17 sdds2tiff
 4.18 sddsanalyticsignal
 4.19 sddsarray2column
 4.20 sddsbaseline
 4.21 sddsbinarystring
 4.22 sddsbreak
 4.23 sddscast
 4.24 sddschanges
 4.25 sddscheck
 4.26 sddscliptails
 4.27 sddscollapse
 4.28 sddscollect
 4.29 sddscombine
 4.30 sddscombinelogfiles
 4.31 sddscongen
 4.32 sddscontour
 4.33 sddsconvert
 4.34 sddsconvertalarmlog
 4.35 sddsconvolve
 4.36 sddscorrelate
 4.37 sddsderef
 4.38 sddsderiv
 4.39 sddsdiff
 4.40 sddsdigfilter
 4.41 sddsdistest
 4.42 sddsduplicate
 4.43 sddseditor
 4.44 sddsendian
 4.45 sddsenvelope
 4.46 sddseventhist
 4.47 sddsexpand
 4.48 sddsexpfit
 4.49 sddsfdfilter
 4.50 sddsfft
 4.51 sddsfindin2dgrid
 4.52 sddsgenericfit
 4.53 sddsgfit
 4.54 sddshist
 4.55 sddshist2d
 4.56 sddsimageconvert
 4.57 sddsimageprofiles
 4.58 sddsinsideboundaries
 4.59 sddsinteg
 4.60 sddsinterp
 4.61 sddsinterpset
 4.62 sddskde2d
 4.63 sddslocaldensity
 4.64 sddslorentzianfit
 4.65 sddsmakedataset
 4.66 sddsmatrix2column
 4.67 sddsmatrixmult
 4.68 sddsmatrixop
 4.69 sddsminterp
 4.70 sddsmpfit
 4.71 sddsmselect
 4.72 sddsmultihist
 4.73 sddsmxref
 4.74 sddsnaff
 4.75 sddsnormalize
 4.76 sddsoutlier
 4.77 sddspeakfind
 4.78 sddspfit
 4.79 sddsplot
 4.80 sddspoly
 4.81 sddsprintout
 4.82 sddsprocess
 4.83 sddspseudoinverse
 4.84 sddsquery
 4.85 sddsregroup
 4.86 sddsremoveoffsets
 4.87 sddsrespmatrixderivative
 4.88 sddsrowstats
 4.89 sddsrunstats
 4.90 sddssampledist
 4.91 sddsselect
 4.92 sddsseparate
 4.93 sddssequence
 4.94 sddsshift
 4.95 sddsshiftcor
 4.96 sddssinefit
 4.97 sddsslopes
 4.98 sddssmooth
 4.99 sddssnap2grid
 4.100 sddssort
 4.101 sddssortcolumn
 4.102 sddssplinefit
 4.103 sddssplit
 4.104 sddsspotanalysis
 4.105 sddstdrpeeling
 4.106 sddstimeconvert
 4.107 sddstranspose
 4.108 sddsunwrap
 4.109 sddsvslopes
 4.110 sddsxra
 4.111 sddsxref
 4.112 sddszerofind
 4.113 tiff2sdds
5 Manual Pages for Misc Features
 5.1 rpn Calculator Module
 5.2 SDDS Editing
 5.3 SDDS Wildcard Conventions
6 Manual Pages for APS-Specific Programs
 6.1 awe2sdds
 6.2 col2sdds
 6.3 mpl2sdds
 6.4 sdds2mpl
7 Manual Pages for Synchrotron Radiation Programs
 7.1 sddssyncflux
Contents