This file is indexed.

/usr/share/xcrysden/Tcl/scriptingScalarField2D.tcl is in xcrysden-data 1.5.60-1build3.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
#############################################################################
# Author:                                                                   #
# ------                                                                    #
#  Anton Kokalj                                  Email: Tone.Kokalj@ijs.si  #
#  Department of Physical and Organic Chemistry  Phone: x 386 1 477 3523    #
#  Jozef Stefan Institute                          Fax: x 386 1 477 3811    #
#  Jamova 39, SI-1000 Ljubljana                                             #
#  SLOVENIA                                                                 #
#                                                                           #
# Source: $XCRYSDEN_TOPDIR/Tcl/scriptingScalarField2D.tcl
# ------                                                                    #
# Copyright (c) 1996-2003 by Anton Kokalj                                   #
#############################################################################

# ------------------------------------------------------------------------
#****c* Scripting/scripting::scalarField2D
#
# NAME
# scripting::scalarField2D
#
# PURPOSE

# Encapsulate the scripting interface for manipulating the 2D scalar
# field and display of isosurfaces and colorplane+contour plots. A
# typical usage of the interface is the following. First the scalar
# field is loaded with the "load" command. Then with the "configure"
# command the isosurface and/or contours display parameters are set.
# Finally the isosurface and/or contours are displayed using the
# "render" command. It is possible to make several snapshots of
# isosurface and/or contours by changing configuration options, this
# would look as:
#
# load
# configure ...
# render
# configure ..
# render
# ...

#
# COMMANDS

#
# -- scripting::scalarField2D::load

# Loads the scalar field.

#
# -- scripting::scalarField2D::configure

# Configure the display parameters for isosurface and/or contours
# plot.

#
# -- scripting::scalarField2D::render

# Renders the sosurface and/or contours.

#****
# ------------------------------------------------------------------------

namespace eval scripting::scalarField2D {
    variable scalarField2D
    
    set scalarField2D(loaded)     0
    set scalarField2D(configured) 0
}



# ------------------------------------------------------------------------
#****f* Scripting/scripting::scalarField2D::load
#
# NAME
# scripting::scalarField2D::load
#
# USAGE
# scripting::scalarField2D::load
#
# PURPOSE
# This proc load the 2D scalar field.
#
# RETURN VALUE
# Undefined.
#
# EXAMPLE
# scripting::scalarField2D::load
#
#****
# ------------------------------------------------------------------------

proc scripting::scalarField2D::load {} {
    variable scalarField2D
    
    #
    # load datagrid 
    #    
    set dim [DataGridOK [DataGrid]]
    if { $dim != "2D" } {
	error "datagrid is not 2D, but $dim"
    }
    set scalarField2D(loaded) 1

    # 
    # check that the grid is really 2D
    #

    # load the scalar-field 2D defaults
    IsoControl_InitVar
}



# ------------------------------------------------------------------------
#****f* Scripting/scripting::scalarField2D::configure
#
# NAME
# scripting::scalarField2D::configure
#
# USAGE
# scripting::scalarField2D::configure -option value ?-option value? ...
#
# PURPOSE

# This proc configures the display parameters of colorplane/contours
# plot.

