man/man1/rcode_ident.1

.\" RCSid "$Id: rcollate.1,v 1.7 2014/05/31 21:33:21 greg Exp $"
.TH RCODE_IDENT 1 7/19/2019 RADIANCE
.SH NAME
rcode_ident - store identifiers in an indexed map and retrieve from same
.SH SYNOPSIS
.B rcode_ident
[
.I "-8 | -16 | -24"
][
.B \-h
][
.B \-tS
][
.B "-x xr -y yr"
]
[
input.txt
[output.idx]
]
.br
.B "rcode_ident -r"
[
.B \-i
][
.B \-u
][
.B \-h
][
.B \-H
][
.B \-tS
]
[
input.idx
[output.txt]
]
.SH DESCRIPTION
.I Rcode_ident
Takes a list of ASCII identifiers on the input and encodes them
as a 16-bit index to a table appended to the output.
This default index size can hold up to 65 thousand unique IDs,
which is suitable for most applications.
The
.I \-8
option may be used to specify an 8-bit index, which saves space
if 256 or fewer unique identifiers appear on the input.
The
.I \-24
option creates a 24-bit index can record over 16 million
unique identifiers.
.PP
Identifiers are separated by newlines by default, but any single-character
separator may be given with the
.I \-tS
option.
Note there is no space between this option and its argument.
Leading and trailing white space is eliminated from each identifier,
and the maximum ID length is 255 characters.
.PP
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 \-h
option tells
.I rcode_ident
not to expect an information header on its input.
The
.I \-x
and
.I \-y
options give the horizontal and vertical map dimensions, respectively.
If these are not specified, then a resolution string must be
included on the header, as produced by
.I rtrace(1)
when both resolutions are specified.
.PP
The second form applies the
.I \-r
option to read an indexed id file and produce the original
identifiers for each pixel position on the output.
The 
.I \-h
and
.I \-H
options may be used to leave off the header and resolution
string, respectively.
The
.I \-tS
option specifies an alternate ID separator instead of the default newline.
.PP
When decoding, the
.I \-i
option tells
.I rcode_ident
to produce an identifier 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 indexed ID file is explicitly given on the command
line, since the pixel coordinates are read from the standard input.
If the
.I \-u
option is also given, output will be flushed after each identifier
.SH EXAMPLES
To store modifier IDs out of rtrace:
.IP "" .2i
rtrace -ffa < rays.flt -x 512 -y 400 -om octree | rcode_ident > mods.idx
.PP
To query specific modifiers using ximage with the 't' command:
.IP "" .2i
ximage -op render.hdr | rcode_ident -i -r mods.idx
.SH AUTHOR
Greg Ward
.SH "SEE ALSO"
rcalc(1), rcode_depth(1), rcode_norm(1), rlam(1), rsplit(1), rtpict(1)
Revision:	1.1
Committed:	Sat Jul 20 02:07:23 2019 UTC (5 years, 9 months ago) by greg
Branch:	MAIN
Log Message:	Created man pages for rcode_depth, rcode_ident, and rcode_norm
#	User	Rev	Content
1	greg	1.1	.\" RCSid "$Id: rcollate.1,v 1.7 2014/05/31 21:33:21 greg Exp $"
2			.TH RCODE_IDENT 1 7/19/2019 RADIANCE
3			.SH NAME
4			rcode_ident - store identifiers in an indexed map and retrieve from same
5			.SH SYNOPSIS
6			.B rcode_ident
7			[
8			.I "-8 \| -16 \| -24"
9			][
10			.B \-h
11			][
12			.B \-tS
13			][
14			.B "-x xr -y yr"
15			]
16			[
17			input.txt
18			[output.idx]
19			]
20			.br
21			.B "rcode_ident -r"
22			[
23			.B \-i
24			][
25			.B \-u
26			][
27			.B \-h
28			][
29			.B \-H
30			][
31			.B \-tS
32			]
33			[
34			input.idx
35			[output.txt]
36			]
37			.SH DESCRIPTION
38			.I Rcode_ident
39			Takes a list of ASCII identifiers on the input and encodes them
40			as a 16-bit index to a table appended to the output.
41			This default index size can hold up to 65 thousand unique IDs,
42			which is suitable for most applications.
43			The
44			.I \-8
45			option may be used to specify an 8-bit index, which saves space
46			if 256 or fewer unique identifiers appear on the input.
47			The
48			.I \-24
49			option creates a 24-bit index can record over 16 million
50			unique identifiers.
51			.PP
52			Identifiers are separated by newlines by default, but any single-character
53			separator may be given with the
54			.I \-tS
55			option.
56			Note there is no space between this option and its argument.
57			Leading and trailing white space is eliminated from each identifier,
58			and the maximum ID length is 255 characters.
59			.PP
60			Input is taken from the first named file, or standard input if no
61			files are given.
62			Output is sent to the second named file, or standard output if none.
63			.PP
64			The
65			.I \-h
66			option tells
67			.I rcode_ident
68			not to expect an information header on its input.
69			The
70			.I \-x
71			and
72			.I \-y
73			options give the horizontal and vertical map dimensions, respectively.
74			If these are not specified, then a resolution string must be
75			included on the header, as produced by
76			.I rtrace(1)
77			when both resolutions are specified.
78			.PP
79			The second form applies the
80			.I \-r
81			option to read an indexed id file and produce the original
82			identifiers for each pixel position on the output.
83			The
84			.I \-h
85			and
86			.I \-H
87			options may be used to leave off the header and resolution
88			string, respectively.
89			The
90			.I \-tS
91			option specifies an alternate ID separator instead of the default newline.
92			.PP
93			When decoding, the
94			.I \-i
95			option tells
96			.I rcode_ident
97			to produce an identifier for each integer input pair specifying
98			the horizontal and vertical coordinates of a particular pixel,
99			where x is measured from 0 on the left and y from 0 at the bottom
100			in the standard orientation.
101			Note that
102			.I \-i
103			implies that an indexed ID file is explicitly given on the command
104			line, since the pixel coordinates are read from the standard input.
105			If the
106			.I \-u
107			option is also given, output will be flushed after each identifier
108			.SH EXAMPLES
109			To store modifier IDs out of rtrace:
110			.IP "" .2i
111			rtrace -ffa < rays.flt -x 512 -y 400 -om octree \| rcode_ident > mods.idx
112			.PP
113			To query specific modifiers using ximage with the 't' command:
114			.IP "" .2i
115			ximage -op render.hdr \| rcode_ident -i -r mods.idx
116			.SH AUTHOR
117			Greg Ward
118			.SH "SEE ALSO"
119			rcalc(1), rcode_depth(1), rcode_norm(1), rlam(1), rsplit(1), rtpict(1)