man/man1/rcode_ident.1

.\" RCSid "$Id: rcode_ident.1,v 1.5 2021/04/28 19:15:09 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 \-l
][
.B \-n
][
.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 that 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.
(Input file is required for
.I \-r
option.)
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.
The
.I \-l
option tells
.I rcode_ident
to list identifiers following the header information (if present).
The
.I \-n
option prints identifier table indexes rather than the strings themselves.
Indexing starts from 0 for the first table entry.
.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
.PP
To only print out the list of unique identifiers:
.IP "" .2i
rcode_ident -r -h -H -i -l mods.idx < /dev/null
.SH AUTHOR
Greg Ward
.SH "SEE ALSO"
rcalc(1), rcode_depth(1), rcode_norm(1), rcode2bmp(1),
rlam(1), rsplit(1), rtpict(1)
Revision:	1.6
Committed:	Wed Feb 2 22:25:24 2022 UTC (3 years, 4 months ago) by greg
Branch:	MAIN
Changes since 1.5:	+4 -3 lines
Log Message:	docs(rcode_ident): corrected information about file requirements for -r option
#	User	Rev	Content
1	greg	1.6	.\" RCSid "$Id: rcode_ident.1,v 1.5 2021/04/28 19:15:09 greg Exp $"
2	greg	1.1	.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	greg	1.2	.B \-l
32			][
33			.B \-n
34			][
35	greg	1.1	.B \-tS
36			]
37			input.idx
38			[output.txt]
39			.SH DESCRIPTION
40			.I Rcode_ident
41	greg	1.5	takes a list of ASCII identifiers on the input and encodes them
42	greg	1.1	as a 16-bit index to a table appended to the output.
43			This default index size can hold up to 65 thousand unique IDs,
44			which is suitable for most applications.
45			The
46			.I \-8
47			option may be used to specify an 8-bit index, which saves space
48			if 256 or fewer unique identifiers appear on the input.
49			The
50			.I \-24
51	greg	1.4	option creates a 24-bit index that can record over 16 million
52	greg	1.1	unique identifiers.
53			.PP
54			Identifiers are separated by newlines by default, but any single-character
55			separator may be given with the
56			.I \-tS
57			option.
58			Note there is no space between this option and its argument.
59			Leading and trailing white space is eliminated from each identifier,
60			and the maximum ID length is 255 characters.
61			.PP
62			Input is taken from the first named file, or standard input if no
63			files are given.
64	greg	1.6	(Input file is required for
65			.I \-r
66			option.)
67	greg	1.1	Output is sent to the second named file, or standard output if none.
68			.PP
69			The
70			.I \-h
71			option tells
72			.I rcode_ident
73			not to expect an information header on its input.
74			The
75			.I \-x
76			and
77			.I \-y
78			options give the horizontal and vertical map dimensions, respectively.
79			If these are not specified, then a resolution string must be
80			included on the header, as produced by
81			.I rtrace(1)
82			when both resolutions are specified.
83			.PP
84			The second form applies the
85			.I \-r
86			option to read an indexed id file and produce the original
87			identifiers for each pixel position on the output.
88			The
89			.I \-h
90			and
91			.I \-H
92			options may be used to leave off the header and resolution
93			string, respectively.
94			The
95			.I \-tS
96			option specifies an alternate ID separator instead of the default newline.
97	greg	1.2	The
98			.I \-l
99			option tells
100			.I rcode_ident
101			to list identifiers following the header information (if present).
102			The
103			.I \-n
104			option prints identifier table indexes rather than the strings themselves.
105			Indexing starts from 0 for the first table entry.
106	greg	1.1	.PP
107			When decoding, the
108			.I \-i
109			option tells
110			.I rcode_ident
111			to produce an identifier for each integer input pair specifying
112			the horizontal and vertical coordinates of a particular pixel,
113			where x is measured from 0 on the left and y from 0 at the bottom
114			in the standard orientation.
115			Note that
116			.I \-i
117			implies that an indexed ID file is explicitly given on the command
118			line, since the pixel coordinates are read from the standard input.
119			If the
120			.I \-u
121			option is also given, output will be flushed after each identifier
122			.SH EXAMPLES
123			To store modifier IDs out of rtrace:
124			.IP "" .2i
125			rtrace -ffa < rays.flt -x 512 -y 400 -om octree \| rcode_ident > mods.idx
126			.PP
127			To query specific modifiers using ximage with the 't' command:
128			.IP "" .2i
129			ximage -op render.hdr \| rcode_ident -i -r mods.idx
130	greg	1.2	.PP
131			To only print out the list of unique identifiers:
132			.IP "" .2i
133			rcode_ident -r -h -H -i -l mods.idx < /dev/null
134	greg	1.1	.SH AUTHOR
135			Greg Ward
136			.SH "SEE ALSO"
137	greg	1.3	rcalc(1), rcode_depth(1), rcode_norm(1), rcode2bmp(1),
138			rlam(1), rsplit(1), rtpict(1)