Wiki source code of IDL cheat sheet

Version 54.1 by fwilde on 2024/06/13 13:58

version	line-number	content
54.1	1	== {{id name="IDLcheatsheet-eCoordinatesystem"/}}eCoordinate 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
12.1	11	(% class="wrapped fixed-table" %)
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
46.1	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
46.1	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
45.1	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	\|(((
51.1	147	##**save_magn_set(, name_add)
	148	**##
45.1	149	)))\|(((
51.1	150	save current magnification set, optionally add something to the automatically generated name
45.1	151	)))
	152	\|(((
51.1	153	##**restore_magn_set(, name)
	154	**##
45.1	155	)))\|(((
51.1	156	restore last magnification set, or optionally load a file with a specific name
45.1	157	)))
	158
6.1	159	== {{id name="IDLcheatsheet-Detectorpositioning"/}}Detector positioning ==
	160
12.1	161	(% class="wrapped fixed-table" %)
6.1	162	\|=(((
7.1	163	IDL command
6.1	164	)))\|=(((
	165	description
	166	)))\|=(((
	167	motion
	168	)))
3.1	169	\|(((
50.1	170	##o_ccd_dist, 5##
1.1	171	)))\|(((
50.1	172	move detector in y direction relative by 5 mm
6.1	173	)))\|(((
50.1	174	relative [ mm ]
6.1	175	)))
	176	\|(((
50.1	177	##goto_o_ccd_dist, 30##
3.1	178	)))\|(((
50.1	179	move detector in y direction absoilute to 30 mm
6.1	180	)))\|(((
50.1	181	\\
6.1	182	)))
	183	\|(((
50.1	184	##pos_o_ccd_dist()##
6.1	185	)))\|(((
50.1	186	return current of the camera stage distance
6.1	187	)))\|(((
3.1	188	\\
1.1	189	)))
3.1	190
45.1	191	== {{id name="IDLcheatsheet-Slitpositioning"/}}Slit positioning ==
	192
	193	(% class="wrapped" %)
	194	\|=(((
	195	IDL command
	196	)))\|=(((
	197	description
	198	)))
	199	\|(((
47.1	200	##slit_oh, rx=1 (rz=1)##
	201	)))\|(((
	202	moves oh slit aperture horizontally (vertically) by 1mm
	203	)))
	204	\|(((
	205	##slit_oh, rdx=1 (rdz=1)##
	206	)))\|(((
	207	opens oh the slit aperture horizontally (vertically) by 1 mm
	208	)))
	209	\|(((
46.1	210	##slit_eh2, rx=1 (rz=1)##
45.1	211	)))\|(((
47.1	212	moves eh2 slit aperture horizontally (vertically) by 1 mm
45.1	213	)))
	214	\|(((
47.1	215	##slit_eh2, rdx=1 (rdz=1)##
45.1	216	)))\|(((
47.1	217	opens eh2 the slit aperture horizontally (vertically) by 1 mm
45.1	218	)))
	219	\|(((
46.1	220	##slit_info##
45.1	221	)))\|(((
	222	show all slit positions
	223	)))
	224
	225	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)
	226
47.1	227	== {{id name="IDLcheatsheet-Makeandsaveimages"/}}Make and save images ==
7.1	228
12.1	229	(% class="wrapped fixed-table" %)
7.1	230	\|=(((
	231	IDL command
	232	)))\|=(((
	233	description
	234	)))
	235	\|(((
47.1	236	##**i=quick(100) & display_image, BYSTCL(i, 0, 4096)
	237	**##
7.1	238	)))\|(((
47.1	239	make an image & scale image (eg. from 0 to 4096, usually from 0 to maximum value the camera can do)
7.1	240	)))
	241	\|(((
47.1	242	##a=quick_abs(100) & display_image, BYTSCL(a, 0, 2)##
7.1	243	)))\|(((
47.1	244	make an absorption image & scale image (usually from 0 to to 2)
7.1	245	)))
34.1	246	\|(((
47.1	247	##write_tiff, '/gpfs/current/raw/test_projection.tif', i, /SHORT##
34.1	248	)))\|(((
47.1	249	save i as 16-bit integer tiff in /gpfs/...
34.1	250	)))
47.1	251	\|(((
	252	##write_tiff, '/gpfs/current/raw/test_absorption.tif', a, /FLOAT##
	253	)))\|(((
	254	save a as 32-bit float tiff in /gpfs/...
	255	)))