#
# ARGUMENTS
# args -- various configuration "-option value" pairs (see Options).
#
# OPTIONS
# ------------------------------------------------------------------------
#   OPTION::                 ALLOWED-VALUES + Description        
# ------------------------------------------------------------------------
#   -interpolation_degree    integer                            
#                            degree of scalar-field interpolation
#
#   -colorbasis              MONOCHROME|RAINBOW|RGB|GEOGRAPHIC|BLUE-WHITE-RED|BLACK-BROWN-WHITE
#                            the color basis for the colorplane
#
#   -scalefunction           LINEAR|LOG10|SQRT|3th-ROOT|EXP(x)|EXP(x^2)
#                            the scalefunctions for contour/colorplane plots
#
#   -expand2D                none|whole|specify
#                            none = do not expand the contour/colorplane plots
#                                   along the periodic directions
#                            whole = expand the contour/colorplane plots
#                                    over the whole structure along the 
#                                    periodic directions
#                            specify = expand the contour/colorplane plots
#                                    along the periodic directions as specified
#                                    by -expand2D_X, -expand2D_Y, and 
#                                    -expand2D_Z factors
#
#   -expand2D_X              positive-integer
#                            expand  contour/colorplane n-times along the 1st
#                            periodic dimension
#
#
#   -expand2D_Y              positive-integer
#                            expand  contour/colorplane n-times along the 2nd
#                            periodic dimension
#
#   -expand2D_Z              positive-integer
#                            expand  contour/colorplane n-times along the 3rd
#                            periodic dimension
#
#   -colorplane              0|1
#                            do not display|display the colorplane
#
#   -isoline                 0|1
#                            do not display|display the isolines
#             
#   -colorplane_lighting     0|1
#                            0 = do not perform lighting for colorplane
#                            1 = perform lighting for colorplane
#
#   -cpl_transparency        0|1
#                            0 = render colorplane as non-transparent
#                            1 = render colorplane as transparent
#
#   -cpl_thermometer         0|1
#                            0 = do not make a legend (i.e. thermometer) for 
#                                colorplane colors
#                            1 = make a legend (i.e. thermometer) for 
#                                colorplane colors
#
#   -2Dlowvalue              real
#                            minimum rendered value of colorplane/isolines
#
#   -2Dhighvalue             real
#                            maximum rendered value of colorplane/isolines
#              
#   -2Dnisoline              positive-integer
#                            number of isoline
#
#   -isoline_color           monocolor|{property color}
#                            monocolor = all isolines have the same color
#                            {property color} = isolines are colorer according
#                            to color-basis
#
#   -isoline_width           positive-integer
#                            width (i.e. thickness) of isolines
#
#   -isoline_monocolor       #rgb
#                            color of the monolor-type isolines
#
# ------------------------------------------------------------------------
#
# RETURN VALUE
# Undefined.
# 
# EXAMPLE
# scripting::scalarField2D::configure \
#     -interpolation_degree 2 \
#     -colorbasis           RAINBOW \
#     -scalefunction        LOG10 \
#     -expand2D             specify \
#     -expand2D_X 	    1 \
#     -expand2D_Y           1 \
#     -expand2D_Z           1 \
#     -colorplane           1 \
#     -isoline              1 \
#     -colorplane_lighting  0 \
#     -cpl_transparency     0 \
#     -cpl_thermometer      1 \
#     -2Dlowvalue           +0.00001 \
#     -2Dhighvalue          +0.1 \
#     -2Dnisoline           5 \
#     -isoline_color        monocolor \
#     -isoline_width        3 \
#     -isoline_monocolor    \#ffffff
#
#****
# ------------------------------------------------------------------------

