apply

	apply - Gate a spectrum

Syntax

apply GateName Spectrum1 [Spectrum2 ...]
apply -list [pattern]

Synopsis

Applies a gate to a set of spectrum or lists the gates applied to a spectrum.

Detailed Description

This command applies a gate as a increment condition to a set of histograms as well as allowing you to list the conditions applied to various histograms.

A spectrum is incremented only if all of the following are true:

All parameters required by the spectrum are defined by the event (exception, summary spectra are incremented for all parameters present which are required).
All parameters required by the spectrum are within the channel limits of the spectrum after scaling (again, summary spectra are an exception).
The gate applied to the spectrum evaluates TRUE for the event.

apply GateName Spectrum1 [Spectrum2...]

Applies the named gate to the spectra described by the list.

Top

apply -list [pattern]

For each spectrum whose name matches the pattern, describes that spectrum's increment condition. If no spectra are supplied, the gates applied on all spectra are listed. The format of the output from this command is a Tcl list. Each element of the list contains:

The spectrum name.
The gate description as it would be returned from gate -list

Note that un-gated spectra appear to have a gate named -TRUE- applied to them which is a true gate. This is normal.

Top

Examples:

Computer output is in red.

gate Gate1 c {Distribution1 Distribution2 { 
              {128 64} {512 255} {512 64} {128 10}}}
apply Gate1 spectrum1 spectrum2 spectrum3 ;#three spectra gated with Gate1
apply -list spectrum1
{spectrum1 {Gate1 15 c {{Distribution1 Distribution2} {128 64} {512 255} {512 64} {128 10}
}}}