-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.html
864 lines (778 loc) · 31.1 KB
/
README.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
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.16: http://docutils.sourceforge.net/" />
<title>libpnmio user manual</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
.subscript {
vertical-align: sub;
font-size: smaller }
.superscript {
vertical-align: super;
font-size: smaller }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left, table.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right, table.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
.align-top {
vertical-align: top }
.align-middle {
vertical-align: middle }
.align-bottom {
vertical-align: bottom }
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="libpnmio-user-manual">
<h1 class="title">libpnmio user manual</h1>
<table border="1" class="docutils">
<colgroup>
<col width="25%" />
<col width="75%" />
</colgroup>
<tbody valign="top">
<tr><td><strong>Title</strong></td>
<td>libpnmio (I/O PNM library)</td>
</tr>
<tr><td><strong>Author</strong></td>
<td>Nikolaos Kavvadias 2012, 2013, 2014, 2015, 2016, 2017,
2018, 2019, 2020</td>
</tr>
<tr><td><strong>Contact</strong></td>
<td><a class="reference external" href="mailto:nikolaos.kavvadias@gmail.com">nikolaos.kavvadias@gmail.com</a></td>
</tr>
<tr><td><strong>Website</strong></td>
<td><a class="reference external" href="http://www.nkavvadias.com">http://www.nkavvadias.com</a></td>
</tr>
<tr><td><strong>Release Date</strong></td>
<td>10 March 2016</td>
</tr>
<tr><td><strong>Version</strong></td>
<td>1.2.6</td>
</tr>
<tr><td><strong>Rev. history</strong></td>
<td> </td>
</tr>
<tr><td><strong>v1.2.6</strong></td>
<td><p class="first">2016-03-10</p>
<p class="last">Add sftbyvec.c, related changes.</p>
</td>
</tr>
<tr><td><strong>v1.2.5</strong></td>
<td><p class="first">2014-10-28</p>
<p class="last">Fixed bugs in PFM format I/O.</p>
</td>
</tr>
<tr><td><strong>v1.2.4</strong></td>
<td><p class="first">2014-10-28</p>
<p class="last">Added names to prototype parameters.</p>
</td>
</tr>
<tr><td><strong>v1.2.3</strong></td>
<td><p class="first">2014-10-28</p>
<p class="last">Documentation update; add <tt class="docutils literal">get_pnm_type</tt> and reference
to the IrfanView image viewer.</p>
</td>
</tr>
<tr><td><strong>v1.2.2</strong></td>
<td><p class="first">2014-10-26</p>
<ul class="last simple">
<li>New test application, <tt class="docutils literal">rnwimg</tt> for reading and
writing PBM, PGM, PPM and PFM images.</li>
<li>Numerous bug fixes to <tt class="docutils literal">read_p*m_header</tt> routines.</li>
<li>Added <tt class="docutils literal">get_pnm_type</tt>.</li>
<li>Removed <tt class="docutils literal">squares.binary.pgm</tt> (all-black image).</li>
<li>Removed <tt class="docutils literal">feep.ascii.ppm</tt> (incomplete image).</li>
<li>PFM reading still needs work.</li>
</ul>
</td>
</tr>
<tr><td><strong>v1.2.1</strong></td>
<td><p class="first">2014-10-25</p>
<p class="last">Added sample PBM, PGM, PPM and PFM images for testing.</p>
</td>
</tr>
<tr><td><strong>v1.2.0</strong></td>
<td><p class="first">2014-10-25</p>
<p class="last">Added support for reading and writing PFM (Portable Float
Map) image data files.</p>
</td>
</tr>
<tr><td><strong>v1.1.1</strong></td>
<td><p class="first">2014-10-01</p>
<p class="last">Date notation change.</p>
</td>
</tr>
<tr><td><strong>v1.1.0</strong></td>
<td><p class="first">2014-09-23</p>
<p class="last">Moved AUTHORS, LICENSE, README, VERSION to top-level.</p>
</td>
</tr>
<tr><td><strong>v1.0.1</strong></td>
<td><p class="first">2014-06-14</p>
<p class="last">Changed README to README.rst.</p>
</td>
</tr>
<tr><td><strong>v1.0.0</strong></td>
<td><p class="first">2014-02-20</p>
<p class="last">First public release.</p>
</td>
</tr>
</tbody>
</table>
<div class="section" id="introduction">
<h1>1. Introduction</h1>
<p>The <tt class="docutils literal">libpnmio</tt> library provides an implementation and API for reading
and writing <a class="reference external" href="http://en.wikipedia.org/wiki/Netpbm_format">PNM</a> (some times termed as Portable AnyMap) images. The <a class="reference external" href="http://en.wikipedia.org/wiki/Netpbm_format">PNM</a>
convention is collectively used to address <a class="reference external" href="http://netpbm.sourceforge.net/doc/pbm.html">PBM</a> (Portable Bitmap), <a class="reference external" href="http://netpbm.sourceforge.net/doc/pgm.html">PGM</a>
(Portable Greymap) and <a class="reference external" href="http://netpbm.sourceforge.net/doc/ppm.html">PPM</a> (Portable Pixmap) images.</p>
<p>The current version of <tt class="docutils literal">libpnmio</tt> supports the ASCII variation of the
PNM formats, however, it will be extended in order to support the
corresponding binary formats.</p>
<p>The library is accompanied by the following test applications:</p>
<ul class="simple">
<li><tt class="docutils literal">randimg</tt>: produces PBM/PGM/PPM image files filled with random data</li>
<li><tt class="docutils literal">doset</tt>: generates a color illustration of the Mandelbrot set</li>
<li><tt class="docutils literal">rnwimg</tt>: reads and writes PBM/PGM/PPM/PFM images for testing the library</li>
<li><tt class="docutils literal">sftbyvec</tt>: reads an input ASCII PGM image, shifts its contents by a
given vector and then writes it back.</li>
</ul>
<p>Since version 1.2.0, support for the Portable Float Map format (<a class="reference external" href="http://netpbm.sourceforge.net/doc/pfm.html">PFM</a>) has been
added.</p>
<p>Additional information on the PFM format can be found at the
<a class="reference external" href="http://paulbourke.net/dataformats/pbmhdr/">PFM page by Paul Bourke</a>.</p>
<p>Reference documentation for LIBPNMIO can be found in the <tt class="docutils literal">/doc</tt> subdirectory
in plain text, HTML and PDF form.</p>
</div>
<div class="section" id="file-listing">
<h1>2. File listing</h1>
<p>The <tt class="docutils literal">libpnmio</tt> distribution includes the following files:</p>
<table border="1" class="docutils">
<colgroup>
<col width="30%" />
<col width="70%" />
</colgroup>
<tbody valign="top">
<tr><td>/libpnmio</td>
<td>Top-level directory</td>
</tr>
<tr><td>AUTHORS</td>
<td>List of authors.</td>
</tr>
<tr><td>LICENSE</td>
<td>License agreement (modified BSD license).</td>
</tr>
<tr><td>README.rst</td>
<td>This file.</td>
</tr>
<tr><td>README.html</td>
<td>HTML version of README.rst.</td>
</tr>
<tr><td>README.pdf</td>
<td>PDF version of README.rst.</td>
</tr>
<tr><td>VERSION</td>
<td>Current version of the LIBPNMIO distribution.</td>
</tr>
<tr><td>rst2docs.sh</td>
<td>Shell script for generating the documentation using
<tt class="docutils literal">docutils</tt>.</td>
</tr>
<tr><td>/bin</td>
<td>Executables directory (initially empty)</td>
</tr>
<tr><td>/images</td>
<td>Image data (PBM, PGM, PPM, PFM) for testing</td>
</tr>
<tr><td>*.pbm, *.pgm,
*.ppm, *.pfm</td>
<td>Sample images.</td>
</tr>
<tr><td>/lib</td>
<td>Compiled static library directory</td>
</tr>
<tr><td>/src</td>
<td>Source code directory</td>
</tr>
<tr><td>Makefile</td>
<td>Makefile for compiling the library and generating
the executables.</td>
</tr>
<tr><td>doset.c</td>
<td>Generates a color visualization of the Mandelbrot
set.</td>
</tr>
<tr><td>pnmio.c</td>
<td>Implementation of the <tt class="docutils literal">libpnmio</tt> library in C.</td>
</tr>
<tr><td>pnmio.h</td>
<td>Header file (interface) of the <tt class="docutils literal">libpnmio</tt> library.</td>
</tr>
<tr><td>randimg.c</td>
<td>Random PBM/PGM/PPM/PFM image generator.</td>
</tr>
<tr><td>rnwimg.c</td>
<td>Reads and writes PBM/PGM/PPM/PFM images for
exercising the <tt class="docutils literal">libpnmio</tt> API.</td>
</tr>
<tr><td>sftbyvec.c</td>
<td>Read an input ASCII PGM image, shift its contents by
a given vector and then writes it back</td>
</tr>
<tr><td>/test</td>
<td>Test script directory</td>
</tr>
<tr><td>run-doset.sh</td>
<td>Bash script for running the Mandelbrot set example.</td>
</tr>
<tr><td>run-randimg.sh</td>
<td>Bash script for running the random image generator.</td>
</tr>
<tr><td>run-rnwimg.sh</td>
<td>Bash script for running the read-and-write API tests.</td>
</tr>
<tr><td>run-sftbyvec.sh</td>
<td>Bash script for running the shift-by-vector tests.</td>
</tr>
</tbody>
</table>
<p>The original sources for the images included in the <tt class="docutils literal">/libpnmio/images</tt>
directory are the following:</p>
<ul class="simple">
<li><em>prague, squares, lena32, fruit, blocks</em><ul>
<li><a class="reference external" href="http://graphics.stanford.edu/~jowens/223b/examples.html">http://graphics.stanford.edu/~jowens/223b/examples.html</a></li>
</ul>
</li>
<li><em>letter_j, feep, ppmex255.ascii, ppmex1</em><ul>
<li><a class="reference external" href="http://en.wikipedia.org/wiki/Netpbm_format">http://en.wikipedia.org/wiki/Netpbm_format</a></li>
</ul>
</li>
<li><em>haus</em><ul>
<li><a class="reference external" href="http://goo.gl/DBbPpF">http://goo.gl/DBbPpF</a></li>
</ul>
</li>
<li><em>ppmex255.binary</em><ul>
<li><a class="reference external" href="http://wiki.multimedia.cx/index.php">http://wiki.multimedia.cx/index.php</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="api-description">
<h1>3. API description</h1>
<p>This section summarizes the intended functionality of the functions supported
by the <tt class="docutils literal">libpnmio</tt> application programming interface.</p>
<div class="section" id="get-pnm-type">
<h2>3.1 get_pnm_type</h2>
<div class="line-block">
<div class="line"><tt class="docutils literal">int get_pnm_type(FILE *f);</tt></div>
</div>
<p>Read the header contents of a PBM/PGM/PPM/PFM file up to the point of extracting
its type. Valid types for a PNM image are as follows:</p>
<ul class="simple">
<li><tt class="docutils literal">PBM_ASCII</tt> = 1</li>
<li><tt class="docutils literal">PGM_ASCII</tt> = 2</li>
<li><tt class="docutils literal">PPM_ASCII</tt> = 3</li>
<li><tt class="docutils literal">PBM_BINARY</tt> = 4</li>
<li><tt class="docutils literal">PGM_BINARY</tt> = 5</li>
<li><tt class="docutils literal">PPM_BINARY</tt> = 6</li>
<li><tt class="docutils literal">PAM</tt> = 7 (unimplemented)</li>
<li><tt class="docutils literal">PFM_RGB</tt> = 16</li>
<li><tt class="docutils literal">PFM_GREYSCALE</tt> = 17</li>
</ul>
<p>The result (pnm_type) is returned.</p>
</div>
<div class="section" id="read-pbm-header">
<h2>3.2 read_pbm_header</h2>
<div class="line-block">
<div class="line"><tt class="docutils literal">void read_pbm_header(FILE *f, int *img_xdim, int *img_ydim, int is_ascii);</tt></div>
</div>
<p>Read the header contents of a PBM (portable bit map) file. A PBM image file
follows the format:</p>
<pre class="literal-block">
P1
<X> <Y>
<I1> <I2> ... <IMAX>
</pre>
<p>A binary PBM image file uses P4 instead of P1 and the data values are
represented in binary.
Comment lines start with <tt class="docutils literal">#</tt>.
<tt class="docutils literal">< ></tt> denote integer values (in decimal). For the PBM format, they can
take only the 0 and 1 values.
<tt class="docutils literal">img_xdim</tt> and <tt class="docutils literal">img_ydim</tt> correspond to <tt class="docutils literal">X</tt> and <tt class="docutils literal">Y</tt>, respectively.
If <tt class="docutils literal">is_ascii</tt> is 1, an ASCII PBM file is assumed; otherwise a binary PBM file
is.</p>
</div>
<div class="section" id="read-pgm-header">
<h2>3.3 read_pgm_header</h2>
<div class="line-block">
<div class="line"><tt class="docutils literal">read_pgm_header(FILE *f, int *img_xdim, int *img_ydim, int *img_colors, int is_ascii);</tt></div>
</div>
<p>Read the header contents of a PGM (portable grey map) file. A PGM image file
follows the format:</p>
<pre class="literal-block">
P2
<X> <Y>
<levels>
<I1> <I2> ... <IMAX>
</pre>
<p>A binary PGM image file uses P5 instead of P2 and the data values are
represented in binary.
Comment lines start with <tt class="docutils literal">#</tt>.
<tt class="docutils literal">< ></tt> denote integer values (in decimal).
<tt class="docutils literal">img_xdim</tt>, <tt class="docutils literal">img_ydim</tt>, and <tt class="docutils literal">img_colors</tt> correspond to <tt class="docutils literal">X</tt>, <tt class="docutils literal">Y</tt>
and <tt class="docutils literal">levels</tt>, respectively.
If <tt class="docutils literal">is_ascii</tt> is 1, an ASCII PGM file is assumed; otherwise a binary PGM file
is.</p>
</div>
<div class="section" id="read-ppm-header">
<h2>3.4 read_ppm_header</h2>
<div class="line-block">
<div class="line"><tt class="docutils literal">void read_ppm_header(FILE *f, int *img_xdim, int *img_ydim, int *img_colors, int is_ascii);</tt></div>
</div>
<p>Read the header contents of a PPM (portable pix map) file. A PPM image file
follows the format:</p>
<pre class="literal-block">
P3
<X> <Y>
<levels>
<R1> <G1> <B1> ... <RMAX> <GMAX> <BMAX>
</pre>
<p>A binary PPM image file uses P6 instead of P3 and the data values are
represented in binary.
Comment lines start with <tt class="docutils literal">#</tt>.
<tt class="docutils literal">< ></tt> denote integer values (in decimal).
<tt class="docutils literal">img_xdim</tt>, <tt class="docutils literal">img_ydim</tt>, and <tt class="docutils literal">img_colors</tt> correspond to <tt class="docutils literal">X</tt>, <tt class="docutils literal">Y</tt>
and <tt class="docutils literal">levels</tt>, respectively. Each color component, R, G, and B can take any
value from 0 to levels.
If <tt class="docutils literal">is_ascii</tt> is 1, an ASCII PPM file is assumed; otherwise a binary PPM file
is.</p>
</div>
<div class="section" id="read-pfm-header">
<h2>3.5 read_pfm_header</h2>
<div class="line-block">
<div class="line"><tt class="docutils literal">void read_pfm_header(FILE *f, int *img_xdim, int *img_ydim, int *img_type, int *endianess);</tt></div>
</div>
<p>Read the header contents of a PFM (portable float map) file. A PFM image file
follows the format:</p>
<pre class="literal-block">
[PF|Pf]
<X> <Y>
(endianess)
{R1}{G1}{B1} ... {RMAX}{GMAX}{BMAX}
</pre>
<p>A PFM image file has its data values represented in binary.
Comment lines start with <tt class="docutils literal">#</tt>.
<tt class="docutils literal">< ></tt> denote integer values (in decimal).
<tt class="docutils literal">( )</tt> denote floating-point values (in decimal).
<tt class="docutils literal">{ }</tt> denote floating-point values (coded in binary).
<tt class="docutils literal">img_xdim</tt> and <tt class="docutils literal">img_ydim</tt> correspond to <tt class="docutils literal">X</tt> and <tt class="docutils literal">Y</tt>, respectively. If
<tt class="docutils literal">img_type</tt> is equal to 1, the PFM image encodes RGB (color) information,
otherwise if it is equal to 0, it stores greyscale information.
If <tt class="docutils literal">endianess</tt> is negative (-1), the binary data are encoded in little-endian
ordering, otherwise if <tt class="docutils literal">endianess</tt> is positive (+1), the data follow
big-endian ordering.</p>
</div>
<div class="section" id="read-pbm-data">
<h2>3.6 read_pbm_data</h2>
<div class="line-block">
<div class="line"><tt class="docutils literal">void read_pgm_data(FILE *f, int *img_in, int is_ascii);</tt></div>
</div>
<p>Read the data contents of a PBM (portable bit map) file.
<tt class="docutils literal">img_in</tt> denotes an array of integer values representing image data.
If <tt class="docutils literal">is_ascii</tt> is 1, an ASCII PBM file is assumed; otherwise a binary PBM file
is.</p>
</div>
<div class="section" id="read-pgm-data">
<h2>3.7 read_pgm_data</h2>
<div class="line-block">
<div class="line"><tt class="docutils literal">void read_pgm_data(FILE *f, int *img_in, int is_ascii);</tt></div>
</div>
<p>Read the data contents of a PGM (portable grey map) file.
<tt class="docutils literal">img_in</tt> denotes an array of integer values representing image data.
If <tt class="docutils literal">is_ascii</tt> is 1, an ASCII PGM file is assumed; otherwise a binary PGM file
is.</p>
</div>
<div class="section" id="read-ppm-data">
<h2>3.8 read_ppm_data</h2>
<div class="line-block">
<div class="line"><tt class="docutils literal">void read_ppm_data(FILE *f, int *img_in, int is_ascii);</tt></div>
</div>
<p>Read the data contents of a PPM (portable pix map) file.
<tt class="docutils literal">img_in</tt> denotes an array of integer values representing image data.
If <tt class="docutils literal">is_ascii</tt> is 1, an ASCII PPM file is assumed; otherwise a binary PPM file
is.</p>
</div>
<div class="section" id="read-pfm-data">
<h2>3.9 read_pfm_data</h2>
<div class="line-block">
<div class="line"><tt class="docutils literal">void read_ppm_data(FILE *f, float *img_in, int img_type, int endianess);</tt></div>
</div>
<p>Read the data contents of a PFM (portable float map) file.
<tt class="docutils literal">img_in</tt> denotes an array of floating-point (<tt class="docutils literal">float</tt>) values representing
image data. If <tt class="docutils literal">img_type</tt> is 1, color/RGB image data are assumed; otherwise
(0) the image data are in greyscale. A negative <tt class="docutils literal">endianess</tt> indicates
little-endian ordering and positive one, big-endian.</p>
</div>
<div class="section" id="write-pbm-file">
<h2>3.10 write_pbm_file</h2>
<div class="line-block">
<div class="line"><tt class="docutils literal">void write_pbm_file(FILE *f, int *img_out,</tt></div>
<div class="line"><tt class="docutils literal">int x_size, int y_size, int x_scale_val, int y_scale_val, int linevals, int is_ascii);</tt></div>
</div>
<p>Write the contents of a PBM (portable bit map) file.
Data stored in array <tt class="docutils literal">img_out</tt> are written to file <tt class="docutils literal">f</tt>. The
image data represent an image of size <tt class="docutils literal">x_size</tt> by <tt class="docutils literal">y_size</tt>. x-axis and
y-axis scaling factors can be defined by <tt class="docutils literal">x_scale_val</tt> and <tt class="docutils literal">y_scale_val</tt>.
<tt class="docutils literal">linevals</tt> determines the emission of newline characters for easier
reading of the PBM file data.
If <tt class="docutils literal">is_ascii</tt> is 1, an ASCII PBM file is assumed; otherwise a binary PBM file
is.</p>
</div>
<div class="section" id="write-pgm-file">
<h2>3.11 write_pgm_file</h2>
<div class="line-block">
<div class="line"><tt class="docutils literal">void write_pgm_file(FILE *f, int *img_out,</tt></div>
<div class="line"><tt class="docutils literal">int x_size, int y_size, int x_scale_val, int y_scale_val, int img_colors,</tt></div>
<div class="line"><tt class="docutils literal">int linevals, int is_ascii);</tt></div>
</div>
<p>Write the contents of a PGM (portable grey map) file.
Data stored in array <tt class="docutils literal">img_out</tt> are written to file <tt class="docutils literal">f</tt>. The
image data represent an image of size <tt class="docutils literal">x_size</tt> by <tt class="docutils literal">y_size</tt>. x-axis and
y-axis scaling factors can be defined by <tt class="docutils literal">x_scale_val</tt> and <tt class="docutils literal">y_scale_val</tt>.
<tt class="docutils literal">img_colors</tt> determines the levels (0 to levels) for the common color
component.
<tt class="docutils literal">linevals</tt> determines the emission of newline characters for easier
reading of the PGM file data.
If <tt class="docutils literal">is_ascii</tt> is 1, an ASCII PGM file is assumed; otherwise a binary PGM file
is.</p>
</div>
<div class="section" id="write-ppm-file">
<h2>3.12 write_ppm_file</h2>
<div class="line-block">
<div class="line"><tt class="docutils literal">void write_ppm_file(FILE *f, int *img_out,</tt></div>
<div class="line"><tt class="docutils literal">int x_size, int y_size, int x_scale_val, int y_scale_val, int img_colors, int is_ascii);</tt></div>
</div>
<p>Write the contents of a PPM (portable pix map) file.
Data stored in array <tt class="docutils literal">img_out</tt> are written to file <tt class="docutils literal">f</tt>. The
image data represent an image of size <tt class="docutils literal">x_size</tt> by <tt class="docutils literal">y_size</tt>. x-axis and
y-axis scaling factors can be defined by <tt class="docutils literal">x_scale_val</tt> and <tt class="docutils literal">y_scale_val</tt>.
<tt class="docutils literal">img_colors</tt> determines the levels (0 to levels) for the common color
component. Each R-G-B triplet is printed to a separate line.
If <tt class="docutils literal">is_ascii</tt> is 1, an ASCII PPM file is assumed; otherwise a binary PPM file
is.</p>
</div>
<div class="section" id="write-pfm-file">
<h2>3.13 write_pfm_file</h2>
<div class="line-block">
<div class="line"><tt class="docutils literal">void write_pfm_file(FILE *f, float *img_out,</tt></div>
<div class="line"><tt class="docutils literal">int x_size, int y_size, int img_type, int endianess);</tt></div>
</div>
<p>Write the contents of a PFM (portable float map) file.
Data stored in array <tt class="docutils literal">img_out</tt> are written to file <tt class="docutils literal">f</tt>. The
image data represent an image of size <tt class="docutils literal">x_size</tt> by <tt class="docutils literal">y_size</tt>. x-axis and
y-axis scaling factors can be defined by <tt class="docutils literal">x_scale_val</tt> and <tt class="docutils literal">y_scale_val</tt>.
If <tt class="docutils literal">img_type</tt> is equal to 1, the PFM image encodes RGB (color) information,
otherwise if it is equal to 0, it stores greyscale information.
If <tt class="docutils literal">endianess</tt> is negative (-1), the binary data are encoded in little-endian
ordering, otherwise if <tt class="docutils literal">endianess</tt> is positive (+1), the data follow
big-endian ordering.</p>
</div>
</div>
<div class="section" id="build-and-setup">
<h1>4. Build and setup</h1>
<p>In order to produce the static library, change directory to <tt class="docutils literal">/src</tt> and
run the Makefile as follows:</p>
<div class="line-block">
<div class="line"><tt class="docutils literal">$ make clean ; make</tt></div>
</div>
<p>This will produce the static library <tt class="docutils literal">libpnmio.a</tt> and copy it to the
<tt class="docutils literal">/lib</tt> subdirectory of the distribution. The executable files for the
reference applications will also be generated and copied to the <tt class="docutils literal">/bin</tt>
subdirectory.</p>
</div>
<div class="section" id="run-tests">
<h1>5. Run tests</h1>
<p>Two sample scripts are provided in the <tt class="docutils literal">/test</tt> subdirectory. Change
directory to <tt class="docutils literal">/test</tt> and run the scripts as follows:</p>
<div class="line-block">
<div class="line"><tt class="docutils literal">$ cd test</tt></div>
<div class="line"><tt class="docutils literal">$ <span class="pre">./run-doset.sh</span></tt></div>
<div class="line"><tt class="docutils literal">$ <span class="pre">./run-randimg.sh</span></tt></div>
<div class="line"><tt class="docutils literal">$ <span class="pre">./run-rnwimg.sh</span></tt></div>
<div class="line"><tt class="docutils literal">$ <span class="pre">./run-sftbyvec.sh</span></tt></div>
</div>
<p>PBM, PGM and PPM files can be directly visualized by using freeware image
viewers such as <a class="reference external" href="http://www.xnview.com">XnView</a>, <a class="reference external" href="http://www.irfanview.com">IrfanView</a> (non-commercial use only) and <a class="reference external" href="http://www.nyam.pe.kr/">Imagine</a>. The
informal/non-standardized PFM format was introduced by <a class="reference external" href="http://www.pauldebevec.com/Research/HDR/">Paul Debevec</a>. A PFM
viewer (<tt class="docutils literal">HDRView</tt>) can be found here:
<a class="reference external" href="http://web.archive.org/web/20060614160328/http://www.debevec.org/FiatLux/hdrview/">http://web.archive.org/web/20060614160328/http://www.debevec.org/FiatLux/hdrview/</a> .</p>
</div>
<div class="section" id="prerequisites">
<h1>6. Prerequisites</h1>
<ul>
<li><p class="first">Standard UNIX-based tools (tested with gcc-4.6.2 and gcc-4.8.1 on MinGW/x64).</p>
<ul class="simple">
<li>make</li>
<li>bash (shell)</li>
</ul>
<p>For this reason, MinGW (<a class="reference external" href="http://www.mingw.org">http://www.mingw.org</a>) or Cygwin
(<a class="reference external" href="http://sources.redhat.com/cygwin">http://sources.redhat.com/cygwin</a>) are suggested, since POSIX emulation
environments of sufficient completeness.</p>
</li>
</ul>
</div>
</div>
</body>
</html>