This file is indexed.

/usr/share/xcrysden/examples/Scripting/colorplane_animation.tcl is in xcrysden-data 1.5.53-1.

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
# ------------------------------------------------------------------------
#****** ScriptingExamples/colorplane_animation.tcl ***
#
# NAME
# colorplane_animation.tcl -- a simple example for animating a contour plots
#
# USAGE
# xcrysden --script colorplane_animation.tcl
#
# COPYRIGHT
# Anton Kokalj (C) 2003
#
# PURPOSE

# This is a scripting example that shows how to produce an animation
# of colorplane/contour plots by loading the XSF file which contains
# the description of the 3D scalar field. In this example the contours
# of the LUMO molecular-orbital are animated trough the CO molecule
# for all three three basal planes (i.e. XY, XZ, and YZ).

#
# AUTHOR
# Anton Kokalj
#
# CREATION DATE
# Sometime in February 2003
# 
# SOURCE


# ------------------------------------------------------------------------
# load the structure (the argument to scription:open is the command line
# ------------------------------------------------------------------------

scripting::open --xsf $env(XCRYSDEN_TOPDIR)/examples/Xcrysden_Structure_Files/CO_lumo.xsf.gz



# ------------------------------------------------------------------------
# display the structure in appropriate display-mode
# ------------------------------------------------------------------------

#-----
# this is Lighting-On modes:
#-----
scripting::lighting On

# choose a given 3D-display mode

#scripting::displayMode3D Stick
scripting::displayMode3D Pipe&Ball
#scripting::displayMode3D BallStick
#scripting::displayMode3D SpaceFill
#----


# ------------------------------------------------------------------------
# maximize the XCRYSDEN main window
# ------------------------------------------------------------------------

#scripting::mainWindow maximize
scripting::displayWindow fullscreen

# ------------------------------------------------------------------------
# load the 3D scalar field
# ------------------------------------------------------------------------

scripting::scalarField3D::load


# ------------------------------------------------------------------------
# hide the isosourface control window
# ------------------------------------------------------------------------

IsoControl_Hide
# alternatively you could do
#wm withdraw .iso


# ------------------------------------------------------------------------
# this is preliminary, used for the sake of better visualizing
# effect. See below the desciption of the two functions used here.
# ------------------------------------------------------------------------

scripting::scalarField3D::configure \
    -isosurface           0 \
    -interpolation_degree 2 \
    -basalplane           2 \
    -colorbasis           BLUE-WHITE-RED \
    -scalefunction        LINEAR \
    -colorplane           1 \
    -isoline              1 \
    -colorplane_lighting  0 \
    -cpl_transparency     1 \
    -cpl_thermometer      1 \
    -2Dlowvalue           -0.2 \
    -2Dhighvalue          +0.2 \
    -2Dnisoline           11 \
    -anim_step            1 \
    -current_slide        1 \
    -isoline_color        {property color} \
    -isoline_width        3 \

#    -isoline_monocolor    \#000000            
scripting::scalarField3D::render



# ------------------------------------------------------------------------
# zoom and rotate the structure 
# ------------------------------------------------------------------------

scripting::zoom -0.08 8 
scripting::rotate x -5 18
scripting::rotate y +5 15


# do the animation show forever

