forked from johannesgerer/jburkardt-cpp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathxyz_io.html
442 lines (400 loc) · 11.9 KB
/
xyz_io.html
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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
<html>
<head>
<title>
XYZ_IO - XYZ File Input/Output routines.
</title>
</head>
<body bgcolor="#EEEEEE" link="#CC0000" alink="#FF3300" vlink="#000055">
<h1 align = "center">
XYZ_IO <br> XYZ File Input/Output routines.
</h1>
<hr>
<p>
<b>XYZ_IO</b>
is a C++ library which
reads and writes files in the XYZ, XYZL and XYZF formats.
</p>
<p>
XYZ files are a simple way of storing information about sets of points in 3D.
</p>
<p>
An XYZ file has a simple structure. There are three kinds of records:
<ul>
<li>
COMMENT LINES begin with the character '#' and are ignored;
</li>
<li>
BLANK LINES are gnored;
</li>
<li>
COORDINATE LINES each contain one triple of XYZ coordinates;
</li>
</ul>
</p>
<p>
Here is an example of an XYZ file containing 13 points:
<pre>
# cube.xyz
#
0.000000 0.000000 0.000000
1.000000 0.000000 0.000000
1.000000 1.000000 0.000000
0.000000 1.000000 0.000000
0.000000 0.000000 1.000000
1.000000 0.000000 1.000000
1.000000 1.000000 1.000000
0.000000 1.000000 1.000000
</pre>
</p>
<p>
Of course, in many cases, we would like to describe LINES between the points.
We can add this information by including a second file, called an XYZL file,
which consists of a string of point indices. A line is drawn from one point
to the next, and so on for each point listed in a record. Thus, an XYZL file
associated with the above XYZ file might be:
<pre>
# cube.xyzl
#
0 1 2 3 0
4 5 6 7 4
0 4
1 5
2 6
3 7
</pre>
</p>
<p>
We might also like to describe FACES defined by the points.
We can add this information by including a file, called an XYZF file,
which consists of a string of point indices. A face is defined by
listing in counterclockwise order the vertices that lie on it.
The first vertex is not repeated
as the final vertex. Thus, an XYZF file
associated with the above XYZ file might be:
<pre>
# cube.xyzf
#
0 3 2 1
1 2 6 5
4 5 6 7
4 7 3 0
0 1 5 4
2 3 7 6
</pre>
</p>
<h3 align = "center">
Licensing:
</h3>
<p>
The computer code and data files described and made available on this web page
are distributed under
<a href = "../../txt/gnu_lgpl.txt">the GNU LGPL license.</a>
</p>
<h3 align = "center">
Languages:
</h3>
<p>
<b>XYZ_IO</b> is available in
<a href = "../../cpp_src/xyz_io/xyz_io.html">a C++ version</a> and
<a href = "../../f_src/xyz_io/xyz_io.html">a FORTRAN90 version</a> and
<a href = "../../m_src/xyz_io/xyz_io.html">a MATLAB version</a>.
</p>
<h3 align = "center">
Related Data and Programs:
</h3>
<p>
<a href = "../../f_src/ivread/ivread.html">
IVREAD</a>,
a FORTRAN90 program which
can convert graphics information between various 3D formats,
including the XYZ format.
</p>
<p>
<a href = "../../f_src/pdb_to_xyz/pdb_to_xyz.html">
PDB_TO_XYZ</a>,
a FORTRAN90 program which
reads the ATOM records
from a PDB file, and writes the atomic coordinates to an XYZ file.
</p>
<p>
<a href = "../../f_src/stripack_interactive/stripack_interactive.html">
STRIPACK_INTERACTIVE</a>,
a FORTRAN90 program which
reads an XYZ file of 3D points on
the unit sphere, computes the Delaunay triangulation, and writes it
to a file.
</p>
<p>
<a href = "../../data/xy/xy.html">
XY</a>,
a data directory which
contains examples of XY files,
a simple 2D graphics point and line format;
</p>
<p>
<a href = "../../data/xyz/xyz.html">
XYZ</a>,
a data directory which
contains examples of XYZ files,
a simple 3D graphics point and line format;
</p>
<p>
<a href = "../../m_src/xyz_display/xyz_display.html">
XYZ_DISPLAY</a>,
a MATLAB program which
reads XYZ information defining points in 3D, and displays
an image in the MATLAB graphics window.
</p>
<p>
<a href = "../../cpp_src/xyz_display_opengl/xyz_display_opengl.html">
XYZ_DISPLAY_OPENGL</a>,
a C++ program which
reads an XYZ file of 3D point coordinates, and displays
an image of those points using OpenGL.
</p>
<p>
<a href = "../../f_src/xyz_to_pdb/xyz_to_pdb.html">
XYZ_TO_PDB</a>,
a FORTRAN90 program which
reads a set of XYZ spatial coordinates, and
rewrites them as ATOM records in a PDB file.
</p>
<p>
<a href = "../../data/xyzf/xyzf.html">
XYZF</a>,
a data directory which
contains examples of XYZF files,
a simple 3D graphics point and face format;
</p>
<p>
<a href = "../../m_src/xyzf_display/xyzf_display.html">
XYZF_DISPLAY</a>,
a MATLAB program which
reads XYZF information defining points and faces in 3D,
and displays an image in a MATLAB graphics window.
</p>
<p>
<a href = "../../cpp_src/xyzf_display_opengl/xyzf_display_opengl.html">
XYZF_DISPLAY_OPENGL</a>,
a C++ program which
reads XYZF information defining 3D points and faces and displays
an image using OpenGL.
</p>
<p>
<a href = "../../data/xyzl/xyzl.html">
XYZL</a>,
a data directory which
contains examples of XYZL files,
a simple 3D graphics point and line format;
</p>
<p>
<a href = "../../m_src/xyzl_display/xyzl_display.html">
XYZL_DISPLAY</a>,
a MATLAB program which
reads XYZL information defining points and lines in 3D,
and displays an image in a MATLAB graphics window.
</p>
<p>
<a href = "../../cpp_src/xyzl_display_opengl/xyzl_display_opengl.html">
XYZL_DISPLAY_OPENGL</a>,
a C++ program which
reads XYZL information defining 3D points and lines and displays
an image using OpenGL.
</p>
<h3 align = "center">
Source Code:
</h3>
<p>
<ul>
<li>
<a href = "xyz_io.cpp">xyz_io.cpp</a>, the source code.
</li>
<li>
<a href = "xyz_io.hpp">xyz_io.hpp</a>, the include file.
</li>
<li>
<a href = "xyz_io.sh">xyz_io.sh</a>,
commands to compile the source code.
</li>
</ul>
</p>
<h3 align = "center">
Examples and Tests:
</h3>
<p>
<ul>
<li>
<a href = "xyz_io_prb.cpp">xyz_io_prb.cpp</a>,
a sample calling program.
</li>
<li>
<a href = "xyz_io_prb.sh">xyz_io_prb.sh</a>,
commands to compile and run the sample program.
</li>
<li>
<a href = "xyz_io_prb_output.txt">xyz_io_prb_output.txt</a>,
the output file.
</li>
<li>
<a href = "helix.xyz">helix.xyz</a>,
an XYZ file created by the example program.
</li>
<li>
<a href = "xy_io_prb_02.xyz">xy_io_prb_02.xyz</a>,
an XYZ file created by the example program.
</li>
<li>
<a href = "cube.xyz">cube.xyz</a>,
an XYZ file of points created by the example program.
</li>
<li>
<a href = "cube.xyzl">cube.xyzl</a>,
an XYZL file of lines created by the example program.
</li>
<li>
<a href = "cube.xyzf">cube.xyzf</a>,
an XYZF file of lines created by the example program.
</li>
</ul>
</p>
<h3 align = "center">
List of Routines:
</h3>
<p>
<ul>
<li>
<b>CH_EQI</b> is true if two characters are equal, disregarding case.
</li>
<li>
<b>CH_TO_DIGIT</b> returns the integer value of a base 10 digit.
</li>
<li>
<b>I4VEC_COPY</b> copies an I4VEC.
</li>
<li>
<b>R8VEC_COPY</b> copies an R8VEC.
</li>
<li>
<b>S_LEN_TRIM</b> returns the length of a string to the last nonblank.
</li>
<li>
<b>S_TO_I4</b> reads an I4 from a string.
</li>
<li>
<b>S_TO_I4VEC</b> reads an I4VEC from a string.
</li>
<li>
<b>S_TO_R8</b> reads an R8 value from a string.
</li>
<li>
<b>S_TO_R8VEC</b> reads an R8VEC from a string.
</li>
<li>
<b>S_WORD_COUNT</b> counts the number of "words" in a string.
</li>
<li>
<b>TIMESTAMP</b> prints the current YMDHMS date as a time stamp.
</li>
<li>
<b>XYZ_DATA_PRINT</b> prints the data for an XYZ file.
</li>
<li>
<b>XYZ_DATA_READ</b> reads the data in an XYZ file.
</li>
<li>
<b>XYZ_DATA_WRITE</b> writes the data for an XYZ file.
</li>
<li>
<b>XYZ_EXAMPLE</b> sets up data suitable for an XYZ file.
</li>
<li>
<b>XYZ_EXAMPLE_SIZE</b> sizes an example XYZ dataset.
</li>
<li>
<b>XYZ_HEADER_PRINT</b> prints the header of an XYZ file.
</li>
<li>
<b>XYZ_HEADER_READ</b> reads the header of an XYZ file.
</li>
<li>
<b>XYZ_HEADER_WRITE</b> writes the header of an XYZ file.
</li>
<li>
<b>XYZ_READ</b> reads the header and data from an XYZ file.
</li>
<li>
<b>XYZ_READ_TEST</b> tests the XYZ file read routines.
</li>
<li>
<b>XYZ_WRITE</b> writes the header and data for an XYZ file.
</li>
<li>
<b>XYZ_WRITE_TEST</b> tests the XYZ write routines.
</li>
<li>
<b>XYZF_DATA_PRINT</b> prints the data of an XYZF file.
</li>
<li>
<b>XYZF_DATA_READ</b> reads the data in an XYZF file.
</li>
<li>
<b>XYZF_DATA_WRITE</b> writes the data of an XYZF file.
</li>
<li>
<b>XYZF_EXAMPLE</b> sets data suitable for a pair of XYZ and XYZF files.
</li>
<li>
<b>XYZF_EXAMPLE_SIZE</b> sizes the data to be created by XYZF_EXAMPLE.
</li>
<li>
<b>XYZF_HEADER_PRINT</b> prints the header of an XYZF file.
</li>
<li>
<b>XYZF_HEADER_READ</b> determines the number of face items in an XYZF file.
</li>
<li>
<b>XYZF_HEADER_WRITE</b> writes the header of an XYZF file.
</li>
<li>
<b>XYZF_WRITE</b> writes the header and data for an XYZF file.
</li>
<li>
<b>XYZL_DATA_PRINT</b> prints the data of an XYZL file.
</li>
<li>
<b>XYZL_DATA_READ</b> reads the data in an XYZL file.
</li>
<li>
<b>XYZL_DATA_WRITE</b> writes the data of an XYZL file.
</li>
<li>
<b>XYZL_EXAMPLE</b> sets data suitable for a pair of XYZ and XYZL files.
</li>
<li>
<b>XYZL_EXAMPLE_SIZE</b> sizes the data to be created by XYZL_EXAMPLE.
</li>
<li>
<b>XYZL_HEADER_PRINT</b> prints the header of an XYZL file.
</li>
<li>
<b>XYZL_HEADER_READ</b> determines the number of line items in an XYZL file.
</li>
<li>
<b>XYZL_HEADER_WRITE</b> writes the header of an XYZL file.
</li>
<li>
<b>XYZL_WRITE</b> writes the header and data for an XYZL file.
</li>
</ul>
</p>
<p>
You can go up one level to <a href = "../cpp_src.html">
the C++ source codes</a>.
</p>
<hr>
<i>
Last revised on 25 October 2010.
</i>
<!-- John Burkardt -->
</body>
</html>