Wiki source code of IDL cheat sheet

Version 59.27 by fwilde on 2025/03/28 19:42

version	line-number	content
59.1	1	== {{id name="IDLcheatsheet-Coordinatesystem"/}}Coordinate system ==
22.1	2
23.1	3	Right-handed coordinate system with y-direction along the x-ray beam.
	4
25.1	5	[[image:attach:p05_uct.png\|\|width="700"]]
	6
6.1	7	== {{id name="IDLcheatsheet-Samplepositioning"/}}Sample positioning ==
	8
31.1	9	=== {{id name="IDLcheatsheet-Relativemovement"/}}Relative movement ===
	10
59.2	11	(% class="fixed-table wrapped" %)
1.1	12	\|=(((
	13	IDL command
	14	)))\|=(((
	15	description
3.1	16	)))\|=(((
	17	motion
1.1	18	)))
	19	\|(((
46.1	20	##s_stage_x/z, 1##
1.1	21	)))\|(((
15.1	22	move rotation stage in x/z-direction by 1 mm
3.1	23	)))\|(((
	24	relative [ mm ]
1.1	25	)))
	26	\|(((
46.1	27	##s_pos_x/y/z, 1##
1.1	28	)))\|(((
45.1	29	move sample stage in x/y/z-direction by 1 mm (caution with directions: stage mount on rotation axis)
3.1	30	)))\|(((
	31	relative [ mm ]
1.1	32	)))
	33	\|(((
52.1	34	##s_pos, 1##
18.1	35	)))\|(((
	36	move sample stage in x-direction by 1 mm, regardless of position of rotation axis
	37	)))\|(((
	38	relative [ mm ]
	39	)))
	40	\|(((
46.1	41	##s_angle, 90##
3.1	42	)))\|(((
9.1	43	rotate sample around z axis
3.1	44	)))\|(((
9.1	45	relative [ deg ]
3.1	46	)))
6.1	47
31.1	48	=== {{id name="IDLcheatsheet-Absolutemovement"/}}Absolute movement ===
	49
59.2	50	(% class="relative-table wrapped" style="width:67.0892%" %)
15.1	51	\|=(((
	52	IDL command
	53	)))\|=(((
	54	description
	55	)))\|=(((
	56	motion
	57	)))
	58	\|(((
46.1	59	##goto_s_stage_x/z, 1##
15.1	60	)))\|(((
	61	move rotation stage in x/z-direction to 1 mm
	62	)))\|(((
	63	absolute [ mm ]
	64	)))
	65	\|(((
46.1	66	##goto_s_pos_x/y/z, 1##
15.1	67	)))\|(((
45.1	68	move sample stage in x/y/z-direction to 1 mm
15.1	69	)))\|(((
	70	absolute [ mm ]
	71	)))
	72	\|(((
46.1	73	##goto_s_angle, 90##
15.1	74	)))\|(((
46.1	75	rotate sample around z axis to 90° (alias command: s_rot)
15.1	76	)))\|(((
	77	absolute [ deg ]
	78	)))
	79
32.1	80	=== {{id name="IDLcheatsheet-Getcurrentposition"/}}Get current position ===
31.1	81
59.2	82	(% class="relative-table wrapped" style="width:54.0627%" %)
15.1	83	\|=(((
	84	IDL command
	85	)))\|=(((
	86	description
	87	)))
	88	\|(((
46.1	89	##pos_s_stage_x/z()##
15.1	90	)))\|(((
	91	return current rotation stage in x/z position
	92	)))
	93	\|(((
46.1	94	##pos_s_pos_x/y/z()##
15.1	95	)))\|(((
45.1	96	return current sample stage in x/y/z position
15.1	97	)))
	98	\|(((
46.1	99	##pos_s_angle()##
15.1	100	)))\|(((
	101	return current rotation stage angle
	102	)))
	103
31.1	104	=== {{id name="IDLcheatsheet-Predefinedpositions"/}}Predefined positions ===
	105
59.2	106	(% class="relative-table wrapped" style="width:55.721%" %)
31.1	107	\|=(((
	108	IDL command
	109	)))\|=(((
	110	description
	111	)))
	112	\|(((
46.1	113	##s_in##
31.1	114	)))\|(((
	115	move sample to "in" position
	116	)))
	117	\|(((
46.1	118	##s_out##
31.1	119	)))\|(((
	120	move sample to "out" position
	121	)))
	122	\|(((
46.1	123	##s_change##
31.1	124	)))\|(((
	125	move sample to "change" position
	126	)))
	127	\|(((
53.1	128	##set_s_in_pos(, 0)##
31.1	129	)))\|(((
53.1	130	set s_in position to current stage position, or optionally to e.g. 0.0 mm
31.1	131	)))
	132	\|(((
46.1	133	##set_s_out_dist, 10##
31.1	134	)))\|(((
	135	set s_out distance to 10.0 mm
	136	)))
	137