while {1} {

#
# description of scripting::scalarField3D::configure options:
#
# ------------------------------------------------------------------------
#   OPTION::                 ALLOWED-VALUES + Description          STATUS
# ------------------------------------------------------------------------
#   -isosurface              0|1                                 REQUIRED
#                            0 = do not render isosurface
#                            1 = render isosurface
#
#   -interpolation_degree    integer                             OPTIONAL
#                            degree of scalar-field interpolation
#
#   -isolevel                real                                REQUIRED
#                            the isovalue of isosurface
#
#   -plusminus               0|1
#                            0 = display only the isosurface of isovalue 
#                                specified by -isolevel
#                            1 = display the two isosurfaces of +-isovalue
#
#   -revertsides             pos|neg|{pos neg}
#                            pos = revert the front- and back-side of isovalue 
#                                  isosurface
#                            neg = revert the front- and back-side of -isovalue
#                                  isosurface
#   -revertnormals           pos|neg|{pos neg}
#                            pos = revert the normals of isovalue isosurface
#                            neg = revert the normals of -isovalue isosurface
#
#   -basalplane              0|1|2
#                            show the ith basal plane (0=xy, 1=xz, 2=yz)
#                            as colorplane and/or isolines (as specified by
#                            -colorplane and -isoline options)
#
#   -colorbasis              MONOCHROME|RAINBOW|RGB|GEOGRAPHIC|BLUE-WHITE-RED
#                            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
#
#   -anim_step               positive-integer
#                            animation step
#
#   -current_slide           positive-integer
#                            iD (i.e. sequential number) of colorplane
#
#   -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
#
# ------------------------------------------------------------------------
#
#
# Example:
#
# scripting::scalarField3D::configure \
#     -isosurface           1 \
#     -interpolation_degree 2 \
#     -isolevel             0.1 \
#     -plusminus            1 \
#     -revertsides          {pos neg} \
#     -revertnormal         {pos neg} \
#     -basalplane           0 \
#     -colorbasis           BLUE-WHITE-RED \
#     -scalefunction        LINEAR \
#     -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.1 \
#     -2Dhighvalue          +0.1 \
#     -2Dnisoline           11 \
#     -anim_step            1 \
#     -current_slide        30 \
#     -isoline_color        monocolor \
#     -isoline_width        3 \
#     -isoline_monocolor    \#000000
# 


    # ------------------------------------------------------------------------
    # configure, i.e., specify how to render the scalar field
    #
    # render 2nd basal plane
    # ------------------------------------------------------------------------
    scripting::scalarField3D::configure \
	-isosurface           0 \
	-interpolation_degree 2 \
	-basalplane           2 \
	-colorbasis           BLUE-WHITE-RED \
	-scalefunction        LINEAR \
	-colorplane           1 \
	-isoline              1 \
	-colorplane_lighting  0 \
	-cpl_transparency     1 \
	-cpl_thermometer      1 \
	-2Dlowvalue           -0.2 \
	-2Dhighvalue          +0.2 \
	-2Dnisoline           11 \
	-anim_step            1 \
	-current_slide        1 \
	-isoline_color        {property color} \
	-isoline_width        3 \

#	-isoline_monocolor    \#000000            
    
    # ------------------------------------------------------------------------
    # render the 3D scalar field as requested by 
    # scripting::scalarField3D::configure
    # ------------------------------------------------------------------------
    
    scripting::scalarField3D::render
    

    
    # ------------------------------------------------------------------------
    # now let us do the animation
    # ------------------------------------------------------------------------
    
    for {set i 1} {$i <= 49} {incr i} {
	scripting::scalarField3D::configure -current_slide $i
	scripting::scalarField3D::render
    }
    for {set i 49} {$i > 0} {incr i -1} {
	scripting::scalarField3D::configure -current_slide $i
	scripting::scalarField3D::render
    }
    scripting::scalarField3D::configure -colorplane 0 -isoline 0 -cpl_thermometer 0
    
    
    # now render the 1st basal plane

    scripting::scalarField3D::configure \
	-basalplane           1 \
	-colorbasis           BLUE-WHITE-RED \
	-scalefunction        LINEAR \
	-colorplane           1 \
	-isoline              1 \
	-colorplane_lighting  0 \
	-cpl_transparency     1 \
	-cpl_thermometer      1 \
	-2Dlowvalue           -0.2 \
	-2Dhighvalue          +0.2 \
	-2Dnisoline           11 \
	-anim_step            49 \
	-current_slide        1 \
	-isoline_color        {property color} \
	-isoline_width        3 \

#	-isoline_monocolor    \#000000
    scripting::scalarField3D::render
    scripting::rotate y 5 18    

    for {set i 1} {$i <= 49} {incr i} {
	scripting::scalarField3D::configure -current_slide $i
	scripting::scalarField3D::render
    }
    for {set i 49} {$i > 0} {incr i -1} {
	scripting::scalarField3D::configure -current_slide $i
	scripting::scalarField3D::render
    }
    scripting::scalarField3D::configure -colorplane 0 -isoline 0 \
	-cpl_thermometer 0    


    # now render the 3rd basal plane
    scripting::scalarField3D::configure \
	-basalplane           3 \
	-colorbasis           BLUE-WHITE-RED \
	-scalefunction        LINEAR \
	-colorplane           1 \
	-isoline              1 \
	-colorplane_lighting  0 \
	-cpl_transparency     1 \
	-cpl_thermometer      1 \
	-2Dlowvalue           -0.2 \
	-2Dhighvalue          +0.2 \
	-2Dnisoline           11 \
	-anim_step            1 \
	-current_slide        1 \
	-isoline_color        {property color} \
	-isoline_width        3 \

#	-isoline_monocolor    \#000000
    scripting::scalarField3D::render
    scripting::rotate y -5 18    
    scripting::rotate x +5 26 

    for {set i 1} {$i <= 49} {incr i} {
	scripting::scalarField3D::configure -current_slide $i
	scripting::scalarField3D::render
    }
    for {set i 49} {$i > 0} {incr i -1} {
	scripting::scalarField3D::configure -current_slide $i
	scripting::scalarField3D::render
    }
    scripting::rotate x -5 26
    scripting::scalarField3D::configure -colorplane 0 -isoline 0 \
	-cpl_thermometer 0      
}

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