source: sans/Dev/trunk/NCNR_User_Procedures/Reduction/VSANS/V_Initialize.ipf @ 1114

Last change on this file since 1114 was 1114, checked in by srkline, 4 years ago

bug fixes for:

RealTime? updating at VSANS
Mask loading at SANS

added highResGain field for VSANS R/W
File size: 16.9 KB
Line 
1#pragma rtGlobals=3             // Use modern global access method and strict wave access.
2#pragma version=0.1
3#pragma IgorVersion=6.1
4
5//***********************
6// NOV 2015 Vers 0.1
7//
8// Initialization procedures that must be run before anything
9// this is accomplished by placing:
10//
11// Initialize()
12// #include "includes"
13//
14// in the built-in procedure window of the .pxt (template) experiment
15// IGOR recognizes this, and executes Initialize() immediately after
16// compiling all of the included procedures. This is all done as the blank
17// template is opened
18//
19// Choosing initialize from the VSANS menu will do the same, and no harm is done
20// to the experiment by re- initializing. no data or folders are overwritten
21//
22//************************
23
24
25
26// TODO -- need to set up a separate file of "constants" or "globals" where the actual numbers are
27//stored. If there are not a lot, that place could be here. InitFacilityGlobals() is currently in NCNR_Utils.ipf
28
29
30// for the change in July 2017 where the beam center is now defined in cm, rather than pixels.
31// this need not ever change from 1
32Constant kBCTR_CM = 1                   //set to 1 to use beam center in cm. O to use pixels
33
34// // TODO: -- replace this constant with V_getDet_panel_gap(fname,detStr)
35//Constant kPanelTouchingGap = 10                       // TODO -- measure this gap when panels "touch", UNITS OF mm, not cm
36
37
38// the base data folder path where the raw data is loaded
39Strconstant ksBaseDFPath = "root:Packages:NIST:VSANS:RawVSANS:"
40
41
42// the list of WORK Folders
43// RawVSANS does not behave as a WORK folder, but it is local. so add it in explicitly to the list if needed
44// VCALC behaves *almost* as a WORK folder, but it is local. so add it in explicitly to the list if needed
45//Strconstant ksWorkFolderList = "RAW;SAM;EMP;BGD;COR;DIV;ABS;MSK;CAL;STO;SUB;DRK;ADJ;VCALC;RawVSANS;"
46Strconstant ksWorkFolderListShort = "RAW;SAM;EMP;BGD;COR;DIV;ABS;MSK;CAL;STO;SUB;DRK;ADJ;"
47
48
49// for defining which "bin type" corresponds to which set of extensions for I(q) data
50// !! see V_BinTypeStr2Num() for the numbering, not the order of the list
51//
52//////////////////
53//Strconstant ksBinTypeStr = "One;Two;Four;Slit Mode;"
54Strconstant ksBinTypeStr = "F4-M4-B;F2-M2-B;F1-M1-B;F2-M1-B;F1-M2xTB-B;F2-M2xTB-B;SLIT-F2-M2-B;"
55Strconstant ksBinType1 = "FT;FB;FL;FR;MT;MB;ML;MR;B;"           //these are the "active" extensions
56Strconstant ksBinType2 = "FTB;FLR;MTB;MLR;B;"
57Strconstant ksBinType3 = "FLRTB;MLRTB;B;"
58//Strconstant ksBinType4 = "FT;FB;FL;FR;MT;MB;ML;MR;B;"
59Strconstant ksBinType4 = "FL;FR;ML;MR;B;"               //in SLIT mode, disregard the T/B panels
60Strconstant ksBinType5 = "FTB;FLR;MLRTB;B;"
61Strconstant ksBinType6 = "FLRTB;MLR;B;"
62Strconstant ksBinType7 = "FTB;FLR;MLR;B;"
63///////////////////
64
65
66// for looping over each detector
67Strconstant ksDetectorListNoB = "FL;FR;FT;FB;ML;MR;MT;MB;"
68Strconstant ksDetectorListAll = "FL;FR;FT;FB;ML;MR;MT;MB;B;"
69
70
71// for Protocols
72Constant kNumProtocolSteps = 12
73// for trimming of the I(q) data sets, and part of the protocol
74Strconstant ksPanelBinTypeList = "B;FT;FB;FL;FR;MT;MB;ML;MR;FTB;FLR;MTB;MLR;FLRTB;MLRTB;"
75Strconstant ksBinTrimBegDefault = "B=5;FT=3;FB=3;FL=3;FR=3;MT=3;MB=3;ML=3;MR=3;FTB=2;FLR=2;MTB=2;MLR=2;FLRTB=1;MLRTB=1;"
76Strconstant ksBinTrimEndDefault = "B=10;FT=5;FB=5;FL=5;FR=5;MT=5;MB=5;ML=5;MR=5;FTB=4;FLR=4;MTB=4;MLR=4;FLRTB=3;MLRTB=3;"
77
78// the average read noise level of the back detector
79// taken from multiple runs with the beam off, 6-28-18
80// runs sans12324 - sans12353
81//
82// used in V_Raw_to_Work()
83// average of whole panel (tested several data files) = 208 +/- 14
84//
85// 200 appears to be a better value - (empirical, based on teflon/converging pinhole data)
86Constant kReadNoiseLevel = 200
87//Constant kReadNoiseLevel = 208
88Constant kReadNoiseLevel_Err = 14
89
90
91
92// Pixel shifts for the back detector to bring the three CCDs into registry
93// data from pinholes used to match up CCDs
94// 27 JUN 2018
95// runs 12221,12225,27,33,34,35,38,42
96// middle CCD is not moved
97// See V_ShiftBackDetImage() for implementation
98Constant        kShift_TopX = 7
99Constant                kShift_TopY = 105
100Constant                kShift_BottomX = 5
101Constant                kShift_BottomY = 35
102
103
104
105
106
107
108Proc Initialize_VSANS()
109        V_Initialize()
110End
111
112//this is the main initualization procedure that must be the first thing
113//done when opening a new Data reduction experiment
114//
115//sets up data folders, globals, protocols, and draws the main panel
116Proc V_Initialize()
117
118        Variable curVersion = 0.1
119        Variable oldVersion = NumVarOrDefault("root:VSANS_RED_VERSION",curVersion)
120               
121        if(oldVersion == curVersion)
122                //must just be a new startup with the current version
123                Variable/G root:VSANS_RED_VERSION=0.1
124        endif
125       
126        if(oldVersion < curVersion)
127                String str =    "This experiment was created with version "+num2str(oldVersion)+" of the macros. I'll try to make this work, but please start new work with a current template"
128                DoAlert 0,str
129        endif
130       
131        V_InitFolders()
132       
133        VC_Initialize_Space()           //initialize folders for VCALC
134       
135        V_InitFakeProtocols()
136        V_InitGlobals()
137        V_InitFacilityGlobals()
138        DoWindow/F Main_VSANS_Panel
139        If(V_flag == 0)
140                //draw panel
141                Main_VSANS_Panel()
142        Endif
143//      V_ResizeCmdWindow()
144
145// TODO - be sure that NCNR is defined correctly       
146        //unload the NCNR_Package_Loader, if NCNR not defined
147        UnloadNCNR_VSANS_Procedures()
148
149End
150
151//creates all the necessary data folders in the root folder
152//does not overwrite any existing folders of the same name
153//it leaves data in them untouched
154//
155// x-- make sure that I have all of the folders that I need
156//
157Function V_InitFolders()
158       
159        NewDataFolder/O root:Packages
160        NewDataFolder/O root:Packages:NIST
161        NewDataFolder/O root:Packages:NIST:VSANS
162       
163// for the file catalog
164        NewDataFolder/O root:Packages:NIST:VSANS:CatVSHeaderInfo
165// for the globals
166        NewDataFolder/O root:Packages:NIST:VSANS:Globals
167// for the raw nexus data (so I don't need to reload to get a single value)
168        NewDataFolder/O root:Packages:NIST:VSANS:RawVSANS
169
170// folders for the reduction steps             
171        NewDataFolder/O root:Packages:NIST:VSANS:RAW
172        NewDataFolder/O root:Packages:NIST:VSANS:SAM
173        NewDataFolder/O root:Packages:NIST:VSANS:EMP
174        NewDataFolder/O root:Packages:NIST:VSANS:BGD
175        NewDataFolder/O root:Packages:NIST:VSANS:COR
176        NewDataFolder/O root:Packages:NIST:VSANS:DIV
177        NewDataFolder/O root:Packages:NIST:VSANS:MSK
178        NewDataFolder/O root:Packages:NIST:VSANS:ABS
179        NewDataFolder/O root:Packages:NIST:VSANS:CAL
180        NewDataFolder/O root:Packages:NIST:VSANS:STO
181        NewDataFolder/O root:Packages:NIST:VSANS:SUB
182        NewDataFolder/O root:Packages:NIST:VSANS:DRK
183        NewDataFolder/O root:Packages:NIST:VSANS:ADJ
184        NewDataFolder/O root:Packages:NIST:VSANS:RealTime
185        NewDataFolder/O root:Packages:NIST:VSANS:VCALC
186
187
188// ?? anything else
189
190// for simulation
191//      NewDataFolder/O root:Packages:NIST:VSANS:SAS
192
193
194       
195        Return(0)
196End
197
198
199
200
201//
202//Global folder already exists...
203//adds appropriate globals to the newly created myGlobals folder
204//return data folder to root: before leaving
205//
206//
207Function V_InitGlobals()
208       
209       
210        Variable/G root:Packages:NIST:VSANS:Globals:gIsLogScale = 0
211        String/G root:Packages:NIST:VSANS:Globals:gCurDispType = "RAW"
212       
213        //check platform, so Angstrom can be drawn correctly
214
215        //TODO  -- this is different on Igor 7. Macintosh # has been updated, but Windows has not
216        // use Print char2num("Å") to find the magic number
217        if(cmpstr("Macintosh",IgorInfo(2)) == 0)
218                String/G root:Packages:NIST:VSANS:Globals:gAngstStr = num2char(197)
219                String/G root:Packages:NIST:gAngstStr = num2char(197)
220                Variable/G root:Packages:NIST:VSANS:Globals:gIsMac = 1
221        else
222                //either Windows or Windows NT
223                String/G root:Packages:NIST:VSANS:Globals:gAngstStr = num2char(-59)
224                String/G root:Packages:NIST:gAngstStr = num2char(-59)
225                Variable/G root:Packages:NIST:VSANS:Globals:gIsMac = 0
226                //SetIgorOption to keep some PC's (graphics cards?) from smoothing the 2D image
227                Execute "SetIgorOption WinDraw,forceCOLORONCOLOR=1"
228        endif
229       
230        // TODO x- find the SANS preferences, copy over and update for VSANS
231        // x- these are all in PlotUtilsMacro_v40.ipf as the preferences are set up as common
232        // to all packages. I'm not sure that I want to do this with VSANS, but make the packages
233        // separate entities. I'm seeing little benefit of the crossover, especially now that
234        // Analysis is not mine. So for VSANS, there is a new, separate file: V_VSANS_Preferences.ipf
235
236        //this is critical to initialize now - as it has the y/n flags for the detector correction steps
237        Execute "Initialize_VSANSPreferences()"
238
239       
240        // set the lookup waves for log/lin display of the detector images
241        V_MakeImageLookupTables(10000,0,1)
242
243
244
245        //set flag if Demo Version is detected
246        Variable/G root:Packages:NIST:VSANS:Globals:isDemoVersion = V_isDemo()
247       
248        //set XML globals
249//      String/G root:Packages:NIST:gXMLLoader_Title = ""
250       
251        Return(0)
252End
253
254//
255//num = number of points (10000 seeems to be a good number so far)
256// lo = lower value (between 0 and 1)
257// hi = upper value (between 0 and 1)
258//
259// note that it is currenty NOT OK for lo > hi (!= reversed color scale, right now log(negative) == bad)
260//
261// TODO hi, lo not used properly here, seems to mangle log display now that I'm switching the lo,hi of the ctab
262//
263Function V_MakeImageLookupTables(num,lo,hi)
264        Variable num,lo,hi
265
266                // lookup waves for log and linear display of images
267        // this is used for the main data display. With this, I can use the original
268        // detector data (no copy) and the zeros in the data set are tolerated when displaying
269        // on log scale
270        SetDataFolder root:Packages:NIST:VSANS:Globals
271        Variable val,offset
272       
273        offset = 1/num          //can't use 1/lo if lo == 0
274       
275        Make/O/D/N=(num) logLookupWave,linearLookupWave
276       
277        linearLookupWave = (p+1)/num
278       
279       
280        logLookupWave = log(linearLookupWave)
281        val = logLookupWave[0]
282        logLookupWave += -val + offset
283        val = logLookupWave[num-1]
284        logLookupWave /= val
285       
286        SetDataFolder root:
287       
288        return(0)
289end
290
291//
292// initializes globals that are specific to VSANS
293//
294// there really should be nothing here... all of this should now be in the Nexus data file
295// and not tethered to hard-wired constants.
296//
297// -- what was here was:
298// number of detector pixels
299// pixel size
300// deadtime
301// beamstop "tolerance" to identify Trans files
302// sample aperture offset
303//
304Function V_InitFacilityGlobals()
305
306//      //Detector -specific globals
307//      Variable/G root:myGlobals:gNPixelsX=128
308//      Variable/G root:myGlobals:gNPixelsY=128
309//     
310//      // as of Jan2008, detector pixel sizes are read directly from the file header, so they MUST
311//      // be set correctly in instr.cfg - these values are not used, but declared to avoid errors
312//      Variable/G root:myGlobals:PixelResNG3_ILL = 1.0         //pixel resolution in cm
313//      Variable/G root:myGlobals:PixelResNG5_ILL = 1.0
314//      Variable/G root:myGlobals:PixelResNG7_ILL = 1.0
315//      Variable/G root:myGlobals:PixelResNG3_ORNL = 0.5
316//      Variable/G root:myGlobals:PixelResNG5_ORNL = 0.5
317//      Variable/G root:myGlobals:PixelResNG7_ORNL = 0.5
318//      Variable/G root:myGlobals:PixelResNGB_ORNL = 0.5
319////    Variable/G root:myGlobals:PixelResCGB_ORNL = 0.5                // fiction
320//
321//      Variable/G root:myGlobals:PixelResDefault = 0.5
322//     
323//      Variable/G root:myGlobals:DeadtimeNG3_ILL = 3.0e-6              //deadtime in seconds
324//      Variable/G root:myGlobals:DeadtimeNG5_ILL = 3.0e-6
325//      Variable/G root:myGlobals:DeadtimeNG7_ILL = 3.0e-6
326//      Variable/G root:myGlobals:DeadtimeNGB_ILL = 4.0e-6              // fictional
327//      Variable/G root:myGlobals:DeadtimeNG3_ORNL_VAX = 3.4e-6         //pre - 23-JUL-2009 used VAX
328//      Variable/G root:myGlobals:DeadtimeNG3_ORNL_ICE = 1.5e-6         //post - 23-JUL-2009 used ICE
329//      Variable/G root:myGlobals:DeadtimeNG5_ORNL = 0.6e-6                     //as of 9 MAY 2002
330//      Variable/G root:myGlobals:DeadtimeNG7_ORNL_VAX = 3.4e-6         //pre 25-FEB-2010 used VAX
331//      Variable/G root:myGlobals:DeadtimeNG7_ORNL_ICE = 2.3e-6         //post 25-FEB-2010 used ICE
332//      Variable/G root:myGlobals:DeadtimeNGB_ORNL_ICE = 4.0e-6         //per JGB 16-JAN-2013, best value we have for the oscillating data
333//
334////    Variable/G root:myGlobals:DeadtimeCGB_ORNL_ICE = 1.5e-6         // fiction
335//
336//      Variable/G root:myGlobals:DeadtimeDefault = 3.4e-6
337//
338//      //new 11APR07
339//      Variable/G root:myGlobals:BeamstopXTol = -8                     // (cm) is BS Xpos is -5 cm or less, it's a trans measurement
340//      // sample aperture offset is NOT stored in the VAX header, but it should be
341//      // - when it is, remove the global and write an accessor AND make a place for
342//      // it in the RealsRead
343//      Variable/G root:myGlobals:apOff = 5.0                           // (cm) distance from sample aperture to sample position
344
345End
346
347///////////////////////////////////////////////
348// TODO
349////////////// everything below needs to be re-written for VSANS
350//
351//////////////////////////////////////////////
352
353
354//
355// do I need to make the protocols any longer for VSANS? (yes -- now 12 points)
356// What other options for processing / averaging / saving are needed??
357//  TODO
358// x- likely that I'll want to have #pts to cut from I(q) as input to NSORT within the protocol so that the
359// entire reduction can be automatic
360//
361//
362// x- creates the "base" protocols that should be available, after creating the data folder
363// x- all protocols are kept in the root:Packages:NIST:VSANS:Globals:Protocols folder, created here
364//
365//
366//*****as of 05_2017, protocols are 12 points long, [6] is used for work.drk, [7,8] are for trimmig points, and [9,11] are currently unused
367//
368Function V_InitFakeProtocols()
369       
370        NewDataFolder/O root:Packages:NIST:VSANS:Globals:Protocols
371        Make/O/T $"root:Packages:NIST:VSANS:Globals:Protocols:Base"={"none","none","ask","ask","none","AVTYPE=Circular;SAVE=Yes;NAME=Auto;PLOT=Yes;BINTYPE=F4-M4-B;","DRK=none,DRKMODE=0,","","","","",""}
372        Make/O/T $"root:Packages:NIST:VSANS:Globals:Protocols:DoAll"={"ask","ask","ask","ask","ask","AVTYPE=Circular;SAVE=Yes;NAME=Auto;PLOT=Yes;BINTYPE=F4-M4-B;","DRK=none,DRKMODE=0,","","","","",""}
373        Make/O/T/N=(kNumProtocolSteps) $"root:Packages:NIST:VSANS:Globals:Protocols:CreateNew"                  //null wave
374        //Initialize waves to store values in
375       
376        String/G root:Packages:NIST:VSANS:Globals:Protocols:gProtoStr=""
377        String/G root:Packages:NIST:VSANS:Globals:Protocols:gNewStr=""
378        String/G root:Packages:NIST:VSANS:Globals:Protocols:gAvgInfoStr = "AVTYPE=Circular;SAVE=Yes;NAME=Auto;PLOT=Yes;BINTYPE=F4-M4-B;"
379       
380        String/G root:Packages:NIST:VSANS:Globals:Protocols:gBegPtsStr=""
381        String/G root:Packages:NIST:VSANS:Globals:Protocols:gEndPtsStr=""
382        String/G root:Packages:NIST:VSANS:Globals:Protocols:gAbsStr=""
383       
384        Return(0)
385End
386
387//simple function to resize the comand window to a nice size, no matter what the resolution
388//need to test out on several different monitors and both platforms
389//
390// could easily be incorporated into the initialization routines to ensure that the
391// command window is always visible at startup of the macros. No need for a hook function
392//
393Function V_ResizeCmdWindow()
394
395        String str=IgorInfo(0),rect="",platform=igorinfo(2)
396        Variable depth,left,top,right,bottom,factor
397       
398        if(cmpstr(platform,"Macintosh")==0)
399                factor=1
400        else
401                factor = 0.6            //fudge factor to get command window on-screen on Windows
402        endif
403        rect = StringByKey("SCREEN1", str  ,":",";")   
404        sscanf rect,"DEPTH=%d,RECT=%d,%d,%d,%d",depth, left,top,right,bottom
405        MoveWindow/C  (left+3)*factor,(bottom-150)*factor,(right-50)*factor,(bottom-10)*factor
406End
407
408// since the NCNR procedures can't be loaded concurrently with the other facility functions,
409// unload this procedure file, and add this to the functions that run at initialization of the
410// experiment
411//
412// TODO - be sure that this unloads correctly
413Function UnloadNCNR_VSANS_Procedures()
414
415#if (exists("NCNR_VSANS")==6)                   //defined in the main #includes file.
416        //do nothing if an NCNR reduction experiment
417#else
418        if(ItemsInList(WinList("NCNR_Package_Loader.ipf", ";","WIN:128")))
419                Execute/P "CloseProc /NAME=\"NCNR_Package_Loader.ipf\""
420                Execute/P "COMPILEPROCEDURES "
421        endif
422#endif
423
424End
425
426//returns 1 if demo version, 0 if full version
427Function V_IsDemo()
428
429        // create small offscreen graph
430        Display/W=(3000,3000,3010,3010)
431        DoWindow/C IsDemoGraph
432
433        // try to save a PICT or bitmap of it to the clipboard
434        SavePICT/Z  as "Clipboard"
435        Variable isDemo= V_Flag != 0    // if error: must be demo
436        DoWindow/K IsDemoGraph
437        return isDemo
438End
439
440// Clean out the RawVSANS folder before saving
441Function BeforeExperimentSaveHook(rN,fileName,path,type,creator,kind)
442        Variable rN,kind
443        String fileName,path,type,creator
444
445        // clean out, so that the file SAVE is not slow due to the large experiment size
446        // TODO -- decide if this is really necessary
447//     
448//      V_CleanOutRawVSANS()
449// present a progress window
450        V_CleanupData_w_Progress(0,1)
451        Printf "Hook cleaned out RawVSANS, experiment saved\r"
452
453
454// these KillDF are a bad idea - it wipes out all of the current work
455// whenever a save is done - which is the opposite of what you want
456// to happen when you save!
457
458//      KillDataFolder/Z root:Packages:NIST:VSANS:RAW
459//      KillDataFolder/Z root:Packages:NIST:VSANS:SAM
460//      KillDataFolder/Z root:Packages:NIST:VSANS:EMP
461//      KillDataFolder/Z root:Packages:NIST:VSANS:BGD
462//      KillDataFolder/Z root:Packages:NIST:VSANS:COR
463//      KillDataFolder/Z root:Packages:NIST:VSANS:DIV
464//      KillDataFolder/Z root:Packages:NIST:VSANS:MSK
465//      KillDataFolder/Z root:Packages:NIST:VSANS:ABS
466//      KillDataFolder/Z root:Packages:NIST:VSANS:CAL
467//      KillDataFolder/Z root:Packages:NIST:VSANS:STO
468//      KillDataFolder/Z root:Packages:NIST:VSANS:SUB
469//      KillDataFolder/Z root:Packages:NIST:VSANS:DRK
470//      KillDataFolder/Z root:Packages:NIST:VSANS:ADJ
471
472// re-create anthing that was killed
473        V_initFolders()
474
475End
Note: See TracBrowser for help on using the repository browser.