-
Notifications
You must be signed in to change notification settings - Fork 0
/
makeIDLRef.pro
643 lines (544 loc) · 24.8 KB
/
makeIDLRef.pro
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
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
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
;*************************************************************************
; Copyright (c) 2002 The University of Chicago, as Operator of Argonne
; National Laboratory.
; Copyright (c) 2002 The Regents of the University of California, as
; Operator of Los Alamos National Laboratory.
; This file is distributed subject to a Software License Agreement found
; in the file LICENSE that is included with this distribution.
;*************************************************************************
@mk_html_help.pro
PRO makeCurvFit
files = [ $
'/usr/local/rsi/idl_5/lib/comfit.pro', $
'/usr/local/rsi/idl_5/lib/curvefit.pro', $
'/usr/local/rsi/idl_5/lib/gaussfit.pro', $
'/usr/local/rsi/idl_5/lib/ladfit.pro', $
'/usr/local/rsi/idl_5/lib/linfit.pro', $
'/usr/local/rsi/idl_5/lib/lmfit.pro', $
'/usr/local/rsi/idl_5/lib/poly_fit.pro', $
'/usr/local/rsi/idl_5/lib/polyfitw.pro', $
'/usr/local/rsi/idl_5/lib/regress.pro', $
; '/usr/local/rsi/idl_5/lib/sfit.pro', $
'/usr/local/rsi/idl_5/lib/svdfit.pro' $
]
descript=[ '<H1>IDL Curve Fitting Routines</H1> ', $
'<PRE>', $
'<BR><BR><I><B>For detail information please refer to the IDL reference manual.</B></I>', $
'<BR>COMFIT - Six common types of gradient-expansion least-square fit', $
'<BR> EXPONENTIAL Y = a0 * a1^x + a2 ', $
'<BR> GEOMETRIC Y = a0 * x^a1 + a2 ', $
'<BR> GOMPERTZ Y = a0 * a1^(a2*x) + a3 ', $
'<BR> HYPERBOLIC Y = 1./(a0 + a1*x) ', $
'<BR> LOGISTIC Y = 1./(a0 * a1^x + a2) ', $
'<BR> LOGSQUARE Y = a0 + a1*alog10(x) + a2 * alog10(x)^2 ', $
'<BR>CURVEFIT - Least-square fit to an arbitrary non-linear function', $
'<BR>ERRORFFIT - Errorf function fit', $
'<BR> F(x) = A0 + A1*ERRORF((x-A2)/A3) + A4*x ', $
'<BR> F1(x) = A0 + A1*ERRORF((x-A2)/A3) + A4*x^2 ', $
'<BR>GAUSSFIT - Least-square fit to ', $
'<BR> F(x) = A0*EXP(-((x-A1)/A2)^2/2) + A3 + A4*x + A5*x^2 ', $
'<BR>LADFIT - Least-absolute-deviation fit to Y = A + Bx ', $
'<BR>LINFIT - Minimize-chi-square error fit to Y = A + Bx ', $
'<BR>LMFIT - Non-linear least-square fit to n arbitrary non-linear function ', $
'<BR>POLYFITW - Weighted least-square polynomial fit', $
'<BR>POLY_FIT - Least-square polynomial fit', $
'<BR>REGRESS - Multiple linear regression fit', $
'<BR>SVDFIT - Least-square fit to user-supplied/built-in/legendre polynomial ', $
'</PRE>' $
]
mk_html_help,files,'html/CurvFitRef.html', descript=descript
END
PRO catcherRef
descript=[ '<H1>catcher_v1.pro</H1> ', $
'At APS this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program normally is automatically invoked by the script command <B>catcher</B>.' $
]
mk_html_help,'catcher_v1.pro','html/catcherRef.html', $
descript=descript
END
PRO v1dOvlRef
descript=[ '<H1>view1d_overlay.pro</H1> ', $
'At APS this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program allows the user to overlay few different 1D scan data on the same plot.', $
'This program normally is automatically invoked by the script command <B>viewer</B>.' $
]
mk_html_help,'view1d_overlay.pro','html/v1dOvlRef.html', $
descript=descript
END
PRO dcviewerRef
descript=[ '<H1>dcviewer.pro</H1> ', $
'At APS this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program integrates the <B>view1d</B>, <B>view2d</B>, <B>bi2xdr_converter</B> programs into a single system', $
'This program normally is automatically invoked by the script command <B>viewer</B>.' $
]
mk_html_help,'dcviewer.pro','html/dcviewerRef.html', $
descript=descript
END
PRO view1dRef
descript=[ '<H1>view1d.pro</H1> ', $
'At APS this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program allows the user to view 1D scan data.', $
'This program can be directly accessed by the <B>viewer</B>.' $
]
mk_html_help,'view1d.pro','html/view1dRef.html', $
descript=descript
END
PRO view2dRef
descript=[ '<H1>view2d.pro</H1> ', $
'At APS this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program allows the user to view 2D image data.', $
'This program can be directly accessed by the <B>catcher</B> or <B>viewer</B>.' $
]
mk_html_help,'view2d.pro','html/view2dRef.html', $
descript=descript
END
PRO plot1dRef
descript=[ '<H1>plot1d.pro</H1> ', $
'At APS this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This is a general purpose of 1D multi-line plot package.' $
]
mk_html_help,'plot1d.pro','html/plot1dRef.html', $
descript=descript
END
PRO plot2dRef
descript=[ '<H1>plot2d.pro</H1> ', $
'At APS this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This is a general purpose of 2D plot package.' $
]
mk_html_help,'plot2d.pro','html/plot2dRef.html', $
descript=descript
END
PRO colorbarRef
descript=[ '<H1>scan_colorbar.pro</H1> ', $
'At APS this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This is a utility routine for generating the colorbar on a plot device.' $
]
mk_html_help,'scan_colorbar.pro','html/colorbarRef.html', $
descript=descript
END
PRO panImageRef
descript=[ '<H1>panimage.pro</H1> ', $
'At APS this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This is a utility routine for generating the panImage on a plot device.' $
]
mk_html_help,'panimage.pro','html/panImageRef.html', $
descript=descript
END
PRO u_readRef
descript=[ '<H1>u_read.pro</H1> ', $
'At APS this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This is a utility program for unformatted binary I/O. It supports both native and platform-independent XDR binary.' $
]
mk_html_help,'u_read.pro','html/u_readRef.html', $
descript=descript
END
PRO PS_openRef
descript=[ '<H1>PS_open.pro</H1> ', $
'At APS this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This is a utility program for supporting PostScript plot.' $
]
mk_html_help,'PS_open.pro','html/PS_openRef.html', $
descript=descript
END
PRO scan2dOverlayRef
descript=[ '<H1>scan2d_overlay.pro</H1> ', $
'At APS this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This is a flexible 2D image displaying widget program.',$
'This program dynamically constructs the 2D composite image from the selected images from a list of 2D XDR image files or 2D image arrays, or from 2D scan objects. ', $
'<P>This program also consists of a sub-program of <I>scanSee__define.pro</I> and is dynamically loaded into <I>scanSee__define</I> at the run-time.', $
'<P>This program also consists of a sub-program of <I>scan2d__define.pro</I> and is dynamically loaded into <I>scan2d__define</I> at the run-time.' $
]
mk_html_help,'scan2d_overlay.pro','html/scan2d_OverlayRef.html', $
descript=descript
END
PRO cw_termRef
descript=[ '<H1>cw_term.pro</H1> ', $
'At APS this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This is a utility program for generating window display terminal. It also provides a button of printing the window contents.' $
]
mk_html_help,'cw_term.pro','html/cw_termRef.html', $
descript=descript
END
PRO toImageRef
;
descript=[ '<H1>toImage.pro</H1> ', $
'At APS this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This is a utility program for extracting 1D scans and created 2D images.', $
'This program normally is invoked by <B>toimage</B> script.' $
]
mk_html_help,'toImage.pro','html/toImageRef.html', $
descript=descript
END
PRO ez_fitRef
;
descript=[ '<H1>ez_fit.pro</H1> ', $
'At present this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This is a general purpose curve fitting widget program.', $
'It integrates all the line fitting routines into a single system.', $
'It allows the IDL user easily to access various form of curve fitting.', $
'It is internally available to the data catcher R2.1 and viewer R2.1 or later release.', $
'<P>From the unix operating system to access <B>ez_fit</B> as a stand alone program by entering :', $
'<PRE> <B>ezfit</B></PRE>', $
'<P>In order to access <B>ez_fit</B> from other IDL program, a user has to make',$
'sure that the following environment variable is set before invoking IDL :', $
'<PRE><B> setenv EPICS_EXTENSIONS /usr/local/epics/extensions </B></PRE>', $
'<P>and make sure including the directory <B>/usr/local/epics/extensions/idllib</B>',$
'in his/her IDL search path.' $
]
mk_html_help,'ez_fit.pro','html/ez_fitRef.html', $
descript=descript
END
PRO objCleanRef
descript=[ '<H1>obj_clean.pro</H1> ', $
'At present this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program provides the utility routine OBJ_CLEAN to easily clean up various', $
'objects from the IDL heap.']
mk_html_help,'obj_clean.pro','html/objCleanRef.html', $
descript=descript
END
PRO scan2d_convertRef
descript=[ '<H1>scan2d_convert.pro</H1> ', $
'At present this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program is specially written for scan2d object, it provides the user with', $
'flexible object methods of reading / writing TIFF or GIF images for a list', $
'of desired image numbers.']
mk_html_help,'scan2d_convert.pro','html/scan2d_convertRef.html', $
descript=descript
END
PRO scan2d_ROIRef
descript=[ '<H1>scan2d_roi.pro</H1> ', $
'At present this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program provides IDL users a widget application SCAN2D_ROI to flexiblely', $
'define a 2D-ROI and caluculate statistics with any input 2D image.']
mk_html_help,'scan2d_roi.pro','html/scan2d_ROIRef.html', $
descript=descript
END
PRO calibrationRef
descript=[ '<H1>calibration_factor.pro</H1> ', $
'At present this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program provides IDL users a widget application CALIBRATION_FACTOR to flexiblely', $
'define and calculate various image calibrations with a set of input 2D scan image_array.']
mk_html_help,'calibration_factor.pro','html/calibrationRef.html', $
descript=descript
END
PRO view3d_slicerRef
descript=[ '<H1>view3d_slicer.pro</H1> ', $
'At present this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program provides IDL users a widget application VIEW3D_SLICER to flexiblely', $
'access the 2D data from the 3D data array. Currently, the 3D data must be automatically saved by', $
'the IOC scan software in XDR format. ']
mk_html_help,'view3d_slicer.pro','html/view3D_slicerRef.html', $
descript=descript
END
;
PRO scan1d_ObjectRef
;
descript=[ '<H1>scan1d__define.pro</H1> ', $
'At present this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program is written in IDL object programming language .', $
'It allows the IDL user easily to access 1D scan data captured by the data catcher', $
'without bringing up data catcher or viewer.', $
'<P>For proper operation of the <B>scan1d</B> object, a user first has to make',$
'sure that the IDL 5.0 or later is used by his environment settings.', $
'<P>In order to access <B>scan1d</B> object from other IDL program, a user has to make',$
'sure that the following environment variables are set before invoking IDL :', $
'<PRE> <B>setenv EPICS_EXTENSIONS /usr/local/epics/extensions </B></PRE>', $
'<PRE><B> setenv IDL_STARTUP $EPICS_EXTENSIONS/idllib/viewer_startup.pro </B></PRE>', $
'and make sure including the directory <B>/usr/local/epics/extensions/idllib</B>',$
'in his/her IDL search path.', $
'<P>From the unix operating system to access IDL <I><B>scan1d</B></I> object class by entering :', $
'<PRE> <B>idl go_scan1d</B></PRE>', $
'<P>The files <B>u_read.pro</B>, <B>plot1d.pro</B>, and <B>scan1d__define.pro</B> are automatically loaded into IDL for user.', $
"</B><P>For an example to create a <I><B>'scan1d'</B></I> object with variable name as <B>v1d</B>, ", $
"where the 1D catcher data is saved in the file <B><I>'junk2'</I></B>:", $
"<PRE><B> v1d = obj_new('scan1d',file=<I>'junk2'</I>)</B></PRE>", $
"<P>To get the positioner array PA and detector array DA for scan number 10, plus plotting and listing windows:", $
'<PRE><B> v1d->read,10,DA=da,PA=pa,/plot,/list </B></PRE>' $
]
mk_html_help,'scan1d__define.pro','html/scan1d_ObjectRef.html', $
descript=descript
END
PRO scan2d_ObjectRef
;
descript=[ '<H1>scan2d__define.pro</H1> ', $
'At present this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program is written in IDL object programming language .', $
'It allows the IDL user easily to access 2D scan data captured by the data catcher.', $
'<P>In order to access <B>scan2d</B> object from other IDL program, a user has to make',$
'sure that the following environment variable is set before invoking IDL :', $
'<PRE> <B>setenv EPICS_EXTENSIONS /usr/local/epics/extensions </B></PRE>', $
'<PRE><B> setenv IDL_STARTUP /usr/local/epics/extensions/idllib/viewer_startup.pro </B></PRE>', $
'<P>and make sure including the directory <B>/usr/local/epics/extensions/idllib</B>',$
'in his/her IDL search path.', $
'<P>From the unix operating system to access IDL <I><B>scan2d</B></I> object class by entering :', $
'<PRE> <B>idl go_scan2d</B></PRE>', $
'<P>The files <B>u_read.pro</B>, and <B>scan2d__define.pro</B> are automatically loaded into IDL for user.', $
"</B><P>For an example to create a <I><B>'scan2d'</B></I> object with variable name as <B>v2</B>, ", $
"where the 2D catcher data is saved in the file <B><I>'junk2.image'</I></B>:", $
"<PRE><B> v2 = obj_new('scan2d',file=<I>'junk2.image'</I>)</B></PRE>", $
"<P>To view the image number 135 from the file:", $
'<PRE><B> v2->view,135 </B></PRE>' $
]
mk_html_help,'scan2d__define.pro','html/scan2d_ObjectRef.html', $
descript=descript
END
PRO NX_ObjectRef
;
descript=[ '<H1>NX__define.pro</H1> ', $
'At present this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program is written in IDL 5.1 object programming language .', $
'It provides the IDL user conveninent methods of accessing NX HDF data set.', $
'<P>In order to access <B>NX</B> object from other IDL program, a user has to make',$
'sure that the following environment variable is set before invoking IDL :', $
'<PRE> <B>setenv EPICS_EXTENSIONS /usr/local/epics/extensions </B></PRE>', $
'<PRE><B> setenv IDL_STARTUP /usr/local/epics/extensions/idllib/viewer_startup.pro </B></PRE>', $
'<P>During an IDL session to access <I><B>NX</B></I> object class by entering :', $
'<PRE> <B>.run NX__define</B></PRE>', $
"</B><P>For an example to create a <I><B>'NX'</B></I> object with variable name as <B>v</B>, ", $
"where the NX HDF data is saved in the file <B><I>'1.hdf'</I></B>:", $
"<PRE><B> v = obj_new('NX',file=<I>'1.hdf'</I>)</B></PRE>", $
"<P>To view the HDF file summary:", $
'<PRE><B> v->print </B></PRE>' $
]
mk_html_help,'NX__define.pro','html/NX_ObjectRef.html', $
descript=descript
END
PRO readScanRef
;
descript=[ '<H1>readScan.pro</H1> ', $
'At present this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program is written in IDL 5.1 programming language .', $
'It provides the IDL user conveninent methods of accessing scan data set ',$
'automatically saved by the IOC savedata software.',$
'<P>In order to access <B>scanSee</B> data from other IDL program, a user has to make',$
'sure that the following environment variable is set before invoking IDL :', $
'<PRE> <B>setenv EPICS_EXTENSIONS /usr/local/epics/extensions </B></PRE>', $
'<PRE><B> setenv IDL_STARTUP /usr/local/epics/extensions/idllib/viewer_startup.pro </B></PRE>', $
'<P>and make sure including the directory <B>/usr/local/epics/extensions/idllib</B>',$
'in his/her IDL search path.', $
'<P>During an IDL session to access <I><B>scanSee</B></I> data by entering :', $
'<PRE> <B>.run readScan</B></PRE>', $
"</B><P>For an example to access the scan data with the scan data structure pointer <B>gD</B>, ", $
"where the scan data is saved in the file <B><I>'rix:._0003.scan'</I></B>:", $
"<PRE><B> readScanFile,<I>'rix:._0003.scan'</I>,gD</B></PRE>", $
"<P>To view the scan data summary:", $
'<PRE><B> scanImage_print,gD </B></PRE>' $
]
mk_html_help,'readScan.pro','html/readScan.html', $
descript=descript
END
PRO multiroi_pickRef
descript=[ '<H1>multiroi_pick.pro</H1> ', $
'At present this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program provides IDL users a widget application MULTIROI_PICK to flexiblely', $
'define multiple 2D-ROIs and caluculates statistics with any input 2D image.']
mk_html_help,'multiroi_pick.pro','html/multiroi_pickRef.html', $
descript=descript
END
PRO vw2dRef
descript=[ '<H1>vw2d.pro</H1> ', $
'At present this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program provides IDL users a widget application VW2D ', $
'to load a 2D scan scan file saved by the IOC and obtaining various display features of the 2D data.']
mk_html_help,'vw2d.pro','html/vw2dRef.html', $
descript=descript
END
PRO pick2dRef
descript=[ '<H1>pick2d.pro</H1> ', $
'At present this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program provides IDL users a widget application PICK2D to flexiblely', $
'pick a 2D scan detector and obtaining various display features of the 2D data.']
mk_html_help,'pick2d.pro','html/pick2dRef.html', $
descript=descript
END
PRO pick3dRef
descript=[ '<H1>pick3d.pro</H1> ', $
'At present this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program provides IDL users a widget application PICK3D to flexiblely', $
'pick a 3D scan detector and obtaining various display features of the 3D data.']
mk_html_help,'pick3d.pro','html/pick3dRef.html', $
descript=descript
END
PRO view3d_2dsumRef
descript=[ '<H1>view3d_2dsum.pro</H1> ', $
'At present this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program provides IDL users a widget application VIEW3D_2DSUM to flexiblely', $
'define multiple 2D-ROIs and caluculates statistics with any input 3D image.']
mk_html_help,'view3d_2dsum.pro','html/view3d_2dsum.html', $
descript=descript
END
PRO view3d_2dRef
descript=[ '<H1>view3d_2d.pro</H1> ', $
'At present this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program provides IDL users a widget application VIEW3D_2D to flexiblely', $
'extract any 2D data array from the input 3D data array.']
mk_html_help,'view3d_2d.pro','html/view3d_2dRef.html', $
descript=descript
END
PRO xdr_openRef
descript=[ '<H1>xdr_open.pro</H1> ', $
'At present this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program provides IDL users a set of simple to use routines to handle XDR file. ', $
'It provides XDR open, write, read, and close to access xdr fromat.']
mk_html_help,'xdr_open.pro','html/xdr_open.html', $
descript=descript
END
PRO imageRef
descript=[ '<H1>image.pro</H1> ', $
'At present this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program provides IDL users a convenient image process widget program. ', $
'It supports image files in any of the TIF, PNG, JPG, XDR formats.', $
'It let the user very easily to enlarge, shrink, inverse, or rotate the display; redisplay the extracted sub-region of image;',$
'tailor and manipulate with various IDL color tables; and convert image to different output format or PS printer.']
mk_html_help,'image.pro','html/imageRef.html', $
descript=descript
END
PRO image2dRef
descript=[ '<H1>image2d.pro</H1> ', $
'At APS this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program allows the user to view any 2D image data array.', $
'This program can be directly plugged into any IDL program with image data array as input parameter.' $
]
mk_html_help,'image2d.pro','html/image2dRef.html', $
descript=descript
END
PRO sscanRef
descript=[ '<H1>sscan.pro</H1> ', $
'At APS this program is installed in <B>/usr/local/epics/extensions/idllib</B> directory for R3.14.', $
'This program allows the user to view any 1D/2D/3D scan MDA files.', $
'This program can be directly plugged into any IDL program.' $
]
mk_html_help,'sscan.pro','html/sscanRef.html', $
descript=descript
END
PRO sscan_ObjectRef
descript=[ '<H1>sscan__define.pro</H1> ', $
'At APS this program is installed in <B>/usr/local/epics/extensions/idllib</B> directory for R3.14.', $
'This program allows the user to use ssscn object to access or view any 1D/2D/3D data array from the MDA scan files.', '<P>', $
'In order to access <b>sscan</b> object from other IDL program, a suser has to',$
' make sure the following environment variable is set before invoking IDL:', $
'<PRE> <B>setenv EPICS_EXTENSIONS /usr/local/epics/extensions </B></PRE>', $
'<PRE> <B>setenv IDL_STARTUP $EPICS_EXTENSIONS/idllib/viewer_startup.pro </B></PRE>', $
'This program can be accessed directly from the IDL prompt.', $
'An example of using IDL to create an <b>sscan</b> object, and then use', $
'the object method <i>image2d</i> to access the 2D images are given below:', $
'<pre>', $
' <b>idl</b>',$
' IDL> @os.init',$
' IDL> loadct,39',$
' IDL> .run sscan__define', $
" IDL> file='/home/beams/CHA/Yorick/data/2idd_0002.mda'", $
" IDL> v = obj_new('sscan',file=file)", $
' IDL> v->image2d', $
'</pre>' $
]
mk_html_help,'sscan__define.pro','html/sscan_ObjectRef.html', $
descript=descript
END
PRO wd_readasciiRef
descript=[ '<H1>wd_readascii.pro</H1> ', $
'At APS this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program allows the user to use the widget program wd_readascii to ', $
'freely extract 1D or 2D data array from any fixed format text file.' $
]
mk_html_help,'wd_readascii.pro','html/wd_readasciiRef.html', $
descript=descript
END
PRO volanimatorRef
descript=[ '<H1>volume_animator.pro</H1> ', $
'At APS this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program allows the user to access animate routines for processing ', $
'array of 2D image data or 3D volume data' $
]
mk_html_help,'volume_animator.pro','html/volanimatorRef.html', $
descript=descript
END
PRO wv_appletRef
descript=[ '<H1>wv__define.pro</H1> ', $
'At present this program is installed in the <B>/usr/local/epics/extensions/idllib</B> directory for EPICS R3.14.', $
'This program provides IDL users a set of wavelet input methods for the IDL WV_APPLET program. ', $
'It provides a wv_applet method for each type of <B>scan1d</B>, <B>scan2d</B>, and <B>scanSee</B> objects.', $
'It let the user very easily to extract the desired vectors or images from the scan files and load into the IDL WV_APPLET program and perform wavelet transformation provided by IDL.']
mk_html_help,'wv__define.pro','html/wv_applet.html', $
descript=descript
END
PRO makeIDLRef
; This program builds the catcher.html from the source files
files = ['catcher_v1.pro','view2d.pro','plot2d.pro','plot1d.pro','view1d.pro','dcviewer.pro','scan2d_roi.pro']
mk_html_help, files, 'catcher.html'
; catcherRef
catcherRef
; v1dOvlRef
v1dOvlRef
; dcviewerRef
dcviewerRef
; view1dRef
view1dRef
; view2dRef
view2dRef
; plot1dRef
plot1dRef
; plot2dRef
plot2dRef
; u_readRef
u_readRef
; PS_openRef
PS_openRef
; cw_termRef
cw_termRef
; toImageRef
toImageRef
; ez_fitRef
ez_fitRef
; scan1d_ObjectRef
scan1d_ObjectRef
; scan2d_ObjectRef
scan2d_ObjectRef
; objCleanRef
objCleanRef
; NX_ObjectRef
NX_ObjectRef
; readScanRef
readScanRef
; scan2dOverlayRef
scan2dOverlayRef
; scan2d_convertRef
scan2d_convertRef
; calibrationRef
calibrationRef
; view3d_slicerRef
view3d_slicerRef
; scan2d_ROIRef
scan2d_ROIRef
; colorbarRef
colorbarRef
; panImageRef
panImageRef
; multiROI_pickRef
multiROI_pickRef
; vw2dRef
vw2dRef
; pick2dRef
pick2dRef
; pick3dRef
pick3dRef
; view3d_2dsumRef
view3d_2dsumRef
; view3d_2dRef
view3d_2dRef
; xdr_OpenRef
xdr_OpenRef
; imageRef
imageRef
; image2dRef
image2dRef
; sscanRef
sscanRef
; sscan_ObjectRef
sscan_ObjectRef
; wd_readasciiRef
wd_readasciiRef
; volanimatorRef
VolAnimatorRef
; wv_appletRef
END