source: branches/sandbox/readexp.tcl @ 1208

Last change on this file since 1208 was 1208, checked in by toby, 10 years ago

Add routines for Fourier map access

  • Property svn:keywords set to Author Date Revision Id
File size: 129.2 KB
Line 
1# $Id: readexp.tcl 1208 2012-08-13 03:42:44Z toby $
2# Routines to deal with the .EXP "data structure"
3set expmap(Revision) {$Revision: 1208 $ $Date: 2012-08-13 03:42:44 +0000 (Mon, 13 Aug 2012) $}
4
5#  The GSAS data is read from an EXP file.
6#   ... reading an EXP file into an array
7# returns -1 on error
8# returns 0 if the file is old-style UNIX format (no CR/LF)
9# returns 1 if the file is 80 char/line + cr/lf
10# returns 2 if the file is sequential but not fixed-record length
11proc expload {expfile "ns {}"} {
12    # expfile is the path to the data file.
13    # ns is the namespace to place the output array (default is global)
14    if {$ns != ""} {
15        namespace eval $ns {}
16    }
17    if [catch {set fil [open "$expfile" r]}] {
18        tk_dialog .expFileErrorMsg "File Open Error" \
19                "Unable to open file $expfile" error 0 "Exit" 
20        return -1
21    }
22    fconfigure $fil -translation lf
23    set len [gets $fil line]
24    if {[string length $line] != $len} {
25        tk_dialog .expConvErrorMsg "old tcl" \
26                "You are using an old version of Tcl/Tk and your .EXP file has binary characters; run convstod or upgrade" \
27                error 0 "Exit"
28        return -1
29    }
30    catch {
31        unset ${ns}::exparray
32    }
33    if {$len > 160} {
34        set fmt 0
35        # a UNIX-type file
36        set i1 0
37        set i2 79
38        while {$i2 < $len} {
39            set nline [string range $line $i1 $i2]
40            incr i1 80
41            incr i2 80
42            set key [string range $nline 0 11]
43            set ${ns}::exparray($key) [string range $nline 12 end]
44        }
45    } else {
46        set fmt 1
47        while {$len > 0} {
48            set key [string range $line 0 11]
49            set ${ns}::exparray($key) [string range $line 12 79]
50            if {$len != 81 || [string range $line end end] != "\r"} {set fmt 2}
51            set len [gets $fil line]
52        }
53    }
54    close $fil
55    return $fmt
56}
57
58proc createexp {expfile title} {
59    global exparray expmap
60    catch {unset exparray}
61    foreach key   {"     VERSION" "      DESCR" "ZZZZZZZZZZZZ" " EXPR NPHAS"} \
62            value {"   6"         ""            "  Last EXP file record" ""} {
63        # truncate long keys & pad short ones
64        set key [string range "$key        " 0 11]
65        set exparray($key) $value
66    }
67    expinfo title set $title
68    exphistory add " created readexp.tcl [lindex $expmap(Revision) 1] [clock format [clock seconds] -format %Y-%m-%dT%T]"
69    expwrite $expfile
70}
71
72# get information out from an EXP file
73#   creates the following entries in global array expmap
74#     expmap(phaselist)     gives a list of defined phases
75#     expmap(phasetype)     gives the phase type for each defined phase
76#                           =1 nuclear; 2 mag+nuc; 3 mag; 4 macro
77#     expmap(atomlist_$p)   gives a list of defined atoms in phase $p
78#     expmap(htype_$n)      gives the GSAS histogram type for histogram (all)
79#     expmap(powderlist)    gives a list of powder histograms in use
80#     expmap(phaselist_$n)  gives a list of phases used in histogram $n
81#     expmap(nhst)          the number of GSAS histograms
82#
83proc mapexp {} {
84    global expgui expmap exparray
85    # clear out the old array
86    set expmap_Revision $expmap(Revision)
87    unset expmap
88    set expmap(Revision) $expmap_Revision
89    # apply any updates to the .EXP file
90    updateexpfile
91    # get the defined phases
92    set line [readexp " EXPR NPHAS"]
93#    if {$line == ""} {
94#       set msg "No EXPR NPHAS entry. This is an invalid .EXP file"
95#       tk_dialog .badexp "Error in EXP" $msg error 0 Exit
96#       destroy .
97#    }
98    set expmap(phaselist) {}
99    set expmap(phasetype) {}
100    # loop over phases
101    foreach iph {1 2 3 4 5 6 7 8 9} {
102        set i5s [expr {($iph - 1)*5}]
103        set i5e [expr {$i5s + 4}]
104        set flag [string trim [string range $line $i5s $i5e]]
105        if {$flag == ""} {set flag 0}
106        if $flag {
107            lappend expmap(phaselist) $iph
108            lappend expmap(phasetype) $flag
109        }
110    }
111    # get the list of defined atoms for each phase
112    foreach iph $expmap(phaselist) {
113        set expmap(atomlist_$iph) {}
114        if {[lindex $expmap(phasetype) [expr {$iph - 1}]] != 4} {
115            foreach key [array names exparray "CRS$iph  AT*A"] {
116                regexp { AT *([0-9]+)A} $key a num
117                lappend expmap(atomlist_$iph) $num
118            }
119        } else {
120            foreach key [array names exparray "CRS$iph  AT*"] {
121                scan [string range $key 8 11] %x atm
122                lappend expmap(atomlist_$iph) $atm
123            }
124        }
125        # note that sometimes an .EXP file contains more atoms than are actually defined
126        # drop the extra ones
127        set expmap(atomlist_$iph) [lsort -integer $expmap(atomlist_$iph)]
128        set natom [phaseinfo $iph natoms]
129        if {$natom != [llength $expmap(atomlist_$iph)]} {
130            set expmap(atomlist_$iph) [lrange $expmap(atomlist_$iph) 0 [expr {$natom-1}]]
131        }
132    }
133    # now get the histogram types
134    set expmap(nhst) [string trim [readexp { EXPR  NHST }]]
135    set n 0
136    set expmap(powderlist) {}
137    for {set i 0} {$i < $expmap(nhst)} {incr i} {
138        set ihist [expr {$i + 1}]
139        if {[expr {$i % 12}] == 0} {
140            incr n
141            set line [readexp " EXPR  HTYP$n"]
142            if {$line == ""} {
143                set msg "No HTYP$n entry for Histogram $ihist. This is an invalid .EXP file"
144                tk_dialog .badexp "Error in readexp" $msg error 0 Exit
145            }
146            set j 0
147        } else {
148            incr j
149        }
150        set expmap(htype_$ihist) [string range $line [expr 2+5*$j] [expr 5*($j+1)]]
151        # is this a dummy histogram?
152        if {$ihist <=9} {
153            set key "HST  $ihist DUMMY"
154        } else {
155            set key "HST $ihist DUMMY"
156        }
157        # at least for now, ignore non-powder histograms
158        if {[string range $expmap(htype_$ihist) 0 0] == "P" && \
159                [string range $expmap(htype_$ihist) 3 3] != "*"} {
160            if {[existsexp $key]} {
161                set expmap(htype_$ihist) \
162                        [string range $expmap(htype_$ihist) 0 2]D
163            }
164            lappend expmap(powderlist) $ihist
165        }
166    }
167
168    # now process powder histograms
169    foreach ihist $expmap(powderlist) {
170        # make a 2 digit key -- hh
171        if {$ihist < 10} {
172            set hh " $ihist"
173        } else {
174            set hh $ihist
175        }
176        set line [readexp "HST $hh NPHAS"]
177        if {$line == ""} {
178            set msg "No NPHAS entry for Histogram $ihist. This is an invalid .EXP file"
179            tk_dialog .badexp "Error in readexp" $msg error 0 Exit
180        }
181        set expmap(phaselist_$ihist) {}
182        # loop over phases
183        foreach iph {1 2 3 4 5 6 7 8 9} {
184            set i5s [expr {($iph - 1)*5}]
185            set i5e [expr {$i5s + 4}]
186            set flag [string trim [string range $line $i5s $i5e]]
187            if {$flag == ""} {set flag 0}
188            if $flag {lappend expmap(phaselist_$ihist) $iph}
189        }
190    }
191    # load the constrained parameters
192    atom_constraint_load
193    # construct tables of mapped atoms in rigid bodies
194    foreach phase $::expmap(phaselist) {
195        set expmap(rbatoms_$phase) {}
196        foreach bodnum [RigidBodyList] {
197            set natoms [llength [lindex [lindex [lindex [ReadRigidBody $bodnum] 1] 0] 3]]
198            foreach mapnum [RigidBodyMappingList $phase $bodnum] {
199                set atomnum [lindex [ReadRigidBodyMapping $phase $bodnum $mapnum] 0]
200                set st [lsearch $::expmap(atomlist_$phase) $atomnum]
201                set en [expr {$st+$natoms-1}]
202                set atoms [lrange $::expmap(atomlist_$phase) $st $en]
203                set expmap(rbatoms_$phase) [concat $expmap(rbatoms_$phase) $atoms]
204            }
205        }
206    }
207    set expgui(mapstat) 1
208}
209
210# this routine is called to update changes in the .EXP file
211proc updateexpfile {} {
212    global exparray
213    # change "CRSx  ODFxxx" records to "CRSx  OD xxx" records
214    # needed by the June 8, 2005 GSAS release
215    set ODFlist [array names exparray "CRS?  ODF*"]
216    if {[llength $ODFlist] > 0} {
217        catch {incr ::expgui(changed)}
218        foreach key $ODFlist {
219            regsub "ODF" $key "OD " newkey
220            set exparray($newkey) $exparray($key)
221            unset exparray($key)
222        }
223    }
224}
225
226
227# return the value for a ISAM key
228proc readexp {key} {
229    global exparray
230    # truncate long keys & pad short ones
231    set key [string range "$key        " 0 11]
232    if [catch {set val $exparray($key)}] {
233        global expgui
234        if $expgui(debug) {puts "Error accessing record $key"}
235        return ""
236    }
237    return $val
238}
239
240# return the number of records matching ISAM key (may contain wildcards)
241proc existsexp {key} {
242    global exparray
243    # key can contain wild cards so don't pad
244    return [llength [array names exparray  $key]]
245}
246
247
248# replace a section of the exparray with $value
249#   replace $char characters starting at character $start (numbered from 1)
250proc setexp {key value start chars} {
251    global exparray
252    # truncate long keys & pad short ones
253    set key [string range "$key        " 0 11]
254    if [catch {set exparray($key)}] {
255        global expgui
256        if $expgui(debug) {puts "Error accessing record $key"}
257        return ""
258    }
259
260    # pad value to $chars
261    set l0 [expr {$chars - 1}]
262    set value [string range "$value                                           " 0 $l0]
263
264    if {$start == 1} {
265        set ret {}
266        set l1 $chars
267    } else {
268        set l0 [expr {$start - 2}]
269        set l1 [expr {$start + $chars - 1}]
270        set ret [string range $exparray($key) 0 $l0]
271    }
272    append ret $value [string range $exparray($key) $l1 end]
273    set exparray($key) $ret
274}
275
276proc makeexprec {key} {
277    global exparray
278    # truncate long keys & pad short ones
279    set key [string range "$key        " 0 11]
280    if [catch {set exparray($key)}] {
281        # set to 68 blanks
282        set exparray($key) [format %68s " "]
283    }
284}
285
286# delete an exp record
287# returns 1 if OK; 0 if not found
288proc delexp {key} {
289    global exparray
290    # truncate long keys & pad short ones
291    set key [string range "$key        " 0 11]
292    if [catch {unset exparray($key)}] {
293        return 0
294    }
295    return 1
296}
297
298# test an argument if it is a valid number; reform the number to fit
299proc validreal {val length decimal} {
300    upvar $val value
301    # is this a number?
302    if [catch {expr {$value}}] {return 0}
303    if [catch {
304        # how many digits are needed to the left of the decimal?
305        set sign 0
306        if {$value > 0} {
307            set digits [expr {1 + int(log10($value))}]
308        } elseif {$value < 0} {
309            set digits [expr {1 + int(log10(-$value))}]
310            set sign 1
311        } else {
312            set digits 1
313        }
314        if {$digits <= 0} {set digits 1}
315        if {$digits + $sign >= $length} {
316            # the number is much too big -- use exponential notation
317            set decimal [expr {$length - 6 - $sign}]
318            # drop more decimal places, as needed
319            set tmp [format "%${length}.${decimal}E" $value]
320            while {[string length $tmp] > $length && $decimal >= 0} {
321                incr decimal -1
322                set tmp [format "%${length}.${decimal}E" $value]
323            }
324        } elseif {$digits + $sign >= $length - $decimal} {
325            # we will have to trim the number of decimal digits
326            set decimal [expr {$length - $digits - $sign - 1}]
327            set tmp [format "%#.${decimal}f" $value]
328        } elseif {abs($value) < pow(10,2-$decimal) && $length > 6 && $value != 0} {
329            # for small values, switch to exponential notation (2-$decimal -> three sig figs.)
330            set decimal [expr {$length - 6 - $sign}]
331            # drop more decimal places, as needed
332            set tmp [format "%${length}.${decimal}E" $value]
333            while {[string length $tmp] > $length && $decimal >= 0} {
334                incr decimal -1
335                set tmp [format "%${length}.${decimal}E" $value]
336            }
337        } else {
338            # use format as specified
339            set tmp [format "%${length}.${decimal}f" $value]
340        }
341        set value $tmp
342    } errmsg] {return 0}
343    return 1
344}
345
346# test an argument if it is a valid integer; reform the number into
347# an integer, if appropriate -- be sure to pass the name of the variable not the value
348proc validint {val length} {
349    upvar $val value
350    # FORTRAN type assumption: blank is 0
351    if {$value == ""} {set value 0}
352    if [catch {
353        set tmp [expr {round($value)}]
354        if {$tmp != $value} {return 0}
355        set value [format "%${length}d" $tmp]
356    }] {return 0}
357    return 1
358}
359
360# process history information
361#    action == last
362#       returns number and value of last record
363#    action == add
364#
365proc exphistory {action "value 0"} {
366    global exparray
367    if {$action == "last"} {
368        set key [lindex [lsort -decreasing [array names exparray *HSTRY*]] 0]
369        if {$key == ""} {return ""}
370        return [list [string trim [string range $key 9 end]] $exparray($key)]
371    } elseif {$action == "add"} {
372        set key [lindex [lsort -decreasing [array names exparray *HSTRY*]] 0]
373        if {$key == ""} {
374            set index 1
375        } else {
376            set index [string trim [string range $key 9 end]]
377            if {$index != "***"} {
378                if {$index < 999} {incr index}
379                set key [format "    HSTRY%3d" $index]
380                set exparray($key) $value
381            }
382        }
383        set key [format "    HSTRY%3d" $index]
384        set exparray($key) $value
385    }
386}
387# get overall info
388#   parm:
389#     print     -- GENLES print option (*)
390#     cycles    -- number of GENLES cycles (*)
391#     title     -- the overall title (*)
392#     convg     -- convergence criterion: -200 to 200 (*)
393#     marq      -- Marquardt damping factor: 1.0 to 9.99 (*)
394#     mbw       -- LS matrix bandwidth; =0 for full matrix (*)
395proc expinfo {parm "action get" "value {}"} {
396    switch ${parm}-$action {
397        title-get {
398            return [string trim [readexp "      DESCR"]]
399        }
400        title-set {
401            setexp "      DESCR" "  $value" 2 68
402        }
403        cycles-get {
404            return [string trim [cdatget MXCY]]
405        }
406        cycles-set {
407            if ![validint value 1] {return 0}
408            cdatset MXCY [format %4d $value]
409        }
410        cyclesrun-get {
411            set cycle -1
412            regexp {.*cycles run *([0-9]*) } [readexp "  GNLS  RUN"] x cycle
413            return $cycle
414        }
415        print-get {
416            set print [string trim [cdatget PRNT]]
417            if {$print != ""} {return $print}
418            return 0
419        }
420        print-set {
421            if ![validint value 1] {return 0}
422            cdatset PRNT [format %4d $value]
423        }
424        convg-get {
425            set cvg [string trim [cdatget CVRG]]
426            if {$cvg == ""} {return -200}
427            if [catch {expr {$cvg}}] {return -200}
428            return $cvg
429        }
430        convg-set {
431            if ![validint value 1] {return 0}
432            set value [expr {-200>$value?-200:$value}]
433            set value [expr {200<$value?200:$value}]
434            cdatset CVRG [format %4d $value]
435        }
436        marq-get {
437            set mar [string trim [cdatget MARQ]]
438            if {$mar == ""} {return 1.0}
439            if [catch {expr $mar}] {return 1.}
440            return $mar
441        }
442        marq-set {
443            if [catch {
444                set value [expr {1.0>$value?1.0:$value}]
445                set value [expr {9.99<$value?9.99:$value}]
446            }] {return 0}
447            if ![validreal value 4 2] {return 0}
448            cdatset MARQ $value
449        }
450        mbw-get {
451            set mbw [string trim [cdatget MBW]]
452            if {$mbw == ""} {return 0}
453            if [catch {expr $mbw}] {return 0}
454            return $mbw
455        }
456        mbw-set {
457            if ![validint value 1] {return 0}
458            if {$value < 0} {return 0}
459            cdatset MBW [format %5d $value]
460        }
461        default {
462            set msg "Unsupported expinfo access: parm=$parm action=$action"
463            tk_dialog .badexp "Error in readexp" $msg error 0 Exit
464        }
465    }
466    return 1
467}
468
469proc cdatget {key} {
470    foreach i {1 2 3 4 5 6 7 8 9} {
471        if {[existsexp "  GNLS CDAT$i"] == 0} break
472        set line [readexp "  GNLS CDAT$i"]
473        if {$line == {}} break
474        foreach i1 {2 10 18 26 34 42 50 58 66} \
475                i2 {9 17 25 33 41 49 57 65 73} {
476            set item [string range $line $i1 $i2]
477            if {[string trim $item] == {}} continue
478            if [regexp "${key}(.*)" $item a b] {return $b}
479        }
480    }
481    return {}
482}
483
484proc cdatset {key value} {
485    # round 1 see if we can find the string
486    foreach i {1 2 3 4 5 6 7 8 9} {
487        set line [readexp "  GNLS CDAT$i"]
488        if {$line == {}} break
489        foreach i1 {2 10 18 26 34 42 50 58 66} \
490                i2 {9 17 25 33 41 49 57 65 73} {
491            set item [string range $line $i1 $i2]
492            if {[string trim $item] == {}} continue
493            if [regexp "${key}(.*)" $item a b] {
494                # found it now replace it
495                incr i1
496                setexp "  GNLS CDAT$i" "${key}${value}" $i1 8
497                return
498            }
499        }
500    }
501    # not found, take the 1st blank space, creating a card if needed
502    foreach i {1 2 3 4 5 6 7 8 9} {
503        set line [readexp "  GNLS CDAT$i"]
504        if {$line == {}} {makeexprec "  GNLS CDAT$i"}
505        foreach i1 {2 10 18 26 34 42 50 58 66} \
506                i2 {9 17 25 33 41 49 57 65 73} {
507            set item [string range $line $i1 $i2]
508            if {[string trim $item] == {}} {
509                # found a blank space: now replace it
510                incr i1
511                setexp "  GNLS CDAT$i" "${key}${value}" $i1 8
512                return
513            }
514        }
515    }
516    return {}
517}
518
519proc disagldat_get {phase} {
520    set key "  DSGL CDAT$phase"
521    if {[existsexp $key] == 0} {return "{none} {none}"}
522    set line [readexp $key]
523    set i1 2
524    # read atom-atom distance parameter
525    set dist {}
526    set item [string range $line $i1 [expr {$i1+3}]]
527    if {$item == "DMAX"} {
528        set val [string range $line [expr {$i1+4}] [expr {$i1+11}]]
529        set dist [string trim $val]
530        incr i1 13
531    } else {
532        set dist "radii"
533        incr i1 5
534    }
535    # read atom-atom-atom angle parameter
536    set ang {}
537    set item [string range $line $i1 [expr {$i1+3}]]
538    if {$item == "DAGL"} {
539        set val [string range $line [expr {$i1+4}] [expr {$i1+11}]]
540        set ang [string trim $val]
541        incr i1 13
542    } else {
543        set ang "radii"
544        incr i1 5
545    }
546    # note there are two more parameters, NOFO/FORA & ONCR/DFLT, but they are not being processed yet
547    return "$dist $ang"
548}
549
550# get phase information: phaseinfo phase parm action value
551#   phase: 1 to 9 (as defined)
552#   parm:
553#     name -- phase name
554#     natoms -- number of atoms (*)
555#     a b c alpha beta gamma -- cell parameters (*)
556#     cellref -- refinement flag for the unit cell(*)
557#     celldamp  -- damping for the unit cell refinement (*)
558#     spacegroup -- space group symbol (*)
559#     ODForder -- spherical harmonic order (*)
560#     ODFsym   -- sample symmetry (0-3) (*)
561#     ODFdampA -- damping for angles (*)
562#     ODFdampC -- damping for coefficients (*)
563#     ODFomega -- omega oriention angle (*)
564#     ODFchi -- chi oriention angle (*)
565#     ODFphi -- phi oriention angle (*)
566#     ODFomegaRef -- refinement flag for omega (*)
567#     ODFchiRef -- refinement flag for chi (*)
568#     ODFphiRef -- refinement flag for phi (*)
569#     ODFterms -- a list of the {l m n} values for each ODF term (*)
570#     ODFcoefXXX -- the ODF coefficient for for ODF term XXX (*)
571#     ODFRefcoef -- refinement flag for ODF terms (*)
572#     DistCalc   -- returns "radii", "none" or a number (*)
573#                   none: no distance or angle computation for the phase
574#                   radii: computation will be done by sums of radii
575#                          (see AtmTypInfo and DefAtmTypInfo)
576#                   other: a distance specifing the maximum distance
577#     AngCalc    -- returns "radii", "none" or a number (*)
578#                   none: no distance or angle computation for the phase
579#                   radii: computation will be done by sums of radii
580#                          (see AtmTypInfo and DefAtmTypInfo)
581#                   other: a distance specifing the maximum distance
582#  action: get (default) or set
583#  value: used only with set
584#  * =>  read+write supported
585proc phaseinfo {phase parm "action get" "value {}"} {
586    switch -glob ${parm}-$action {
587
588        name-get {
589            return [string trim [readexp "CRS$phase    PNAM"]]
590        }
591
592        name-set {
593            setexp "CRS$phase    PNAM" " $value" 2 68
594        }
595
596        spacegroup-get {
597            return [string trim [readexp "CRS$phase  SG SYM"]]
598        }
599
600        spacegroup-set {
601            setexp "CRS$phase  SG SYM" " $value" 2 68
602        }
603
604        natoms-get {
605            return [string trim [readexp "CRS$phase   NATOM"]]     
606        }
607
608        natoms-set {
609            if ![validint value 5] {return 0}
610            setexp "CRS$phase   NATOM" $value 1 5
611        }
612
613        a-get {
614           return [string trim [string range [readexp "CRS$phase  ABC"] 0 9]]
615        }
616        b-get {
617           return [string trim [string range [readexp "CRS$phase  ABC"] 10 19]]
618        }
619        c-get {
620           return [string trim [string range [readexp "CRS$phase  ABC"] 20 29]]
621        }
622        alpha-get {
623           return [string trim [string range [readexp "CRS$phase  ANGLES"] 0 9]]
624        }
625        beta-get {
626           return [string trim [string range [readexp "CRS$phase  ANGLES"] 10 19]]
627        }
628        gamma-get {
629           return [string trim [string range [readexp "CRS$phase  ANGLES"] 20 29]]
630        }
631
632        a-set {
633            if ![validreal value 10 6] {return 0}
634            setexp "CRS$phase  ABC" $value 1 10             
635        }
636        b-set {
637            if ![validreal value 10 6] {return 0}
638            setexp "CRS$phase  ABC" $value 11 10           
639        }
640        c-set {
641            if ![validreal value 10 6] {return 0}
642            setexp "CRS$phase  ABC" $value 21 10           
643        }
644        alpha-set {
645            if ![validreal value 10 4] {return 0}
646            setexp "CRS$phase  ANGLES" $value 1 10         
647        }
648        beta-set {
649            if ![validreal value 10 4] {return 0}
650            setexp "CRS$phase  ANGLES" $value 11 10         
651        }
652        gamma-set {
653            if ![validreal value 10 4] {return 0}
654            setexp "CRS$phase  ANGLES" $value 21 10         
655        }
656        cellref-get {
657            if {[string toupper [string range [readexp "CRS$phase  ABC"] 34 34]] == "Y"} {
658                return 1
659            }
660            return 0
661        }
662        cellref-set {
663            if $value {
664                setexp "CRS$phase  ABC" "Y" 35 1
665            } else {
666                setexp "CRS$phase  ABC" "N" 35 1
667            }       
668        }
669        celldamp-get {
670            set val [string range [readexp "CRS$phase  ABC"] 39 39]
671            if {$val == " "} {return 0}
672            return $val
673        }
674        celldamp-set {
675            setexp "CRS$phase  ABC" $value 40 1
676        }
677
678        ODForder-get {
679            set val [string trim [string range [readexp "CRS$phase  OD "] 0 4]]
680            if {$val == " "} {return 0}
681            return $val
682        }
683        ODForder-set {
684            if ![validint value 5] {return 0}
685            setexp "CRS$phase  OD " $value 1 5
686        }
687        ODFsym-get {
688            set val [string trim [string range [readexp "CRS$phase  OD "] 10 14]]
689            if {$val == " "} {return 0}
690            return $val
691        }
692        ODFsym-set {
693            if ![validint value 5] {return 0}
694            setexp "CRS$phase  OD " $value 11 5
695        }
696        ODFdampA-get {
697            set val [string range [readexp "CRS$phase  OD "] 24 24]
698            if {$val == " "} {return 0}
699            return $val
700        }
701        ODFdampA-set {
702            setexp "CRS$phase  OD " $value 25 1
703        }
704        ODFdampC-get {
705            set val [string range [readexp "CRS$phase  OD "] 29 29]
706            if {$val == " "} {return 0}
707            return $val
708        }
709        ODFdampC-set {
710            setexp "CRS$phase  OD " $value 30 1
711        }
712        ODFomegaRef-get {
713            if {[string toupper [string range [readexp "CRS$phase  OD "] 16 16]] == "Y"} {
714                return 1
715            }
716            return 0
717        }
718        ODFomegaRef-set {
719            if $value {
720                setexp "CRS$phase  OD " "Y" 17 1
721            } else {
722                setexp "CRS$phase  OD " "N" 17 1
723            }       
724        }
725        ODFchiRef-get {
726            if {[string toupper [string range [readexp "CRS$phase  OD "] 17 17]] == "Y"} {
727                return 1
728            }
729            return 0
730        }
731        ODFchiRef-set {
732            if $value {
733                setexp "CRS$phase  OD " "Y" 18 1
734            } else {
735                setexp "CRS$phase  OD " "N" 18 1
736            }       
737        }
738        ODFphiRef-get {
739            if {[string toupper [string range [readexp "CRS$phase  OD "] 18 18]] == "Y"} {
740                return 1
741            }
742            return 0
743        }
744        ODFphiRef-set {
745            if $value {
746                setexp "CRS$phase  OD " "Y" 19 1
747            } else {
748                setexp "CRS$phase  OD " "N" 19 1
749            }       
750        }
751        ODFcoef*-get {
752            regsub ODFcoef $parm {} term
753            set k [expr {($term+5)/6}]
754            if {$k <= 9} {
755                set k "  $k"
756            } elseif {$k <= 99} {
757                set k " $k"
758            }
759            set j [expr {(($term-1) % 6)+1}]
760            set lineB [readexp "CRS$phase  OD${k}B"]
761            set j0 [expr { ($j-1) *10}]
762            set j1 [expr {$j0 + 9}]
763            set val [string trim [string range $lineB $j0 $j1]]
764            if {$val == ""} {return 0.0}
765            return $val
766        }
767        ODFcoef*-set {
768            regsub ODFcoef $parm {} term
769            if ![validreal value 10 3] {return 0}
770            set k [expr {($term+5)/6}]
771            if {$k <= 9} {
772                set k "  $k"
773            } elseif {$k <= 99} {
774                set k " $k"
775            }
776            set j [expr {(($term-1) % 6)+1}]
777            set col [expr { ($j-1)*10 + 1}]
778            setexp "CRS$phase  OD${k}B" $value $col 10
779        }
780        ODFRefcoef-get {
781            if {[string toupper [string range [readexp "CRS$phase  OD "] 19 19]] == "Y"} {
782                return 1
783            }
784            return 0
785        }
786        ODFRefcoef-set {
787            if $value {
788                setexp "CRS$phase  OD " "Y" 20 1
789            } else {
790                setexp "CRS$phase  OD " "N" 20 1
791            }       
792        }
793        ODFomega-get {
794           return [string trim [string range [readexp "CRS$phase  OD "] 30 39]]
795        }
796        ODFchi-get {
797           return [string trim [string range [readexp "CRS$phase  OD "] 40 49]]
798        }
799        ODFphi-get {
800           return [string trim [string range [readexp "CRS$phase  OD "] 50 59]]
801        }
802        ODFomega-set {
803            if ![validreal value 10 4] {return 0}
804            setexp "CRS$phase  OD " $value 31 10
805        }
806        ODFchi-set {
807            if ![validreal value 10 4] {return 0}
808            setexp "CRS$phase  OD " $value 41 10
809        }
810        ODFphi-set {
811            if ![validreal value 10 4] {return 0}
812            setexp "CRS$phase  OD " $value 51 10
813        }
814
815        ODFterms-get {
816            set vallist {}
817            set val [string trim [string range [readexp "CRS$phase  OD "] 5 9]]
818            for {set i 1} {$i <= $val} {incr i 6} {
819                set k [expr {1+($i-1)/6}]
820                if {$k <= 9} {
821                    set k "  $k"
822                } elseif {$k <= 99} {
823                    set k " $k"
824                }
825                set lineA [readexp "CRS$phase  OD${k}A"]
826                set k 0
827                for {set j $i} {$j <= $val && $j < $i+6} {incr j} {
828                    set j0 [expr {($k)*10}]
829                    set j1 [expr {$j0 + 9}]
830                    lappend vallist [string trim [string range $lineA $j0 $j1]]
831                    incr k
832                }
833            }
834            return $vallist
835        }
836        ODFterms-set {
837            set key "CRS$phase  OD    "
838            if {![existsexp $key]} {
839                makeexprec $key
840                set oldlen 0
841            } else {
842                set oldlen [string trim [string range [readexp $key] 5 9]]
843            }
844            set len [llength $value]
845            if ![validint len 5] {return 0}
846            setexp $key $len 6 5
847            set j 0
848            set k 0
849            foreach item $value {
850                incr j
851                if {$j % 6 == 1} {
852                    incr k
853                    if {$k <= 9} {
854                        set k "  $k"
855                    } elseif {$k <= 99} {
856                        set k " $k"
857                    }
858                    set col 1
859                    set keyA "CRS$phase  OD${k}A"
860                    set keyB "CRS$phase  OD${k}B"
861                    if {![existsexp $keyA]} {
862                        makeexprec $keyA
863                        makeexprec $keyB
864                    }
865                }
866                set col1 [expr {$col + 1}]
867                foreach n [lrange $item 0 2] {
868                    if ![validint n 3] {return 0}
869                    setexp $keyA $n $col1 3
870                    incr col1 3
871                }
872                incr col 10
873            }
874            for {incr j} {$j <= $oldlen} {incr j} {
875                if {$j % 6 == 1} {
876                    incr k
877                    if {$k <= 9} {
878                        set k "  $k"
879                    } elseif {$k <= 99} {
880                        set k " $k"
881                    }
882                    set col 1
883                    set keyA "CRS$phase  OD${k}A"
884                    set keyB "CRS$phase  OD${k}B"
885                    delexp $keyA
886                    delexp $keyB
887                }
888                if {[existsexp $keyA]} {
889                    setexp $keyA "          " $col 10
890                    setexp $keyB "          " $col 10
891                }
892                incr col 10
893            }
894        }
895        DistCalc-get {
896            set val [disagldat_get $phase]
897            return [lindex $val 0]
898        }
899        DistCalc-set {
900            set key "  DSGL CDAT$phase"
901            # for none delete the record & thats all folks
902            if {$value == "none"} {
903                catch {unset ::exparray($key)}
904                return
905            }
906            if {[existsexp $key] == 0} {
907                makeexprec $key
908            }
909            set line [readexp $key]
910            if {[string trim $line] == ""} {
911                # blank set to defaults
912                set line [string replace $line 2 15 "DRAD ARAD NOFO"]
913            }
914            if {$value == "radii"} {
915                if {[string range $line 2 5] == "DMAX"} {
916                    set line [string replace $line 2 13 "DRAD"]
917                } else {
918                    set line [string replace $line 2 5 "DRAD"]
919                }
920            } else {
921                if ![validreal value 8 2] {return 0}
922                if {[string range $line 2 5] == "DMAX"} {
923                    set line [string replace $line 6 13 $value]
924                } else {
925                    set line [string replace $line 2 5 "DMAX"]
926                    set line [string replace $line 6 6 "$value "]
927                }
928            }
929            setexp $key $line 0 68
930        }
931        AngCalc-get {
932            set val [disagldat_get $phase]
933            return [lindex $val 1]
934        }
935        AngCalc-set {
936            set key "  DSGL CDAT$phase"
937            # for none delete the record & thats all folks
938            if {$value == "none"} {
939                catch {unset ::exparray($key)}
940                return
941            }
942            if {[existsexp $key] == 0} {
943                makeexprec $key
944            }
945            set line [readexp $key]
946            if {[string trim $line] == ""} {
947                # blank set to defaults
948                set line [string replace $line 2 15 "DRAD ARAD NOFO"]
949            }
950            if {[string range $line 2 5] == "DMAX"} {
951                set i2 8
952            } else {
953                set i2 0
954            }
955            if {$value == "radii"} {
956                if {[string range $line [expr {$i2+7}] [expr {$i2+10}]] == "DAGL"} {
957                    set line [string replace $line [expr {$i2+7}] [expr {$i2+18}] "ARAD"]
958                } else {
959                    set line [string replace $line [expr {$i2+7}] [expr {$i2+10}] "ARAD"]
960                }
961            } else {
962                if ![validreal value 8 2] {return 0}
963                if {[string range $line [expr {$i2+7}] [expr {$i2+10}]] == "DAGL"} {
964                    set line [string replace $line [expr {$i2+11}] [expr {$i2+18}] $value]
965                } else {
966                    set line [string replace $line [expr {$i2+7}] [expr {$i2+10}] "DAGL"]
967                    set line [string replace $line [expr {$i2+11}] [expr {$i2+11}] "$value "]
968                }
969            }
970            setexp $key $line 0 68
971        }
972        default {
973            set msg "Unsupported phaseinfo access: parm=$parm action=$action"
974            tk_dialog .badexp "Error in readexp" $msg error 0 Exit
975        }
976    }
977    return 1
978}
979
980
981
982# get atom information: atominfo phase atom parm action value
983#   phase: 1 to 9 (as defined)
984#   atom: a valid atom number [see expmap(atomlist_$phase)]
985#      Note that atom and phase can be paired lists, but if there are extra
986#      entries in the atoms list, the last phase will be repeated.
987#      so that atominfo 1 {1 2 3} xset 1
988#               will set the xflag for atoms 1-3 in phase 1
989#      but atominfo {1 2 3} {1 1 1} xset 1
990#               will set the xflag for atoms 1 in phase 1-3
991#   parm:
992#     type -- element code
993#     mult -- atom multiplicity
994#     label -- atom label (*)
995#     x y z -- coordinates (*)
996#     frac --  occupancy (*)
997#     temptype -- I or A for Isotropic/Anisotropic (*)
998#     Uiso  -- Isotropic temperature factor (*)
999#     U11  -- Anisotropic temperature factor (*)
1000#     U22  -- Anisotropic temperature factor (*)
1001#     U33  -- Anisotropic temperature factor (*)
1002#     U12  -- Anisotropic temperature factor (*)
1003#     U13  -- Anisotropic temperature factor (*)
1004#     U23  -- Anisotropic temperature factor (*)
1005#     xref/xdamp -- refinement flag/damping value for the coordinates (*)
1006#     uref/udamp -- refinement flag/damping value for the temperature factor(s)  (*)
1007#     fref/fdamp -- refinement flag/damping value for the occupancy (*)
1008#  action: get (default) or set
1009#  value: used only with set
1010#  * =>  read+write supported
1011proc atominfo {phaselist atomlist parm "action get" "value {}"} {
1012    foreach phase $phaselist atom $atomlist {
1013        if {$phase == ""} {set phase [lindex $phaselist end]}
1014        if {$atom < 10} {
1015            set key "CRS$phase  AT  $atom"
1016        } elseif {$atom < 100} {
1017            set key "CRS$phase  AT $atom"
1018        } else {
1019            set key "CRS$phase  AT$atom"
1020        }
1021        switch -glob ${parm}-$action {
1022            type-get {
1023                return [string trim [string range [readexp ${key}A] 2 9] ]
1024            }
1025            mult-get {
1026                return [string trim [string range [readexp ${key}A] 58 61] ]
1027            }
1028            label-get {
1029                return [string trim [string range [readexp ${key}A] 50 57] ]
1030            }
1031            label-set {
1032                setexp ${key}A $value 51 8
1033            }
1034            temptype-get {
1035                return [string trim [string range [readexp ${key}B] 62 62] ]
1036            }
1037            temptype-set {
1038                if {$value == "A"} {
1039                    setexp ${key}B A 63 1
1040                    # copy the Uiso to the diagonal terms
1041                    set Uiso [string range [readexp ${key}B] 0 9]
1042                    foreach value [CalcAniso $phase $Uiso] \
1043                            col {1 11 21 31 41 51} {
1044                        validreal value 10 6
1045                        setexp ${key}B $value $col 10
1046                    }
1047                } else {
1048                    setexp ${key}B I 63 1
1049                    set value 0.0
1050                    catch {
1051                        # get the trace
1052                        set value [expr {( \
1053                                [string range [readexp ${key}B] 0 9] + \
1054                                [string range [readexp ${key}B] 10 19] + \
1055                                [string range [readexp ${key}B] 20 29])/3.}]
1056                    }
1057                    validreal value 10 6
1058                    setexp ${key}B $value 1 10
1059                    # blank out the remaining terms
1060                    set value " "
1061                    setexp ${key}B $value 11 10
1062                    setexp ${key}B $value 21 10
1063                    setexp ${key}B $value 31 10
1064                    setexp ${key}B $value 41 10
1065                    setexp ${key}B $value 51 10
1066                }
1067            }
1068            x-get {
1069                return [string trim [string range [readexp ${key}A] 10 19] ]
1070            }
1071            x-set {
1072                if ![validreal value 10 6] {return 0}
1073                setexp ${key}A $value 11 10
1074            }
1075            y-get {
1076                return [string trim [string range [readexp ${key}A] 20 29] ]
1077            }
1078            y-set {
1079                if ![validreal value 10 6] {return 0}
1080                setexp ${key}A $value 21 10
1081            }
1082            z-get {
1083                return [string trim [string range [readexp ${key}A] 30 39] ]
1084            }
1085            z-set {
1086                if ![validreal value 10 6] {return 0}
1087                setexp ${key}A $value 31 10
1088            }
1089            frac-get {
1090                return [string trim [string range [readexp ${key}A] 40 49] ]
1091            }
1092            frac-set {
1093                if ![validreal value 10 6] {return 0}
1094                setexp ${key}A $value 41 10
1095            }
1096            U*-get {
1097                regsub U $parm {} type
1098                if {$type == "iso" || $type == "11"} {
1099                    return [string trim [string range [readexp ${key}B] 0 9] ]
1100                } elseif {$type == "22"} {
1101                    return [string trim [string range [readexp ${key}B] 10 19] ]
1102                } elseif {$type == "33"} {
1103                    return [string trim [string range [readexp ${key}B] 20 29] ]
1104                } elseif {$type == "12"} {
1105                    return [string trim [string range [readexp ${key}B] 30 39] ]
1106                } elseif {$type == "13"} {
1107                    return [string trim [string range [readexp ${key}B] 40 49] ]
1108                } elseif {$type == "23"} {
1109                    return [string trim [string range [readexp ${key}B] 50 59] ]
1110                }
1111            }
1112            U*-set {
1113                if ![validreal value 10 6] {return 0}
1114                regsub U $parm {} type
1115                if {$type == "iso" || $type == "11"} {
1116                    setexp ${key}B $value 1 10
1117                } elseif {$type == "22"} {
1118                    setexp ${key}B $value 11 10
1119                } elseif {$type == "33"} {
1120                    setexp ${key}B $value 21 10
1121                } elseif {$type == "12"} {
1122                    setexp ${key}B $value 31 10
1123                } elseif {$type == "13"} {
1124                    setexp ${key}B $value 41 10
1125                } elseif {$type == "23"} {
1126                    setexp ${key}B $value 51 10
1127                }
1128            }
1129            xref-get {
1130                if {[string toupper [string range [readexp ${key}B] 64 64]] == "X"} {
1131                    return 1
1132                }
1133                return 0
1134            }
1135            xref-set {
1136                if $value {
1137                    setexp ${key}B "X" 65 1
1138                } else {
1139                    setexp ${key}B " " 65 1
1140                }           
1141            }
1142            xdamp-get {
1143                set val [string range [readexp ${key}A] 64 64]
1144                if {$val == " "} {return 0}
1145                return $val
1146            }
1147            xdamp-set {
1148                setexp ${key}A $value 65 1
1149            }
1150            fref-get {
1151                if {[string toupper [string range [readexp ${key}B] 63 63]] == "F"} {
1152                    return 1
1153                }
1154                return 0
1155            }
1156            fref-set {
1157                if $value {
1158                    setexp ${key}B "F" 64 1
1159                } else {
1160                    setexp ${key}B " " 64 1
1161                }           
1162            }
1163            fdamp-get {
1164                set val [string range [readexp ${key}A] 63 63]
1165                if {$val == " "} {return 0}
1166                return $val
1167            }
1168            fdamp-set {
1169                setexp ${key}A $value 64 1
1170            }
1171
1172            uref-get {
1173                if {[string toupper [string range [readexp ${key}B] 65 65]] == "U"} {
1174                    return 1
1175                }
1176                return 0
1177            }
1178            uref-set {
1179                if $value {
1180                    setexp ${key}B "U" 66 1
1181                } else {
1182                    setexp ${key}B " " 66 1
1183                }           
1184            }
1185            udamp-get {
1186                set val [string range [readexp ${key}A] 65 65]
1187                if {$val == " "} {return 0}
1188                return $val
1189            }
1190            udamp-set {
1191                setexp ${key}A $value 66 1
1192            }
1193            default {
1194                set msg "Unsupported atominfo access: parm=$parm action=$action"
1195                tk_dialog .badexp "Error in readexp" $msg error 0 Exit
1196            }
1197        }
1198    }
1199    return 1
1200}
1201
1202# get macromolecular atom information: mmatominfo phase atom parm action value
1203#   phase: 1 (at present only one mm phase can be defined)
1204#   atom: a valid atom number [see expmap(atomlist_$phase)]
1205#      Note that atoms can be lists
1206#      so that mmatominfo 1 {1 2 3} xset 1
1207#               will set the xflag for atoms 1-3 in phase 1
1208#   parm:
1209#     type -- element code
1210#     frac --  occupancy (*)
1211#     x y z -- coordinates (*)
1212#     Uiso  -- Isotropic temperature factor (*)
1213#     label -- atom label (*)
1214#     residue -- residue label (*)
1215#     group -- group label (*)
1216#     resnum -- residue number (*)
1217#     xref/xdamp -- refinement flag/damping value for the coordinates (*)
1218#     uref/udamp -- refinement flag/damping value for the temperature factor(s)  (*)
1219#     fref/fdamp -- refinement flag/damping value for the occupancy (*)
1220#  action: get (default) or set
1221#  value: used only with set
1222#  * =>  read+write supported
1223proc mmatominfo {phaselist atomlist parm "action get" "value {}"} {
1224    foreach phase $phaselist atom $atomlist {
1225        if {$phase == ""} {set phase [lindex $phaselist end]}
1226        set num [string toupper [format %.4x $atom]]
1227        set key "CRS$phase  AT$num"
1228        switch -glob ${parm}-$action {
1229            type-get {
1230                return [string trim [string range [readexp ${key}] 2 9] ]
1231            }
1232            frac-get {
1233                return [string trim [string range [readexp ${key}] 10 15] ]
1234            }
1235            frac-set {
1236                if ![validreal value 6 4] {return 0}
1237                setexp ${key} $value 11 6
1238            }
1239            x-get {
1240                return [string trim [string range [readexp ${key}] 16 23] ]
1241            }
1242            x-set {
1243                if ![validreal value 8 5] {return 0}
1244                setexp ${key} $value 17 8
1245            }
1246            y-get {
1247                return [string trim [string range [readexp ${key}] 24 31] ]
1248            }
1249            y-set {
1250                if ![validreal value 8 5] {return 0}
1251                setexp ${key} $value 25 8
1252            }
1253            z-get {
1254                return [string trim [string range [readexp ${key}] 32 39] ]
1255            }
1256            z-set {
1257                if ![validreal value 8 5] {return 0}
1258                setexp ${key} $value 33 8
1259            }
1260            Uiso-get {
1261                return [string trim [string range [readexp ${key}] 40 45] ]
1262            }
1263            Uiso-set {
1264                if ![validreal value 6 4] {return 0}
1265                setexp ${key} $value 41 6
1266            }
1267            label-get {
1268                return [string trim [string range [readexp ${key}] 46 50] ]
1269            }
1270            label-set {
1271                setexp ${key} $value 47 5
1272            }
1273            residue-get {
1274                return [string range [readexp ${key}] 51 53]
1275            }
1276            residue-set {
1277                setexp ${key} $value 52 3
1278            }
1279            group-get {
1280                return [string range [readexp ${key}] 54 55]
1281            }
1282            group-set {
1283                setexp ${key} $value 55 2
1284            }
1285            resnum-get {
1286                return [string trim [string range [readexp ${key}] 56 59] ]
1287            }
1288            resnum-set {
1289                if ![validint value 4] {return 0}
1290                setexp "${key} EPHAS" $value 57 4
1291            }
1292            fref-get {
1293                if {[string toupper [string range [readexp $key] 60 60]] == "F"} {
1294                    return 1
1295                }
1296                return 0
1297            }
1298            fref-set {
1299                if $value {
1300                    setexp $key "F" 61 1
1301                } else {
1302                    setexp $key " " 61 1
1303                }           
1304            }
1305            xref-get {
1306                if {[string toupper [string range [readexp $key] 61 61]] == "X"} {
1307                    return 1
1308                }
1309                return 0
1310            }
1311            xref-set {
1312                if $value {
1313                    setexp $key "X" 62 1
1314                } else {
1315                    setexp ${key}B " " 62 1
1316                }           
1317            }
1318            uref-get {
1319                if {[string toupper [string range [readexp $key] 62 62]] == "U"} {
1320                    return 1
1321                }
1322                return 0
1323            }
1324            uref-set {
1325                if $value {
1326                    setexp $key "U" 63 1
1327                } else {
1328                    setexp $key " " 63 1
1329                }           
1330            }
1331
1332            fdamp-get {
1333                set val [string range [readexp ${key}] 63 63]
1334                if {$val == " "} {return 0}
1335                return $val
1336            }
1337            fdamp-set {
1338                setexp ${key} $value 64 1
1339            }
1340            xdamp-get {
1341                set val [string range [readexp ${key}] 64 64]
1342                if {$val == " "} {return 0}
1343                return $val
1344            }
1345            xdamp-set {
1346                setexp ${key} $value 65 1
1347            }
1348
1349            udamp-get {
1350                set val [string range [readexp ${key}] 65 65]
1351                if {$val == " "} {return 0}
1352                return $val
1353            }
1354            udamp-set {
1355                setexp ${key} $value 66 1
1356            }
1357            default {
1358                set msg "Unsupported mmatominfo access: parm=$parm action=$action"
1359                tk_dialog .badexp "Error in readexp" $msg error 0 Exit
1360            }
1361        }
1362    }
1363    return 1
1364}
1365
1366
1367
1368# get histogram information: histinfo histlist parm action value
1369# histlist is a list of histogram numbers
1370# parm:
1371#     title
1372#     file  -- file name of raw data for histogram (*)
1373#     scale (*)
1374#     sref/sdamp -- refinement flag/damping value for the scale factor (*)
1375#     lam1, lam2 (*)
1376#     ttref refinement flag for the 2theta (ED Xray) (*)
1377#     wref refinement flag for the wavelength (*)
1378#     ratref refinement flag for the wavelength ratio (*)
1379#     difc, difa -- TOF calibration constants (*)
1380#     dcref,daref -- refinement flag for difc, difa (*)
1381#     zero (*)
1382#     zref refinement flag for the zero correction (*)
1383#     ipola (*)
1384#     pola (*)
1385#     pref refinement flag for the polarization (*)
1386#     kratio (*)
1387#     ddamp -- damping value for the diffractometer constants (*)
1388#     backtype -- background function number *
1389#     backterms -- number of background terms *
1390#     bref/bdamp -- refinement flag/damping value for the background (*)
1391#     bterm$n -- background term #n (*)
1392#     bank -- Bank number
1393#     tofangle -- detector angle (TOF only)
1394#     foextract  -- Fobs extraction flag (*)
1395#     LBdamp  -- LeBail damping value (*)
1396#     tmin/tmax -- minimum & maximum usable 2theta/TOF/energy
1397#     excl -- excluded regions (*)
1398#     dmin -- minimum d-space for reflection generation (*)
1399#     use  -- use flag; 1 = use; 0 = do not use (*)
1400#     dstart -- dummy histogram starting tmin/emin/2theta (*)
1401#     dstep -- dummy histogram step size tmin/emin/2theta (*)
1402#     dpoints -- dummy histogram number of points (*)
1403#     dtype   -- dummy histogram type (CONST or SLOG)
1404#     abscor1 -- 1st absorption correction (*)
1405#     abscor2 -- 2nd absorption correction (*)
1406#     abstype -- absorption correction type (*)
1407#     absdamp -- damping for absorption refinement (*)
1408#     absref -- refinement damping for absorption refinement (*)
1409#     proftbl -- returns number of profile table terms
1410#     anomff -- returns a list of elements, f' and f"
1411#   parameters transferred from the instrument parameter file:
1412#     ITYP    -- returns the contents of the ITYP record
1413proc histinfo {histlist parm "action get" "value {}"} {
1414    global expgui
1415    foreach hist $histlist {
1416        if {$hist < 10} {
1417            set key "HST  $hist"
1418        } else {
1419            set key "HST $hist"
1420        }
1421        switch -glob ${parm}-$action {
1422            foextract-get {
1423                set line [readexp "${key} EPHAS"]
1424                # add a EPHAS if not exists
1425                if {$line == {}} {
1426                    makeexprec "${key} EPHAS"
1427                    # expedt defaults this to "F", but I think "T" is better
1428                    setexp "${key} EPHAS" "Y" 50 1
1429                    if $expgui(debug) {puts "Warning: creating a ${key} EPHAS record"}
1430                }
1431                if {[string toupper [string range $line 49 49]] == "T"} {
1432                    return 1
1433                }
1434                # the flag has changed to "Y/N" in the latest versions
1435                # of GSAS
1436                if {[string toupper [string range $line 49 49]] == "Y"} {
1437                    return 1
1438                }
1439                return 0
1440            }
1441            foextract-set {
1442                # the flag has changed to "Y/N" in the latest versions
1443                # of GSAS
1444                if $value {
1445                    setexp "${key} EPHAS" "Y" 50 1
1446                } else {
1447                    setexp "${key} EPHAS" "N" 50 1
1448                }
1449            }
1450            LBdamp-get {
1451                set v [string trim [string range [readexp "${key} EPHAS"] 54 54]]
1452                if {$v == ""} {return 0}
1453                return $v
1454            }
1455            LBdamp-set {
1456                if ![validint value 5] {return 0}
1457                setexp "${key} EPHAS" $value 51 5
1458            }
1459            title-get {
1460                return [string trim [readexp "${key}  HNAM"] ]
1461            }
1462            scale-get {
1463                if {![existsexp ${key}HSCALE]} {
1464                    # fix missing scale factor record
1465                    makeexprec ${key}HSCALE
1466                    set value 1.0
1467                    validreal value 15 6
1468                    setexp ${key}HSCALE $value 1 15
1469                    catch {incr ::expgui(changed)}
1470                    setexp ${key}HSCALE "N" 20 1
1471                }
1472                return [string trim [string range [readexp ${key}HSCALE] 0 14]]
1473            }
1474            scale-set {
1475                if ![validreal value 15 6] {return 0}
1476                setexp ${key}HSCALE $value 1 15
1477            }
1478            sref-get {
1479                if {[string toupper [string range [readexp ${key}HSCALE] 19 19]] == "Y"} {
1480                    return 1
1481                }
1482                return 0
1483            }
1484            sref-set {
1485                if $value {
1486                    setexp ${key}HSCALE "Y" 20 1
1487                } else {
1488                    setexp ${key}HSCALE "N" 20 1
1489                }           
1490            }
1491            sdamp-get {
1492                set val [string range [readexp ${key}HSCALE] 24 24]
1493                if {$val == " "} {return 0}
1494                return $val
1495            }
1496            sdamp-set {
1497                setexp ${key}HSCALE $value 25 1
1498            }
1499
1500            difc-get -
1501            lam1-get {
1502                return [string trim [string range [readexp "${key} ICONS"] 0 9]]
1503            }
1504            difc-set -
1505            lam1-set {
1506                if ![validreal value 10 7] {return 0}
1507                setexp "${key} ICONS" $value 1 10
1508                # set the powpref warning (1 = suggested)
1509                catch {
1510                    global expgui
1511                    if {$expgui(needpowpref) == 0} {set expgui(needpowpref) 1}
1512                    set msg "Diffractometer constants" 
1513                    if {[string first $msg $expgui(needpowpref_why)] == -1} {
1514                        append expgui(needpowpref_why) "\t$msg were changed\n"
1515                    }
1516                }
1517            }
1518            difa-get -
1519            lam2-get {
1520                return [string trim [string range [readexp "${key} ICONS"] 10 19]]
1521            }
1522            difa-set -
1523            lam2-set {
1524                if ![validreal value 10 7] {return 0}
1525                setexp "${key} ICONS" $value 11 10
1526                # set the powpref warning (1 = suggested)
1527                catch {
1528                    global expgui
1529                    if {$expgui(needpowpref) == 0} {set expgui(needpowpref) 1}
1530                    set msg "Diffractometer constants" 
1531                    if {[string first $msg $expgui(needpowpref_why)] == -1} {
1532                        append expgui(needpowpref_why) "\t$msg were changed\n"
1533                    }
1534                }
1535            }
1536            zero-get {
1537                return [string trim [string range [readexp "${key} ICONS"] 20 29]]
1538            }
1539            zero-set {
1540                if ![validreal value 10 5] {return 0}
1541                setexp "${key} ICONS" $value 21 10
1542                # set the powpref warning (1 = suggested)
1543                catch {
1544                    global expgui
1545                    if {$expgui(needpowpref) == 0} {set expgui(needpowpref) 1}
1546                    set msg "Diffractometer constants" 
1547                    if {[string first $msg $expgui(needpowpref_why)] == -1} {
1548                        append expgui(needpowpref_why) "\t$msg were changed\n"
1549                    }
1550                }
1551            }
1552            ipola-get {
1553                return [string trim [string range [readexp "${key} ICONS"] 54 54]]
1554            }
1555            ipola-set {
1556                if ![validint value 1] {return 0}
1557                setexp "${key} ICONS" $value 55 1
1558            }
1559            pola-get {
1560                return [string trim [string range [readexp "${key} ICONS"] 40 49]]
1561            }
1562            pola-set {
1563                if ![validreal value 10 5] {return 0}
1564                setexp "${key} ICONS" $value 41 10
1565            }
1566            kratio-get {
1567                set val [string trim [string range [readexp "${key} ICONS"] 55 64]]
1568                if {$val == ""} {set val 0}
1569                # N.B. this code is used w/CW, where Kratio may not be 0.0
1570                set lam2 [string trim [string range [readexp "${key} ICONS"] 10 19]]
1571                if {$lam2 == ""} {set lam2 0}
1572                # Change kratio & flag the change (this is rather kludged)
1573                if {$val == 0 && $lam2 != 0} {
1574                    set val 0.5
1575                    validreal val 10 5
1576                    setexp "${key} ICONS" $val 56 10
1577                    catch {incr ::expgui(changed)}
1578                }
1579                return $val
1580            }
1581            kratio-set {
1582                if ![validreal value 10 5] {return 0}
1583                setexp "${key} ICONS" $value 56 10
1584            }
1585
1586            wref-get {
1587            #------------------------------------------------------
1588            # col 33: refine flag for lambda, difc, ratio and theta
1589            #------------------------------------------------------
1590                if {[string toupper [string range \
1591                        [readexp "${key} ICONS"] 32 32]] == "L"} {
1592                    return 1
1593                }
1594                return 0
1595            }
1596            wref-set {
1597                if $value {
1598                    setexp "${key} ICONS" "L" 33 1
1599                } else {
1600                    setexp "${key} ICONS" " " 33 1
1601                }           
1602            }
1603            ratref-get {
1604                if {[string toupper [string range \
1605                        [readexp "${key} ICONS"] 32 32]] == "R"} {
1606                    return 1
1607                }
1608                return 0
1609            }
1610            ratref-set {
1611                if $value {
1612                    setexp "${key} ICONS" "R" 33 1
1613                } else {
1614                    setexp "${key} ICONS" " " 33 1
1615                }           
1616            }
1617            dcref-get {
1618                if {[string toupper [string range \
1619                        [readexp "${key} ICONS"] 32 32]] == "C"} {
1620                    return 1
1621                }
1622                return 0
1623            }
1624            dcref-set {
1625                if $value {
1626                    setexp "${key} ICONS" "C" 33 1
1627                } else {
1628                    setexp "${key} ICONS" " " 33 1
1629                }           
1630            }
1631            ttref-get {
1632                if {[string toupper [string range \
1633                        [readexp "${key} ICONS"] 32 32]] == "T"} {
1634                    return 1
1635                }
1636                return 0
1637            }
1638            ttref-set {
1639                if $value {
1640                    setexp "${key} ICONS" "T" 33 1
1641                } else {
1642                    setexp "${key} ICONS" " " 33 1
1643                }           
1644            }
1645
1646
1647            pref-get {
1648            #------------------------------------------------------
1649            # col 34: refine flag for POLA & DIFA
1650            #------------------------------------------------------
1651                if {[string toupper [string range \
1652                        [readexp "${key} ICONS"] 33 33]] == "P"} {
1653                    return 1
1654                }
1655                return 0
1656            }
1657            pref-set {
1658                if $value {
1659                    setexp "${key} ICONS" "P" 34 1
1660                } else {
1661                    setexp "${key} ICONS" " " 34 1
1662                }           
1663            }
1664            daref-get {
1665                if {[string toupper [string range \
1666                        [readexp "${key} ICONS"] 33 33]] == "A"} {
1667                    return 1
1668                }
1669                return 0
1670            }
1671            daref-set {
1672                if $value {
1673                    setexp "${key} ICONS" "A" 34 1
1674                } else {
1675                    setexp "${key} ICONS" " " 34 1
1676                }           
1677            }
1678
1679            zref-get {
1680            #------------------------------------------------------
1681            # col 34: refine flag for zero correction
1682            #------------------------------------------------------
1683                if {[string toupper [string range [readexp "${key} ICONS"] 34 34]] == "Z"} {
1684                    return 1
1685                }
1686                return 0
1687            }
1688            zref-set {
1689                if $value {
1690                    setexp "${key} ICONS" "Z" 35 1
1691                } else {
1692                    setexp "${key} ICONS" " " 35 1
1693                }           
1694            }
1695
1696            ddamp-get {
1697                set val [string range [readexp "${key} ICONS"] 39 39]
1698                if {$val == " "} {return 0}
1699                return $val
1700            }
1701            ddamp-set {
1702                setexp "${key} ICONS" $value 40 1
1703            }
1704
1705            backtype-get {
1706                set val [string trim [string range [readexp "${key}BAKGD "] 0 4]]
1707                if {$val == " "} {return 0}
1708                return $val
1709            }
1710            backtype-set {
1711                if ![validint value 5] {return 0}
1712                setexp "${key}BAKGD " $value 1 5
1713            }
1714            backterms-get {
1715                set val [string trim [string range [readexp "${key}BAKGD "] 5 9]]
1716                if {$val == " "} {return 0}
1717                return $val
1718            }
1719            backterms-set {
1720                # this takes a bit of work -- if terms are added, add lines as needed to the .EXP
1721                set oldval [string trim [string range [readexp "${key}BAKGD "] 5 9]]
1722                if ![validint value 5] {return 0}
1723                if {$oldval < $value} {
1724                    set line1  [expr {2 + ($oldval - 1) / 4}]
1725                    set line2  [expr {1 + ($value - 1) / 4}]
1726                    for {set i $line1} {$i <= $line2} {incr i} {
1727                        # create a blank entry if needed
1728                        makeexprec ${key}BAKGD$i
1729                    }
1730                    incr oldval
1731                    for {set num $oldval} {$num <= $value} {incr num} {
1732                        set f1 [expr {15*(($num - 1) % 4)}]
1733                        set f2 [expr {15*(1 + ($num - 1) % 4)-1}]
1734                        set line  [expr {1 + ($num - 1) / 4}]
1735                        if {[string trim [string range [readexp ${key}BAKGD$line] $f1 $f2]] == ""} {
1736                            set f1 [expr {15*(($num - 1) % 4)+1}]
1737                            setexp ${key}BAKGD$line 0.0 $f1 15                 
1738                        }
1739                    }
1740                }
1741                setexp "${key}BAKGD " $value 6 5
1742
1743            }
1744            bref-get {
1745                if {[string toupper [string range [readexp "${key}BAKGD"] 14 14]] == "Y"} {
1746                    return 1
1747                }
1748                return 0
1749            }
1750            bref-set {
1751                if $value {
1752                    setexp "${key}BAKGD "  "Y" 15 1
1753                } else {
1754                    setexp "${key}BAKGD "  "N" 15 1
1755                }
1756            }
1757            bdamp-get {
1758                set val [string range [readexp "${key}BAKGD "] 19 19]
1759                if {$val == " "} {return 0}
1760                return $val
1761            }
1762            bdamp-set {
1763                setexp "${key}BAKGD " $value 20 1
1764            }
1765            bterm*-get {
1766                regsub bterm $parm {} num
1767                set f1 [expr {15*(($num - 1) % 4)}]
1768                set f2 [expr {15*(1 + ($num - 1) % 4)-1}]
1769                set line  [expr {1 + ($num - 1) / 4}]
1770                return [string trim [string range [readexp ${key}BAKGD$line] $f1 $f2] ]
1771            }
1772            bterm*-set {
1773                regsub bterm $parm {} num
1774                if ![validreal value 15 6] {return 0}
1775                set f1 [expr {15*(($num - 1) % 4)+1}]
1776                set line  [expr {1 + ($num - 1) / 4}]
1777                setexp ${key}BAKGD$line $value $f1 15
1778            }
1779            bank-get {
1780                return [string trim [string range [readexp "${key} BANK"] 0 4]]
1781            }
1782            tofangle-get {
1783                return [string trim [string range [readexp "${key}BNKPAR"] 10 19]]
1784            }
1785            tmin-get {
1786                return [string trim [string range [readexp "${key} TRNGE"] 0 9]]
1787            }
1788            tmax-get {
1789                return [string trim [string range [readexp "${key} TRNGE"] 10 19]]
1790            }
1791            excl-get {
1792                set n [string trim [string range [readexp "${key} NEXC"] 0 4]]
1793                set exlist {}
1794                for {set i 1} {$i <= $n} {incr i} {
1795                    set line [readexp [format "${key}EXC%3d" $i]]
1796                    lappend exlist [list \
1797                            [string trim [string range $line  0  9]] \
1798                            [string trim [string range $line 10 19]]]
1799                }
1800                return $exlist
1801            }
1802            excl-set {
1803                set n [llength $value]
1804                if ![validint n 5] {return 0}
1805                setexp "${key} NEXC" $n 1 5
1806                set i 0
1807                foreach p $value {
1808                    incr i
1809                    foreach {r1 r2} $p {}
1810                    validreal r1 10 3
1811                    validreal r2 10 3
1812                    set k [format "${key}EXC%3d" $i]
1813                    if {![existsexp $k]} {
1814                        makeexprec $k
1815                    }
1816                    setexp $k ${r1}${r2} 1 20
1817                }
1818                # set the powpref warning (2 = required)
1819                catch {
1820                    global expgui
1821                    set expgui(needpowpref) 2
1822                    set msg "Excluded regions" 
1823                    if {[string first $msg $expgui(needpowpref_why)] == -1} {
1824                        append expgui(needpowpref_why) "\t$msg were changed\n"
1825                    }
1826                }
1827            }
1828            file-get {
1829                return [string trim [readexp "${key}  HFIL"] ]
1830            }
1831            file-set {
1832                setexp "${key}  HFIL" $value 3 65
1833            }
1834            bank-get {
1835                return [string trim [string range [readexp "${key} BANK"] 0 4]]
1836            }
1837            dmin-get {
1838                return [string trim [string range [readexp "${key} NREF"] 5 14]]
1839            }
1840            dmin-set {
1841                if ![validreal value 10 4] {return 0}
1842                setexp "${key} NREF" $value 6 10
1843                # set the powpref warning (2 = required)
1844                catch {
1845                    global expgui
1846                    set expgui(needpowpref) 2
1847                    set msg "Dmin (reflection range)" 
1848                    if {[string first $msg $expgui(needpowpref_why)] == -1} {
1849                        append expgui(needpowpref_why) "\t$msg was changed\n"
1850                    }
1851                }
1852            }
1853            use-get {
1854                set k [expr {($hist+11)/12}]
1855                set line [readexp " EXPR  HTYP$k"]
1856                set j [expr {((($hist-1) % 12)+1)*5}]
1857                if {[string range $line $j $j] == "*"} {return 0}
1858                return 1
1859            }
1860            use-set {
1861                set k [expr {($hist+11)/12}]
1862                set line [readexp " EXPR  HTYP$k"]
1863                set j [expr {((($hist-1) % 12)+1)*5+1}]
1864                if {$value} {
1865                    setexp " EXPR  HTYP$k" " " $j 1
1866                } else {
1867                    setexp " EXPR  HTYP$k" "*" $j 1
1868                }
1869                # set the powpref warning (2 = required)
1870                catch {
1871                    global expgui
1872                    set expgui(needpowpref) 2
1873                    set msg "Histogram use flags" 
1874                    if {[string first $msg $expgui(needpowpref_why)] == -1} {
1875                        append expgui(needpowpref_why) "\t$msg were changed\n"
1876                    }
1877                }
1878            }
1879            dstart-get {
1880                return [string trim [string range [readexp "${key} DUMMY"] 20 29]]
1881            }
1882            dstart-set {
1883                if ![validreal value 10 3] {return 0}
1884                setexp "${key} DUMMY" $value 21 10
1885                # set the powpref warning (1 = suggested)
1886                catch {
1887                    global expgui
1888                    if {$expgui(needpowpref) == 0} {set expgui(needpowpref) 1}
1889                    set msg "Dummy histogram parameters" 
1890                    if {[string first $msg $expgui(needpowpref_why)] == -1} {
1891                        append expgui(needpowpref_why) "\t$msg were changed\n"
1892                    }
1893                }
1894            }
1895            dstep-get {
1896                return [string trim [string range [readexp "${key} DUMMY"] 30 39]]
1897            }
1898            dstep-set {
1899                if ![validreal value 10 3] {return 0}
1900                setexp "${key} DUMMY" $value 31 10
1901                catch {
1902                    global expgui
1903                    if {$expgui(needpowpref) == 0} {set expgui(needpowpref) 1}
1904                    set msg "Dummy histogram parameters" 
1905                    if {[string first $msg $expgui(needpowpref_why)] == -1} {
1906                        append expgui(needpowpref_why) "\t$msg were changed\n"
1907                    }
1908                }
1909            }
1910            dpoints-get {
1911                return [string trim [string range [readexp "${key} DUMMY"] 0 9]]
1912            }
1913            dpoints-set {
1914                if ![validint value 10] {return 0}
1915                setexp "${key} DUMMY" $value 1 10
1916                catch {
1917                    global expgui
1918                    if {$expgui(needpowpref) == 0} {set expgui(needpowpref) 1}
1919                    set msg "Dummy histogram parameters" 
1920                    if {[string first $msg $expgui(needpowpref_why)] == -1} {
1921                        append expgui(needpowpref_why) "\t$msg were changed\n"
1922                    }
1923                }
1924            }
1925            dtype-get {
1926                return [string trim [string range [readexp "${key} DUMMY"] 10 19]]
1927            }
1928            abscor1-get {
1929                return [string trim [string range [readexp "${key}ABSCOR"] 0 14]]
1930            }
1931            abscor1-set {
1932                if ![validreal value 15 7] {return 0}
1933                setexp "${key}ABSCOR" $value 1 15
1934            }
1935            abscor2-get {
1936                return [string trim [string range [readexp "${key}ABSCOR"] 15 29]]
1937            }
1938            abscor2-set {
1939                # this must have a decimal as the 5th character, so that we end up with a
1940                # decimal point in column 20.
1941                set tmp $value
1942                if ![validreal tmp 12 7] {return 0}
1943                set pos [string first "." $tmp]
1944                while {$pos < 4} {
1945                    set tmp " $tmp"
1946                    set pos [string first "." $tmp]
1947                }
1948                if {$pos == 4} {
1949                    setexp "${key}ABSCOR" $tmp 16 15
1950                    return
1951                }
1952                catch {
1953                    set tmp [format "%12.6E" $value]
1954                    set pos [string first "." $tmp]
1955                    while {$pos < 4} {
1956                        set tmp " $tmp"
1957                        set pos [string first "." $tmp]
1958                    }
1959                    if {$pos == 4} {
1960                        setexp "${key}ABSCOR" $tmp 16 15
1961                        return
1962                    }
1963                }
1964                return 0
1965            }
1966            abstype-get {
1967                set val [string trim [string range [readexp "${key}ABSCOR"] 40 44]]
1968                if {$val == ""} {set val 0}
1969                return $val
1970            }
1971            abstype-set {
1972                if ![validint value 5] {return 0}
1973                setexp "${key}ABSCOR" $value 41 5
1974            }
1975            absdamp-get {
1976                set val [string range [readexp "${key}ABSCOR"] 39 39]
1977                if {$val == " "} {return 0}
1978                return $val
1979            }
1980            absdamp-set {
1981                if ![validint value 5] {return 0}
1982                setexp "${key}ABSCOR" $value 36 5
1983            }
1984            absref-get {
1985                if {[string toupper \
1986                        [string range [readexp "${key}ABSCOR"] 34 34]] == "Y"} {
1987                    return 1
1988                }
1989                return 0
1990            }
1991            absref-set {
1992                if $value {
1993                    setexp "${key}ABSCOR" "    Y" 31 5
1994                } else {
1995                    setexp "${key}ABSCOR" "    N" 31 5
1996                }
1997            }
1998            ITYP-get {
1999                return [string trim [readexp "${key}I ITYP"]]
2000            }
2001            proftbl-get {
2002                set line [readexp "${key}PAB3"]
2003                if {$line == ""} {return 0}
2004                set val [string trim [string range $line 0 4]]
2005                if {$val == ""} {return 0}
2006                return $val
2007            }
2008            anomff-get {
2009                set l {}
2010                foreach i {1 2 3 4 5 6 7 8 9} {
2011                    if {![existsexp "${key}FFANS$i"]} continue
2012                    set line [readexp "${key}FFANS$i"]
2013                    set elem [string trim [string range $line 2 9]]
2014                    set fp [string trim [string range $line 10 19]]
2015                    set fpp [string trim [string range $line 20 29]]
2016                    lappend l [list $elem $fp $fpp]
2017                }
2018                return $l
2019            }
2020            anomff-set {
2021                # match up input against elements in list.
2022                # change elements included, return any elements that are
2023                # not found.
2024                set errorlist {}
2025                foreach triplet $value {
2026                    foreach {e fp fpp} $triplet {}               
2027                    foreach i {1 2 3 4 5 6 7 8 9} {
2028                        if {![existsexp "${key}FFANS$i"]} continue
2029                        # note that the element name is not used or validated
2030                        set elem [string trim [string range \
2031                                                   [readexp "${key}FFANS$i"] 2 9]]
2032                        if {[string match -nocase $e $elem]} { 
2033                            if ![validreal fp 10 3] {return 0}
2034                            setexp "${key}FFANS$i" $fp 11 10
2035                            if ![validreal fpp 10 3] {return 0}
2036                            setexp "${key}FFANS$i" $fpp 21 10
2037                            set e {}
2038                            break
2039                        }
2040                    }
2041                    if {$e != ""} {
2042                        # oops, no match
2043                        lappend errorlist $e
2044                    }
2045                }
2046                if {$errorlist != ""} {return [list 0 $errorlist]}
2047            }
2048            default {
2049                set msg "Unsupported histinfo access: parm=$parm action=$action"
2050                tk_dialog .badexp "Error in readexp" $msg error 0 Exit
2051            }
2052        }
2053    }
2054    return 1
2055}
2056
2057# read the information that differs by both histogram and phase (profile & phase fraction)
2058# use: hapinfo hist phase parm action value
2059
2060#     frac -- phase fraction (*)
2061#     frref/frdamp -- refinement flag/damping value for the phase fraction (*)
2062#     proftype -- profile function number (*)
2063#     profterms -- number of profile terms (*)
2064#     pdamp -- damping value for the profile (*)
2065#     pcut -- cutoff value for the profile (*)
2066#     pterm$n -- profile term #n (*)
2067#     pref$n -- refinement flag value for profile term #n (*)
2068#     extmeth -- Fobs extraction method (*)
2069#     POnaxis -- number of defined M-D preferred axes
2070proc hapinfo {histlist phaselist parm "action get" "value {}"} {
2071    foreach phase $phaselist hist $histlist {
2072        if {$phase == ""} {set phase [lindex $phaselist end]}
2073        if {$hist == ""} {set hist [lindex $histlist end]}
2074        if {$hist < 10} {
2075            set hist " $hist"
2076        }
2077        set key "HAP${phase}${hist}"
2078        switch -glob ${parm}-$action {
2079            extmeth-get {
2080                set i1 [expr {($phase - 1)*5}]
2081                set i2 [expr {$i1 + 4}]
2082                return [string trim [string range [readexp "HST $hist EPHAS"] $i1 $i2]]
2083            }
2084            extmeth-set {
2085                set i1 [expr {($phase - 1)*5 + 1}]
2086                if ![validint value 5] {return 0}
2087                setexp "HST $hist EPHAS" $value $i1 5
2088            }
2089            frac-get {
2090                return [string trim [string range [readexp ${key}PHSFR] 0 14]]
2091            }
2092            frac-set {
2093                if ![validreal value 15 6] {return 0}
2094                setexp ${key}PHSFR $value 1 15
2095            }
2096            frref-get {
2097                if {[string toupper [string range [readexp ${key}PHSFR] 19 19]] == "Y"} {
2098                    return 1
2099                }
2100                return 0
2101            }
2102            frref-set {
2103                if $value {
2104                    setexp ${key}PHSFR "Y" 20 1
2105                } else {
2106                    setexp ${key}PHSFR "N" 20 1
2107                }           
2108            }
2109            frdamp-get {
2110                set val [string range [readexp ${key}PHSFR] 24 24]
2111                if {$val == " "} {return 0}
2112                return $val
2113            }
2114            frdamp-set {
2115                setexp ${key}PHSFR $value 25 1
2116            }
2117            proftype-get {
2118                set val [string range [readexp "${key}PRCF "] 0 4]
2119                if {$val == " "} {return 0}
2120                return $val
2121            }
2122            proftype-set {
2123                if ![validint value 5] {return 0}
2124                setexp "${key}PRCF " $value 1 5
2125                # set the powpref warning (1 = suggested)
2126                catch {
2127                    global expgui
2128                    if {$expgui(needpowpref) == 0} {set expgui(needpowpref) 1}
2129                    set msg "Profile parameters" 
2130                    if {[string first $msg $expgui(needpowpref_why)] == -1} {
2131                        append expgui(needpowpref_why) "\t$msg were changed\n"
2132                    }
2133                }
2134            }
2135            profterms-get {
2136                set val [string range [readexp "${key}PRCF "] 5 9]
2137                if {$val == " "} {return 0}
2138                return $val
2139            }
2140            profterms-set {
2141                if ![validint value 5] {return 0}
2142                setexp "${key}PRCF " $value 6 5
2143                # now check that all needed entries exist
2144                set lines [expr {1 + ($value - 1) / 4}]
2145                for {set i 1} {$i <= $lines} {incr i} {
2146                    makeexprec "${key}PRCF $i"
2147                }
2148                # set the powpref warning (1 = suggested)
2149                catch {
2150                    global expgui
2151                    if {$expgui(needpowpref) == 0} {set expgui(needpowpref) 1}
2152                    set msg "Profile parameters" 
2153                    if {[string first $msg $expgui(needpowpref_why)] == -1} {
2154                        append expgui(needpowpref_why) "\t$msg were changed\n"
2155                    }
2156                }
2157            }
2158            pcut-get {
2159                return [string trim [string range [readexp "${key}PRCF "] 10 19]]
2160            }
2161            pcut-set {
2162                if ![validreal value 10 5] {return 0}
2163                setexp "${key}PRCF " $value 11 10
2164                # set the powpref warning (1 = suggested)
2165                catch {
2166                    global expgui
2167                    if {$expgui(needpowpref) == 0} {set expgui(needpowpref) 1}
2168                    set msg "Profile parameters" 
2169                    if {[string first $msg $expgui(needpowpref_why)] == -1} {
2170                        append expgui(needpowpref_why) "\t$msg were changed\n"
2171                    }
2172                }
2173            }
2174            pdamp-get {
2175                set val [string range [readexp "${key}PRCF "] 24 24]
2176                if {$val == " "} {return 0}
2177                return $val
2178            }
2179            pdamp-set {
2180                setexp "${key}PRCF   " $value 25 1
2181            }
2182            pterm*-get {
2183                regsub pterm $parm {} num
2184                set f1 [expr {15*(($num - 1) % 4)}]
2185                set f2 [expr {15*(1 + ($num - 1) % 4)-1}]
2186                set line  [expr {1 + ($num - 1) / 4}]
2187                return [string trim [string range [readexp "${key}PRCF $line"] $f1 $f2] ]
2188            }
2189            pterm*-set {
2190                if ![validreal value 15 6] {return 0}
2191                regsub pterm $parm {} num
2192                set f1 [expr {1+ 15*(($num - 1) % 4)}]
2193                set line  [expr {1 + ($num - 1) / 4}]
2194                setexp "${key}PRCF $line" $value $f1 15
2195                # set the powpref warning (1 = suggested)
2196                catch {
2197                    global expgui
2198                    if {$expgui(needpowpref) == 0} {set expgui(needpowpref) 1}
2199                    set msg "Profile parameters" 
2200                    if {[string first $msg $expgui(needpowpref_why)] == -1} {
2201                        append expgui(needpowpref_why) "\t$msg were changed\n"
2202                    }
2203                }
2204            }
2205            pref*-get {
2206                regsub pref $parm {} num
2207                set f [expr {24+$num}]
2208                if {[string toupper [string range [readexp "${key}PRCF  "] $f $f]] == "Y"} {
2209                    return 1
2210                }
2211                return 0
2212            }
2213            pref*-set {
2214                regsub pref $parm {} num
2215                set f [expr {25+$num}]
2216                if $value {
2217                    setexp ${key}PRCF "Y" $f 1
2218                } else {
2219                    setexp ${key}PRCF "N" $f 1
2220                }           
2221            }
2222            POnaxis-get {
2223                set val [string trim \
2224                        [string range [readexp "${key}NAXIS"] 0 4]]
2225                if {$val == ""} {return 0}
2226                return $val
2227            }
2228            POnaxis-set {
2229                if ![validint value 5] {return 0}
2230                # there should be a NAXIS record, but if not make one
2231                if {![existsexp "${key}NAXIS"]} {
2232                    makeexprec "${key}NAXIS"
2233                }
2234                setexp "${key}NAXIS  " $value 1 5
2235            }
2236            default {
2237                set msg "Unsupported hapinfo access: parm=$parm action=$action"
2238                tk_dialog .badexp "Error in readexp" $msg error 0 Exit
2239            }
2240        }
2241    }
2242    return 1
2243}
2244
2245#  read fixed constraints for a phase
2246proc atom_constraint_read {phase} {
2247    set fixlist ""
2248    foreach k {1 2 3 4 5 6 7 8 9} {
2249        set key [format "LEQV HOLD%1d%2d" $phase $k]
2250        set line [readexp $key]
2251        foreach j {2 10 18 26 34 42 50 58} {
2252            set fix_param [string range $line $j [expr $j+7]]
2253            if {[string trim $fix_param] == ""} {return $fixlist}
2254            lappend fixlist $fix_param
2255        }
2256    }
2257    return $fixlist
2258}
2259
2260# load all atom constraints into global array fix_param
2261proc atom_constraint_load { } {
2262    catch {unset ::fix_param}
2263    foreach i $::expmap(phaselist) {
2264        set temp [atom_constraint_read $i]
2265        foreach j $temp {
2266            set atomnum [string trim [string range $j 2 3]]
2267            set param [string trim [string range $j 4 6]]
2268            set ::fix_param($i,$atomnum,$param) 1   
2269        }
2270    }
2271}
2272
2273# returns 1 if the specified variable is fixed
2274proc atom_constraint_get {phase atom type} {
2275    if {[array names ::fix_param "$phase,$atom,$type"] == ""} {
2276        return 0
2277    }
2278    return 1
2279}
2280
2281proc atom_constraint_set {phase atomlist type mode} {
2282    foreach atom $atomlist {
2283        set key "$phase,$atom,$type"
2284        if {$mode} {
2285            set ::fix_param($key) 1
2286        } else {
2287            array unset ::fix_param $key
2288        }
2289    } 
2290    set fixlist {}
2291    foreach key [array names ::fix_param "$phase,*"] {
2292        foreach {j atom parm} [split $key ","] {}
2293        lappend fixlist \
2294            [format "%1s %+2s%-4s" $phase $atom $parm]
2295    }
2296    foreach key [array names ::exparray "LEQV HOLD$phase*"] {
2297        delexp $key
2298    }
2299    set k 0
2300    set j 1
2301    set line ""
2302    foreach fix $fixlist {
2303        incr k
2304        append line $fix
2305        if {$k == 8} {
2306            set key [format "LEQV HOLD%1d%2d" $phase $j]
2307            makeexprec $key
2308            setexp $key $line 3 [expr ($k * 8) + 2]
2309            set k 0
2310            incr j
2311            set line ""
2312        }
2313    }
2314    if {$line != ""} {
2315        set key [format "LEQV HOLD%1d%2d" $phase $j]
2316        makeexprec $key
2317        setexp $key $line 3 [expr ($k * 8) + 2]
2318    }   
2319}
2320
2321
2322#  get a logical constraint
2323#
2324#  type action
2325#  -----------
2326#  atom get  number        returns a list of constraints.
2327#   "   set  number value  replaces a list of constraints
2328#                          (value is a list of constraints)
2329#   "   add  number value  inserts a new list of constraints
2330#                          (number is ignored)
2331#   "   delete number      deletes a set of constraint entries
2332# Each item in the list of constraints is composed of 4 items:
2333#              phase, atom, variable, multiplier
2334# If variable=UISO atom can be ALL, otherwise atom is a number
2335# legal variable names: FRAC, X, Y, Z, UISO, U11, U22, U33, U12, U23, U13,
2336#                       MX, MY, MZ
2337#
2338#  type action
2339#  -----------
2340#  profileXX get number         returns a list of constraints for term XX=1-36
2341#                               use number=0 to get # of defined
2342#                                  constraints for term XX
2343#   "        set number value   replaces a list of constraints
2344#                               (value is a list of constraints)
2345#   "        add number value   inserts a new list of constraints
2346#                               (number is ignored)
2347#   "        delete number      deletes a set of constraint entries
2348# Each item in the list of constraints is composed of 3 items:
2349#              phase-list, histogram-list, multiplier
2350# Note that phase-list and/or histogram-list can be ALL
2351
2352proc constrinfo {type action number "value {}"} {
2353    global expmap
2354    if {[lindex $expmap(phasetype) 0] == 4} {
2355        set mm 1
2356    } else {
2357        set mm 0
2358    }
2359    switch -glob ${type}-$action {
2360        atom-get {
2361            # does this constraint exist?
2362            set key [format "LNCN%4d%4d" $number 1]
2363            if {![existsexp $key]} {return -1}
2364            set clist {}
2365            for {set i 1} {$i < 999} {incr i} {
2366                set key [format "LNCN%4d%4d" $number $i]
2367                if {![existsexp $key]} break
2368                set line [readexp $key]
2369                set j1 2
2370                set j2 17
2371                set seg [string range $line $j1 $j2]
2372                while {[string trim $seg] != ""} {
2373                    set p [string range $seg 0 0]
2374                    if {$p == 1 && $mm} {
2375                        set atom [string trim [string range $seg 1 4]]
2376                        set var [string trim [string range $seg 5 7]]
2377                        if {$atom == "ALL"} {
2378                            set var UIS
2379                        } else {
2380                            scan $atom %x atom
2381                        }
2382                        lappend clist [list $p $atom $var \
2383                                [string trim [string range $seg 8 end]]]
2384                    } else {
2385                        lappend clist [list $p \
2386                                [string trim [string range $seg 1 3]] \
2387                                [string trim [string range $seg 4 7]] \
2388                                [string trim [string range $seg 8 end]]]
2389                    }
2390                    incr j1 16
2391                    incr j2 16
2392                    set seg [string range $line $j1 $j2]
2393                }
2394            }
2395            return $clist
2396        }
2397        atom-set {
2398            # delete records for current constraint
2399            for {set i 1} {$i < 999} {incr i} {
2400                set key [format "LNCN%4d%4d" $number $i]
2401                if {![existsexp $key]} break
2402                delexp $key
2403            }
2404            set line {}
2405            set i 1
2406            foreach tuple $value {
2407                set p [lindex $tuple 0]
2408                if {$p == 1 && $mm && \
2409                        [string toupper [lindex $tuple 1]] == "ALL"} {
2410                    set seg [format %1dALL UIS%8.4f \
2411                            [lindex $tuple 0] \
2412                            [lindex $tuple 3]]
2413                } elseif {$p == 1 && $mm} {
2414                    set seg [eval format %1d%.4X%-3s%8.4f $tuple]
2415                } elseif {[string toupper [lindex $tuple 1]] == "ALL"} {
2416                    set seg [format %1dALL%-4s%8.4f \
2417                            [lindex $tuple 0] \
2418                            [lindex $tuple 2] \
2419                            [lindex $tuple 3]]
2420                } else {
2421                    set seg [eval format %1d%3d%-4s%8.4f $tuple]
2422                }
2423                append line $seg
2424                if {[string length $line] > 50} {
2425                    set key  [format "LNCN%4d%4d" $number $i]
2426                    makeexprec $key
2427                    setexp $key $line 3 68
2428                    set line {}
2429                    incr i
2430                }
2431            }
2432            if {$line != ""} {
2433                set key  [format "LNCN%4d%4d" $number $i]
2434                makeexprec $key
2435                setexp $key $line 3 68
2436            }
2437            return
2438        }
2439        atom-add {
2440            # loop over defined constraints
2441            for {set j 1} {$j < 9999} {incr j} {
2442                set key [format "LNCN%4d%4d" $j 1]
2443                if {![existsexp $key]} break
2444            }
2445            set number $j
2446            # save the constraint
2447            set line {}
2448            set i 1
2449            foreach tuple $value {
2450                set p [lindex $tuple 0]
2451                if {$p == 1 && $mm && \
2452                        [string toupper [lindex $tuple 1]] == "ALL"} {
2453                    set seg [format %1dALL UIS%8.4f \
2454                            [lindex $tuple 0] \
2455                            [lindex $tuple 3]]
2456                } elseif {$p == 1 && $mm} {
2457                    set seg [eval format %1d%.4X%-3s%8.4f $tuple]
2458                } elseif {[string toupper [lindex $tuple 1]] == "ALL"} {
2459                    set seg [format %1dALL%-4s%8.4f \
2460                            [lindex $tuple 0] \
2461                            [lindex $tuple 2] \
2462                            [lindex $tuple 3]]
2463                } else {
2464                    set seg [eval format %1d%3d%-4s%8.4f $tuple]
2465                }
2466                append line $seg
2467                if {[string length $line] > 50} {
2468                    set key  [format "LNCN%4d%4d" $number $i]
2469                    makeexprec $key
2470                    setexp $key $line 3 68
2471                    set line {}
2472                    incr i
2473                }
2474            }
2475            if {$line != ""} {
2476                set key  [format "LNCN%4d%4d" $number $i]
2477                makeexprec $key
2478                setexp $key $line 3 68
2479            }
2480            return
2481        }
2482        atom-delete {
2483            for {set j $number} {$j < 9999} {incr j} {
2484                # delete records for current constraint
2485                for {set i 1} {$i < 999} {incr i} {
2486                    set key [format "LNCN%4d%4d" $j $i]
2487                    if {![existsexp $key]} break
2488                    delexp $key
2489                }
2490                # now copy records, from the next entry, if any
2491                set j1 $j
2492                incr j1
2493                set key1 [format "LNCN%4d%4d" $j1 1]
2494                # if there is no record, there is nothing to copy -- done
2495                if {![existsexp $key1]} return
2496                for {set i 1} {$i < 999} {incr i} {
2497                    set key1 [format "LNCN%4d%4d" $j1 $i]
2498                    if {![existsexp $key1]} break
2499                    set key  [format "LNCN%4d%4d" $j  $i]
2500                    makeexprec $key
2501                    setexp $key [readexp $key1] 1 68
2502                }
2503            }
2504        }
2505        profile*-delete {
2506            regsub profile $type {} term
2507            if {$term < 10} {
2508                set term " $term"
2509            }
2510            set key "LEQV PF$term   "
2511            # return nothing if no term exists
2512            if {![existsexp $key]} {return 0}
2513
2514            # number of constraint terms
2515            set nterms [string trim [string range [readexp ${key}] 0 4] ]
2516            # don't delete a non-existing entry
2517            if {$number > $nterms} {return 0}
2518            set val [expr {$nterms - 1}]
2519            validint val 5
2520            setexp $key $val 1 5
2521            for {set i1 $number} {$i1 < $nterms} {incr i1} {
2522                set i2 [expr {1 + $i1}]
2523                # move the contents of constraint #i2 -> i1
2524                if {$i1 > 9} {
2525                    set k1 [expr {($i1+1)/10}]
2526                    set l1 $i1
2527                } else {
2528                    set k1 " "
2529                    set l1 " $i1"
2530                }
2531                set key1 "LEQV PF$term  $k1"
2532                # number of constraint lines for #i1
2533                set n1 [string trim [string range [readexp ${key1}] \
2534                        [expr {($i1%10)*5}] [expr {4+(($i1%10)*5)}]] ]
2535                if {$i2 > 9} {
2536                    set k2 [expr {($i2+1)/10}]
2537                    set l2 $i2
2538                } else {
2539                    set k2 " "
2540                    set l2 " $i2"
2541                }
2542                set key2 "LEQV PF$term  $k2"
2543                # number of constraint lines for #i2
2544                set n2 [string trim [string range [readexp ${key2}] \
2545                        [expr {($i2%10)*5}] [expr {4+(($i2%10)*5)}]] ]
2546                set val $n2
2547                validint val 5
2548                # move the # of terms
2549                setexp $key1 $val [expr {1+(($i1%10)*5)}] 5
2550                # move the terms
2551                for {set j 1} {$j <= $n2} {incr j 1} {
2552                    set key "LEQV PF${term}${l1}$j"
2553                    makeexprec $key
2554                    setexp $key [readexp "LEQV PF${term}${l2}$j"] 1 68
2555                }
2556                # delete any remaining lines
2557                for {set j [expr {$n2+1}]} {$j <= $n1} {incr j 1} {
2558                    delexp "LEQV PF${term}${l1}$j"
2559                }
2560            }
2561
2562            # clear the last term
2563            if {$nterms > 9} {
2564                set i [expr {($nterms+1)/10}]
2565            } else {
2566                set i " "
2567            }
2568            set key "LEQV PF$term  $i"
2569            set cb [expr {($nterms%10)*5}]
2570            set ce [expr {4+(($nterms%10)*5)}]
2571            set n2 [string trim [string range [readexp ${key}] $cb $ce] ]
2572            incr cb
2573            setexp $key "     " $cb 5
2574            # delete any remaining lines
2575            for {set j 1} {$j <= $n2} {incr j 1} {
2576                delexp "LEQV PF${term}${nterms}$j"
2577            }
2578        }
2579        profile*-set {
2580            regsub profile $type {} term
2581            if {$term < 10} {
2582                set term " $term"
2583            }
2584            set key "LEQV PF$term   "
2585            # get number of constraint terms
2586            set nterms [string trim [string range [readexp ${key}] 0 4] ]
2587            # don't change a non-existing entry
2588            if {$number > $nterms} {return 0}
2589            if {$number > 9} {
2590                set k1 [expr {($number+1)/10}]
2591                set l1 $number
2592            } else {
2593                set k1 " "
2594                set l1 " $number"
2595            }
2596            set key1 "LEQV PF$term  $k1"
2597            # old number of constraint lines
2598            set n1 [string trim [string range [readexp ${key1}] \
2599                    [expr {($number%10)*5}] [expr {4+(($number%10)*5)}]] ]
2600            # number of new constraints
2601            set j2 [llength $value]
2602            # number of new constraint lines
2603            set val [set n2 [expr {($j2 + 2)/3}]]
2604            # store the new # of lines
2605            validint val 5
2606            setexp $key1 $val [expr {1+(($number%10)*5)}] 5
2607
2608            # loop over the # of lines in the old or new, whichever is greater
2609            set v0 0
2610            for {set j 1} {$j <= [expr {($n1 > $n2) ? $n1 : $n2}]} {incr j 1} {
2611                set key "LEQV PF${term}${l1}$j"
2612                # were there more lines in the old?
2613                if {$j > $n2} {
2614                    # this line is not needed
2615                    if {$j % 3 == 1} {
2616                        delexp %key
2617                    }
2618                    continue
2619                }
2620                # are we adding new lines?
2621                if {$j > $n1} {
2622                    makeexprec $key
2623                }
2624                # add the three constraints to the line
2625                foreach s {3 23 43} \
2626                        item [lrange $value $v0 [expr {2+$v0}]] {
2627                    if {$item != ""} {
2628                        set val [format %-10s%9.3f \
2629                                [lindex $item 0],[lindex $item 1] \
2630                                [lindex $item 2]]
2631                        setexp $key $val $s 19
2632                    } else {
2633                        setexp $key " " $s 19
2634                    }
2635                }
2636                incr v0 3
2637            }
2638        }
2639        profile*-add {
2640            regsub profile $type {} term
2641            if {$term < 10} {
2642                set term " $term"
2643            }
2644            set key "LEQV PF$term   "
2645            if {![existsexp $key]} {makeexprec $key}
2646            set nterms [string trim [string range [readexp ${key}] 0 4] ]
2647            if {$nterms == ""} {
2648                set nterms 1
2649            } elseif {$nterms >= 99} {
2650                return 0
2651            } else {
2652                incr nterms
2653            }
2654            # store the new # of constraints
2655            set val $nterms
2656            validint val 5
2657            setexp $key $val 1 5
2658
2659            if {$nterms > 9} {
2660                set k1 [expr {($nterms+1)/10}]
2661                set l1 $nterms
2662            } else {
2663                set k1 " "
2664                set l1 " $nterms"
2665            }
2666            set key1 "LEQV PF$term  $k1"
2667
2668            # number of new constraints
2669            set j2 [llength $value]
2670            # number of new constraint lines
2671            set val [set n2 [expr {($j2 + 2)/3}]]
2672            # store the new # of lines
2673            validint val 5
2674            setexp $key1 $val [expr {1+(($nterms%10)*5)}] 5
2675
2676            # loop over the # of lines to be added
2677            set v0 0
2678            for {set j 1} {$j <= $n2} {incr j 1} {
2679                set key "LEQV PF${term}${l1}$j"
2680                makeexprec $key
2681                # add the three constraints to the line
2682                foreach s {3 23 43} \
2683                        item [lrange $value $v0 [expr {2+$v0}]] {
2684                    if {$item != ""} {
2685                        set val [format %-10s%9.3f \
2686                                [lindex $item 0],[lindex $item 1] \
2687                                [lindex $item 2]]
2688                        setexp $key $val $s 19
2689                    } else {
2690                        setexp $key " " $s 19
2691                    }
2692                }
2693                incr v0 3
2694            }
2695        }
2696        profile*-get {
2697            regsub profile $type {} term
2698            if {$term < 10} {
2699                set term " $term"
2700            }
2701            if {$number > 9} {
2702                set i [expr {($number+1)/10}]
2703            } else {
2704                set i " "
2705            }
2706            set key "LEQV PF$term  $i"
2707            # return nothing if no term exists
2708            if {![existsexp $key]} {return 0}
2709            # number of constraint lines
2710           
2711            set numline [string trim [string range [readexp ${key}] \
2712                    [expr {($number%10)*5}] [expr {4+(($number%10)*5)}]] ]
2713            if {$number == 0} {return $numline}
2714            set clist {}
2715            if {$number < 10} {
2716                set number " $number"
2717            }
2718            for {set i 1} {$i <= $numline} {incr i} {
2719                set key "LEQV PF${term}${number}$i"
2720                set line [readexp ${key}]
2721                foreach s {1 21 41} e {20 40 60} {
2722                    set seg [string range $line $s $e]
2723                    if {[string trim $seg] == ""} continue
2724                    # parse the string segment
2725                    set parse [regexp { *([0-9AL]+),([0-9AL]+) +([0-9.]+)} \
2726                            $seg junk phase hist mult]
2727                    # was parse successful
2728                    if {!$parse} {continue}
2729                    lappend clist [list $phase $hist $mult]
2730                }
2731            }
2732            return $clist
2733        }
2734        default {
2735            set msg "Unsupported constrinfo access: type=$type action=$action"
2736            tk_dialog .badexp "Error in readexp access" $msg error 0 OK
2737        }
2738
2739    }
2740}
2741
2742# read the default profile information for a histogram
2743# use: profdefinfo hist set# parm action
2744
2745#     proftype -- profile function number
2746#     profterms -- number of profile terms
2747#     pdamp -- damping value for the profile (*)
2748#     pcut -- cutoff value for the profile (*)
2749#     pterm$n -- profile term #n
2750#     pref$n -- refinement flag value for profile term #n (*)
2751
2752proc profdefinfo {hist set parm "action get"} {
2753    global expgui
2754    if {$hist < 10} {
2755        set key "HST  $hist"
2756    } else {
2757        set key "HST $hist"
2758    }
2759    switch -glob ${parm}-$action {
2760        proftype-get {
2761            set val [string range [readexp "${key}PRCF$set"] 0 4]
2762            if {$val == " "} {return 0}
2763            return $val
2764        }
2765        profterms-get {
2766            set val [string range [readexp "${key}PRCF$set"] 5 9]
2767            if {$val == " "} {return 0}
2768            return $val
2769        }
2770        pcut-get {
2771            return [string trim [string range [readexp "${key}PRCF$set"] 10 19]]
2772        }
2773        pdamp-get {
2774                set val [string range [readexp "${key}PRCF$set"] 24 24]
2775            if {$val == " "} {return 0}
2776            return $val
2777        }
2778        pterm*-get {
2779            regsub pterm $parm {} num
2780            set f1 [expr {15*(($num - 1) % 4)}]
2781            set f2 [expr {15*(1 + ($num - 1) % 4)-1}]
2782            set line  [expr {1 + ($num - 1) / 4}]
2783            return [string trim [string range [\
2784                        readexp "${key}PRCF${set}$line"] $f1 $f2] ]
2785        }
2786        pref*-get {
2787            regsub pref $parm {} num
2788            set f [expr {24+$num}]
2789            if {[string toupper [string range [readexp "${key}PRCF$set"] $f $f]] == "Y"} {
2790                return 1
2791            }
2792            return 0
2793        }
2794        default {
2795            set msg "Unsupported profdefinfo access: parm=$parm action=$action"
2796            tk_dialog .badexp "Code Error" $msg error 0 Exit
2797        }
2798    }
2799}
2800
2801# get March-Dollase preferred orientation information
2802# use MDprefinfo hist phase axis-number parm action value
2803#    ratio    -- ratio of xtallites in PO direction vs random (>1 for more)
2804#    fraction -- fraction in this direction, when more than one axis is used
2805#    h k & l  -- indices of P.O. axis
2806#    ratioref -- flag to vary ratio
2807#    fracref  -- flag to vary fraction
2808#    damp     -- damping value
2809#    type     -- model type (0 = P.O. _|_ to beam, 1 = || to beam)
2810#    new      -- creates a new record with default values (set only)
2811proc MDprefinfo {histlist phaselist axislist parm "action get" "value {}"} {
2812    foreach phase $phaselist hist $histlist axis $axislist {
2813        if {$phase == ""} {set phase [lindex $phaselist end]}
2814        if {$hist == ""} {set hist [lindex $histlist end]}
2815        if {$axis == ""} {set axis [lindex $axislist end]}
2816        if {$hist < 10} {
2817            set hist " $hist"
2818        }
2819        if {$axis > 9} {
2820            set axis "0"
2821        }
2822        set key "HAP${phase}${hist}PREFO${axis}"
2823        switch -glob ${parm}-$action {
2824            ratio-get {
2825                return [string trim [string range [readexp $key] 0 9]]
2826            }
2827            ratio-set {
2828                if ![validreal value 10 6] {return 0}
2829                setexp $key $value 1 10
2830            }
2831            fraction-get {
2832                return [string trim [string range [readexp $key] 10 19]]
2833            }
2834            fraction-set {
2835                if ![validreal value 10 6] {return 0}
2836                setexp $key $value 11 10
2837            }
2838            h-get {
2839                set h [string trim [string range [readexp $key] 20 29]]
2840                # why not allow negative h values?
2841                #               if {$h < 1} {return 0}
2842                return $h
2843            }
2844            h-set {
2845                if ![validreal value 10 2] {return 0}
2846                setexp $key $value 21 10
2847            }
2848            k-get {
2849                set k [string trim [string range [readexp $key] 30 39]]
2850                #               if {$k < 1} {return 0}
2851                return $k
2852            }
2853            k-set {
2854                if ![validreal value 10 2] {return 0}
2855                setexp $key $value 31 10
2856            }
2857            l-get {
2858                set l [string trim [string range [readexp $key] 40 49]]
2859                #if {$l < 1} {return 0}
2860                return $l
2861            }
2862            l-set {
2863                if ![validreal value 10 2] {return 0}
2864                setexp $key $value 41 10
2865            }
2866            ratioref-get {
2867                if {[string toupper \
2868                        [string range [readexp $key] 53 53]] == "Y"} {
2869                    return 1
2870                }
2871                return 0
2872            }
2873            ratioref-set {
2874                if $value {
2875                    setexp $key "Y" 54 1
2876                } else {
2877                    setexp $key "N" 54 1
2878                }
2879            }
2880            fracref-get {
2881                if {[string toupper \
2882                        [string range [readexp $key] 54 54]] == "Y"} {
2883                    return 1
2884                }
2885                return 0
2886            }
2887            fracref-set {
2888                if $value {
2889                    setexp $key "Y" 55 1
2890                } else {
2891                    setexp $key "N" 55 1
2892              }
2893            }
2894            damp-get {
2895                set val [string trim [string range [readexp $key] 59 59]]
2896                if {$val == " "} {return 0}
2897                return $val
2898            }
2899            damp-set {
2900                setexp $key $value 60 1
2901            }
2902            type-get {
2903                set val [string trim [string range [readexp $key] 64 64]]
2904                if {$val == " "} {return 0}
2905                return $val
2906            }
2907            type-set {
2908                # only valid settings are 0 & 1
2909                if {$value != "0" && $value != "1"} {set value "0"}
2910                setexp $key $value 65 1
2911            }
2912            new-set {
2913                makeexprec $key
2914                setexp $key \
2915                        {  1.000000  1.000000  0.000000  0.000000  1.000000   NN    0    0} \
2916                        1 68
2917            }
2918            default {
2919                set msg "Unsupported MDprefinfo access: parm=$parm action=$action"
2920                tk_dialog .badexp "Error in readexp" $msg error 0 Exit
2921            }
2922
2923        }
2924
2925    }
2926}
2927
2928# get list of defined atom types
2929proc AtmTypList {} {
2930    set natypes [readexp " EXPR  NATYP"]
2931    if {$natypes == ""} return
2932    set j 0
2933    set typelist {}
2934    for {set i 1} {$i <= $natypes} {incr i} {
2935        set key {this should never be matched}
2936        while {![existsexp $key]} {
2937            incr j
2938            if {$j > 99} {
2939                return $typelist
2940            } elseif {$j <10} {
2941                set key " EXPR ATYP $j"
2942            } else {
2943                set key " EXPR ATYP$j"
2944            }
2945        }
2946        lappend typelist [string trim [string range $::exparray($key) 2 9]]
2947    }
2948    return $typelist
2949}
2950
2951# read information about atom types
2952#     distrad    atomic distance search radius (get/set)
2953#     angrad     atomic angle search radius (get/set)
2954proc AtmTypInfo {parm atmtype "action get" "value {}"} {
2955    # first, search through the records to find the record matching the type
2956    set natypes [readexp " EXPR  NATYP"]
2957    if {$natypes == ""} return
2958    set j 0
2959    set typelist {}
2960    for {set i 1} {$i <= $natypes} {incr i} {
2961        set key {this should never be matched}
2962        while {![existsexp $key]} {
2963            incr j
2964            if {$j > 99} {
2965                return $typelist
2966            } elseif {$j <10} {
2967                set key " EXPR ATYP $j"
2968            } else {
2969                set key " EXPR ATYP$j"
2970            }
2971        }
2972        if {[string toupper $atmtype] == \
2973                [string toupper [string trim [string range $::exparray($key) 2 9]]]} break
2974        set key {}
2975    }
2976    if {$key == ""} {
2977        # atom type not found
2978        return {}
2979    }
2980    switch -glob ${parm}-$action {
2981        distrad-get {
2982            return [string trim [string range [readexp $key] 15 24]]
2983        }
2984        distrad-set {
2985            if ![validreal value 10 2] {return 0}
2986            setexp $key $value 16 10
2987        }
2988        angrad-get {
2989            return [string trim [string range [readexp $key] 25 34]]
2990        }
2991        angrad-set {
2992            if ![validreal value 10 2] {return 0}
2993            setexp $key $value 26 10
2994        }
2995        default {
2996            set msg "Unsupported AtmTypInfo access: parm=$parm action=$action"
2997            tk_dialog .badexp "Error in readexp" $msg error 0 Exit
2998        }
2999    }
3000}
3001# read default information about atom types (records copied to the .EXP file
3002# from the gsas/data/atomdata.dat file as AFAC ...
3003#     distrad returns a list of atom types (one or two letters) and
3004#                the corresponding distance
3005# note that these values are read only (no set option)
3006proc DefAtmTypInfo {parm} {
3007    set keys [array names ::exparray " AFAC *_SIZ"]
3008    set elmlist {}
3009    if {[llength $keys] <= 0} {return ""}
3010    foreach key $keys {
3011        lappend elmlist [string trim [string range $key 6 7]]
3012    }
3013    switch -glob ${parm} {
3014        distrad {
3015            set out {}
3016            foreach key $keys elm $elmlist {
3017                set val [string range $::exparray($key) 0 9]
3018                lappend out "$elm [string trim $val]"
3019            }
3020            return $out
3021        }
3022        angrad {
3023            set out {}
3024            foreach key $keys elm $elmlist {
3025                set val [string range $::exparray($key) 10 19]
3026                lappend out "$elm [string trim $val]"
3027            }
3028            return $out
3029        }
3030        default {
3031            set msg "Unsupported DefAtmTypInfo access: parm=$parm"
3032            tk_dialog .badexp "Error in readexp" $msg error 0 Exit
3033        }
3034    }
3035}
3036# write the .EXP file
3037proc expwrite {expfile} {
3038    global exparray
3039    set blankline \
3040     "                                                                        "
3041    set fp [open ${expfile} w]
3042    fconfigure $fp -translation crlf -encoding ascii
3043    set keylist [lsort [array names exparray]]
3044    # reorder the keys so that VERSION comes 1st
3045    set pos [lsearch -exact $keylist {     VERSION}]
3046    set keylist "{     VERSION} [lreplace $keylist $pos $pos]"
3047    foreach key $keylist {
3048        puts $fp [string range \
3049                "$key$exparray($key)$blankline" 0 79]
3050    }
3051    close $fp
3052}
3053
3054# history commands -- delete all but last $keep history records,
3055# renumber if $renumber is true
3056proc DeleteHistory {keep renumber} {
3057    global exparray
3058    foreach y [lrange [lsort -decreasing \
3059            [array names exparray {    HSTRY*}]] $keep end] {
3060        unset exparray($y)
3061    }
3062    if !$renumber return
3063    # renumber
3064    set i 0
3065    foreach y [lsort -increasing \
3066            [array names exparray {    HSTRY*}]] {
3067        set key [format "    HSTRY%3d" [incr i]]
3068        set exparray($key) $exparray($y)
3069        unset exparray($y)
3070    }
3071    # list all history
3072    #    foreach y [lsort -decreasing [array names exparray {    HSTRY*}]] {puts "$y $exparray($y)"}
3073}
3074
3075proc CountHistory {} {
3076    global exparray
3077    return [llength [array names exparray {    HSTRY*}]]
3078}
3079
3080# set the phase flags for histogram $hist to $plist
3081proc SetPhaseFlag {hist plist} {
3082    # make a 2 digit key -- hh
3083    if {$hist < 10} {
3084        set hh " $hist"
3085    } else {
3086        set hh $hist
3087    }
3088    set key "HST $hh NPHAS"
3089    set str {}
3090    foreach iph {1 2 3 4 5 6 7 8 9} {
3091        if {[lsearch $plist $iph] != -1} {
3092            append str {    1}
3093        } else {
3094            append str {    0}     
3095        }
3096    }
3097    setexp $key $str 1 68
3098}
3099
3100# erase atom $atom from phase $phase
3101# update the list of atom types, erasing the record if not needed.
3102proc EraseAtom {atom phase} {
3103    set type [atominfo $phase $atom type]
3104    if {$type == ""} return
3105    if {$atom < 10} {
3106        set key "CRS$phase  AT  $atom"
3107    } elseif {$atom < 100} {
3108        set key "CRS$phase  AT $atom"
3109    } else {
3110        set key "CRS$phase  AT$atom"
3111    }
3112    # delete the records for the atom
3113    global exparray
3114    foreach k [array names exparray ${key}*] {
3115        delexp $k
3116    }
3117    # change the number of atoms in the phase
3118    phaseinfo $phase natoms set [expr {[phaseinfo $phase natoms] -1}]
3119
3120    # now adjust numbers in "EXPR ATYP" records and delete, if needed.
3121    set natypes [readexp " EXPR  NATYP"]
3122    if {$natypes == ""} return
3123    set j 0
3124    for {set i 1} {$i <= $natypes} {incr i} {
3125        incr j
3126        if {$j <10} {
3127            set key " EXPR ATYP $j"
3128        } else {
3129            set key " EXPR ATYP$j"
3130        }
3131        while {![existsexp $key]} {
3132            incr j
3133            if {$j > 99} {
3134                return
3135            } elseif {$j <10} {
3136                set key " EXPR ATYP $j"
3137            } else {
3138                set key " EXPR ATYP$j"
3139            }
3140        }
3141        set keytype [string trim [string range $exparray($key) 2 9]]
3142        if {$type == $keytype} {
3143            # found the type record
3144            set val [string trim [string range $exparray($key) 10 14]]
3145            incr val -1
3146            # if this is the last reference, remove the record,
3147            # otherwise, decrement the counter
3148            if {$val <= 0} {
3149                incr natypes -1 
3150                validint natypes 5
3151                setexp " EXPR  NATYP" $natypes 1 5
3152                delexp $key
3153            } else {
3154                validint val 5
3155                setexp $key $val 11 5
3156            }
3157            return
3158        }
3159    }
3160}
3161
3162# compute equivalent anisotropic temperature factor for Uequiv
3163proc CalcAniso {phase Uequiv} {
3164    foreach var {a b c alpha beta gamma} {
3165        set $var [phaseinfo $phase $var]
3166    }
3167
3168    set G(1,1) [expr {$a * $a}]
3169    set G(2,2) [expr {$b * $b}]
3170    set G(3,3) [expr {$c * $c}]
3171    set G(1,2) [expr {$a * $b * cos($gamma*0.017453292519943)}]
3172    set G(2,1) $G(1,2)
3173    set G(1,3) [expr {$a * $c * cos($beta *0.017453292519943)}]
3174    set G(3,1) $G(1,3)
3175    set G(2,3) [expr {$b * $c * cos($alpha*0.017453292519943)}]
3176    set G(3,2) $G(2,3)
3177
3178    # Calculate the volume**2
3179    set v2 0.0
3180    foreach i {1 2 3} {
3181        set J [expr {($i%3) + 1}]
3182        set K [expr {(($i+1)%3) + 1}]
3183        set v2 [expr {$v2+ $G(1,$i)*($G(2,$J)*$G(3,$K)-$G(3,$J)*$G(2,$K))}]
3184    }
3185    if {$v2 > 0} {
3186        set v [expr {sqrt($v2)}]
3187        foreach i {1 2 3} {
3188            set i1 [expr {($i%3) + 1}]
3189            set i2 [expr {(($i+1)%3) + 1}]
3190            foreach j {1 2 3} {
3191                set j1 [expr {($j%3) + 1}]
3192                set j2 [expr {(($j+1)%3) + 1}]
3193                set C($j,$i) [expr {(\
3194                        $G($i1,$j1) * $G($i2,$j2) - \
3195                        $G($i1,$j2)  * $G($i2,$j1)\
3196                        )/ $v}]
3197            }
3198        }
3199        set A(1,2) [expr {0.5 * ($C(1,2)+$C(2,1)) / sqrt( $C(1,1)* $C(2,2) )}]
3200        set A(1,3) [expr {0.5 * ($C(1,3)+$C(3,1)) / sqrt( $C(1,1)* $C(3,3) )}]
3201        set A(2,3) [expr {0.5 * ($C(2,3)+$C(3,2)) / sqrt( $C(2,2)* $C(3,3) )}]
3202        foreach i {1 1 2} j {2 3 3} {
3203            set A($i,$j) [expr {0.5 * ($C($i,$j) + $C($j,$i)) / \
3204                    sqrt( $C($i,$i)* $C($j,$j) )}]
3205            # clean up roundoff
3206            if {abs($A($i,$j)) < 1e-5} {set A($i,$j) 0.0}
3207        }
3208    } else {
3209        set A(1,2) 0.0
3210        set A(1,3) 0.0
3211        set A(2,3) 0.0
3212    }
3213    return "$Uequiv $Uequiv $Uequiv \
3214            [expr {$Uequiv * $A(1,2)}] \
3215            [expr {$Uequiv * $A(1,3)}] \
3216            [expr {$Uequiv * $A(2,3)}]"
3217}
3218
3219# read/edit soft (distance) restraint info
3220#  parm:
3221#    weight -- histogram weight (factr) *
3222#    restraintlist -- list of restraints *
3223#  action: get (default) or set
3224#  value: used only with set
3225#  * =>  read+write supported
3226proc SoftConst {parm "action get" "value {}"} {
3227    set HST {}
3228    # look for RSN record
3229    set n 0
3230    for {set i 0} {$i < $::expmap(nhst)} {incr i} {
3231        set ihist [expr {$i + 1}]
3232        if {[expr {$i % 12}] == 0} {
3233            incr n
3234            set line [readexp " EXPR  HTYP$n"]
3235            if {$line == ""} {
3236                set msg "No HTYP$n entry for Histogram $ihist. This is an invalid .EXP file"
3237                tk_dialog .badexp "Error in readexp" $msg error 0 Exit
3238            }
3239            set j 0
3240        } else {
3241            incr j
3242        }
3243        if {[string range $line [expr 2+5*$j] [expr 5*($j+1)]] == "RSN "} {
3244            set HST $ihist
3245        }
3246    }
3247    if {$HST <=9} {
3248        set key "HST  $HST"
3249    } else {
3250        set key "HST $HST"
3251    }
3252    if {$HST == "" && $action == "set"} {
3253        # no RSN found need to add the soft constr. histogram
3254        # increment number of histograms
3255        set hst [string trim [string range [readexp { EXPR  NHST }] 0 4]]
3256        incr hst
3257        set HST $hst
3258        if ![validint hst 5] {return 0}
3259        setexp  { EXPR  NHST } $hst 1 5
3260        # add to EXPR HTYPx rec, creating if needed
3261        set n [expr { 1+ (($HST - 1) / 12) }]
3262        set key " EXPR  HTYP$n"
3263        if {[array names ::exparray $key] == ""} {
3264            makeexprec $key
3265        }
3266        setexp $key "RSN " [expr 3 + 5*(($HST-1) % 12)] 5
3267        # create other HST  xx recs
3268        if {$HST <=9} {
3269            set key "HST  $HST"
3270        } else {
3271            set key "HST $HST"
3272        }
3273        makeexprec "$key  HNAM"
3274        setexp "$key  HNAM" "Bond distance restraints" 3 24
3275        makeexprec "$key FACTR"
3276        makeexprec "$key NBNDS"
3277        mapexp
3278    } elseif {$HST == ""} {
3279        if $::expgui(debug) {puts "no restraints"}
3280        return "1"
3281    }
3282
3283    switch -glob ${parm}-$action {
3284        weight-get {
3285            return [string trim [string range [readexp "$key FACTR"] 0 14]]
3286        }
3287        weight-set {
3288            # update FACTR
3289            if ![validreal value 15 6] {return 0}
3290            setexp "$key FACTR" $value 1 15
3291        }
3292        restraintlist-get {
3293            set ncons [string trim [string range [readexp "$key NBNDS"] 0 4]]
3294            set conslist {}
3295            for {set i 1} {$i <= $ncons} {incr i} {
3296                set fi [string toupper [format %.4x $i]]
3297                set line [readexp "${key}BD$fi"]
3298                set const {}
3299                foreach len {3 5 5 3 3 3 3 3 6 6} {
3300                  set lenm1 [expr {$len - 1}]
3301                  lappend const [string trim [string range $line 0 $lenm1]]
3302                  set line [string range $line $len end]
3303                }
3304                lappend conslist $const
3305            }
3306            return $conslist
3307        }
3308        restraintlist-set {
3309            set num [llength $value]
3310            if ![validint num 5] {return 0}
3311            setexp "$key NBNDS" $num 1 5
3312            # delete all old records
3313            foreach i [array names ::exparray "${key}BD*"] {unset ::exparray($i)}
3314            set i 0
3315            foreach cons $value {
3316                incr i
3317                set fi [string toupper [format %.4x $i]]
3318                makeexprec "${key}BD$fi"
3319                set pos 1
3320                foreach num $cons len {3 5 5 3 3 3 3 3 -6 -6} {
3321                    if {$len > 0} {
3322                        validint num $len
3323                        setexp "${key}BD$fi" $num $pos $len
3324                    } else {
3325                        set len [expr abs($len)]
3326                        validreal num $len 3
3327                        setexp "${key}BD$fi" $num $pos $len
3328                    }
3329                    incr pos $len
3330                }
3331            }
3332        }
3333        default {
3334            set msg "Unsupported phaseinfo access: parm=$parm action=$action"
3335            tk_dialog .badexp "Error in readexp" $msg error 0 Exit
3336        }
3337    return 1
3338    }
3339}
3340
3341#======================================================================
3342# conversion routines
3343#======================================================================
3344
3345# convert x values to d-space
3346proc tod {xlist hst} {
3347    global expmap
3348    if {[string range $expmap(htype_$hst) 2 2] == "T"} {
3349        return [toftod $xlist $hst]
3350    } elseif {[string range $expmap(htype_$hst) 2 2] == "C"} {
3351        return [tttod $xlist $hst]
3352    } elseif {[string range $expmap(htype_$hst) 2 2] == "E"} {
3353        return [engtod $xlist $hst]
3354    } else {
3355        return {}
3356    }
3357}
3358
3359# convert tof to d-space
3360proc toftod {toflist hst} {
3361    set difc [expr {[histinfo $hst difc]/1000.}]
3362    set difc2 [expr {$difc*$difc}]
3363    set difa [expr {[histinfo $hst difa]/1000.}]
3364    set zero [expr {[histinfo $hst zero]/1000.}]
3365    set ans {}
3366    foreach tof $toflist {
3367        if {$tof == 0.} {
3368            lappend ans 0.
3369        } elseif {$tof == 1000.} {
3370            lappend ans 1000.
3371        } else {
3372            set td [expr {$tof-$zero}]
3373            lappend ans [expr {$td*($difc2+$difa*$td)/ \
3374                    ($difc2*$difc+2.0*$difa*$td)}]
3375        }
3376    }
3377    return $ans
3378}
3379
3380# convert two-theta to d-space
3381proc tttod {twotheta hst} {
3382    set lamo2 [expr {0.5 * [histinfo $hst lam1]}]
3383    set zero [expr [histinfo $hst zero]/100.]
3384    set ans {}
3385    set cnv [expr {acos(0.)/180.}]
3386    foreach tt $twotheta {
3387        if {$tt == 0.} {
3388            lappend ans 99999.
3389        } elseif {$tt == 1000.} {
3390            lappend ans 0.
3391        } else {
3392            lappend ans [expr {$lamo2 / sin($cnv*($tt-$zero))}]
3393        }
3394    }
3395    return $ans
3396}
3397
3398# convert energy (edx-ray) to d-space
3399# (note that this ignores the zero correction)
3400proc engtod {eng hst} {
3401    set lam [histinfo $hst lam1]
3402    set zero [histinfo $hst zero]
3403    set ans {}
3404    set v [expr {12.398/(2.0*[sind[expr ($lam/2.0)]])}]
3405    foreach e $eng {
3406        if {$e == 0.} {
3407            lappend ans 1000.
3408        } elseif {$e == 1000.} {
3409            lappend ans 0.
3410        } else {
3411            lappend ans [expr {$v/$e}]
3412        }
3413    }
3414    return $ans
3415}
3416
3417# convert x values to Q
3418proc toQ {xlist hst} {
3419    global expmap
3420    if {[string range $expmap(htype_$hst) 2 2] == "T"} {
3421        return [toftoQ $xlist $hst]
3422    } elseif {[string range $expmap(htype_$hst) 2 2] == "C"} {
3423        return [tttoQ $xlist $hst]
3424    } elseif {[string range $expmap(htype_$hst) 2 2] == "E"} {
3425        return [engtoQ $xlist $hst]
3426    } else {
3427        return {}
3428    }
3429}
3430# convert tof to Q
3431proc toftoQ {toflist hst} {
3432    set difc [expr {[histinfo $hst difc]/1000.}]
3433    set difc2 [expr {$difc*$difc}]
3434    set difa [expr {[histinfo $hst difa]/1000.}]
3435    set zero [expr {[histinfo $hst zero]/1000.}]
3436    set 2pi [expr {4.*acos(0.)}]
3437    set ans {}
3438    foreach tof $toflist {
3439        if {$tof == 0.} {
3440            lappend ans 99999.
3441        } elseif {$tof == 1000.} {
3442            lappend ans 0.
3443        } else {
3444            set td [expr {$tof-$zero}]
3445            lappend ans [expr {$2pi * \
3446                    ($difc2*$difc+2.0*$difa*$td)/($td*($difc2+$difa*$td))}]
3447        }
3448    }
3449    return $ans
3450}
3451
3452# convert two-theta to Q
3453proc tttoQ {twotheta hst} {
3454    set lamo2 [expr {0.5 * [histinfo $hst lam1]}]
3455    set zero [expr [histinfo $hst zero]/100.]
3456    set ans {}
3457    set cnv [expr {acos(0.)/180.}]
3458    set 2pi [expr {4.*acos(0.)}]
3459    foreach tt $twotheta {
3460        if {$tt == 0.} {
3461            lappend ans 0.
3462        } elseif {$tt == 1000.} {
3463            lappend ans 1000.
3464        } else {
3465            lappend ans [expr {$2pi * sin($cnv*($tt-$zero)) / $lamo2}]
3466        }
3467    }
3468    return $ans
3469}
3470# convert energy (edx-ray) to Q
3471# (note that this ignores the zero correction)
3472proc engtoQ {eng hst} {
3473    set lam [histinfo $hst lam1]
3474    set zero [histinfo $hst zero]
3475    set ans {}
3476    set v [expr {12.398/(2.0*[sind[expr ($lam/2.0)]])}]
3477    set 2pi [expr {4.*acos(0.)}]
3478    foreach e $eng {
3479        if {$e == 0.} {
3480            lappend ans 0.
3481        } elseif {$e == 1000.} {
3482            lappend ans 1000.
3483        } else {
3484            lappend ans [expr {$2pi * $e / $v}]
3485        }
3486    }
3487    return $ans
3488}
3489proc sind {angle} {
3490    return [expr {sin($angle*acos(0.)/90.)}]
3491}
3492
3493# convert d-space values to 2theta, TOF or KeV
3494proc fromd {dlist hst} {
3495    global expmap
3496    if {[string range $expmap(htype_$hst) 2 2] == "T"} {
3497        set difc [expr {[histinfo $hst difc]/1000.}]
3498        set difa [expr {[histinfo $hst difa]/1000.}]
3499        set zero [expr {[histinfo $hst zero]/1000.}]
3500        set ans {}
3501        foreach d $dlist {
3502            if {$d == 0.} {
3503                lappend ans 0.
3504            } elseif {$d == 1000.} {
3505                lappend ans 1000.
3506            } else {
3507                lappend ans [expr {$difc*$d + $difa*$d*$d + $zero}]
3508            }
3509        }
3510        return $ans
3511    } elseif {[string range $expmap(htype_$hst) 2 2] == "C"} {
3512        set lamo2 [expr {0.5 * [histinfo $hst lam1]}]
3513        set zero [expr [histinfo $hst zero]/100.]
3514        set ans {}
3515        set cnv [expr {180./acos(0.)}]
3516        foreach d $dlist {
3517            if {$d == 99999.} {
3518                lappend ans 0
3519            } elseif {$d == 0.} {
3520                lappend ans 1000.
3521            } else {
3522                lappend ans [expr {$cnv*asin($lamo2/$d) + $zero}]
3523            }
3524        }
3525        return $ans
3526    } elseif {[string range $expmap(htype_$hst) 2 2] == "E"} {
3527        set lam [histinfo $hst lam1]
3528        set zero [histinfo $hst zero]
3529        set v [expr {12.398/(2.0*[sind[expr ($lam/2.0)]])}]
3530        set ans {}
3531        foreach d $dlist {
3532            if {$d == 1000.} {
3533                lappend ans 0
3534            } elseif {$d == 0.} {
3535                lappend ans 1000.
3536            } else {
3537                lappend ans [expr {$v/$d}]
3538            }
3539        }
3540        return $ans
3541    } else {
3542        return {}
3543    }
3544}
3545
3546# convert Q values to 2theta, TOF or KeV
3547proc fromQ {Qlist hst} {
3548    global expmap
3549    if {[string range $expmap(htype_$hst) 2 2] == "T"} {
3550        set difc [expr {[histinfo $hst difc]/1000.}]
3551        set difa [expr {[histinfo $hst difa]/1000.}]
3552        set zero [expr {[histinfo $hst zero]/1000.}]
3553        set ans {}
3554        foreach Q $Qlist {
3555            if {$Q == 0.} {
3556                lappend ans 1000.
3557            } elseif {$Q == 99999.} {
3558                lappend ans 1000.
3559            } else {
3560                set d [expr {4.*acos(0.)/$Q}]
3561                lappend ans [expr {$difc*$d + $difa*$d*$d + $zero}]
3562            }
3563        }
3564        return $ans
3565    } elseif {[string range $expmap(htype_$hst) 2 2] == "C"} {
3566        set lamo4pi [expr {[histinfo $hst lam1]/(8.*acos(0.))}]
3567        set zero [expr [histinfo $hst zero]/100.]
3568        set ans {}
3569        set cnv [expr {180./acos(0.)}]
3570        foreach Q $Qlist {
3571            if {$Q == 0.} {
3572                lappend ans 0
3573            } elseif {$Q == 1000.} {
3574                lappend ans 1000.
3575            } else {
3576                lappend ans [expr {$cnv*asin($Q*$lamo4pi) + $zero}]
3577            }
3578        }
3579        return $ans
3580    } elseif {[string range $expmap(htype_$hst) 2 2] == "E"} {
3581        set lam [histinfo $hst lam1]
3582        set zero [histinfo $hst zero]
3583        set v [expr {12.398/(2.0*[sind[expr ($lam/2.0)]])}]
3584        set ans {}
3585        set 2pi [expr {4.*acos(0.)}]
3586        foreach Q $Qlist {
3587            if {$Q == 1000.} {
3588                lappend ans 0
3589            } elseif {$Q == 0.} {
3590                lappend ans 1000.
3591            } else {
3592                lappend ans [expr {$Q * $v/$2pi}]
3593            }
3594        }
3595        return $ans
3596    } else {
3597        return {}
3598    }
3599}
3600#============================================================================
3601# rigid body EXP editing routines (to move into readexp.tcl)
3602# RigidBodyList -- returns a list of the defined rigid body types
3603# SetRigidBodyVar -- set variables and damping for rigid body type multipliers
3604# ReadRigidBody  -- # of times a body is mapped, scaling factors, var #s & coordinates
3605# RigidBodyMappingList - return a list instances where a RB is mapped in phase
3606# RigidBodyEnableTLS -- Enable or Disable TLS use for a rigid body mapping
3607# RigidBodySetTLS  -- change the TLS values for a rigid body mapping
3608# RigidBodySetDamp -- change the damping values for a rigid body mapping
3609# RigidBodyVary    -- set refinement variable numbers for a rigid body mapping
3610# RigidBodyTLSVary -- set TLS refinement variable nums for a rigid body mapping
3611# AddRigidBody -- defines a new rigid body type
3612# DeleteRigidBody -- remove a rigid body definition
3613# ReplaceRigidBody -- replaces a previous rigid body type
3614# ReadRigidBodyMapping  -- get parameters for a rigid body mapping
3615# MapRigidBody -- map a rigid body type into a phase
3616# EditRigidBodyMapping -- change the parameters in a rigid body mapping
3617# UnMapRigidBody --remove a rigid body constraint by removing a RB "instance"
3618#----- note that these older routines should not be used ------
3619# RigidBodyCount -- returns the number of defined rigid bodies (body types)
3620#    use RigidBodyList instead
3621# RigidBodyMappingCount -- # of times a rigid body is mapped in phase
3622#    use RigidBodyMappingList instead
3623#============================================================================
3624# returns the number of defined rigid bodies
3625proc RigidBodyCount {} {
3626    set n [string trim [readexp "RGBD  NRBDS"]]
3627    if {$n == ""} {
3628        set n 0
3629    }
3630    return $n
3631}
3632
3633# returns a list of the defined rigid body types
3634proc RigidBodyList {} {
3635    set n [string trim [readexp "RGBD  NRBDS"]]
3636    if {$n == ""} {
3637        set n 0
3638    }
3639    set rblist {}
3640    foreach rbnum {1 2 3 4 5 6 7 8 9 10 11 12 13 14 15} {
3641        set value $rbnum
3642        validint value 2
3643        set key "RGBD${value}"
3644        if {[existsexp "$key NATR "]} {
3645            lappend rblist $rbnum
3646        }
3647        if {[llength $rblist] == $n} break
3648    }
3649    return $rblist
3650}
3651
3652# ReadRigidBody provides all information associated with a rigid body type
3653#  rbnum is the rigid body type number
3654# it returns two items:
3655#   the number of times the rigid body is mapped
3656#   a list containing an element for each scaling factor in rigid body #rbnum.
3657# in each element there are four items:
3658#    a multiplier value for the rigid body coordinates
3659#    a damping value (0-9) for the refinement of the multiplier
3660#    a variable number if the multiplier will be refined
3661#    a list of cartesian coordinates coordinates
3662# each cartesian coordinate contains 4 items: x,y,z and a label
3663#  note that the label is present only when the RB is created in EXPGUI and is
3664#  not used in GSAS.
3665proc ReadRigidBody {rbnum} {
3666    if {[lsearch [RigidBodyList] $rbnum] == -1} {
3667        return ""
3668    }
3669    set value $rbnum
3670    validint value 2
3671    set key "RGBD${value}"
3672    set n [string trim [string range [readexp "$key NATR"] 0 4]]
3673    set used [string trim [string range [readexp "$key NBDS"] 0 4]]
3674    set nmult [string trim [string range [readexp "$key NSMP"] 0 4]]
3675    set out {}
3676    for {set i 1} {$i <= $nmult} {incr i} {
3677        set line [readexp "${key}${i}PARM"]
3678        set mult [string trim [string range $line 0 9]]
3679        set var [string trim [string range $line 10 14]]
3680        set damp [string trim [string range $line 15 19]]
3681        set coordlist {}
3682        for {set j 1} {$j <= $n} {incr j} {
3683            set value $j
3684            validint value 3
3685            set line [readexp "${key}${i}SC$value"]
3686            set x [string trim [string range $line 0 9]]
3687            set y [string trim [string range $line 10 19]]
3688            set z [string trim [string range $line 20 29]]
3689            set lbl [string trim [string range $line 30 39]]
3690            lappend coordlist [list $x $y $z $lbl]
3691        }
3692        lappend out [list $mult $damp $var $coordlist]
3693    }
3694    return [list $used $out]
3695}
3696
3697# SetRigidBodyVar
3698#   rbnum is the rigid body type number
3699#   varnumlist is a list of variable numbers
3700#      note that if this list is shorter than the number of actual multipliers
3701#      for the body, the unspecified variable will not be changed
3702#   damplist   is a list of damping values (0-9)
3703#      note that if the damplist is shorter than the number of actual multipliers
3704#      the unspecified values are not changed
3705#  SetRigidBodVar 2 {1 2 3} {}
3706#       will vary the (first 3) translations in body #3 and will not change the
3707#       damping values
3708#  SetRigidBodVar 3 {} {0 0 0}
3709#       will not change variable settings but will change the (first 3) damping values
3710#  SetRigidBodVar 4 {11 11} {8 8}
3711#      changes both variable numbers and damping at the same time
3712# Nothing is returned
3713proc SetRigidBodyVar {rbnum varnumlist damplist} {
3714    if {[lsearch [RigidBodyList] $rbnum] == -1} {
3715        return ""
3716    }
3717    set value $rbnum
3718    validint value 2
3719    set key "RGBD${value}"
3720    set nmult [string trim [string range [readexp "$key NSMP"] 0 4]]
3721    for {set i 1} {$i <= $nmult} {incr i} {
3722        set j $i
3723        incr j -1
3724        set var [lindex $varnumlist $j]
3725        if {$var != ""} {
3726            validint var 5
3727            setexp "${key}${i}PARM" $var 11 15
3728        }
3729        set damp [lindex $damplist $j]
3730        if {$damp != ""} {
3731            if {$damp > 9} {set damp 9}
3732            if {$damp < 0} {set damp 0}
3733            validint damp 5
3734        }
3735        setexp "${key}${i}PARM" $damp 16 20
3736    }
3737}
3738
3739
3740# return the number of times rigid body $bodytyp is mapped in phase $phase
3741proc RigidBodyMappingCount {phase bodytyp} {
3742    set key "RGBD[ToHex $phase 1][ToHex $bodytyp 1]"
3743    if {! [existsexp "$key  NBDS"]} {return 0}
3744    set n [string trim [readexp "$key  NBDS"]]
3745    if {$n == ""} {
3746        set n 0
3747    }
3748    return $n
3749}
3750# return a list of the instances where rigid body $bodytyp is mapped in phase $phase
3751proc RigidBodyMappingList {phase bodytyp} {
3752    set key "RGBD[ToHex $phase 1][ToHex $bodytyp 1]"
3753    if {! [existsexp "$key  NBDS"]} {return {}}
3754    set n [string trim [readexp "$key  NBDS"]]
3755    if {$n == ""} {
3756        set n 0
3757    }
3758    set rblist {}
3759    foreach rbnum {1 2 3 4 5 6 7 8 9 10 11 12 13 14 15} {
3760        set value $rbnum
3761        validint value 2
3762        set key "RGBD[ToHex $phase 1][ToHex $bodytyp 1][ToHex $rbnum 1]"
3763        if {[existsexp "$key  NDA"]} {
3764            lappend rblist $rbnum
3765        }
3766        if {[llength $rblist] == $n} break
3767    }
3768    return $rblist
3769}
3770
3771
3772
3773# reads rigid body mapping parameters for phase ($phase), body type # ($bodytyp) and instance # ($num)
3774# returns a list of items (most lists) as follows:
3775#   1) sequence # of first atom in body
3776#   2) origin of body in fractional coordinates (3 elements)
3777#   3) Euler angles as 6 pairs of numbers (see below)
3778#   4) variable numbers for the 9 position variables (origin followed by rotations)
3779#   5) damping vals for the 9 position variables (origin followed by rotations)
3780#   6) the TLS values, in order below (empty list if TLS is not in use)
3781#   7) the variable numbers for each TLS values, in order below (or empty)
3782#   8) three damping values for the T, L and S terms.
3783# returns an empty list if no such body exists.
3784#
3785# Euler angles are a list of axes and angles to rotate:
3786#   { {axis1 angle1} {axis2 angle2} ...}
3787# where axis1,... can be 1, 2 or 3 corresponding to the cartesian X, Y or Z axes
3788#
3789# The 20 TLS terms are ordered:
3790#    T11, T22, T33, T12, T13, T23
3791#    L11, L22, L33, L12, L13, L23
3792#    S12, S13, S21, S23, S31, S32, SAA, SBB
3793#
3794proc ReadRigidBodyMapping {phase bodytyp num} {
3795    if {[lsearch [RigidBodyMappingList $phase $bodytyp] $num] == -1} {
3796        return ""
3797    }
3798    set key "RGBD[ToHex $phase 1][ToHex $bodytyp 1][ToHex $num 1]"
3799    set first [string trim [string range [readexp "$key  NDA"] 0 4]]
3800    set line [readexp "$key BDFL"]
3801    set varlist {}
3802    set damplist {}
3803    foreach i {0 1 2 3 4 5 6 7 8} {
3804        lappend varlist [string trim [string range $line [expr {5*$i}] [expr {4 + 5*$i}] ]]
3805        lappend damplist [string trim [string range $line [expr {45 + $i}] [expr {45 + $i}] ]]
3806    }
3807    set TLSdamplist {}
3808    foreach i {54 55 56} {
3809        lappend TLSdamplist [string trim [string range $line $i $i ]]
3810    }
3811    set line [readexp "${key} BDLC"]
3812    set x [string trim [string range $line 0 9]]
3813    set y [string trim [string range $line 10 19]]
3814    set z [string trim [string range $line 20 29]]
3815    set origin [list $x $y $z]
3816    set line [readexp "${key} BDOR"]
3817    set rotations {}
3818    foreach i {0 10 20 30 40 50} {
3819        set angle [string trim [string range $line $i [expr {$i+7}]]]
3820        set axis [string trim [string range $line [expr {$i+8}] [expr {$i+9}]]]
3821        lappend rotations [list $angle $axis]
3822    }
3823    set TLS [string trim [string range [readexp "${key} LSTF"] 0 4]]
3824    set tlsvars {}
3825    set tlsvals {}
3826    if {$TLS != 0} {
3827        set line [readexp "${key}TLSF1"]
3828        for {set j 0} {$j < 20} {incr j} {
3829            set var [string trim [string range $line [expr {3*$j}] [expr {3*$j+2}]]]
3830            if {$var == ""} {set var 0}
3831            lappend tlsvars $var
3832        }
3833        for {set j 0} {$j < 20} {incr j} {
3834            set i 0
3835            if {$j == 0} {
3836                set i 1
3837            } elseif {$j == 8} {
3838                set i 2
3839            } elseif {$j == 16} {
3840                set i 3
3841            }
3842            if {$i != 0} {
3843                set line [readexp "${key}TLSP$i"]
3844                set i 0
3845                set j1 0
3846                set j2 7
3847            } else {
3848                incr j1 8
3849                incr j2 8
3850            }
3851            set val [string trim [string range $line $j1 $j2]]
3852            if {$val == ""} {set val 0}
3853            lappend tlsvals $val
3854        }
3855    }
3856    return [list $first $origin $rotations $varlist $damplist $tlsvals $tlsvars $TLSdamplist]
3857}
3858
3859# Control TLS representation for phase, body # and instance number of a Rigid body mapping
3860#   for mapping with phase ($phase), body type # ($bodytyp) and instance # ($num)
3861# Enable TLS use if TLS is non-zero (true). Disable if zero
3862proc RigidBodyEnableTLS {phase bodytyp num TLS} {
3863    if {[lsearch [RigidBodyMappingList $phase $bodytyp] $num] == -1} {
3864        return ""
3865    }
3866    set key "RGBD[ToHex $phase 1][ToHex $bodytyp 1][ToHex $num 1]"
3867    if {$TLS} {
3868        setexp "${key} LSTF" [format "%5d" 1] 1 5
3869        if {![existsexp "${key}TLSF1"]} {makeexprec "${key}TLSF1"}
3870        if {![existsexp "${key}TLSP1"]} {
3871            makeexprec "${key}TLSP1"
3872            set str {}
3873            foreach v {.01 .01 .01 0 0 0 0 0} d {4 4 4 4 4 4 2 2} {
3874                validreal v 8 $d
3875                append str $v
3876            }
3877            setexp "${key}TLSP1" $str 1 64
3878        }
3879        if {![existsexp "${key}TLSP2"]} {
3880            makeexprec "${key}TLSP2"
3881            set str {}
3882            set v 0
3883            foreach d {2 2 2 2 4 4 4 4} {
3884                validreal v 8 $d
3885                append str $v
3886            }
3887            setexp "${key}TLSP2" $str 1 64
3888        }
3889        if {![existsexp "${key}TLSP3"]} {
3890            makeexprec "${key}TLSP3"
3891            set str {}
3892            set v 0
3893            foreach d {4 4 4 4} {
3894                validreal v 8 $d
3895                append str $v
3896            }
3897            setexp "${key}TLSP3" $str 1 64
3898        }
3899    } else {
3900        setexp "${key} LSTF" [format "%5d" 0] 1 5
3901    }
3902    return 1
3903}
3904
3905# Control the TLS values for Rigid body mapping for mapping with
3906#    phase ($phase), body type # ($bodytyp) and instance # ($num)
3907# set the 20 TLS values to the values in TLSvals
3908# There must be exactly 20 TLS terms, which are ordered:
3909#    T11, T22, T33, T12, T13, T23
3910#    L11, L22, L33, L12, L13, L23
3911#    S12, S13, S21, S23, S31, S32, SAA, SBB
3912proc RigidBodySetTLS {phase bodytyp num TLSvals} {
3913    if {[lsearch [RigidBodyMappingList $phase $bodytyp] $num] == -1} {
3914        return ""
3915    }
3916    if {[llength $TLSvals] != 20} {return ""}
3917    set key "RGBD[ToHex $phase 1][ToHex $bodytyp 1][ToHex $num 1]"
3918    set TLS [string trim [string range [readexp "${key} LSTF"] 0 4]]
3919    if {$TLS == 0} {return ""}
3920    if {![existsexp "${key}TLSF1"]} {makeexprec "${key}TLSF1"}
3921    foreach n {1 2 3} {
3922        if {![existsexp "${key}TLSP$n"]} {makeexprec "${key}TLSP$n"}
3923    }
3924    set str {}
3925    set n 1
3926    set i 0
3927    foreach v $TLSvals d {4 4 4 4 4 4 2 2 2 2 2 2 4 4 4 4 4 4 4 4} {
3928        incr i
3929        validreal v 8 $d
3930        append str $v
3931        if {$i == 8} {
3932            set i 0
3933            setexp "${key}TLSP$n" $str 1 64
3934            incr n
3935            set str {}
3936        }
3937    }
3938    setexp "${key}TLSP$n" $str 1 64
3939    return 1
3940}
3941
3942# set damping values for a Rigid body mapping
3943#   for mapping with phase ($phase), body type # ($bodytyp) and instance # ($num)
3944# there must be 9 damping values in RBdamp for the 9 position variables (origin followed by rotations)
3945# Use of TLSdamp is optional, but to be used, TLS representation must be enabled and there must be
3946# three damping terms (for all T terms; for all L terms and for all S terms)
3947proc RigidBodySetDamp {phase bodytyp num RBdamp "TLSdamp {}"} {
3948    if {[lsearch [RigidBodyMappingList $phase $bodytyp] $num] == -1} {
3949        return ""
3950    }
3951    set key "RGBD[ToHex $phase 1][ToHex $bodytyp 1][ToHex $num 1]"
3952    if {[llength $RBdamp] != 9} {return ""}
3953    set str {}
3954    foreach v $RBdamp {
3955        if {[validint v 1] != 1} {set v " "}
3956        append str $v
3957    }
3958    setexp "$key BDFL" $str 46 9
3959    set TLS [string trim [string range [readexp "${key} LSTF"] 0 4]]
3960    if {$TLS != 0 &&  [llength $TLSdamp] == 3} {
3961        set str {}
3962        foreach v $TLSdamp {
3963        if {[validint v 1] != 1} {set v " "}
3964            append str $v
3965        }
3966        setexp "$key BDFL" $str 55 3
3967    }
3968    return 1
3969}
3970
3971# set refinement variable numbers for a Rigid body mapping
3972#   for mapping with phase ($phase), body type # ($bodytyp) and instance # ($num)
3973# there must be 9 variable values in RBvar for the 9 position variables (origin followed by rotations)
3974# note that the variable values should be unique integers
3975proc RigidBodyVary {phase bodytyp num RBvar} {
3976    if {[lsearch [RigidBodyMappingList $phase $bodytyp] $num] == -1} {
3977        return ""
3978    }
3979    set key "RGBD[ToHex $phase 1][ToHex $bodytyp 1][ToHex $num 1]"
3980    if {[llength $RBvar] != 9} {return ""}
3981    set str {}
3982    foreach v $RBvar {
3983        if {[validint v 5] != 1} {set v " "}
3984        append str $v
3985    }
3986    setexp "$key BDFL" $str 1 45   
3987}
3988
3989# set TLS refinement variable numbers for a Rigid body mapping
3990#   for mapping with phase ($phase), body type # ($bodytyp) and instance # ($num)
3991# there must be 20 variable values in TLSvar for the 20 parameters:
3992#    T11, T22, T33, T12, T13, T23
3993#    L11, L22, L33, L12, L13, L23
3994#    S12, S13, S21, S23, S31, S32, SAA, SBB
3995# note that the variable values should be unique integers
3996proc RigidBodyTLSVary {phase bodytyp num TLSvar} {
3997    if {[lsearch [RigidBodyMappingList $phase $bodytyp] $num] == -1} {
3998        return ""
3999    }
4000    set key "RGBD[ToHex $phase 1][ToHex $bodytyp 1][ToHex $num 1]"
4001    if {[llength $TLSvar] != 20} {return ""}
4002    set TLS [string trim [string range [readexp "${key} LSTF"] 0 4]]
4003    if {$TLS == 0} {return ""}
4004    set str {}
4005    foreach v $TLSvar {
4006        if {[validint v 3] != 1} {set v " "}
4007        append str $v
4008    }
4009    setexp "${key}TLSF1" $str 1 60
4010
4011# AddRigidBody: add a new rigid body definition into the .EXP file
4012# arguments are:
4013#   multlist: defines a list of multipliers for each set of coordinates. In the
4014#             simplest case this will be {1}
4015#   coordlist: a nested list of coordinates such as { { {0 0 0} {.1 .1 .1} {.2 .2 .2} } }
4016# note that when the length of multlist > 1 then coordlist must have the same length.
4017# for input where
4018#     multlist = {s1 s2} and
4019#     coordlist = { { {0 0 0} {1 1 0} {.0 .0 .0} ...}
4020#                     {0 0 0} {1 1 0} {2 1 2} ...}
4021#                 }
4022# the cartesian coordinates are defined from the input as
4023#    atom 1 = s1 * (0,0,0) + s2*(0,0,0) [ = (0,0,0)]
4024#    atom 2 = s1 * (1,1,0) + s2*(1,1,0) [ = (s1+s2) * (1,1,0)]
4025#    atom 3 = s1 * (0,0,0) + s2*(2,1,2) [ = s2 * (2,1,2)]
4026#    ...
4027# Returns the number of the rigid body that has been created
4028proc AddRigidBody {multlist coordlist} {
4029    # find the first unused body #
4030    foreach rbnum {1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16} {
4031        set value $rbnum
4032        validint value 2
4033        set key "RGBD${value}"
4034        if {! [existsexp "$key NATR "]} {break}
4035    }
4036    # did we go too far?
4037    if {$rbnum == 16} {return ""}
4038    # increment the RB counter
4039    set n [string trim [readexp "RGBD  NRBDS"]]
4040    if {$n == ""} {
4041        makeexprec "RGBD  NRBDS"
4042        set n 0
4043    }
4044    incr n
4045    validint n 5
4046    setexp "RGBD  NRBDS" $n 1 5
4047    SetRigidBody $rbnum $multlist $coordlist
4048    return $rbnum
4049}
4050
4051# DeleteRigidBody: remove a rigid body definition from the .EXP file
4052# The body may not be mapped. I am not sure if GSAS allows more than 9 bodies,
4053# but if it does, the simplifed approach used here will fail, so this
4054# is not allowed.
4055# Input:
4056#   Rigid body number
4057# Returns:
4058#   1 on success
4059#   -1 if the body number is 11 or greater
4060#   -2 if the body is mapped
4061#   -3 if the body is not defined
4062proc DeleteRigidBody {rbnum} {
4063    # can't delete bodies with numbers higher than 10, since the key prefix
4064    # (RGBD11... will overlap with rigid body instance records, which would be
4065    # deleted below
4066    if {$rbnum > 10} {
4067        return -1
4068    }
4069    set value $rbnum
4070    validint value 2
4071    set key "RGBD${value}"
4072    if {![existsexp "$key NATR "]} {
4073        return -2
4074    }
4075    # make sure the body is not mapped
4076    if {[string trim [string range [readexp "$key NBDS"] 0 4]] != 0} {
4077        return -3
4078    }
4079    # delete the records starting with "RGBD x" or "RGBD10"
4080    foreach key [array names ::exparray "${key}*"] {
4081        #puts $key
4082        delexp $key
4083    }
4084    # decrement the RB counter
4085    set n [string trim [readexp "RGBD  NRBDS"]]
4086    if {$n == ""} {
4087        set n 0
4088    }
4089    incr n -1
4090    validint n 5
4091    if {$n > 0} {
4092        setexp "RGBD  NRBDS" $n 1 5
4093    } else {
4094        delexp "RGBD  NRBDS"
4095    }
4096    return 1
4097}
4098
4099# ReplaceRigidBody: replace all the information for rigid body #rbnum
4100# Works the sames as AddRigidBody (see above) except that the rigid body is replaced rather
4101# than added.
4102# Note that count of the # of times the body is used is preserved
4103proc ReplaceRigidBody {rbnum multlist coordlist {varlist ""} {damplist ""}} {
4104    set value $rbnum
4105    validint value 2
4106    set key "RGBD${value}"
4107    set line [readexp "$key NBDS"]
4108    foreach key [array names ::exparray "${key}*"] {
4109        #puts $key
4110        delexp $key
4111    }
4112    SetRigidBody $rbnum $multlist $coordlist $varlist $damplist
4113    setexp "$key NBDS" $line 1 68
4114}
4115
4116# Edit the parameters for rigid body #rbnum
4117# (normally called from ReplaceRigidBody or AddRigidBody)
4118proc SetRigidBody {rbnum multlist coordlist {varlist ""} {damplist ""}} {
4119    set value $rbnum
4120    validint value 2
4121    set key "RGBD${value}"
4122    # number of atoms
4123    set value [llength [lindex $coordlist 0]]
4124    validint value 5
4125    makeexprec "$key NATR"
4126    setexp "$key NATR" $value 1 5
4127    # number of times used
4128    set value 0
4129    validint value 5
4130    makeexprec "$key NBDS"
4131    setexp "$key NBDS" $value 1 5
4132    # number of coordinate matrices
4133    set value [llength $multlist]
4134    validint value 5
4135    makeexprec "$key NSMP"
4136    setexp "$key NSMP" $value 1 5
4137    set i 0
4138    foreach mult $multlist coords $coordlist {
4139        set var [lindex $varlist $i]
4140        if {$var == ""} {set var 0}
4141        set damp [lindex $damplist $i]
4142        if {$damp == ""} {set damp 0}
4143        incr i
4144        makeexprec "${key}${i}PARM"
4145        setexp "${key}${i}PARM" [format "%10.5f%5d%5d" $mult $var $damp] 1 20
4146        set j 0
4147        foreach item $coords {
4148            #puts $item
4149            incr j
4150            set value $j
4151            validint value 3
4152            makeexprec "${key}${i}SC$value"
4153            if {[llength $item] == 4} {
4154                setexp "${key}${i}SC$value" [eval format "%10.6f%10.6f%10.6f%10s" $item] 1 40
4155            } elseif {[llength $item] == 3} {
4156                setexp "${key}${i}SC$value" [eval format "%10.6f%10.6f%10.6f" $item] 1 30
4157            } else {
4158                return -code 3 "Invalid number of coordinates"
4159            }
4160        }
4161    }
4162}
4163
4164# convert a decimal to the GSAS hex encoding with a field $digits long.
4165proc ToHex {num digits} {
4166    return [string toupper [format "%${digits}x" $num]]
4167}
4168
4169# convert a GSAS hex encoding to a decimal integer
4170proc FromHex {hex} {
4171    return [scan $hex "%x"]
4172}
4173
4174# MapRigidBody: define an "instance" of a rigid body: meaning that the coordinates
4175# (and optionally U values) for a set of atoms will be generated from the rigid body
4176# arguments:
4177#   phase: phase number (1-9)
4178#   bodytyp: number of rigid body (1-15) as returned from AddRigidBody
4179#   firstatom: sequence number of the first atom in phase (note that atoms may
4180#              not be numbered sequentially)
4181#   position: list of three fractional coordinates for the origin of the rigid body coordinates
4182#   angles: list of 3 angles to rotate the rigid body coordinates around x, y, z of the
4183#           cartesian system before the body is translated to position.
4184# returns the instance # (number of times body $bodytyp has been used in phase $phase)
4185proc MapRigidBody {phase bodytyp firstatom position angles} {
4186    # find the first unused body # for this phase & type
4187    foreach rbnum {1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16} {
4188        set key "RGBD[ToHex $phase 1][ToHex $bodytyp 1][ToHex $rbnum 1]"
4189        if {! [existsexp "$key  NDA"]} {break}
4190    }
4191    # did we go too far?
4192    if {$rbnum == 16} {return ""}
4193    # increment number of mapped bodies of this type overall
4194    set value $bodytyp
4195    validint value 2
4196    set key "RGBD${value}"
4197    set used [string trim [string range [readexp "$key NBDS"] 0 4]]
4198    incr used
4199    set value $used
4200    validint value 5
4201    setexp "$key NBDS" $value 1 5
4202    # increment number of mapped bodies of this type in this phase
4203    set key "RGBD[ToHex $phase 1][ToHex $bodytyp 1]"
4204    if {[existsexp "$key  NBDS"]} {
4205        set used [string trim [string range [readexp "$key  NBDS"] 0 4]]
4206    } else {
4207        makeexprec "$key  NBDS"
4208        set used 0
4209    }
4210    incr used
4211    set value $used
4212    validint value 5
4213    setexp "$key  NBDS" $value 1 5
4214    # now write the mapping parameters
4215    set key "RGBD[ToHex $phase 1][ToHex $bodytyp 1][ToHex $rbnum 1]"
4216    set value $firstatom
4217    validint value 5
4218    makeexprec "$key  NDA"
4219    setexp "$key  NDA" $value 1 5
4220    set l1 {}
4221    set l2 {}
4222    for {set i 0} {$i < 9} {incr i} {
4223        append l1 [format %5d 0]
4224        append l2 [format %1d 0]
4225    }
4226    makeexprec "$key BDFL"
4227    setexp "$key BDFL" $l1$l2 1 54
4228    makeexprec "${key} BDLC"
4229    setexp "${key} BDLC" [eval format "%10.6f%10.6f%10.6f" $position] 1 30
4230    makeexprec "${key} BDOR"
4231    set l1 {}
4232    foreach val "$angles 0 0 0" dir "1 2 3 1 1 1" {
4233        append l1 [format "%8.2f%2d" $val $dir]
4234    }
4235    setexp "${key} BDOR" $l1 1 60
4236    makeexprec "${key} LSTF"
4237    setexp "${key} LSTF" [format "%5d" 0] 1 5
4238    # turn off the X refinement flags for the new body
4239    set st [lsearch $::expmap(atomlist_$phase) $firstatom]
4240    set natoms [llength [lindex [lindex [lindex [ReadRigidBody $bodytyp] 1] 0] 3]]
4241    set en [expr {$st+$natoms-1}]
4242    set atomlist [lrange $::expmap(atomlist_$phase) $st $en]
4243    atominfo $phase $atomlist xref set 0
4244    # redo the mapping to capture the newly mapped atoms
4245    mapexp
4246    return $rbnum
4247}
4248
4249# EditRigidBodyMapping: edit parameters that define an "instance" of a rigid body (see MapRigidBody)
4250# arguments:
4251#   phase: phase number (1-9)
4252#   bodytyp: number of rigid body (1-15) as returned from AddRigidBody
4253#   bodynum: instance number, as returned by MapRigidBody
4254#   position: list of three fractional coordinates for the origin of the rigid body coordinates
4255#   angles: list of 3 angles to rotate the rigid body coordinates around x, y, z of the
4256#           cartesian system before the body is translated to position.
4257#
4258proc EditRigidBodyMapping {phase bodytyp bodynum position angles} {
4259    # number of bodies of this type in this phase
4260    set key "RGBD[ToHex $phase 1][ToHex $bodytyp 1][ToHex $bodynum 1]"
4261    setexp "${key} BDLC" [eval format "%10.6f%10.6f%10.6f" $position] 1 30
4262    set l1 {}
4263    foreach val "$angles 0 0 0" dir "1 2 3 1 1 1" {
4264        append l1 [format "%8.2f%2d" $val $dir]
4265    }
4266    setexp "${key} BDOR" $l1 1 60
4267}
4268
4269# UnMapRigidBody: remove a rigid body constraint by removing a RB "instance"
4270# (undoes MapRigidBody)
4271# arguments:
4272#   phase: phase number (1-9)
4273#   bodytyp: number of rigid body (1-15) as returned from AddRigidBody
4274#   bodynum: instance number, as returned by MapRigidBody
4275proc UnMapRigidBody {phase bodytyp mapnum} {
4276    if {[lsearch [RigidBodyMappingList $phase $bodytyp] $mapnum] == -1} {
4277        return ""
4278    }
4279    # decrement number of mapped bodies of this type overall
4280    set value $bodytyp
4281    validint value 2
4282    set key "RGBD${value}"
4283    set used [string trim [string range [readexp "$key NBDS"] 0 4]]
4284    incr used -1
4285    set value $used
4286    validint value 5
4287    setexp "$key NBDS" $value 1 5
4288    # decrement number of mapped bodies of this type in this phase
4289    set key "RGBD[ToHex $phase 1][ToHex $bodytyp 1]"
4290    if {[existsexp "$key  NBDS"]} {
4291        set used [string trim [string range [readexp "$key  NBDS"] 0 4]]
4292    } else {
4293        set used 0
4294    }
4295    incr used -1
4296    set value $used
4297    validint value 5
4298    if {$used > 0} {
4299        setexp "$key  NBDS" $value 1 5
4300    } else {
4301        delexp "$key  NBDS"
4302    }
4303    # now delete the mapping parameter records
4304    set key "RGBD[ToHex $phase 1][ToHex $bodytyp 1][ToHex $mapnum 1]"
4305    foreach key [array names ::exparray "${key}*"] {
4306        delexp $key
4307    }
4308    return $used
4309}
4310
4311# return a list of defined Fourier maps
4312proc listFourier {} {
4313    set l {}
4314    foreach i {1 2 3 4 5 6 7 8 9} {
4315        if {[existsexp "  FOUR CDAT$i"]} {
4316            lappend l $i
4317        }
4318    }
4319    return $l
4320}
4321
4322# read a Fourier map entry
4323# returns five values:
4324#   0: type of map (DELF,FCLC,FOBS,NFDF,PTSN,DPTS)
4325#   1: section (X,Y or Z)
4326#   2: phase (1-9)
4327#   3: DMIN (usually 0.0)
4328#   4: DMAX (usually 999.99)
4329proc readFourier {num} {
4330    set key "  FOUR CDAT$num"
4331    if {![existsexp $key]} {
4332        return {}
4333    }
4334    set vals {}
4335    # 0: type of map (DELF,FCLC,FOBS,NFDF,PTSN,DPTS)
4336    lappend vals [string trim [string range [readexp $key] 2 6]]
4337    # 1: section (X,Y or Z)
4338    lappend vals [string trim [string range [readexp $key] 7 8]]
4339    # 2: phase (1-9)
4340    lappend vals [string trim [string range [readexp $key] 8 13]]
4341    # 3: DMIN (usually 0.0)
4342    lappend vals [string trim [string range [readexp $key] 18 25]]
4343    # 4: DMAX (usually 999.99)
4344    lappend vals [string trim [string range [readexp $key] 30 37]]
4345    return $vals
4346}
4347
4348# add a new Fourier map computation type
4349#   arguments:
4350#      phase: (1-9)
4351#      type: type of map (DELF,FCLC,FOBS,NFDF,PTSN,DPTS) - default DELF
4352#      section: (X,Y or Z) - default Z
4353proc addFourier {phase {type "DELF"} {section "Z"}} {
4354    set num {}
4355    foreach i {1 2 3 4 5 6 7 8 9} {
4356        set key "  FOUR CDAT$i"
4357        if {! [existsexp "  FOUR CDAT$i"]} {
4358            set num $i
4359            break
4360        }
4361    }
4362    if {$num == ""} {return {}}
4363    set key "  FOUR CDAT$num"
4364    makeexprec $key
4365    setexp $key $type 3 4
4366    setexp $key $section 8 1
4367    validint phase 5
4368    setexp $key $phase 9 5
4369    setexp $key "NOPR   0.00      999.99" 15 23
4370    return $num
4371}
4372
4373# read/set a Fourier computation value
4374# use: Fourierinfo num parm
4375#  or: Fourierinfo num parm set value
4376#
4377#  num is the Fourier entry
4378#  parm is one of the following
4379#     type    -- type of map (DELF,FCLC,FOBS,NFDF,PTSN,DPTS)
4380#     section -- last running map direction (X,Y or Z)
4381#     phase   -- phase (1-9)
4382#     dmin    -- d-space for highest order reflection to use (usually 0.0)
4383#     dmax    -- d-space for lowest order reflection to use (usually 999.99)
4384# all parameters may be read or set
4385proc Fourierinfo {num parm "action get" "value {}"} {
4386    set key "  FOUR CDAT$num"
4387    if {![existsexp $key]} {
4388        return {}
4389    }
4390    switch -glob ${parm}-$action {
4391        type-get {
4392            # type of map (DELF,FCLC,FOBS,NFDF,PTSN,DPTS)
4393            return [string range [readexp $key] 2 6]
4394        }
4395        type-set {
4396            set found 0
4397            foreach val {DELF FCLC FOBS NFDF PTSN DPTS} {
4398                if {$val == $value} {
4399                    set found 1
4400                    break
4401                }
4402            }
4403            if $found {
4404                setexp $key $value 3 4
4405            }
4406        }
4407        section-get {
4408            # section (X,Y or Z)
4409            return [string range [readexp $key] 7 8]
4410        }
4411        section-set {
4412            set found 0
4413            foreach val {X Y Z} {
4414                if {$val == $value} {
4415                    set found 1
4416                    break
4417                }
4418            }
4419            if $found {
4420                setexp $key $value 8 1
4421            }
4422        }
4423        phase-get {
4424            # phase (1-9)
4425            return [string range [readexp $key] 8 13]
4426        }
4427        phase-set {
4428            validint value 5
4429            setexp $key $value 9 5
4430        }
4431        dmin-get {
4432            # DMIN (usually 0.0)
4433            return [string range [readexp $key] 18 25]
4434        }
4435        dmin-set {
4436            validreal value 7 2
4437            setexp $key $value 19 7
4438        }
4439        dmax-get {
4440            # DMAX (usually 999.99)
4441            return [string range [readexp $key] 30 37]
4442        }
4443        dmax-set {
4444            validreal value 7 2
4445            setexp $key $value 31 7
4446        }
4447        default {
4448            set msg "Unsupported Fourierinfo access: parm=$parm action=$action"
4449            puts $msg
4450            tk_dialog .badexp "Error in readexp" $msg error 0 Exit
4451        }
4452    }
4453}
4454
4455# set histograms used in Fourier computation
4456#  use:
4457#     FourierHists $phase
4458#     FourierHists $phase set {4 3 2 1}
4459# returns a list of histograms to be used to compute that phase's Fourier map
4460# or sets a list of histograms to be used to compute that phase's Fourier map
4461#
4462# Note that the histograms are loaded in the order specified with reflections in
4463# the last histogram overwriting those in earlier ones, where a reflection
4464# occurs in more than one place
4465proc FourierHists {phase "action get" "value {}"} {
4466    # note that in theory one can have more than one CRSm  FMHSTn record
4467    # if more than 22 histograms are used but we will ignore this
4468    set key "CRS$phase  FMHST1"
4469    if {![existsexp $key]} {
4470        makeexprec $key
4471    }
4472    if {$action == "get"} {
4473        return [string trim [readexp $key]]
4474    } else {
4475        set hlist {}
4476        foreach hist $value {
4477            validint hist 3
4478            append hlist $hist
4479        }
4480        setexp $key $hlist 0 67
4481    }
4482}
4483# get the Fourier map computation step and limits
4484# returns 4 lists:
4485#   {stepx stepy stepz} : step size in Angstroms
4486#   {xmin xmax} : min and max x in fractional coordinates
4487#   {ymin ymax} : min and max y in fractional coordinates
4488#   {zmin zmax} : min and max z in fractional coordinates
4489proc getFourierLimits {phase} {
4490    set key "CRS$phase  FMPCTL"
4491    if {![existsexp $key]} {
4492        makeexprec $key
4493    }
4494    set i 0
4495    set line [readexp $key]
4496    foreach v {x y z} cell {a b c} {
4497        set cell_$v [phaseinfo $phase $cell]
4498    }
4499    foreach typ {step min max} {
4500        foreach v {x y z} {
4501            set val [string trim [string range $line $i [expr $i+5]]]
4502            if {$val = ""} {set val 0}
4503            set ${typ}_${v} $val
4504            incr i 5
4505        }           
4506    }
4507    set steps {}
4508    foreach v {x y z} {
4509        set range_$v {}
4510        lappend steps [expr {[set cell_$v] / [set step_$v]}]
4511        lappend range_$v [expr {[set min_$v] * 1. / [set step_$v] }]
4512        lappend range_$v [expr {[set max_$v] * 1. / [set step_$v] }]
4513    }
4514    return [list $steps $range_x $range_y $range_z]
4515}
4516
4517# set the Fourier map computation step and limits
4518#   Asteps contains {stepx stepy stepz} : step size in Angstroms
4519#   range_x contains {xmin xmax} : min and max x in fractional coordinates
4520#   range_y contains {ymin ymax} : min and max y in fractional coordinates
4521#   range_z contains {zmin zmax} : min and max z in fractional coordinates
4522proc setFourierLimits {phase Asteps range_x range_y range_z} {
4523    set key "CRS$phase  FMPCTL"
4524    if {![existsexp $key]} {
4525        makeexprec $key
4526    }
4527    set i 1
4528    foreach v {x y z} cell {a b c} As $Asteps {
4529        set s [expr {1 + int([phaseinfo $phase $cell] / $As)}]
4530        set s [expr {$s + ($s % 2)}]
4531        set step_$v $s
4532        lappend steps [set step_$v]
4533        validint s 5
4534        setexp $key $s $i 5
4535        incr i 5
4536    }
4537    foreach v {x y z} {
4538        foreach {min max} [set range_$v] {}
4539        set s [expr {int($min * [set step_$v]-.5)}]
4540        validint s 5
4541        setexp $key $s $i 5
4542        incr i 5
4543        set s [expr {int($max * [set step_$v]+.5)}]
4544        validint s 5
4545        setexp $key $s $i 5
4546        incr i 5
4547    }
4548}
Note: See TracBrowser for help on using the repository browser.