source: trunk/readexp.tcl @ 1219

Last change on this file since 1219 was 1219, checked in by toby, 8 years ago

Major new release: bug fixes for rigid bodies; Split Restraints from Constraints; add chemistry restraints; edit f' & f; fixes for fixing atoms; start work on Absorption constraints and interface for Fourier maps

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