Wiki source code of Experiment control

Last modified by fwilde on 2018/04/09 09:39

version	line-number	content
7.1	1	{{layout}}
	2	{{layout-section ac:type="two_right_sidebar"}}
	3	{{layout-cell}}
2.1	4	== {{id name="Experimentcontrol-Generalremarks"/}}General remarks ==
	5
20.1	6	This is a detailed description of the experiment control system. A short overview of the most commonly iused commands can be found [[here>>doc:P5I.User guide\: µCT at P05.Experiment control.IDL cheat sheet.WebHome]].
19.1	7
2.1	8	Beamline control at the P05 µCT hutch uses TANGO server as backend for most applications. At P05 the Interactive Data Language (IDL) serves as user interface to the TANGO servers. IDL procedures and functions provide the functionality to control the µCT experiment and beamline optics components conveniently. A couple of general remarks should facilitate to work with IDL at P05.
	9
	10	* IDL has a command history (use arrow keys to browse through recent commands)
3.1	11	* IDL has tab completion (start typing a command e.g. refl<TAB> to complete reflex_opt taken from the command history), Multiple presses on tab will browse through the filtered command history.
2.1	12	* (((
3.1	13	IDL makes a difference between PROCEDURES and FUNCTIONS. A procedure is a piece of code that is executed without delivering a return value whereas a function does. A procedure's (optional) arguments are separated with commas. Functions need to be called with brackets and optionally a comma separated argument list inside the brackets.
	14
	15	{{code title="Procedures and functions"}}print, 'hello world.'
	16	i=quick(300)
19.1	17	{{/code}}\\
3.1	18	)))
	19	* (((
2.1	20	In IDL you can chain commands with the & sign
	21
19.1	22	{{code title="Chaining commands"}}i=quick(300) & tv, bytscl(bin(i,4),0,65000){{/code}}\\
2.1	23	)))
4.1	24	* (((
	25	When IDL is ready to accpt commands, the IDL> prompt is printed in a roman font. When IDL is busy doing something (e.g. waiting for a motor to end its move), the //IDL>// prompt is printed in an italic font.
	26
19.1	27	{{info title="Warning"}}When IDL is busy, you can enter a new command, but it will not be executed until the last command is finished. In order to avoid confusion always wait until IDL is ready to accept commands before typing a new command.{{/info}}\\
4.1	28	)))
5.1	29	* Scripts can be written inside the IDL IDE and saved as .pro files. A script will not be automatically compiled after saving. Press the compile button in IDL in order to make changes in your code applicable.
9.1	30
	31	== {{id name="Experimentcontrol-IDLMacroguide"/}}IDL Macro guide ==
	32
	33	=== {{id name="Experimentcontrol-AboutIDLmacros"/}}About IDL macros ===
	34
	35	To understand the macro naming convention it helps to categorize the the acors roughly into three categories:
	36
	37	1. Motor macros
	38	1. Info macros
	39	1. Script macros
	40
	41	==== {{id name="Experimentcontrol-MotorMacros"/}}Motor Macros ====
	42
17.1	43	Motor macros loosely follow a certain naming convention according to the [[EH2 setup>>doc:P5I.User guide\: µCT at P05.µCT setup.WebHome]]:
9.1	44
	45	* (((
	46	commands contain a name for the stage:
	47
19.1	48	(% class="wrapped" %)
9.1	49	\|=(((
	50	command particle
	51	)))\|=(((
	52	stage
	53	)))
	54	\|(((
	55	o_stage
	56	)))\|(((
	57	camera stage
	58	)))
	59	\|(((
	60	s_stage
	61	)))\|(((
	62	rotation stage
	63	)))
	64	\|(((
	65	s_pos
	66	)))\|(((
	67	sample stage
	68	)))
	69	\|(((
	70	app_tripod or app
	71	)))\|(((
	72	base stage
	73	)))
	74	\|(((
10.1	75	o_ccd
9.1	76	)))\|(((
10.1	77	camera housing
	78	)))
	79	\|(((
	80	o
	81	)))\|(((
9.1	82	microscope optics
	83	)))
	84	)))
	85	* Most commands are followed by a direction or rotation axis (x,y,z, rot_x, rot_y, rot_z)
	86	* (((
	87	A motor command moves either relative or absolute, e.g:
	88
	89	{{code}}goto_s_stage_z, -10{{/code}}This moves the rotation stage to the position -10 mm in z direction.
	90
	91
	92
	93	{{code}}s_stage_z, 1{{/code}}This example moves the rotation stage by 1 mm up in z direction.
	94	)))
	95
11.1	96	==== {{id name="Experimentcontrol-Infomacros"/}}Info macros ====
	97
16.1	98	These are macros that return one more values which provide information about the state of e.g. a stage or a camera.
	99
	100	==== {{id name="Experimentcontrol-Scriptmacros"/}}Script macros ====
	101
	102	Script macros are a collection of lower-level commands to perform a task. The most striking script macros is probably the scan macro, which perform a complete tomographic scan without any further interaction with the user.
7.1	103	{{/layout-cell}}
	104
	105	{{layout-cell}}
19.1	106	{{panel borderColor="blue" titleColor="white" titleBGColor="blue" title="Table of Contents"}}
7.1	107	{{toc/}}
8.1	108	{{/panel}}
12.1	109
19.1	110	{{panel borderColor="red" titleColor="white" titleBGColor="red" title="todo"}}
15.1	111	Attention: this user guide is yet very incomplete.
12.1	112
	113	(% class="task-list" %)
	114	(((
18.1	115	{{task reference="/Tasks/Task_1" status="Done"}}
20.1	116	Continue IDL at EH2 user guide {{mention reference="XWiki.fwilde" style="FULL_NAME" anchor="XWiki-fwilde-IXJaI"/}}\\
12.1	117	{{/task}}
	118	)))
	119	{{/panel}}
7.1	120	{{/layout-cell}}
	121	{{/layout-section}}
	122	{{/layout}}