YODA tcl Commands

YODA graphical user interface (GUI) is written with the tcl/tk windowing toolkit. Much of YODAs funktionality is implemented in tcl commands which may be accessed through the GUI or directly by typing the appropriate command in YODAs main window. The output will appear on YODAs main window and may prove useful for logging purposes. Aditionally the tclCommand() builtin function allows to execute arbitrary tcl commands from within the hoc language.

These commands may be included in the yoda.rc file which is executed on YODA startup.

 

Table 6.1: List of useful tcl commands (histogramming and display)

Function	Purpose
clearhistos	clears all histograms
clearhisto histoname	clears histogram histoname
dumphisto histoname	dump histogram contents of histoname
histowrite file [ mode ]	write all histograms to file, if mode=0(1) is given force output in HBOOK (YZ) format
projecthisto name d b	creates projection or slices for histogram with name in d=x,y direction. If bin is 0 a projection is generated, otherwise slices of b bins are created.
setPawRzfileMode value	if value="rz"("yz") the default storage type for histograms will be HBOOK(YZ)
.display.sh clear	clear display
.display.sh addInc name	display histogram in new zone
.display.sh add name	overlay histogram in last zone
.display.sh sub name	remove histogram in all zones
.display.sh title a b	if a(b) is 1 show histogram (axis) titles
.display.sh zone x y	set number of rows (y) and columns (x) in display
Print2File	writes current display to file zoni.ps

 

 

Table 6.2: List of useful tcl commands

Function	Purpose
offline	puts YODA offline, i.e. data sorting is suspended (do not use this command from within callbacks, use stop instead).
stop	like offline, but waits until the analysis of current event is complete
online	puts YODA online, i.e. data sorting is continued
close_input	close input stream
openInputFile filename	open input file and attach to YODAs input event stream
openInputProc ``input_process''	open input process and attach to YODAs inpur event stream
openOutputFile filename	open output file and attach to YODAs output event stream
openOutputProc ``output_process''	open output process and attach to YODAs output event stream
disable callbackName	disable soft or hard callback
enable callbackName	enable soft or hard callback
load hocfileName	load a hoc file
unload callbackName	unload a hoc file
reload callbackName	reload a hoc file
get_brokerinfo_long_sorted	dump all broker values and their values
get_cutinfo	get information on cuts
get_eventstack	dump info on all subevents encountered by YODA so far
get_histoinfo	get information on histograms: entries, overflows etc.
get_runinfo	get information on runnumber, #events, processing speed etc.
get_statusstr	get information on input and output streams
get_taskinfo	get information on Callbacks, # called, accepted etc
get_versionstr	get YODA version
set_broker variable value	set broker variable
set_containermode on/off	if "on" container subtypes are considered in subevent selection (default "off")
set_displaytimer value	set update time interval (like yoda -z)
set_updatetimer value	set update time interval (like yoda -t)