source: sans/Analysis/branches/ajj_23APR07/IGOR_Package_Files/Put in User Procedures/SANS_Models_v3.00/NewModels_2006/LamellarPS_HG.ipf @ 166

Last change on this file since 166 was 166, checked in by srkline, 15 years ago

Modified all procedure files to add to the keyword=value strings to identify the function, coefficients, and suffix once the model is plotted (and the objects will exist)

a one-liner in the Plot and PlotSmeared? macros.

  • necessary for smoother functioning of the wrapper panel.
File size: 8.2 KB
Line 
1#pragma rtGlobals=1             // Use modern global access method.
2#pragma IgorVersion = 6.0
3
4////////////////////////////////////////////////////
5//
6// model function that calculates the scattering from
7// lamellar surfactant structures. contrast includes the
8// bilayer core, headgroups, and solvent. Integer numbers of
9// repeating bilayers (at a repeat spacing) leads to the
10// familiar lamellar peaks. Bending constant information
11// can be extracted from the Caille parameter with moderate
12// success. A number of the parameters should be held
13// fixed during the fitting procedure, as they should be well
14// known:
15//              repeat spacing D = 2*pi/Qo
16//              contrast = calculated value
17//              polydispersity should be close to 0.1-0.3
18//   Caille parameter <0.8 or 1.0
19//
20// NOTES for Curve Fitting:
21// the epsilon wave "epsilon_LamellarPS_HG" should be used to force a
22// larger derivative step for the # of repeat units, which is an integer.
23// a singular matix error will always result if you don't follow this.
24// Also, the # of repeats should be constrained to ~3<N<200, otherwise
25// the optimization can pick a VERY large N, and waste lots of time
26// in the summation loop
27//
28// instrumental resolution is taken into account in the REGULAR
29// model calculation. resolution of ONLY the S(Q) peaks are
30// included. performing the typical smearing calculation would
31// be "double smearing", so is not done.
32//
33// the delta Q parameter "gDelQ" or "dQ" is taken from the q-dependent
34// instrument resolution "abssq" column as this is the identical definition
35// as in the original reference. If the real resolution function cannot be
36// found, a default value, typical of a "medium" q-range on the NG3 SANS is
37// used, although the real values are highly preferred
38//
39// REFERENCE:   Nallet, Laversanne, and Roux, J. Phys. II France, 3, (1993) 487-502.
40//              also in J. Phys. Chem. B, 105, (2001) 11081-11088.
41//
42// 14 JULY 2003 SRK
43//
44////////////////////////////////////////////////////
45
46//this macro sets up all the necessary parameters and waves that are
47//needed to calculate the model function.
48//
49Proc PlotLamellarPS_HG(num,qmin,qmax)
50        Variable num=128, qmin=.001, qmax=.5
51        Prompt num "Enter number of data points for model: "
52        Prompt qmin "Enter minimum q-value (^1) for model: "
53        Prompt qmax "Enter maximum q-value (^1) for model: "
54//
55        // constants
56        Variable/G root:gEuler = 0.5772156649           // Euler's constant
57        Variable/G root:gDelQ = 0.0025          //[=] 1/A, q-resolution, default value
58       
59        Make/O/D/n=(num) xwave_LamellarPS_HG, ywave_LamellarPS_HG
60        xwave_LamellarPS_HG =  alog(log(qmin) + x*((log(qmax)-log(qmin))/num))
61        Make/O/D coef_LamellarPS_HG = {1,40,10,2,0.4e-6,2e-6,6e-6,30,0.001,0.001}                       //CH#2
62        make/o/t parameters_LamellarPS_HG = {"Scale","Lamellar spacing, D (A)","Tail Thick (delT) (A)","HG Thick (delH) (A)","SLD of tails (A^-2)","SLD of HG (A^-2)","SLD of solvent (A^-2)","# of Lamellar plates","Caille parameter","Incoherent Bgd (cm-1)"}        //CH#3
63        Edit parameters_LamellarPS_HG, coef_LamellarPS_HG
64        ModifyTable width(parameters_LamellarPS_HG)=160
65       
66        Variable/G root:g_LamellarPS_HG
67        g_LamellarPS_HG := LamellarPS_HG(coef_LamellarPS_HG, ywave_LamellarPS_HG,xwave_LamellarPS_HG)
68        Display ywave_LamellarPS_HG vs xwave_LamellarPS_HG
69        ModifyGraph marker=29, msize=2, mode=4
70        ModifyGraph log=1
71        Label bottom "q (\\S-1\\M) "
72        Label left "I(q) (cm\\S-1\\M)"
73        //
74        // make epsilon wave appropriate for integer number of lamellar repeats
75        Duplicate/O coef_LamellarPS_HG epsilon_LamellarPS_HG
76        epsilon_LamellarPS_HG = 1e-4
77        epsilon_LamellarPS_HG[7] = 1            //to make the derivative useful
78        AutoPositionWindow/M=1/R=$(WinName(0,1)) $WinName(0,2)
79       
80        AddModelToStrings("LamellarPS_HG","coef_LamellarPS_HG","LamellarPS_HG")
81End
82
83// - sets up a dependency to a wrapper, not the actual SmearedModelFunction
84//Proc PlotSmeared_LamellarPS_HG(str)                                                           
85//      String str
86//      Prompt str,"Pick the data folder containing the resolution you want",popup,getAList(4)
87//     
88//      // if any of the resolution waves are missing => abort
89//      if(ResolutionWavesMissingDF(str))               //updated to NOT use global strings (in GaussUtils)
90//              Abort
91//      endif
92//     
93//      SetDataFolder $("root:"+str)
94//     
95//      // constants
96//      Variable/G root:gEuler = 0.5772156649           // Euler's constant
97//      Variable/G root:gDelQ = 0.0025          //[=] 1/A, q-resolution, default value
98//      // Setup parameter table for model function
99//      Make/O/D smear_coef_LamellarPS_HG = {1,40,10,2,0.4e-6,2e-6,6e-6,30,0.001,0.001}         //CH#4
100//      make/o/t smear_parameters_LamellarPS_HG = {"Scale","Lamellar spacing, D (A)","Bilayer Thick (delta) (A)","polydisp of Bilayer Thickness","contrast (A^-2)","# of Lamellar plates","Caille parameter","Incoherent Bgd (cm-1)"}
101//      Edit smear_parameters_LamellarPS_HG,smear_coef_LamellarPS_HG                                    //display parameters in a table
102//     
103//      // output smeared intensity wave, dimensions are identical to experimental QSIG values
104//      // make extra copy of experimental q-values for easy plotting
105//      Duplicate/O $(str+"_q") smeared_LamellarPS_HG,smeared_qvals                             //
106//      SetScale d,0,0,"1/cm",smeared_LamellarPS_HG                                                     //
107//                                     
108//      Variable/G gs_LamellarPS_HG     =0
109//      gs_LamellarPS_HG         := fLamellarPS_HG_Smeared(smear_coef_LamellarPS_HG     ,smeared_LamellarPS_HG  ,smeared_qvals) //this wrapper fills the STRUCT
110//     
111//      Display smeared_LamellarPS_HG vs smeared_qvals                                                          //
112//      ModifyGraph log=1,marker=29,msize=2,mode=4
113//      Label bottom "q (\\S-1\\M)"
114//      Label left "I(q) (cm\\S-1\\M)"
115//     
116//      SetDataFolder root:
117//End
118       
119
120
121//AAO version, uses XOP if available
122// simply calls the original single point calculation with
123// a wave assignment (this will behave nicely if given point ranges)
124Function LamellarPS_HG(cw,yw,xw) : FitFunc
125        Wave cw,yw,xw
126       
127#if exists("LamellarPS_HGX")
128        yw = LamellarPS_HGX(cw,xw)
129#else
130        yw = fLamellarPS_HG(cw,xw)
131#endif
132        return(0)
133End
134
135//
136Function fLamellarPS_HG(w,x) : FitFunc
137        Wave w
138        Variable x
139//       Input (fitting) variables are:
140//[0]Scale
141//[1]repeat spacing, D
142//[2]Tail Thickness (delT)
143//[3]HG thickness (delH)
144//[4]SLD tails
145//[5]SLD HG
146//[6]SLD solvent
147//[7]# of Lam plates
148//[8]Caille parameter
149//[9]Incoherent Bgd (cm-1)
150       
151//      give them nice names
152        Variable scale,dd,delT,delH,SLD_T,SLD_H,SLD_S,NN,Cp,bkg
153        scale = w[0]
154        dd = w[1]
155        delT = w[2]
156        delH = w[3]
157        SLD_T = w[4]
158        SLD_H = w[5]
159        SLD_S = w[6]
160        NN = trunc(w[7])                //be sure that NN is an integer
161        Cp = w[8]
162        bkg = w[9]
163       
164//      local variables
165        Variable inten, qval,Pq,Sq,ii,alpha,temp,t1,t2,t3,dQ,drh,drt
166       
167        NVAR Euler = root:gEuler
168        NVAR dQDefault = root:gDelQ
169        //      x is the q-value for the calculation
170        qval = x
171        //get the instrument resolution
172        SVAR/Z sigQ = gSig_Q
173        SVAR/Z qStr = gQVals
174       
175        if(SVAR_Exists(sigQ) && SVAR_Exists(qStr))
176                Wave/Z sigWave=$sigQ
177                Wave/Z sig_Qwave = $qStr
178                if(waveexists(sigWave)&&waveexists(sig_qwave))
179                        dQ = interp(qval, sig_Qwave, sigWave )
180                else
181                        if(qval>0.01 && qval<0.012)
182                                print "using default resolution"
183                        endif
184                        dQ = dQDefault
185                endif
186        else
187                dQ = dQDefault
188        endif
189       
190        drh = SLD_H - SLD_S
191//      drt = SLD_T - SLD_H             //original
192        drt = SLD_T - SLD_S             //matches Lionel's changes in the Lamellar_HG model
193       
194        Pq = drh*(sin(qval*(delH+delT))-sin(qval*delT)) + drt*sin(qval*delT)
195        Pq *= Pq
196        Pq *= 4/(qval^2)
197       
198        ii=0
199        Sq = 0
200        for(ii=1;ii<(NN-1);ii+=1)
201                temp = 0
202                alpha = Cp/4/pi/pi*(ln(pi*ii) + Euler)
203                t1 = 2*dQ*dQ*dd*dd*alpha
204                t2 = 2*qval*qval*dd*dd*alpha
205                t3 = dQ*dQ*dd*dd*ii*ii
206               
207                temp = 1-ii/NN
208                temp *= cos(dd*qval*ii/(1+t1))
209                temp *= exp(-1*(t2 + t3)/(2*(1+t1)) )
210                temp /= sqrt(1+t1)
211               
212                Sq += temp
213        endfor
214        Sq *= 2
215        Sq += 1
216       
217        inten = 2*Pi*scale*Pq*Sq/(dd*Qval^2)
218       
219        inten *= 1e8            // 1/A to 1/cm
220        //inten = Sq
221        Return (inten+bkg)
222End
223
224//wrapper to calculate the smeared model as an AAO-Struct
225// fills the struct and calls the ususal function with the STRUCT parameter
226//
227// used only for the dependency, not for fitting
228//
229//Function fLamellarPS_HG_Smeared(coefW,yW,xW)
230//      Wave coefW,yW,xW
231//     
232//      String str = getWavesDataFolder(yW,0)
233//      String DF="root:"+str+":"
234//     
235//      WAVE resW = $(DF+str+"_res")
236//     
237//      STRUCT ResSmearAAOStruct fs
238//      WAVE fs.coefW = coefW   
239//      WAVE fs.yW = yW
240//      WAVE fs.xW = xW
241//      WAVE fs.resW = resW
242//     
243//      Variable err
244//      err = LamellarPS_HG_Smeared(fs)
245//     
246//      return (0)
247//End
248
249//////the smeared model calculation
250//Function LamellarPS_HG_Smeared(s) :FitFunc
251//      Struct ResSmearAAOStruct &s
252//
253////    the name of your unsmeared model (AAO) is the first argument
254//      Smear_Model_20(LamellarPS_HG,s.coefW,s.xW,s.yW,s.resW)
255//
256//      return(0)
257//End
258       
Note: See TracBrowser for help on using the repository browser.