45.1	138	=== {{id name="IDLcheatsheet-Magnificationsets"/}}Magnification sets ===
	139
	140	(% class="wrapped" %)
	141	\|=(((
	142	IDL command
	143	)))\|=(((
	144	description
	145	)))
	146	\|(((
59.2	147	##save_magn_set(, name_add)##
45.1	148	)))\|(((
51.1	149	save current magnification set, optionally add something to the automatically generated name
45.1	150	)))
	151	\|(((
59.2	152	##restore_magn_set(, name)##
45.1	153	)))\|(((
51.1	154	restore last magnification set, or optionally load a file with a specific name
45.1	155	)))
	156
6.1	157	== {{id name="IDLcheatsheet-Detectorpositioning"/}}Detector positioning ==
	158
59.2	159	(% class="fixed-table wrapped" %)
6.1	160	\|=(((
7.1	161	IDL command
6.1	162	)))\|=(((
	163	description
	164	)))\|=(((
	165	motion
	166	)))
3.1	167	\|(((
50.1	168	##o_ccd_dist, 5##
1.1	169	)))\|(((
50.1	170	move detector in y direction relative by 5 mm
6.1	171	)))\|(((
50.1	172	relative [ mm ]
6.1	173	)))
	174	\|(((
50.1	175	##goto_o_ccd_dist, 30##
3.1	176	)))\|(((
50.1	177	move detector in y direction absoilute to 30 mm
6.1	178	)))\|(((
59.2	179
6.1	180	)))
	181	\|(((
50.1	182	##pos_o_ccd_dist()##
6.1	183	)))\|(((
50.1	184	return current of the camera stage distance
6.1	185	)))\|(((
59.2	186
1.1	187	)))
3.1	188
45.1	189	== {{id name="IDLcheatsheet-Slitpositioning"/}}Slit positioning ==
	190
	191	(% class="wrapped" %)
	192	\|=(((
	193	IDL command
	194	)))\|=(((
	195	description
	196	)))
	197	\|(((
47.1	198	##slit_oh, rx=1 (rz=1)##
	199	)))\|(((
	200	moves oh slit aperture horizontally (vertically) by 1mm
	201	)))
	202	\|(((
	203	##slit_oh, rdx=1 (rdz=1)##
	204	)))\|(((
	205	opens oh the slit aperture horizontally (vertically) by 1 mm
	206	)))
	207	\|(((
46.1	208	##slit_eh2, rx=1 (rz=1)##
45.1	209	)))\|(((
47.1	210	moves eh2 slit aperture horizontally (vertically) by 1 mm
45.1	211	)))
	212	\|(((
47.1	213	##slit_eh2, rdx=1 (rdz=1)##
45.1	214	)))\|(((
47.1	215	opens eh2 the slit aperture horizontally (vertically) by 1 mm
45.1	216	)))
	217	\|(((
46.1	218	##slit_info##
45.1	219	)))\|(((
	220	show all slit positions
	221	)))
	222
	223	rx, rdx, rz and rdz can be concatenated in one command (e.g. slit_oh, rx=1, rz=-2, rdx=0.5, rdz=0.5)
	224
47.1	225	== {{id name="IDLcheatsheet-Makeandsaveimages"/}}Make and save images ==
7.1	226
59.2	227	(% class="fixed-table wrapped" %)
7.1	228	\|=(((
	229	IDL command
	230	)))\|=(((
	231	description
	232	)))
	233	\|(((
59.2	234	##i=quick(100) & display_image, BYSTCL(i, 0, 4096)##
7.1	235	)))\|(((
47.1	236	make an image & scale image (eg. from 0 to 4096, usually from 0 to maximum value the camera can do)
7.1	237	)))
	238	\|(((
47.1	239	##a=quick_abs(100) & display_image, BYTSCL(a, 0, 2)##
7.1	240	)))\|(((
47.1	241	make an absorption image & scale image (usually from 0 to to 2)
7.1	242	)))
34.1	243	\|(((
47.1	244	##write_tiff, '/gpfs/current/raw/test_projection.tif', i, /SHORT##
34.1	245	)))\|(((
47.1	246	save i as 16-bit integer tiff in /gpfs/...
34.1	247	)))
47.1	248	\|(((
	249	##write_tiff, '/gpfs/current/raw/test_absorption.tif', a, /FLOAT##
	250	)))\|(((
	251	save a as 32-bit float tiff in /gpfs/...
	252	)))
