SpecTcl REST plugin

Ron Fox


Table of Contents
1. Introduction
2. Incorporating the REST plugin
3. REST requests supported.
3.1. General Request format
3.2. Parameter requests
3.2.1. list
3.2.2. edit
3.2.3. promote
3.2.4. create
3.2.5. listnew
3.2.6. check
3.2.7. uncheck
3.2.8. version
3.3. spectrum requests
3.3.1. list
3.3.2. delete
3.3.3. create
3.3.4. clear
3.3.5. contents
3.4. gate requests
3.5. list
3.5.1. Compound gates (+ * -)
3.5.2. Slice (s)
3.5.3. Gamma slice (gs)
3.5.4. Simple 2-d gates (b c)
3.5.5. Gamma bands and contours (gb gc
3.5.6. Bit mask gates (em am nm)
3.6. delete
3.7. edit
3.7.1. Compound gates (* + -)
3.7.2. Constant gates (T F)
3.7.3. Bands and Contours (b c)
3.7.4. Bit mask gates (em am nm)
3.7.5. Slice gates (s)
3.7.6. Gamma 2d gates (gb gc
3.7.7. Gamma slice (gs)
3.8. Gate Applications.
3.8.1. Applying a gate to a spectrum.
3.8.2. Listing gate applications
3.9. Attaching data sources (New in 5.5)
3.10. Binding Spectra to Display Memory (new in 5.5)
3.10.1. /sbind/all
3.10.2. /sbind/sbind
3.10.3. /sbin/list
3.11. Accessing the fit command (new in 5.5)
3.12. REST interface for the fold command (new in 5.5)
3.13. Accessing the channel command (new in 5.5)
3.14. Projecting spectra (new in 5.5)
3.15. Spectrum Underflow and Overflow Statistics (new in 5.5)
3.16. Access to the treeevariable command (new in 5.5)
3.17. Accessing the filter command (New in 5.5
3.18. Accessing the integrate command (new in 5.5)
3.19. Accessing the SpecTcl parameter command (new in 5.4)
3.20. Accessing the pseudo command (new in 5.5)
3.21. Access to the sread command (new in 5.5)
3.22. Access the ringformat command (new in 5.5)
3.23. Accessing the unbind command (new in 5.5)
3.24. Accessing the ungate command (new in 5.5)
3.25. Accessing the swrite command (new on 5.5)
3.26. Controlling data anlaysis (new in 5.5)
3.27. Accessing the roottree command (new in 5.5)
3.28. Accessing the pman comman (new in 5.5)
3.29. Accessing the evbunpack command (new in 5.5)
3.30. Excuting arbitrary commands in SpecTcl (new in 5.5)
3.31. Traces (New in 5.5).
3.32. Querying display memory mirrors.
3.33. Waveform requests (new in 7.0-003)
3.33.1. Creating new waveforms
3.33.2. Listing waveform properties
3.33.3. Retrieving waveform samples.
3.33.4. Getting waveform metadata
3.33.5. Modifying waveform metadata
3.33.6. Resizing a waveform.
List of Examples
2-1. Incorporating and starting the REST server