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

Last change on this file since 1022 was 1022, checked in by srkline, 6 years ago

ADDED:

included common NCNR procedures for the PlotManager?, to allow plotting of 1D data sets using a familiar interface

greatly expanded Patch functionality to include input in the multiple sections of the Nexus file, including separate panels to handle patching of waves to the file - needed for non-linear coefficients, dead time, and XY beam centers. All patch operations are expandable as more fields become necessary to patch.

removed bug of group_id being defined in /reduction and in /sample (removed R/W that referenced /reduction)

added panel to "isolate" a single detector panel, allowing the corrections to be applied/removed/recalculated as needed to directly see their effects.

linked new procedures to their appropriate action buttons

Added more data fields (label, intent, etc.) to the VCALC to Nexus data writer to get more realistic values into the fake data files for testing

Added VCALC simulation functions with EMP and BGD in anticipation of testing the CORRECT step

more little bug and documentation fixes which I can't remember, but they are all important...

File size: 12.0 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
31//
32/// Search for TODO to clean up the missing pieces
33//
34
35
36
37
38
39Proc Initialize_VSANS()
40        V_Initialize()
41End
42
43//this is the main initualization procedure that must be the first thing
44//done when opening a new Data reduction experiment
45//
46//sets up data folders, globals, protocols, and draws the main panel
47Proc V_Initialize()
48
49        Variable curVersion = 0.1
50        Variable oldVersion = NumVarOrDefault("root:VSANS_RED_VERSION",curVersion)
51               
52        if(oldVersion == curVersion)
53                //must just be a new startup with the current version
54                Variable/G root:VSANS_RED_VERSION=0.1
55        endif
56       
57        if(oldVersion < curVersion)
58                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"
59                DoAlert 0,str
60        endif
61       
62        V_InitFolders()
63        V_InitFakeProtocols()
64        V_InitGlobals()
65        V_InitFacilityGlobals()
66        DoWindow/F Main_VSANS_Panel
67        If(V_flag == 0)
68                //draw panel
69                Main_VSANS_Panel()
70        Endif
71//      ResizeCmdWindow()
72
73// TODO - be sure that NCNR is defined correctly       
74        //unload the NCNR_Package_Loader, if NCNR not defined
75        UnloadNCNR_VSANS_Procedures()
76
77End
78
79//creates all the necessary data folders in the root folder
80//does not overwrite any existing folders of the same name
81//it leaves data in them untouched
82//
83// TODO -- make sure that I have all of the folders that I need
84//
85Function V_InitFolders()
86       
87        NewDataFolder/O root:Packages
88        NewDataFolder/O root:Packages:NIST
89        NewDataFolder/O root:Packages:NIST:VSANS
90       
91// for the file catalog
92        NewDataFolder/O root:Packages:NIST:VSANS:CatVSHeaderInfo
93// for the globals
94        NewDataFolder/O root:Packages:NIST:VSANS:Globals
95// for the raw nexus data (so I don't need to reload to get a single value)
96        NewDataFolder/O root:Packages:NIST:VSANS:RawVSANS
97
98// folders for the reduction steps             
99        NewDataFolder/O root:Packages:NIST:VSANS:RAW
100        NewDataFolder/O root:Packages:NIST:VSANS:SAM
101        NewDataFolder/O root:Packages:NIST:VSANS:EMP
102        NewDataFolder/O root:Packages:NIST:VSANS:BGD
103        NewDataFolder/O root:Packages:NIST:VSANS:COR
104        NewDataFolder/O root:Packages:NIST:VSANS:DIV
105        NewDataFolder/O root:Packages:NIST:VSANS:MSK
106        NewDataFolder/O root:Packages:NIST:VSANS:ABS
107        NewDataFolder/O root:Packages:NIST:VSANS:CAL
108        NewDataFolder/O root:Packages:NIST:VSANS:STO
109        NewDataFolder/O root:Packages:NIST:VSANS:SUB
110        NewDataFolder/O root:Packages:NIST:VSANS:DRK
111        NewDataFolder/O root:Packages:NIST:VSANS:ADJ
112
113
114// ?? anything else
115
116// for simulation
117//      NewDataFolder/O root:Packages:NIST:VSANS:SAS
118
119
120       
121        Return(0)
122End
123
124
125
126
127//
128//Global folder already exists...
129//adds appropriate globals to the newly created myGlobals folder
130//return data folder to root: before leaving
131//
132//
133Function V_InitGlobals()
134       
135        Variable/G root:Packages:NIST:VSANS:Globals:gIsLogScale = 0
136        String/G root:Packages:NIST:VSANS:Globals:gCurDispType = "RAW"
137       
138        //check platform, so Angstrom can be drawn correctly
139
140        //TODO  - this is different on Igor 7. Macintosh # has been updated, but Windows has not
141        // use Print char2num("Å") to find the magic number
142        if(cmpstr("Macintosh",IgorInfo(2)) == 0)
143                String/G root:Packages:NIST:VSANS:Globals:gAngstStr = num2char(197)
144                String/G root:Packages:NIST:gAngstStr = num2char(197)
145                Variable/G root:Packages:NIST:VSANS:Globals:gIsMac = 1
146        else
147                //either Windows or Windows NT
148                String/G root:Packages:NIST:VSANS:Globals:gAngstStr = num2char(-59)
149                String/G root:Packages:NIST:gAngstStr = num2char(-59)
150                Variable/G root:Packages:NIST:VSANS:Globals:gIsMac = 0
151                //SetIgorOption to keep some PC's (graphics cards?) from smoothing the 2D image
152                Execute "SetIgorOption WinDraw,forceCOLORONCOLOR=1"
153        endif
154       
155        // TODO -- find the SANS preferences, copy over and update for VSANS
156        // -- these are all in PlotUtilsMacro_v40.ipf as the preferences are set up as common
157        // to all packages. I'm not sure that I want to do this with VSANS, but make the packages
158        // separate entities. I'm seeing little benefit of the crossover, especially now that
159        // Analysis is not mine. So for VSANS, there is a new, separate file: V_VSANS_Preferences.ipf
160
161        //this is critical to initialize now - as it has the y/n flags for the detector correction steps
162        Execute "Initialize_VSANSPreferences()"
163
164       
165        // lookup waves for log and linear display of images
166        // this is used for the main data display. With this, I can use the original
167        // detector data (no copy) and the zeros in the data set are tolerated when displaying
168        // on log scale
169        SetDataFolder root:Packages:NIST:VSANS:Globals
170        Variable num,val,offset
171        num=10000
172        offset = 1/num
173       
174        Make/O/D/N=(num) logLookupWave,linearLookupWave
175        linearLookupWave = (p+1)/num
176       
177        logLookupWave = log(linearLookupWave)
178        val = logLookupWave[0]
179        logLookupWave += -val + offset
180        val = logLookupWave[num-1]
181        logLookupWave /= val
182       
183        SetDataFolder root:
184
185
186        //set flag if Demo Version is detected
187        Variable/G root:Packages:NIST:VSANS:Globals:isDemoVersion = V_isDemo()
188       
189        //set XML globals
190//      String/G root:Packages:NIST:gXMLLoader_Title = ""
191       
192        Return(0)
193End
194
195
196//
197// initializes globals that are specific to VSANS
198//
199// there really should be nothing here... all of this should now be in the Nexus data file
200// and not tethered to hard-wired constants.
201//
202// -- what was here was:
203// number of detector pixels
204// pixel size
205// deadtime
206// beamstop "tolerance" to identify Trans files
207// sample aperture offset
208//
209Function V_InitFacilityGlobals()
210
211//      //Detector -specific globals
212//      Variable/G root:myGlobals:gNPixelsX=128
213//      Variable/G root:myGlobals:gNPixelsY=128
214//     
215//      // as of Jan2008, detector pixel sizes are read directly from the file header, so they MUST
216//      // be set correctly in instr.cfg - these values are not used, but declared to avoid errors
217//      Variable/G root:myGlobals:PixelResNG3_ILL = 1.0         //pixel resolution in cm
218//      Variable/G root:myGlobals:PixelResNG5_ILL = 1.0
219//      Variable/G root:myGlobals:PixelResNG7_ILL = 1.0
220//      Variable/G root:myGlobals:PixelResNG3_ORNL = 0.5
221//      Variable/G root:myGlobals:PixelResNG5_ORNL = 0.5
222//      Variable/G root:myGlobals:PixelResNG7_ORNL = 0.5
223//      Variable/G root:myGlobals:PixelResNGB_ORNL = 0.5
224////    Variable/G root:myGlobals:PixelResCGB_ORNL = 0.5                // fiction
225//
226//      Variable/G root:myGlobals:PixelResDefault = 0.5
227//     
228//      Variable/G root:myGlobals:DeadtimeNG3_ILL = 3.0e-6              //deadtime in seconds
229//      Variable/G root:myGlobals:DeadtimeNG5_ILL = 3.0e-6
230//      Variable/G root:myGlobals:DeadtimeNG7_ILL = 3.0e-6
231//      Variable/G root:myGlobals:DeadtimeNGB_ILL = 4.0e-6              // fictional
232//      Variable/G root:myGlobals:DeadtimeNG3_ORNL_VAX = 3.4e-6         //pre - 23-JUL-2009 used VAX
233//      Variable/G root:myGlobals:DeadtimeNG3_ORNL_ICE = 1.5e-6         //post - 23-JUL-2009 used ICE
234//      Variable/G root:myGlobals:DeadtimeNG5_ORNL = 0.6e-6                     //as of 9 MAY 2002
235//      Variable/G root:myGlobals:DeadtimeNG7_ORNL_VAX = 3.4e-6         //pre 25-FEB-2010 used VAX
236//      Variable/G root:myGlobals:DeadtimeNG7_ORNL_ICE = 2.3e-6         //post 25-FEB-2010 used ICE
237//      Variable/G root:myGlobals:DeadtimeNGB_ORNL_ICE = 4.0e-6         //per JGB 16-JAN-2013, best value we have for the oscillating data
238//
239////    Variable/G root:myGlobals:DeadtimeCGB_ORNL_ICE = 1.5e-6         // fiction
240//
241//      Variable/G root:myGlobals:DeadtimeDefault = 3.4e-6
242//
243//      //new 11APR07
244//      Variable/G root:myGlobals:BeamstopXTol = -8                     // (cm) is BS Xpos is -5 cm or less, it's a trans measurement
245//      // sample aperture offset is NOT stored in the VAX header, but it should be
246//      // - when it is, remove the global and write an accessor AND make a place for
247//      // it in the RealsRead
248//      Variable/G root:myGlobals:apOff = 5.0                           // (cm) distance from sample aperture to sample position
249
250End
251
252///////////////////////////////////////////////
253//
254////////////// everything below needs to be re-written for VSANS
255//
256//////////////////////////////////////////////
257
258
259// TODO
260// do I need to make the protocols any longer for VSANS?
261// What other options for processing / averaging / saving are needed??
262// - TODO
263// -- likely that I'll want to have #pts to cut from I(q) as input to NSORT within the protocol so that the
264// entire reduction can be automatic
265//
266//
267// -- creates the "base" protocols that should be available, after creating the data folder
268// -- all protocols are kept in the root:Packages:NIST:VSANS:Globals:Protocols folder, created here
269//
270Function V_InitFakeProtocols()
271       
272        //*****as of 0901, protocols are 8 points long, [6] is used for work.drk, [7] is unused
273        NewDataFolder/O root:Packages:NIST:VSANS:Globals:Protocols
274        Make/O/T $"root:Packages:NIST:VSANS:Globals:Protocols:Base"={"none","none","ask","ask","none","AVTYPE=Circular;SAVE=Yes;NAME=Manual;PLOT=Yes","DRK=none,DRKMODE=0,",""}
275        Make/O/T $"root:Packages:NIST:VSANS:Globals:Protocols:DoAll"={"ask","ask","ask","ask","ask","AVTYPE=Circular;SAVE=Yes;NAME=Manual;PLOT=Yes","DRK=none,DRKMODE=0,",""}
276        Make/O/T/N=8 $"root:Packages:NIST:VSANS:Globals:Protocols:CreateNew"                    //null wave
277        //Initialize waves to store values in
278       
279        String/G root:Packages:NIST:VSANS:Globals:Protocols:gProtoStr=""
280        String/G root:Packages:NIST:VSANS:Globals:Protocols:gNewStr=""
281        String/G root:Packages:NIST:VSANS:Globals:Protocols:gAvgInfoStr = "AVTYPE=Circular;SAVE=Yes;NAME=Auto;PLOT=Yes;"
282       
283        Return(0)
284End
285
286//simple function to resize the comand window to a nice size, no matter what the resolution
287//need to test out on several different monitors and both platforms
288//
289// could easily be incorporated into the initialization routines to ensure that the
290// command window is always visible at startup of the macros. No need for a hook function
291//
292Function ResizeCmdWindow()
293
294        String str=IgorInfo(0),rect="",platform=igorinfo(2)
295        Variable depth,left,top,right,bottom,factor
296       
297        if(cmpstr(platform,"Macintosh")==0)
298                factor=1
299        else
300                factor = 0.6            //fudge factor to get command window on-screen on Windows
301        endif
302        rect = StringByKey("SCREEN1", str  ,":",";")   
303        sscanf rect,"DEPTH=%d,RECT=%d,%d,%d,%d",depth, left,top,right,bottom
304        MoveWindow/C  (left+3)*factor,(bottom-150)*factor,(right-50)*factor,(bottom-10)*factor
305End
306
307// since the NCNR procedures can't be loaded concurrently with the other facility functions,
308// unload this procedure file, and add this to the functions that run at initialization of the
309// experiment
310//
311// TODO - be sure that this unloads correctly
312Function UnloadNCNR_VSANS_Procedures()
313
314#if (exists("NCNR_VSANS")==6)                   //defined in the main #includes file.
315        //do nothing if an NCNR reduction experiment
316#else
317        if(ItemsInList(WinList("NCNR_Package_Loader.ipf", ";","WIN:128")))
318                Execute/P "CloseProc /NAME=\"NCNR_Package_Loader.ipf\""
319                Execute/P "COMPILEPROCEDURES "
320        endif
321#endif
322
323End
324
325//returns 1 if demo version, 0 if full version
326Function V_IsDemo()
327
328        // create small offscreen graph
329        Display/W=(3000,3000,3010,3010)
330        DoWindow/C IsDemoGraph
331
332        // try to save a PICT or bitmap of it to the clipboard
333        SavePICT/Z  as "Clipboard"
334        Variable isDemo= V_Flag != 0    // if error: must be demo
335        DoWindow/K IsDemoGraph
336        return isDemo
337End
338
339// Clean out the RawVSANS folder before saving
340Function BeforeExperimentSaveHook(rN,fileName,path,type,creator,kind)
341        Variable rN,kind
342        String fileName,path,type,creator
343
344        // clean out, so that the file SAVE is not slow due to the large experiment size
345        // TODO -- decide if this is really necessary
346//     
347//      V_CleanOutRawVSANS()
348// present a progress window
349        V_CleanupData_w_Progress(0,1)
350        Printf "Hook cleaned out RawVSANS, experiment saved\r"
351
352End
Note: See TracBrowser for help on using the repository browser.