proc scripting::scalarField2D::configure {args} {
    variable scalarField2D
    global isosurf isoControl prop

    #
    # assuming the 2D grid !!!
    #

    set scalarField2D(configured) 1

    # parse the options
    
    set i 0
    foreach option $args {
	incr i
	
	if { $i%2 } {
            set tag $option
	} else {	    
            switch -glob -- $tag {
		"-interpolation_degree" {
		    if { ! [string is integer $option] } {
			ErrorDialog "expected integer for -interpolationdegree option, but got $option"
		    } elseif { $option < 1 } {
			ErrorDialog "-interpolationdegree value should be greater then 0, but got $option"
		    } else {
			set isosurf(3Dinterpl_degree) $option
		    }
		}
		
		"-colorbasis" {
		    switch -exact -- $option {
			MONOCHROME - RAINBOW - RGB - GEOGRAPHIC - BLUE-WHITE-RED { set cpl_basis $option }			    
			default {
			    ErrorDialog "wrong colorbasis $option, must be ..." 
			    continue
			}  
		    }
		}

		"-scalefunction" {
		    switch -exact -- $option {
			LINEAR - LOG10 - SQRT - 3th-ROOT - EXP(x) - EXP(x^2) {set cpl_function $option }
			default {			    
			    ErrorDialog "wrong scale-function $option, must be ..." 
			    continue
			}  
		    }
		}

		"-expand2D" {
		    switch -- $option {
			none - whole - specify { set expand2D $option }
			default {
			    ErrorDialog "wrong -expand2D value $option, must be none, whole, specify" 
			    continue
			}
		    }
		}
		"-expand2D_X" -	
		"-expand2D_Y" -
		"-expand2D_Z" {
		    if { ! [string is integer $option] } {
			ErrorDialog "expected integer for $tag option, but got $option"
		    } elseif { $option < 1 } {
			ErrorDialog "$tag value should be greater then 0, but got $option"
		    } else {
			set var [string trimleft $tag -]
			set $var $option
		    }
		}
		
		"-colorplane" -
		"-isoline" -
		"-colorplane_lighting" -
		"-cpl_transparency" -
		"-cpl_thermometer" -
		"-2Dlowvalue" -
		"-2Dhighvalue" -
		"-2Dnisoline" -
		"-isoline_color" -
		"-isoline_width" -
		"-isoline_monocolor" {
		    set var [string trimleft $tag -]
		    set $var $option
		}
	    }
	}
    }
    if { $i%2 } {
	ErrorDialog "scripting::scalarField2D::configure called with an odd number of arguments !!!"
    }
    
    if { [info exists 2Dexpand]   } { set isosurf(2Dexpand)       $2Dexpand }
    if { [info exists 2Dexpand_X] } { set isosurf(2Dexpand_X)     $2Dexpand_X }
    if { [info exists 2Dexpand_Y] } { set isosurf(2Dexpand_Y)     $2Dexpand_Y }
    if { [info exists 2Dexpand_Z] } { set isosurf(2Dexpand_Z)     $2Dexpand_Z }   	

    if { [info exists cpl_basis] } {           set isoControl(cpl_basis)           $cpl_basis }
    if { [info exists cpl_function] } {        set isoControl(cpl_function)        $cpl_function }
    if { [info exists colorplane] } {          set isoControl(colorplane)          $colorplane }
    if { [info exists isoline] } {             set isoControl(isoline)             $isoline }
    if { [info exists colorplane_lighting] } { set isoControl(colorplane_lighting) $colorplane_lighting }
    if { [info exists cpl_transparency] } {    set isoControl(cpl_transparency)    $cpl_transparency }
    if { [info exists cpl_thermometer] } {     set isoControl(cpl_thermometer)     $cpl_thermometer }
    if { [info exists cpl_thermoTplw] } {      set isoControl(cpl_thermoTplw)      $cpl_thermoTplw }    
    if { [info exists 2Dlowvalue] } {          set isoControl(2Dlowvalue)          $2Dlowvalue }
    if { [info exists 2Dhighvalue] } {         set isoControl(2Dhighvalue)         $2Dhighvalue }
    if { [info exists 2Dnisoline] } {          set isoControl(2Dnisoline)          $2Dnisoline }    
    if { [info exists isoline_color] } {       set isoControl(isoline_color)       $isoline_color }
    if { [info exists isoline_width] } {       set isoControl(isoline_width)       $isoline_width }
    if { [info exists isoline_monocolor] } {   set isoControl(isoline_monocolor)   $isoline_monocolor }
    if { [info exists isoline_stipple] } {     set isoControl(isoline_stipple)     $isoline_stipple }
}


# ------------------------------------------------------------------------
#****f* Scripting/scripting::scalarField2D::render
#
# NAME
# scripting::scalarField2D::render
#
# USAGE
# scripting::scalarField2D::render
#
# PURPOSE
#
# This proc displays the contours or colorplane or both (depending on
# the configuration).
#
# RETURN VALUE
# Undefined.
#
# EXAMPLE
# scripting::scalarField2D::render
#
#****
# ------------------------------------------------------------------------

proc scripting::scalarField2D::render {} {
    variable scalarField2D

    if { !$scalarField2D(loaded) } {
	ErrorDialog "can't render contours, the scalar field was not loaded. Call scripting::scalarField2D::load and scripting::scalarField2D::configure before calling scripting::scalarField2D::render"
	return
    }

    if { !$scalarField2D(configured) } {
	ErrorDialog "can't render contours, since they were not configured. Call scripting::scalarField2D::configure before calling scripting::scalarField2D::render"
	return
    }

    #############
    UpdatePropertyPlane
}