7.1	253
54.1	254	== {{id name="IDLcheatsheet-Macrosmotion+images"/}}Macros motion + images ==
49.1	255
58.1	256	These macros make images with predefined and internally saved values (like exposure time or display scale). Some move an axis first and then make an image (again with internally saved options likeexposure time, and image type). You may use these macros to quickly align samples.
54.1	257
59.2	258	(% class="relative-table wrapped" style="width:114.69%" %)
54.1	259	\|=(((
	260	IDL command
	261	)))\|=(((
	262	description
	263	)))
	264	\|(((
	265	{{code language="none"}}qt (, t=100, scale=[0,4096]){{/code}}
	266	)))\|(((
57.1	267	Quick transmission image at the current position. Options: set new exposure time, set new scale for image display,
54.1	268	)))
	269	\|(((
55.1	270	{{code language="none"}}qa (, t=100, scale=[0,2], /ref, /here){{/code}}
54.1	271	)))\|(((
57.1	272	Quick absorption image at s_in position. Options: set new exposure time, set new scale for image display, make new reference image, make image at current position.
54.1	273	)))
	274	\|(((
55.1	275	{{code language="none"}}qp (, t=100, scale=[0,2], /ref, /here){{/code}}
54.1	276	)))\|(((
57.1	277	Quick phase image at s_in position. Options: set new exposure time, set new scale for image display, make new reference image, make image at current position
54.1	278	)))
	279	\|(((
59.2	280	{{code language="none"}}qr (, t=100, scale=[0,4096]){{/code}}
57.1	281	)))\|(((
	282	Quick reference image. Options: set new exposure time, set new scale for image display,
	283	)))
	284	\|(((
55.1	285	{{code language="none"}}side, 90 (, t=100, /ref, /rel, /here, imgtype='a') {{/code}}
54.1	286	)))\|(((
56.1	287	Rotate (absolute degrees) and make an image at the new position. Options: set new exposure time, make new reference image, make image at current position, set image type ('a': absorption, 't': transmission, 'p' phase)
54.1	288	)))
	289	\|(((
55.1	290	{{code language="none"}}sshift, 2 (, t=100, /ref, /here, imgtype='a'){{/code}}
54.1	291	)))\|(((
56.1	292	Move sample stage laterally (relative, mm) and make an image at the new position. Options: set exposure time, make new reference image, , make image at current position, set image type ('a': absorption, 't': transmission, 'p' phase)
54.1	293	)))
	294	\|(((
55.1	295	##sz, 2 (, t=100, /ref, /here, imgtype='a')##
54.1	296	)))\|(((
56.1	297	Move rotation stage up or down (relative, mm) and make an image at the new position. Options: set exposure time, make reference image, make image at current position, set image type ('a': absorption, 't': transmission, 'p' phase)
54.1	298	)))
	299	\|(((
59.2	300	{{code language="none"}}zx, 2 (, t=100, /ref, /here, imgtype='a'){{/code}}
54.1	301	)))\|(((
56.1	302	Move rotation stage left or right (relative, mm) and make an image at the new position. Options: set exposure time, make reference image, make image at current position, set image type ('a': absorption, 't': transmission, 'p' phase)
54.1	303	)))
	304
