SpecTcl Command Reference.

Ron Fox

Table of Contents
1. Introduction
I. SpecTcl Commands
apply -- Show which gates are applied to which spectra
attach -- Connect SpecTcl to a data source
sbind -- Store spectrum channels in display share memory
fit -- 1-d Spectrum fitting computation
fold -- Apply a gamma gate as a fold
channel -- Access spectrum channels
clear -- Clear spectra
project -- Create projections of 2-d spectra
specstats -- Return spectrum statistics information
treeparameter -- Create list or modify characteristics treeparameters
treevariable -- List and manipulate tree variables
filter -- Create filtered data sets
gate -- Create, list, delete gates
integrate -- Integrate regions of interest on spectra
parameter -- Define, list and delete parameter definitions
pseudo -- Create, listm, delete pseudo parameters.
sread -- Read spectrum from file or pipe.
ringformat -- Select ringbuffer format
scontents -- Obtain spectrum bulk contents
shmemkey -- Get shared memory key.
shmemsize -- Return the size of the spectrum shared memory region.
spectrum -- Create, list, delete, and trace changes to spectrum definitions.
unbind -- Move spectrum storage out of shared display memory
ungate -- Remove gate applications.
version -- Return SpecTcl version
sread -- Write spectrum contents to file.
start -- Start analyzing data
start -- stop analyzing data
rootexec -- Execute a root macro file.
roottree -- Write CERN ROOT Trees.
pman -- V5.1+ Manipulate the SpecTcl Analysis Pipeline
evbunpack -- Dynamically setup decoding of event built data.
List of Figures
1. A band draw with backtracking
2. Contour interior
List of Examples
1. Applying a gate to a single spectrum
2. Applying a gate to several spectra
3. Listing gates applied to all spectra
4. Using a filter to list gate applications
1. Attaching to a data file for nscldaq-11:
2. Attaching to the online system via a pipe data source
3. Attaching to a compressed datafile:
1. Binding all spectra to display memory
2. Binding a list of spectra to the displayer
3. Listing the bindings of spectra that match a pattern
1. Using the proc subcommand
1. Getting the value of a channel in a 1-d spectrum
2. Clearing a spectrum using channel
1. Clearing all spectra
2. Clearing spectra given their names
3. Clearing spectra given their ids:
4. Clearing spectra whose names match a glob pattern r*
1. Creating a new tree parameter
2. Listing all tree parameters with sample output
3. Listing only some parameters (using a pattern)
4. The treeparameter -check command
5. Unsetting the modified flag:
1. Listing all variables:
2. Using a glob pattern; listing variables thaty start with vars.w
3. Modifying value and units of a tree variable
4. Changing only the value of a tree parameter
5. Modifying only the units of a tree variable
1. Creating a filter
2. Setting filter filenames
3. Enabling filters
1. Creating a slice gate
2. Listing all gates
3. Deleting a gate
4. Establishing a trace
1. Creating a 12 bit 'integer' parameter
2. Creating a real valued parameter with units in mm
1. Defining a simple psuedo
2. Pseudo illustrating quoting:
3. listing pseudos
1. Reading a spectrum in from file
2. Reading several spectra from one file
3. Reading from a pipeline:
1. NSCLDAQ version 10 data:
2. NSDCLDAQ version 11 data
1. Creating a 1-d spectrum
2. Creating a 2-d spectrum
3. Creating a g1 spectrum
4. Creating a g2 spectrum
5. Creating a summary spectrum
6. Creating a bitmask spectrum
7. Making a strip chart spectrum
8. Creating an m2 (multiple 2d spectrum)
9. Creating a gd (gamma deluxe) spectrum
10. Creating a gs (gamma summary) spectrum
11. Listing all spectra
12. Listing only spectra with matching names
13. Deleting a spectrum
14. Spectrum traces:
1. Writing spectra to file by filename
2. Writing to a file descriptor