man/man1/rcode_norm.1

.\" RCSid "$Id: rcode_norm.1,v 1.1 2019/07/20 02:07:23 greg Exp $"
.TH RCODE_NORM 1 7/19/2019 RADIANCE
.SH NAME
rcode_norm - encode/decode 32-bit surface normal map
.SH SYNOPSIS
.B rcode_norm
[
.B \-h[io]
][
.B \-H[io]
][
.B \-f[afd]
]
[
input
[output.nrm]
]
.br
.B "rcode_norm -r"
[
.B \-i
][
.B \-u
][
.B \-h[io]
][
.B \-H[io]
][
.B \-f[afd]
]
[
input.nrm
[output]
]
.SH DESCRIPTION
.I Rcode_norm
reads a map of normaled direction vectors
and encodes them in an efficient 32-bit/pixel format for storage.
Input is taken from the first named file, or standard input if no
files are given.
Output is sent to the second named file, or standard output if none.
.PP
The
.I \-hi
option tells
.I rcode_norm
not to expect an information header on its input.
The
.I \-ho
option tells
.I rcode_norm
not to produce an information header on its output.
Specifying
.I \-h
turns both input and output headers off.
Similarly, the
.I \-Hi
option says not to expect an image resolution string on input, the
.I \-Ho
option says not to produce one on output, and
.I \-H
applies both.
.PP
The default input format is ASCII (user-readable) real triplets,
corresponding to the
.I \-fa
option.
The
.I \-ff
option tells
.I rcode_norm
to expect three binary, 32-bit floating-point values per
normal on its input, instead.
The
.I \-fd
option tells it to expect 64-bit/component vectors.
.PP
The second form applies the
.I \-r
option to perform a reverse conversion, decoding 32-bit normal directions
on the input and producing one of the above formats on output.
The 
.I \-h
and
.I \-H
options have the same behavior as before.
.PP
When decoding, the
.I \-i
option tells
.I rcode_norm
to produce one depth or world point
for each integer input pair specifying
the horizontal and vertical coordinates of a particular pixel,
where x is measured from 0 on the left and y from 0 at the bottom
in the standard orientation.
Note that
.I \-i
implies that an encoded normal file is explicitly given on the command
line, since the pixel coordinates are read from the standard input.
Also, the
.I \-H
option is not supported with
.I \-i,
since the map dimensions are required on the
input and not copied to the output.
If the
.I \-u
option is also given, output will be flushed after each normal.
.SH EXAMPLES
To store float surface normals out of rtrace:
.IP "" .2i
rtrace -ff < rays.flt -x 512 -y 400 -oN octree | rcode_norm -ff > norms.nrm
.PP
To query specific normals using ximage with the 't' command:
.IP "" .2i
ximage -op render.hdr | rcode_norm -i -r norms.nrm
.SH AUTHOR
Greg Ward
.SH "SEE ALSO"
rcalc(1), rcode_depth(1), rcode_ident(1), rcode2bmp(1),
rlam(1), rsplit(1), rtpict(1)
Revision:	1.2
Committed:	Fri Jul 26 01:32:33 2019 UTC (5 years, 10 months ago) by greg
Branch:	MAIN
Changes since 1.1:	+3 -2 lines
Log Message:	Added man page for rcode2bmp
#	Content
1	.\" RCSid "$Id: rcode_norm.1,v 1.1 2019/07/20 02:07:23 greg Exp $"
2	.TH RCODE_NORM 1 7/19/2019 RADIANCE
3	.SH NAME
4	rcode_norm - encode/decode 32-bit surface normal map
5	.SH SYNOPSIS
6	.B rcode_norm
7	[
8	.B \-h[io]
9	][
10	.B \-H[io]
11	][
12	.B \-f[afd]
13	]
14	[
15	input
16	[output.nrm]
17	]
18	.br
19	.B "rcode_norm -r"
20	[
21	.B \-i
22	][
23	.B \-u
24	][
25	.B \-h[io]
26	][
27	.B \-H[io]
28	][
29	.B \-f[afd]
30	]
31	[
32	input.nrm
33	[output]
34	]
35	.SH DESCRIPTION
36	.I Rcode_norm
37	reads a map of normaled direction vectors
38	and encodes them in an efficient 32-bit/pixel format for storage.
39	Input is taken from the first named file, or standard input if no
40	files are given.
41	Output is sent to the second named file, or standard output if none.
42	.PP
43	The
44	.I \-hi
45	option tells
46	.I rcode_norm
47	not to expect an information header on its input.
48	The
49	.I \-ho
50	option tells
51	.I rcode_norm
52	not to produce an information header on its output.
53	Specifying
54	.I \-h
55	turns both input and output headers off.
56	Similarly, the
57	.I \-Hi
58	option says not to expect an image resolution string on input, the
59	.I \-Ho
60	option says not to produce one on output, and
61	.I \-H
62	applies both.
63	.PP
64	The default input format is ASCII (user-readable) real triplets,
65	corresponding to the
66	.I \-fa
67	option.
68	The
69	.I \-ff
70	option tells
71	.I rcode_norm
72	to expect three binary, 32-bit floating-point values per
73	normal on its input, instead.
74	The
75	.I \-fd
76	option tells it to expect 64-bit/component vectors.
77	.PP
78	The second form applies the
79	.I \-r
80	option to perform a reverse conversion, decoding 32-bit normal directions
81	on the input and producing one of the above formats on output.
82	The
83	.I \-h
84	and
85	.I \-H
86	options have the same behavior as before.
87	.PP
88	When decoding, the
89	.I \-i
90	option tells
91	.I rcode_norm
92	to produce one depth or world point
93	for each integer input pair specifying
94	the horizontal and vertical coordinates of a particular pixel,
95	where x is measured from 0 on the left and y from 0 at the bottom
96	in the standard orientation.
97	Note that
98	.I \-i
99	implies that an encoded normal file is explicitly given on the command
100	line, since the pixel coordinates are read from the standard input.
101	Also, the
102	.I \-H
103	option is not supported with
104	.I \-i,
105	since the map dimensions are required on the
106	input and not copied to the output.
107	If the
108	.I \-u
109	option is also given, output will be flushed after each normal.
110	.SH EXAMPLES
111	To store float surface normals out of rtrace:
112	.IP "" .2i
113	rtrace -ff < rays.flt -x 512 -y 400 -oN octree \| rcode_norm -ff > norms.nrm
114	.PP
115	To query specific normals using ximage with the 't' command:
116	.IP "" .2i
117	ximage -op render.hdr \| rcode_norm -i -r norms.nrm
118	.SH AUTHOR
119	Greg Ward
120	.SH "SEE ALSO"
121	rcalc(1), rcode_depth(1), rcode_ident(1), rcode2bmp(1),
122	rlam(1), rsplit(1), rtpict(1)