source: branches/sandbox/readexp.tcl @ 1160

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

a bit of cleanup

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