source: sans/Dev/trunk/NCNR_User_Procedures/Reduction/VSANS/V_VSANS_Preferences.ipf @ 979

Last change on this file since 979 was 979, checked in by srkline, 7 years ago

more additions to start the work file flow of converting RAW folder to a WORK folder. Raw_to_Work will be the function that sequentially applies the corrections. All corrections can be turned on/off with preferences.

File size: 11.9 KB
Line 
1#pragma rtGlobals=3             // Use modern global access method and strict wave access.
2
3
4/// TODO
5// -- update all to be only VSANS-specific
6// -- update all of the function names to be unique to VSANS so that there are no
7//    name clashes with the "duplicate" version that is in PlotUtils.ipf
8//
9// -- Make this a VSANS-only panel
10// -- eliminate the USANS tab
11// -- be sure the general tab is either unique, or eliminate it
12// -- be sure the Analysis tab is unique, or eliminate it
13//
14//
15// global variables used by VSANS are stored in:
16// root:Packages:NIST:VSANS:Globals
17//
18
19
20///////////////////////////
21Proc Show_VSANSPreferences_Panel()
22
23        DoWindow/F VSANSPref_Panel
24        if(V_flag==0)
25                // only re-initialize if the variables don't exist, so you don't overwrite what users have changed
26                if( exists("root:Packages:NIST:VSANS:Globals:gLogScalingAsDefault") != 2 )              //if the global variable does not exist, initialize
27                        Initialize_VSANSPreferences()
28                endif
29                VSANSPref_Panel()
30        Endif
31//      Print "Preferences Panel stub"
32End
33
34
35// TODO -- there are more detector specific corrections here that need to be added
36//
37// create the globals here if they are not already present
38// each package initialization should call this to repeat the initialization
39// without overwriting what was already set
40Proc Initialize_VSANSPreferences()
41       
42        Variable val
43
44        // GENERAL tab
45        /// General items for everyone
46        val = NumVarOrDefault("root:Packages:NIST:VSANS:Globals:gXML_Write", 0 )
47        Variable/G root:Packages:NIST:VSANS:Globals:gXML_Write = val
48       
49       
50        // VSANS tab
51        ///// items for VSANS reduction
52        val = NumVarOrDefault("root:Packages:NIST:VSANS:Globals:gLogScalingAsDefault", 1 )
53        Variable/G root:Packages:NIST:VSANS:Globals:gLogScalingAsDefault=val
54       
55//      val = NumVarOrDefault("root:Packages:NIST:VSANS:Globals:gAllowDRK", 0 )
56//      Variable/G root:Packages:NIST:VSANS:Globals:gAllowDRK=val                       //don't show DRK as default
57       
58        val = NumVarOrDefault("root:Packages:NIST:VSANS:Globals:gDoTransCheck", 1 )
59        Variable/G root:Packages:NIST:VSANS:Globals:gDoTransCheck=val
60       
61        val = NumVarOrDefault("root:Packages:NIST:VSANS:Globals:gBinWidth", 1 )
62        Variable/G root:Packages:NIST:VSANS:Globals:gBinWidth=val
63       
64        val = NumVarOrDefault("root:Packages:NIST:VSANS:Globals:gNPhiSteps", 72 )
65        Variable/G root:Packages:NIST:VSANS:Globals:gNPhiSteps=val
66       
67        // flags to turn detector corrections on/off for testing (you should leave these ON)
68        val = NumVarOrDefault("root:Packages:NIST:VSANS:Globals:gDoDetectorEffCor", 1 )
69        Variable/G root:Packages:NIST:VSANS:Globals:gDoDetectorEffCor = 1
70       
71        val = NumVarOrDefault("root:Packages:NIST:VSANS:Globals:gDoTransmissionCor", 1 )
72        Variable/G root:Packages:NIST:VSANS:Globals:gDoTransmissionCor = 1
73
74        val = NumVarOrDefault("root:Packages:NIST:VSANS:Globals:gDoDIVCor", 1 )
75        Variable/G root:Packages:NIST:VSANS:Globals:gDoDIVCor = 1
76       
77        val = NumVarOrDefault("root:Packages:NIST:VSANS:Globals:gDoDeadTimeCor", 1 )
78        Variable/G root:Packages:NIST:VSANS:Globals:gDoDeadTimeCor = 1
79
80        val = NumVarOrDefault("root:Packages:NIST:VSANS:Globals:gDoSolidAngleCor", 1 )
81        Variable/G root:Packages:NIST:VSANS:Globals:gDoSolidAngleCor = 1
82
83        val = NumVarOrDefault("root:Packages:NIST:VSANS:Globals:gDoNonLinearCor", 1 )
84        Variable/G root:Packages:NIST:VSANS:Globals:gDoNonLinearCor = 1
85
86        val = NumVarOrDefault("root:Packages:NIST:VSANS:Globals:gDoTubeShadowCor", 1 )
87        Variable/G root:Packages:NIST:VSANS:Globals:gDoTubeShadowCor = 1
88       
89
90
91// flag to allow adding raw data files with different attenuation (normally not done)   
92//      val = NumVarOrDefault("root:Packages:NIST:VSANS:Globals:gDoAdjustRAW_Atten",0)
93//      Variable/G root:Packages:NIST:VSANS:Globals:gDoAdjustRAW_Atten=val
94       
95       
96        // VSANS ANALYSIS tab
97        /// items for VSANS Analysis
98       
99       
100end
101
102Function V_LogScalePrefCheck(ctrlName,checked) : CheckBoxControl
103        String ctrlName
104        Variable checked
105       
106        NVAR gLog = root:Packages:NIST:VSANS:Globals:gLogScalingAsDefault
107        glog=checked
108        //print "log pref checked = ",checked
109End
110
111//Function DRKProtocolPref(ctrlName,checked) : CheckBoxControl
112//      String ctrlName
113//      Variable checked
114//     
115//      NVAR gDRK = root:Packages:NIST:VSANS:Globals:gAllowDRK
116//      gDRK = checked
117//      //Print "DRK preference = ",checked
118//End
119
120Function V_UnityTransPref(ctrlName,checked) : CheckBoxControl
121        String ctrlName
122        Variable checked
123       
124        NVAR gVal = root:Packages:NIST:VSANS:Globals:gDoTransCheck
125        gVal = checked
126End
127
128Function V_XMLWritePref(ctrlName,checked) : CheckBoxControl
129        String ctrlName
130        Variable checked
131       
132        NVAR gVal = root:Packages:NIST:VSANS:Globals:gXML_Write
133        gVal = checked
134End
135
136Function V_DoTransCorrPref(ctrlName,checked) : CheckBoxControl
137        String ctrlName
138        Variable checked
139       
140        NVAR gVal = root:Packages:NIST:VSANS:Globals:gDoTransmissionCorr
141        gVal = checked
142End
143
144Function V_DoEfficiencyCorrPref(ctrlName,checked) : CheckBoxControl
145        String ctrlName
146        Variable checked
147       
148        NVAR gVal = root:Packages:NIST:VSANS:Globals:gDoDetectorEffCorr
149        gVal = checked
150End
151
152Function V_DoRawAttenAdjPref(ctrlName,checked) : CheckBoxControl
153        String ctrlName
154        Variable checked
155       
156        NVAR gVal = root:Packages:NIST:VSANS:Globals:gDoAdjustRAW_Atten
157        gVal = checked
158End
159
160Function V_DoDIVCorPref(ctrlName,checked) : CheckBoxControl
161        String ctrlName
162        Variable checked
163       
164        NVAR gVal = root:Packages:NIST:VSANS:Globals:gDoDIVCor
165        gVal = checked
166End
167
168Function V_DoDeadTimeCorPref(ctrlName,checked) : CheckBoxControl
169        String ctrlName
170        Variable checked
171       
172        NVAR gVal = root:Packages:NIST:VSANS:Globals:gDoDeadTimeCor
173        gVal = checked
174End
175
176Function V_DoSolidAngleCorPref(ctrlName,checked) : CheckBoxControl
177        String ctrlName
178        Variable checked
179       
180        NVAR gVal = root:Packages:NIST:VSANS:Globals:gDoSolidAngleCor
181        gVal = checked
182End
183
184Function V_DoNonLinearCorPref(ctrlName,checked) : CheckBoxControl
185        String ctrlName
186        Variable checked
187       
188        NVAR gVal = root:Packages:NIST:VSANS:Globals:gDoNonLinearCor
189        gVal = checked
190End
191
192Function V_DoTubeShadowCorPref(ctrlName,checked) : CheckBoxControl
193        String ctrlName
194        Variable checked
195       
196        NVAR gVal = root:Packages:NIST:VSANS:Globals:gDoTubeShadowCor
197        gVal = checked
198End
199
200Function V_PrefDoneButtonProc(ctrlName) : ButtonControl
201        String ctrlName
202       
203        DoWindow/K VSANSPref_Panel
204End
205
206
207Proc VSANSPref_Panel()
208        PauseUpdate; Silent 1           // building window...
209        NewPanel /W=(646,208,1070,468)/K=2 as "VSANS Preference Panel"
210        DoWindow/C VSANSPref_Panel
211        ModifyPanel cbRGB=(47748,57192,54093)
212        SetDrawLayer UserBack
213        ModifyPanel fixedSize=1
214//////
215//on main portion of panel, always visible
216        Button PrefPanelButtonA,pos={354,12},size={50,20},proc=V_PrefDoneButtonProc,title="Done"
217
218        TabControl PrefTab,pos={7,49},size={410,202},tabLabel(0)="General",proc=V_PrefTabProc
219        TabControl PrefTab,tabLabel(1)="VSANS",tabLabel(2)="Analysis"
220        TabControl PrefTab,value=1
221        TabControl PrefTab labelBack=(47748,57192,54093)
222       
223//on tab(0) - General
224        CheckBox PrefCtrl_0a,pos={21,96},size={124,14},proc=V_XMLWritePref,title="Use canSAS XML Output"
225        CheckBox PrefCtrl_0a,help={"Checking this will set the default output format to be canSAS XML rather than NIST 6 column"}
226        CheckBox PrefCtrl_0a,value= root:Packages:NIST:VSANS:Globals:gXML_Write
227
228        CheckBox PrefCtrl_0a,disable=1
229
230
231//on tab(1) - VSANS - initially visible
232        CheckBox PrefCtrl_1a,pos={21,100},size={171,14},proc=V_LogScalePrefCheck,title="Use Log scaling for 2D data display"
233        CheckBox PrefCtrl_1a,help={"Checking this will display 2D VSANS data with a logarithmic color scale of neutron counts. If not checked, the color mapping will be linear."}
234        CheckBox PrefCtrl_1a,value= root:Packages:NIST:VSANS:Globals:gLogScalingAsDefault
235//      CheckBox PrefCtrl_1b,pos={21,120},size={163,14},proc=V_DRKProtocolPref,title="Allow DRK correction in protocols"
236//      CheckBox PrefCtrl_1b,help={"Checking this will allow DRK correction to be used in reduction protocols. You will need to re-draw the protocol panel for this change to be visible."}
237//      CheckBox PrefCtrl_1b,value= root:Packages:NIST:VSANS:Globals:gAllowDRK
238        CheckBox PrefCtrl_1c,pos={21,140},size={137,14},proc=V_UnityTransPref,title="Check for Transmission = 1"
239        CheckBox PrefCtrl_1c,help={"Checking this will check for SAM or EMP Trans = 1 during data correction"}
240        CheckBox PrefCtrl_1c,value= root:Packages:NIST:VSANS:Globals:gDoTransCheck
241        SetVariable PrefCtrl_1d,pos={21,170},size={200,15},title="Averaging Bin Width (pixels)"
242        SetVariable PrefCtrl_1d,limits={1,100,1},value= root:Packages:NIST:VSANS:Globals:gBinWidth
243        SetVariable PrefCtrl_1e,pos={21,195},size={200,15},title="# Phi Steps (annular avg)"
244        SetVariable PrefCtrl_1e,limits={1,360,1},value= root:Packages:NIST:VSANS:Globals:gNPhiSteps
245        CheckBox PrefCtrl_1f title="Do Transmssion Correction?",size={140,14},value=root:Packages:NIST:VSANS:Globals:gDoTransmissionCor,proc=V_DoTransCorrPref
246        CheckBox PrefCtrl_1f pos={255,100},help={"TURN OFF ONLY FOR DEBUGGING. This corrects the data for angle dependent transmssion."}
247        CheckBox PrefCtrl_1g title="Do Efficiency Correction?",size={140,14},proc=V_DoEfficiencyCorrPref
248        CheckBox PrefCtrl_1g value=root:Packages:NIST:VSANS:Globals:gDoDetectorEffCor,pos={255,120},help={"TURN OFF ONLY FOR DEBUGGING. This corrects the data for angle dependent detector efficiency."}
249//      CheckBox PrefCtrl_1h title="Adjust RAW attenuation?",size={140,14},proc=V_DoRawAttenAdjPref
250//      CheckBox PrefCtrl_1h value=root:Packages:NIST:VSANS:Globals:gDoAdjustRAW_Atten,pos={255,140},help={"This is normally not done"}
251
252        CheckBox PrefCtrl_1i title="Do DIV Correction?",size={140,14},proc=V_DoDIVCorPref
253        CheckBox PrefCtrl_1i value=root:Packages:NIST:VSANS:Globals:gDoDIVCor,pos={255,140},help={"TURN OFF ONLY FOR DEBUGGING."}
254        CheckBox PrefCtrl_1j title="Do DeadTime Correction?",size={140,14},proc=V_DoDeadTimeCorPref
255        CheckBox PrefCtrl_1j value=root:Packages:NIST:VSANS:Globals:gDoDeadTimeCor,pos={255,160},help={"TURN OFF ONLY FOR DEBUGGING."} 
256        CheckBox PrefCtrl_1k title="Do Solid Angle Correction?",size={140,14},proc=V_DoSolidAngleCorPref
257        CheckBox PrefCtrl_1k value=root:Packages:NIST:VSANS:Globals:gDoSolidAngleCor,pos={255,180},help={"TURN OFF ONLY FOR DEBUGGING."}
258        CheckBox PrefCtrl_1l title="Do Non-linear Correction?",size={140,14},proc=V_DoNonLinearCorPref
259        CheckBox PrefCtrl_1l value=root:Packages:NIST:VSANS:Globals:gDoNonLinearCor,pos={255,200},help={"TURN OFF ONLY FOR DEBUGGING."}
260        CheckBox PrefCtrl_1m title="Do Tube Shadow Correction?",size={140,14},proc=V_DoTubeShadowCorPref
261        CheckBox PrefCtrl_1m value=root:Packages:NIST:VSANS:Globals:gDoTubeShadowCor,pos={255,220},help={"TURN OFF ONLY FOR DEBUGGING."}
262       
263//      CheckBox PrefCtrl_1a,disable=1
264//      CheckBox PrefCtrl_1b,disable=1
265//      CheckBox PrefCtrl_1c,disable=1
266//      SetVariable PrefCtrl_1d,disable=1
267//      SetVariable PrefCtrl_1e,disable=1
268//      CheckBox PrefCtrl_1f,disable=1
269//      CheckBox PrefCtrl_1g,disable=1
270//      CheckBox PrefCtrl_1h,disable=1
271
272//on tab(2) - Analysis
273        GroupBox PrefCtrl_2a pos={21,100},size={1,1},title="nothing to set",fSize=12
274       
275        GroupBox PrefCtrl_2a,disable=1
276
277End
278
279// function to control the drawing of controls in the TabControl on the main panel
280// Naming scheme for the controls MUST be strictly adhered to... else controls will
281// appear in odd places...
282// all controls are named PrefCtrl_NA where N is the tab number and A is the letter denoting
283// the controls position on that particular tab.
284// in this way, they will always be drawn correctly..
285//
286Function V_PrefTabProc(name,tab)
287        String name
288        Variable tab
289       
290//      Print "name,number",name,tab
291        String ctrlList = ControlNameList("",";"),item="",nameStr=""
292        Variable num = ItemsinList(ctrlList,";"),ii,onTab
293        for(ii=0;ii<num;ii+=1)
294                //items all start w/"PrefCtrl_", 9 characters
295                item=StringFromList(ii, ctrlList ,";")
296                nameStr=item[0,8]
297                if(cmpstr(nameStr,"PrefCtrl_")==0)
298                        onTab = str2num(item[9])                        //[9] is a number
299                        ControlInfo $item
300                        switch(abs(V_flag))     
301                                case 1:
302                                        Button $item,disable=(tab!=onTab)
303                                        break
304                                case 2:
305                                        CheckBox $item,disable=(tab!=onTab)
306                                        break
307                                case 5:
308                                        SetVariable $item,disable=(tab!=onTab)
309                                        break
310                                case 10:       
311                                        TitleBox $item,disable=(tab!=onTab)
312                                        break
313                                case 4:
314                                        ValDisplay $item,disable=(tab!=onTab)
315                                        break
316                                case 9:
317                                        GroupBox $item,disable=(tab!=onTab)
318                                        break
319                                // add more items to the switch if different control types are used
320                        endswitch
321                endif
322        endfor
323        return(0)
324End
Note: See TracBrowser for help on using the repository browser.