7.1	256
54.1	257	== {{id name="IDLcheatsheet-Macrosmotion+images"/}}Macros motion + images ==
49.1	258
54.1	259	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). Use these macros to quickly align you samples.
	260
	261	(% class="relative-table" style="width: 109.112%;" %)
	262	\|=(((
	263	IDL command
	264	)))\|=(((
	265	description
	266	)))
	267	\|(((
	268	{{code language="none"}}qt (, t=100, scale=[0,4096]){{/code}}
	269	)))\|(((
	270	quick transmission image at the current position, optionally set a new exposure time
	271	)))
	272	\|(((
	273	{{code language="none"}}qa (, t=100, scale=[0,2], /ref){{/code}}
	274	)))\|(((
	275	quick absorption image at the current position, optionally set new exposure time or force to make a new reference image
	276	)))
	277	\|(((
	278	{{code language="none"}}qp (, t=100, scale=[0,2], /ref){{/code}}
	279	)))\|(((
	280	quick phase retreived image at the current position, optionally set new exposure time or for to make a new reference image
	281	)))
	282	\|(((
	283	{{code language="none"}}side, 90 (, t=100, /ref, /rel, imgtype='a') {{/code}}
	284	)))\|(((
	285	move rotation state to absolute angle in degrees (unless /rel is set) and make an imge. Image type can optionally be defined as "a' (absorption), 't' (transmission) or 'p' (phase). Exposure time is also otional
	286	)))
	287	\|(((
	288	{{code language="none"}}sshift, 2 (, t=100, /ref, imgtype='a'){{/code}}
	289	)))\|(((
	290	move sample stage laterally relative to current position and make an image at the new position. Optionally set exposure time, make flat field, or set image type)
	291	)))
	292	\|(((
	293	##sz, 2 (, t=100, /ref, imgtype='a')##
	294	)))\|(((
	295	move rotation stage up or down relative to current position and make an image at the new position. Optionally set exposure time, make reference image or set the image type.
	296	)))
	297	\|(((
	298	**{{code language="none"}}zx, 2 (, t=100, /ref, imgtype='a'){{/code}}
	299	**
	300	)))\|(((
	301	move rotation stage left or right relative to current position and make an image at the new position. Optionally set exposure time, make reference image or set the image type.
	302	)))
	303
49.1	304	\\
	305
	306	{{info title="Monochromator positioning"}}
	307	ATTENTION: Setting up a Monochromator as well as positioning front end slits is only done by the beamline staff!
	308
	309	The commands above may be used by users to realign the beam should it beam profile drift with time.
	310	{{/info}}
	311
47.1	312	== {{id name="IDLcheatsheet-DCMpositioning"/}}DCM positioning ==
6.1	313
12.1	314	(% class="wrapped fixed-table" %)
3.1	315	\|=(((
	316	IDL command
	317	)))\|=(((
	318	description
	319	)))\|=(((
	320	motion
	321	)))
1.1	322	\|(((
46.1	323	##dcm_pitch, 0.00001##
1.1	324	)))\|(((
4.1	325	move 2nd crystal pitch by 0.00001 deg
3.1	326	)))\|(((
4.1	327	relative [ deg ]
3.1	328	)))
	329	\|(((
46.1	330	##goto_dcm_pitch, -0.03976##
3.1	331	)))\|(((
4.1	332	move 2nd crystal pitch to -0.03976 deg
3.1	333	)))\|(((
4.1	334	absolute [ deg ]
1.1	335	)))
3.1	336	\|(((
51.1	337	##reflex_opt_single##
3.1	338	)))\|(((
4.1	339	move 2nd crystal pitch to optimal flux position
3.1	340	)))\|(((
	341	\\
	342	)))
47.1	343
	344	== {{id name="IDLcheatsheet-DMMpositioning"/}}DMM positioning ==
	345
48.1	346	(% class="fixed-table wrapped" %)
47.1	347	\|=(((
	348	IDL command
	349	)))\|=(((
	350	description
	351	)))\|=(((
	352	motion
	353	)))