59.2	305	{{info title="
49.1	306
59.2	307
	308	Monochromator positioning"}}
49.1	309	ATTENTION: Setting up a Monochromator as well as positioning front end slits is only done by the beamline staff!
	310
	311	The commands above may be used by users to realign the beam should it beam profile drift with time.
	312	{{/info}}
	313
47.1	314	== {{id name="IDLcheatsheet-DCMpositioning"/}}DCM positioning ==
6.1	315
59.2	316	(% class="fixed-table wrapped" %)
3.1	317	\|=(((
	318	IDL command
	319	)))\|=(((
	320	description
	321	)))\|=(((
	322	motion
	323	)))
1.1	324	\|(((
46.1	325	##dcm_pitch, 0.00001##
1.1	326	)))\|(((
4.1	327	move 2nd crystal pitch by 0.00001 deg
3.1	328	)))\|(((
4.1	329	relative [ deg ]
3.1	330	)))
	331	\|(((
46.1	332	##goto_dcm_pitch, -0.03976##
3.1	333	)))\|(((
4.1	334	move 2nd crystal pitch to -0.03976 deg
3.1	335	)))\|(((
4.1	336	absolute [ deg ]
1.1	337	)))
3.1	338	\|(((
51.1	339	##reflex_opt_single##
3.1	340	)))\|(((
4.1	341	move 2nd crystal pitch to optimal flux position
3.1	342	)))\|(((
59.2	343
3.1	344	)))
47.1	345
	346	== {{id name="IDLcheatsheet-DMMpositioning"/}}DMM positioning ==
	347
48.1	348	(% class="fixed-table wrapped" %)
47.1	349	\|=(((
	350	IDL command
	351	)))\|=(((
	352	description
	353	)))\|=(((
	354	motion
	355	)))
26.1	356	\|(((
47.1	357	##dmm_x2_rot, 0.001##
	358	)))\|(((
	359	move 2nd crystal pitch by 0.00001 deg
	360	)))\|(((
	361	relative [ deg ]
	362	)))
	363	\|(((
59.2	364	##goto_dmm_x2_rot, 0.8923##
47.1	365	)))\|(((
	366	move 2nd crystal pitch to 0.8923 deg
	367	)))\|(((
	368	absolute [ deg ]
	369	)))
14.1	370
47.1	371
59.2	372
35.1	373	== {{id name="IDLcheatsheet-Generalsyntax"/}}General syntax ==
27.1	374
59.2	375	(% class="relative-table wrapped" style="width:45.5603%" %)
27.1	376	\|=(((
	377	Functionality
	378	)))\|=(((
	379	IDL syntax
	380	)))
	381	\|(((
46.1	382	chaining commands
27.1	383	)))\|(((
	384	command_1 & command_2 & ...
	385	)))
	386	\|(((
	387	absolute movement
	388	)))\|(((
	389	goto_//motor//, position
	390	)))
	391	\|(((
	392	relative movement
	393	)))\|(((
	394	//motor//, position
	395	)))
	396	\|(((
	397	current motor position
	398	)))\|(((
	399	pos_//motor//()
	400	)))
45.1	401
	402	== {{id name="IDLcheatsheet-BeamshutterandInterlockcontrol"/}}Beamshutter and Interlock control ==
	403
59.2	404	(% class="relative-table wrapped" style="width:75.0455%" %)
45.1	405	\|=(((
	406	IDL command
	407	)))\|=(((
	408	description
	409	)))
	410	\|(((
46.1	411	##bs_info##
45.1	412	)))\|(((
	413	prints an overview of the beamline beamshutter status
	414	)))
	415	\|(((
46.1	416	##bsoh_open / bsoh_close##
45.1	417	)))\|(((
	418	opens / closes the optics hutch beamshutter. Closing the OH beamshutter will close all following beamshutters (EH1, EH2)
	419	)))
	420	\|(((
46.1	421	##bseh1_open / bseh1_close##
45.1	422	)))\|(((
	423	opens / closes the EH1 beamshutter. Opening will open the OH beamshutter as well. Closing the OH beamshutter will the EH2 beamshutter as well
	424	)))
	425	\|(((
46.1	426	##bseh2_open / bseh2_close##
45.1	427	)))\|(((
	428	opens / closes the EH2 beamshutter. Openening will open the OH and EH1 beamshutters as well.
	429	)))
	430	\|(((
46.1	431	##ics_info##
45.1	432	)))\|(((
	433	prints an overview of the beamline interlock status
	434	)))
	435	\|(((
51.1	436	##oh_break_ics##
45.1	437	)))\|(((
	438	closes all P05 beamshutters and breaks OH door interlock. P06 beamshutter must be closed for this command to work!
	439	)))
	440	\|(((
51.1	441	##eh1_break_ics##
45.1	442	)))\|(((
	443	closes EH1 beamshutter (and EH2 beamshutter if open) and breaks EH1 door interlock
	444	)))
	445	\|(((
51.1	446	##eh2_break_ics##
45.1	447	)))\|(((
59.2	448	closes EH2 beamshutter and breaks EH2 door interlock
45.1	449	)))
59.2	450
59.6	451	== Serialscan Macros ==
59.2	452
59.27	453	General remarks: The serialscan macros save
59.20	454
59.3	455	\|=IDL command\|=Description
59.5	456	\|##ss_init##\|reset table
59.10	457	\|##ss_info##\|print current stage positions and scan parameters
59.18	458	\|ss_pos, nr, name, dist, sz, sx, sy, dz, ndz, /fetch, /force, /all, /prot\|Modify sample parameters
59.19	459	\|ss_insert, nr, /nosamplechanger\|Insert sample with settings from table
59.3	460
59.2	461

Wiki source code of IDL cheat sheet

Applications

Navigation