1oiiotool(1) OpenImageIO oiiotool(1)
2
6 oiiotool -- simple image processing operations
7
9 Usage: oiiotool [filename,option,action]...
10
13 This program is part of the OpenImageIO (http://www.openimageio.org)
14 tool suite. Detailed documentation is avaliable in pdf format with the
15 OpenImageIO distribution.
16
18 Options (general):
19 --help Print help message
21 -v Verbose status messages
23 -q Quiet mode (turn verbose off)
25 -n No saved output (dry run)
27 -a Do operations on all subimages/miplevels
29 --debug
31 Debug mode
32 --runstats
34 Print runtime statistics
35 --info Print resolution and basic info on all inputs, detailed
37 metadata if -v is also used (options: format=xml:ver‐
38 bose=1)
39 --echo %s Echo message to console (options: new‐
41 line=0)
42 --metamatch %s
44 Regex: which metadata is printed with -info -v
45 --no-metamatch %s
47 Regex: which metadata is excluded with -info -v
48 --stats
50 Print pixel statistics on all inputs
51 --dumpdata
53 Print all pixel data values (options: empty=0)
54 --hash Print SHA-1 hash of each input image
56 --colorcount
58 %s Count of how many pixels have the given color
59 (argument: color;color;...) (options: eps=color)
60 --rangecheck
62 %s %s Count of how many pixels are outside the low
63 and high color arguments (each is a comma-separated color
64 value list)
65 --no-clobber
67 Do not overwrite existing files
68 --threads
70 %d Number of threads (default 0 == #cores)
71 --frames %s
73 Frame range for '#' or printf-style wildcards
74 --framepadding %d
76 Frame number padding digits (ignored when using printf-
77 style wildcards)
78 --views %s
80 Views for %V/%v wildcards (comma-separated, defaults to
81 left,right)
82 --wildcardoff
84 Disable numeric wildcard expansion for subsequent command
85 line arguments
86 --wildcardon
88 Enable numeric wildcard expansion for subsequent command
89 line arguments
90 --no-autopremult
92 Turn off automatic premultiplication of images with unas‐
93 sociated alpha
94 --autopremult
96 Turn on automatic premultiplication of images with unas‐
97 sociated alpha
98 --autoorient
100 Automatically --reorient all images upon input
101 --autocc
103 Automatically color convert based on filename
104 --noautocc
106 Turn off automatic color conversion
107 --native
109 Keep native pixel data type (bypass cache if necessary)
110 --cache
112 %d ImageCache size (in MB: default=4096)
113 --autotile
115 %d Autotile size for cached images
116 (default=4096)
117 Commands that read images:
119 -i %s Input file (argument: filename)
121 (options: now=, printinfo=, autocc=, type=, ch=)
122 --iconfig
124 %s %s Sets input config attribute (name, value)
125 (options: type=...)
126 Commands that write images:
128 -o %s Output the current image to the
130 named file
131 -otex %s Output the current image as a texture
133 -oenv %s Output the current image as a latlong
135 env map
136 Options that affect subsequent image output:
138 -d %s '-d TYPE' sets the output data for‐
140 mat of all channels, '-d CHAN=TYPE' overrides a single
141 named channel (multiple -d args are allowed). Data types
142 include: uint8, sint8, uint10, uint12, uint16, sint16,
143 uint32, sint32, half, float, double
144 --scanline
146 Output scanline images
147 --tile %d %d Output tiled images (tilewidth, tile‐
149 height)
150 --compression %s
152 Set the compression method
153 --quality %d
155 Set the compression quality, 1-100
156 --dither
158 Add dither to 8-bit output
159 --planarconfig %s
161 Force planarconfig (contig, separate, default)
162 --adjust-time
164 Adjust file times to match DateTime metadata
165 --noautocrop
167 Do not automatically crop images whose formats don't sup‐
168 port separate pixel data and full/display windows
169 --autotrim
171 Automatically trim black borders upon output to file for‐
172 mats that support separate pixel data and full/display
173 windows
174 Options that change current image metadata (but not pixel values):
176 --attrib
178 %s %s Sets metadata attribute (name, value)
179 (options: type=...)
180 --sattrib
182 %s %s Sets string metadata attribute (name,
183 value)
184 --eraseattrib
186 %s Erase attributes matching regex
187 --caption
189 %s Sets caption (ImageDescription metadata)
190 --keyword
192 %s Add a keyword
193 --clear-keywords
195 Clear all keywords
196 --nosoftwareattrib
198 Do not write command line into Exif:ImageHistory, Soft‐
199 ware metadata attributes
200 --sansattrib
202 Write command line into Software & ImageHistory but
203 remove --sattrib and --attrib options
204 --orientation
206 %d Set the assumed orientation
207 --orientcw
209 Rotate orientation metadata 90 deg clockwise
210 --orientccw
212 Rotate orientation metadata 90 deg counter-clockwise
213 --orient180
215 Rotate orientation metadata 180 deg
216 --origin
218 %s Set the pixel data window origin (e.g.
219 +20+10)
220 --fullsize
222 %s Set the display window (e.g., 1920x1080,
223 1024x768+100+0, -20-30)
224 --fullpixels
226 Set the 'full' image range to be the pixel data window
227 --chnames
229 %s Set the channel names (comma-separated)
230 Options that affect subsequent actions:
232 --fail %g
234 Failure threshold difference (0.000001)
235 --failpercent %g
237 Allow this percentage of failures in diff (0)
238 --hardfail %g
240 Fail diff if any one pixel exceeds this error (infinity)
241 --warn %g
243 Warning threshold difference (0.00001)
244 --warnpercent %g
246 Allow this percentage of warnings in diff (0)
247 --hardwarn %g
249 Warn if any one pixel difference exceeds this error
250 (infinity)
251 Actions:
253 --create
255 %s %d Create a blank image (args: geom, chan‐
256 nels)
257 --pattern
259 %s %s %d Create a patterned image (args: pattern,
260 geom, channels). Patterns: black, constant, fill,
261 checker, noise
262 --kernel
264 %s %s Create a centered convolution kernel
265 (args: name, geom)
266 --capture
268 Capture an image (options: camera=%d)
269 --diff Print report on the difference of two images (modified by
271 --fail, --failpercent, --hardfail, --warn, --warnpercent
272 --hardwarn)
273 --pdiff
275 Print report on the perceptual difference of two images
276 (modified by --fail, --failpercent, --hardfail, --warn,
277 --warnpercent --hardwarn)
278 --add Add two images
280 --addc %s
282 Add to all channels a scalar or per-channel constants
283 (e.g.: 0.5 or 1,1.25,0.5)
284 --sub Subtract two images
286 --subc %s
288 Subtract from all channels a scalar or per-channel con‐
289 stants (e.g.: 0.5 or 1,1.25,0.5)
290 --mul Multiply two images
292 --mulc %s
294 Multiply the image values by a scalar or per-channel con‐
295 stants (e.g.: 0.5 or 1,1.25,0.5)
296 --div Divide first image by second image
298 --divc %s
300 Divide the image values by a scalar or per-channel con‐
301 stants (e.g.: 0.5 or 1,1.25,0.5)
302 --mad Multiply two images, add a third
304 --invert
306 Take the color inverse (subtract from 1)
307 --abs Take the absolute value of the image pixels
309 --absdiff
311 Absolute difference between two images
312 --absdiffc %s
314 Absolute difference versus a scalar or per-channel con‐
315 stant (e.g.: 0.5 or 1,1.25,0.5)
316 --powc %s
318 Raise the image values to a scalar or per-channel power
319 (e.g.: 2.2 or 2.2,2.2,2.2,1.0)
320 --noise
322 Add noise to an image (options: type=gaussian:mean=0:std‐
323 dev=0.1, type=uniform:min=0:max=0.1,
324 type=salt:value=0:portion=0.1, seed=0
325 --chsum
327 Turn into 1-channel image by summing channels (options:
328 weight=r,g,...)
329 --colormap %s
331 Color map based on channel 0 (arg: "blue-red", "spec‐
332 trum", "heat", or comma-separated list of RGB triples)
333 --crop %s Set pixel data resolution and offset,
335 cropping or padding if necessary (WxH+X+Y or
336 xmin,ymin,xmax,ymax)
337 --croptofull
339 Crop or pad to make pixel data region match the "full"
340 region
341 --trim Crop to the minimal ROI containing nonzero pixel values
343 --cut %s Cut out the ROI and reposition to the
345 origin (WxH+X+Y or xmin,ymin,xmax,ymax)
346 --paste
348 %s Paste fg over bg at the given position
349 (e.g., +100+50)
350 --mosaic
352 %s Assemble images into a mosaic (arg: WxH;
353 options: pad=0)
354 --over ’Over' composite of two images
356 --zover
358 Depth composite two images with Z channels (options:
359 zeroisinf=%d)
360 --deepmerge
362 Merge/composite two deep images
363 --deepholdout
365 Hold out one deep image by another
366 --histogram
368 %s %d Histogram one channel (options: cumulative=0)
369 --rotate90
371 Rotate the image 90 degrees clockwise
372 --rotate180
374 Rotate the image 180 degrees
375 --rotate270
377 Rotate the image 270 degrees clockwise (or 90 degrees
378 CCW)
379 --flip Flip the image vertically (top<->bottom)
381 --flop Flop the image horizontally (left<->right)
383 --reorient
385 Rotate and/or flop the image to transform the pixels to
386 match the Orientation metadata
387 --transpose
389 Transpose the image
390 --cshift
392 %s Circular shift the image (e.g.: +20-10)
393 --resample
395 %s Resample (640x480, 50%) (options: interp=0)
396 --resize
398 %s Resize (640x480, 50%) (options: filter=%s)
399 --fit %s Resize to fit within a window size
401 (options: filter=%s, pad=%d, exact=%d)
402 --pixelaspect
404 %g Scale up the image's width or height to match
405 the given pixel aspect ratio (options: filter=%s)
406 --rotate
408 %g Rotate pixels (argument is degrees clock‐
409 wise) around the center of the display window (options:
410 filter=%s, center=%f,%f, recompute_roi=%d
411 --warp %s Warp pixels (argument is a 3x3 matrix,
413 separated by commas) (options: filter=%s, recom‐
414 pute_roi=%d)
415 --convolve
417 Convolve with a kernel
418 --blur %s Blur the image (arg: WxH; options: ker‐
420 nel=name)
421 --median
423 %s Median filter the image (arg: WxH)
424 --dilate
426 %s Dilate (area maximum) the image (arg: WxH)
427 --erode
429 %s Erode (area minimum) the image (arg: WxH)
430 --unsharp
432 Unsharp mask (options: kernel=gaussian, width=3, con‐
433 trast=1, threshold=0)
434 --laplacian
436 Laplacian filter the image
437 --fft Take the FFT of the image
439 --ifft Take the inverse FFT of the image
441 --polar
443 Convert complex (real,imag) to polar (amplitude,phase)
444 --unpolar
446 Convert polar (amplitude,phase) to complex (real,imag)
447 --fixnan
449 %s Fix NaN/Inf values in the image (options:
450 none, black, box3, error)
451 --fillholes
453 Fill in holes (where alpha is not 1)
454 --clamp
456 Clamp values (options: min=..., max=..., clampalpha=0)
457 --rangecompress
459 Compress the range of pixel values with a log scale
460 (options: luma=0|1)
461 --rangeexpand
463 Un-rangecompress pixel values back to a linear scale
464 (options: luma=0|1)
465 --line %s Render a poly-line (args: x1,y1,x2,y2...
467 ; options: color=)
468 --box %s Render a box (args: x1,y1,x2,y2 ;
470 options: color=)
471 --fill %s Fill a region (options: color=)
473 --text %s Render text into the current image
475 (options: x=, y=, size=, color=)
476 Manipulating channels or subimages:
478 --ch %s Select or shuffle channels (e.g.,
480 "R,G,B", "B,G,R", "2,3,4")
481 --chappend
483 Append the channels of the last two images
484 --unmip
486 Discard all but the top level of a MIPmap
487 --selectmip
489 %d Select just one MIP level (0 = highest res)
490 --subimage
492 %s Select just one subimage (by index or name)
493 --sisplit
495 Split the top image's subimges into separate images
496 --siappend
498 Append the last two images into one multi-subimage image
499 --siappendall
501 Append all images on the stack into a single multi-subim‐
502 age image
503 --deepen
505 Deepen normal 2D image to deep
506 --flatten
508 Flatten deep image to non-deep
509 Image stack manipulation:
511 --dup Duplicate the current image (push a copy onto the stack)
513 --swap Swap the top two images on the stack.
515 --pop Throw away the current image
517 --label
519 %s Label the top image
520 Color management:
522 --colorconfig
524 %s Explicitly specify an OCIO configuration file
525 --iscolorspace
527 %s Set the assumed color space (without altering
528 pixels)
529 --tocolorspace
531 %s Convert the current image's pixels to a named
532 color space
533 --colorconvert
535 %s %s Convert pixels from 'src' to 'dst' color space
536 (options: key=, value=)
537 --ociolook
539 %s Apply the named OCIO look (options: from=,
540 to=, inverse=, key=, value=)
541 --ociodisplay
543 %s %s Apply the named OCIO display and view (options:
544 from=, looks=, key=, value=)
545 --ociofiletransform
547 %s Apply the named OCIO filetransform (options:
548 inverse=)
549 --unpremult
551 Divide all color channels of the current image by the
552 alpha to "un-premultiply"
553 --premult
555 Multiply all color channels of the current image by the
556 alpha
557 Input formats supported: bmp, cineon, dds, dicom, dpx, field3d,
559 fits, gif, hdr, ico, iff, jpeg, jpeg2000, openexr, png, pnm,
560 psd, raw, rla, sgi, socket, softimage, targa, tiff, webp, zfile
561 Output formats supported: bmp, dpx, field3d, fits, gif, hdr,
563 ico, iff, jpeg, jpeg2000, openexr, png, pnm, rla, sgi, socket,
564 targa, tiff, webp, zfile
565 Known color spaces: "linear", "sRGB", "Rec709"
567 Dependent libraries: dcmtk 3.6.2, Field3d 1.7.2, gif_lib 5.1.4,
569 jpeg-turbo 2.0.0, OpenJpeg 2.3.0, OpenEXR 2.2.0, libpng 1.6.34,
570 libraw 0.19.0-Release, LIBTIFF, Version 4.0.9, Webp 1.0.0
571 02 November 2018 oiiotool(1)