26.1	354	\|(((
47.1	355	##dmm_x2_rot, 0.001##
	356	)))\|(((
	357	move 2nd crystal pitch by 0.00001 deg
	358	)))\|(((
	359	relative [ deg ]
	360	)))
	361	\|(((
	362	##**goto_dmm_x2_rot, 0.8923
	363	**##
	364	)))\|(((
	365	move 2nd crystal pitch to 0.8923 deg
	366	)))\|(((
	367	absolute [ deg ]
	368	)))
14.1	369
47.1	370	\\
	371
35.1	372	== {{id name="IDLcheatsheet-Generalsyntax"/}}General syntax ==
27.1	373
46.1	374	(% class="wrapped relative-table" style="width: 45.5603%;" %)
27.1	375	\|=(((
	376	Functionality
	377	)))\|=(((
	378	IDL syntax
	379	)))
	380	\|(((
46.1	381	chaining commands
27.1	382	)))\|(((
	383	command_1 & command_2 & ...
	384	)))
	385	\|(((
	386	absolute movement
	387	)))\|(((
	388	goto_//motor//, position
	389	)))
	390	\|(((
	391	relative movement
	392	)))\|(((
	393	//motor//, position
	394	)))
	395	\|(((
	396	current motor position
	397	)))\|(((
	398	pos_//motor//()
	399	)))
45.1	400
	401	== {{id name="IDLcheatsheet-BeamshutterandInterlockcontrol"/}}Beamshutter and Interlock control ==
	402
46.1	403	(% class="wrapped relative-table" style="width: 75.0455%;" %)
45.1	404	\|=(((
	405	IDL command
	406	)))\|=(((
	407	description
	408	)))
	409	\|(((
46.1	410	##bs_info##
45.1	411	)))\|(((
	412	prints an overview of the beamline beamshutter status
	413	)))
	414	\|(((
46.1	415	##bsoh_open / bsoh_close##
45.1	416	)))\|(((
	417	opens / closes the optics hutch beamshutter. Closing the OH beamshutter will close all following beamshutters (EH1, EH2)
	418	)))
	419	\|(((
46.1	420	##bseh1_open / bseh1_close##
45.1	421	)))\|(((
	422	opens / closes the EH1 beamshutter. Opening will open the OH beamshutter as well. Closing the OH beamshutter will the EH2 beamshutter as well
	423	)))
	424	\|(((
46.1	425	##bseh2_open / bseh2_close##
45.1	426	)))\|(((
	427	opens / closes the EH2 beamshutter. Openening will open the OH and EH1 beamshutters as well.
	428	)))
	429	\|(((
46.1	430	##ics_info##
45.1	431	)))\|(((
	432	prints an overview of the beamline interlock status
	433	)))
	434	\|(((
51.1	435	##oh_break_ics##
45.1	436	)))\|(((
	437	closes all P05 beamshutters and breaks OH door interlock. P06 beamshutter must be closed for this command to work!
	438	)))
	439	\|(((
51.1	440	##eh1_break_ics##
45.1	441	)))\|(((
	442	closes EH1 beamshutter (and EH2 beamshutter if open) and breaks EH1 door interlock
	443	)))
	444	\|(((
51.1	445	##eh2_break_ics##
45.1	446	)))\|(((
	447	closes EH2 beshutter and breaks EH2 door interlock
	448	)))
54.1	449
	450	== {{id name="IDLcheatsheet-Helpermacros"/}}Helper macros ==
	451
	452	The helper macros may help to align a sample quickly. Mainly, these are motion commands which subsequently make an image with predefined values.
	453
	454	(% class="wrapped" %)
	455	\|=(((
	456	IDL command
	457	)))\|=(((
	458	description
	459	)))
	460	\|(((
	461	helper_object, /info
	462	)))\|(((
	463	show predefined values
	464	)))
	465	\|(((
	466	\\
	467	)))\|(((
	468	\\
	469	)))
	470	\|(((
	471	\\
	472	)))\|(((
	473	\\
	474	)))
	475	\|(((
	476	\\
	477	)))\|(((
	478	\\
	479	)))
	480	\|(((
	481	\\
	482	)))\|(((
	483	\\
	484	)))
	485	\|(((
	486	\\
	487	)))\|(((
	488	\\
	489	)))
	490	\|(((
	491	\\
	492	)))\|(((
	493	\\
	494	)))
	495	\|(((
	496	\\
	497	)))\|(((
	498	\\
	499	)))

Wiki source code of IDL cheat sheet

Applications

Navigation