|
Beamline Instrument Software Support |
|
|
|
SPEC Macro documentation:
[ Macro Index |
BCU Home ]
|
|
| xia.mac | ||||||
| [ source code | installed at | configured at ] | ||||||
| See other macros in category: All | ||||||
Description:
| ||||||
Documentation:
SETUP The only setup needed is done by: xiasetup [device name] ROIs can eventually be defined in the setup using xiaroi Counters can be disabled using xiacntoff Detector to be displayed can be set using xiadisplay INTERNALS | ||||||
Macros:
Usage: xia Menu to give access to all xia functionalities xiamenu Usage: xiamenu Shortcut to xia xiasetgate Usage: xiasetgate <0|1> Setup external gate usage 0 means external gate, 1 means ignore gate xiasetup Usage: xiasetup <device_name> [<timeout> <host>] Setup XIA device. Optionnally, timeout can be specified (default=10). Depending on the number of detectors used, configuration may be long and xiaconfigure will return a timeout error. For a 13 element detectors, a timeout of 20 may be good. host is the PC name where is running the device server. It is only used in macro xiaconfigure to give the list of configuration files (using ssh). xiaon Usage: xiaon Activates XIA detector in scans/counts macros. xiastatus Usage: xiastatus Print device status xiaoff Usage: xiaoff Deactivates control of XIA detector It will be called automatically when xiasetup is removed from setup xiacnton Usage: xiacnton Enable XIA counters xiacntoff Usage: xiacntoff Disable XIA counters xiacntshow Usage: xiacntshow Display XIA counters configured in current spec session xiacntmenu Usage: xiacntmenu XIA counters menu. xiasavesetup Usage: xiasavesetup [<scans> <ct-acq> <deffile> [<prefix>] [<suffix>]] Without any arguments, will prompt for saving settings. With arguments: scans: if =1, save spectra during scans, 0 otherwise ct-acq: if =1, save spectra during ct/xiaacq, 0 otherwise deffile: if =1, save to current session datafile, =0, save to separate file using prefix and suffix for filename prefix: file prefix suffix: file suffix xiaroimenu Usage: xiaroimenu Menu to Add/Modify/Delete/Save/Load rois xiaroisave Usage: xiaroisave [<filename>] Save rois in a file. If <filename> is not specified, save to the standard location xiaroiload Usage: xiaroiload [<filename>] Load rois from a file. If <filename> is not specified, load from the standard location Loading rois from file will erase current roi settings. xiaroi Usage: xiaroi <roimne> <detector> <first> <last> [<lvt_corr>] [<dt_corr>] [<mne_norm>] Define a new roi. If no arguments are given, run xiaroimenu. Arguments are: roimne : counter mnemonic for the roi (should be defined in spec config) detector: If >0, define the detector number, =0, the roi is an average on all detectors of a fixed roi defined by [first:last] =-1, add an average roi named <roimne>sum, computed using <roimne>1-N =-2, add roi on all detectors, named <roimne>1-N first : first channel last : last channel lvt_corr: if =1, normalize roi by livetime, 0 otherwise dt_corr : if =1, deadtime correction, 0 otherwise mne_norm: Normalize the roi using the given counter xiadetdisable Usage: xiadetdisable <detector_number> Disable detector in ROI which computes SUM on all det. xiadetenable Usage: xiadetenable <dectector_number> Enable detector in ROI which computes SUM on all det. if <detector_number>==0: enable all configured detectors. xiaroioff Usage: xiaroioff Deactivates use of ROI counters xiaroion Usage: xiaroion Activates use of ROI counters xiaroishow Usage: xiaroishow Shows ROI definition xiatimes Usage: xiatimes Reports livetime, icr, ocr, deadtime of last acquisition xiaacq Usage: xiaacq [ acq-time ] start acquisition and display spectrum xiaconfigure Usage: xiaconfigure Download a configuration file and perform basic calibrations xiadisplaymenu Usage: xiadisplaymenu Setup detectors to be displayed on GUI parameters xiadisplay Usage: xiadisplay <detector_num> <0(no)|1(yes)> Open GUI display for dectector or not. | ||||||
| Internal Macros: | ||||||
Usage: _xia_print(type, msg) xiaunsetup Usage: xiaunsetup Clears up all definition for xia. Called when xiasetup removed from setup file xiabody Usage: xiabody(mode) Called only from blmenu xia_createarrays Usage: xia_createarrays () Create arrays for all detectors _xiacntset Usage: _xiacntset (state) Set XIA counters on (state==1) or off (state==0) If counters are off, all XIA counters are disabled xia_save Usage: xia_save xia_scansave Usage: xia_scansave _xiasave Usage: _xiasave xia_filename Usage: xia_filename(prefix, number, suffix) Create filename using specified prefix and suffix _xiaroiadd Usage: _xiaroiadd (mne, det, min, max, lvt, dt, norm) Add one ROI definition. It returns 0 if failed, the number of created ROIs otherwise. See xiaroi for details about parameters _xiaroiinsert Usage: _xiaroiinsert(mne, det, min, max, lvt, dt, norm) _xiaroishow Usage: _xiaroishow() xia_getcounts Usage: xia_getcounts _xiaroicalc Usage: _xiaroicalc (mne, ndet) Return the computed roi using detector number <ndet> and parameters from roi <mne> xia_prepcount Usage: xia_prepcount Start counting on XIA. Called when xiaon at every ct or scan macro xia_start Usage: xia_start Starts the detector xia_readdata Usage: xia_readdata Reads data from detector xia_stop Usage: xia_stop Stops the detector _xiaacqtimes Usage: _xiaacqtimes Report livetime, ICR, OCR, deadtime during an acquisition _xiaacqcleanup Usage: _xiaacqcleanup Cleanup macro for xiaacq _xiaacqmenu Usage: _xiaacqmenu() Menu accessible during acquisition Return 0 for a stop command, 1 otherwise _xialistconfig Usage: _xialistconfig List configuration files on the host server xia_plotit Usage: xia_plotit xia_guiclose Usage: xia_guiclose Close all graphical interface xia_guirun Usage: xia_guirun Checks wether the GUI is running, otherwise starts it. xia_plotclose Usage: xia_plotclose(modno) Close Graphical Interface for one channel xia_plotopen Usage: xia_plotopen(modno) Starts the Graphical Interface for one channel and returns its PID number. _xia_calcavg Usage: _xia_calcavg (array) Compute average of values in array, using only enabled detectors xia_avglivetime Usage: xia_avglivetime () Compute average livatime [s]. xia_avgicr Usage: xia_avgicr () Compute average input count rate. xia_avgocr Usage: xia_avgocr () Compute average output count rate. xia_avgdeadt Usage: xia_avgdeadt () Calculate the average dead time [percent] as function of the input and the output count rate. | ||||||
|