Debian Codegraph @

website/bin/exrstdattr.rst

raw
1 ..
2 SPDX-License-Identifier: BSD-3-Clause
3 Copyright Contributors to the OpenEXR Project.
4
5 exrstdattr
6 ##########
7
8 ::
9
10 exrstdattr [commands] infile outfile
11
12 Description
13 -----------
14
15 Read OpenEXR image file infile, set the values of one
16 or more attributes in the headers of the file, and save
17 the result in outfile. Infile and outfile must not refer
18 to the same file (the program cannot edit an image file "in place").
19
20 Options for selecting headers:
21 ------------------------------
22
23 .. describe:: -part i
24
25 If i is greater than or equal to zero, and less
26 than the number of parts in the input file, then
27 the header for part i becomes "current." If i
28 is "any" or -1, then all headers become current.
29 Subsequent attribute setting commands affect only
30 the current header or headers. All headers are
31 current before the first -part command.
32
33 For example, the command sequence
34
35 ::
36
37 -focus 3 -part 2 -aperture 8 -expTime 0.01 -part any -owner luke
38
39 sets the focus and owner attributes in all
40 headers, as well as the aperture and expTime
41 attributes in the header of part 2.
42
43 Options for setting attribute values:
44 -------------------------------------
45
46 .. describe:: -chromaticities f f f f f f f f
47
48 CIE xy chromaticities for the red, green
49 and blue primaries, and for the white point
50 (8 floats)
51
52 .. describe:: -whiteLuminance f
53
54 white luminance, in candelas per square meter
55 (float, >= 0.0)
56
57 .. describe:: -adoptedNeutral f f
58
59 CIE xy coordinates that should be considered
60 "neutral" during color rendering. Pixels in
61 the image file whose xy coordinates match the
62 adoptedNeutral value should be mapped to neutral
63 values on the display. (2 floats)
64
65 .. describe:: -renderingTransform s
66
67 name of the CTL rendering transform for this
68 image (string)
69
70 .. describe:: -lookModTransform s
71
72 name of the CTL look modification transform for
73 this image (string)
74
75 .. describe:: -xDensity f
76
77 horizontal output density, in pixels per inch
78 (float, >= 0.0)
79
80 .. describe:: -owner s
81
82 name of the owner of the image (string)
83
84 .. describe:: -comments s
85
86 additional information about the image (string)
87
88 .. describe:: -capDate s
89
90 date when the image was created or
91 captured, in local time (string,
92 formatted as YYYY:MM:DD hh:mm:ss)
93
94 .. describe:: -utcOffset f
95
96 offset of local time at capDate from UTC, in
97 seconds (float, UTC == local time + x)
98
99 .. describe:: -longitude f
100
101 .. describe:: -latitude f
102
103 .. describe:: -altitude f
104
105 location where the image was recorded, in
106 degrees east of Greenwich and north of the
107 equator, and in meters above sea level
108 (float)
109
110 .. describe:: -focus f
111
112 the camera's focus distance, in meters
113 (float, > 0, or "infinity")
114
115 .. describe:: -expTime f
116
117 exposure time, in seconds (float, >= 0)
118
119 .. describe:: -aperture f
120
121 lens apterture, in f-stops (float, >= 0)
122
123 .. describe:: -isoSpeed f
124
125 effective speed of the film or image
126 sensor that was used to record the image
127 (float, >= 0)
128
129 .. describe:: -envmap s
130
131 indicates that the image is an environment map
132 (string, LATLONG or CUBE)
133
134 .. describe:: -framesPerSecond i i
135
136 playback frame rate expressed as a ratio of two
137 integers, n and d (the frame rate is n/d frames
138 per second)
139
140 .. describe:: -keyCode i i i i i i i
141
142 key code that uniquely identifies a motion
143 picture film frame using 7 integers:
144
145 * film manufacturer code (0 - 99)
146 * film type code (0 - 99)
147 * prefix to identify film roll (0 - 999999)
148 * count, increments once every perfsPerCount
149 perforations (0 - 9999)
150 * offset of frame, in perforations from
151 zero-frame reference mark (0 - 119)
152 * number of perforations per frame (1 - 15)
153 * number of perforations per count (20 - 120)
154
155 .. describe:: -timeCode i i
156
157 SMPTE time and control code, specified as a pair
158 of 8-digit base-16 integers. The first number
159 contains the time address and flags (drop frame,
160 color frame, field/phase, bgf0, bgf1, bgf2).
161 The second number contains the user data and
162 control codes.
163
164 .. describe:: -wrapmodes s
165
166 if the image is used as a texture map, specifies
167 how the image should be extrapolated outside the
168 zero-to-one texture coordinate range
169 (string, e.g. "clamp" or "periodic,clamp")
170
171 .. describe:: -pixelAspectRatio f
172
173 width divided by height of a pixel
174 (float, >= 0)
175
176 .. describe:: -screenWindowWidth f
177
178 width of the screen window (float, >= 0)
179
180 .. describe:: -screenWindowCenter f f
181
182 center of the screen window (2 floats)
183
184 .. describe:: -string s s
185
186 custom string attribute
187 (2 strings, attribute name and value)
188
189 .. describe:: -float s f
190
191 custom float attribute (string + float,
192 attribute name and value)
193
194 .. describe:: -int s i
195
196 custom integer attribute (string + integer,
197 attribute name and value)
198
199 Other options:
200 --------------
201
202 .. describe:: -h, --help
203
204 print this message
205
206 .. describe:: --version
207
208 print version information
209