NAME¶
oiiotool - the OIIO Swiss Army Knife
SYNOPSIS¶
oiiotool [
filename|
option|
action]...
DESCRIPTION¶
The
oiiotool program will read images (from any file format for which an
ImageInput plugin can be found), perform various operations on them, and write
images (in any format for which an ImageOutput plugin can be found).
The oiiotool utility is invoked as follows:
oiiotool args
oiiotool maintains an image stack, with the top image in the stack also called
the current image. The stack begins containing no images.
oiiotool arguments consist of image names, or commands. When an image name is
encountered, that image is pushed on the stack and becomes the new current
image.
Most other commands either alter the current image (replacing it with the
alteration), or in some cases will pull more than one image off the stack
(such as the current image and the next item on the stack) and then push a new
image.
For a complete description, see
/usr/share/doc/libopenimageio-dev/openimageio.pdf.gz.
OPTIONS¶
Options (general):¶
- --help
- Print help message
- -v
- Verbose status messages
- -q
- Quiet mode (turn verbose off)
- -a
- Do operations on all subimages/miplevels
- --info
- Print resolution and metadata on all inputs
- --stats
- Print pixel statistics on all inputs
- --hash
- Print SHA-1 hash of each input image
- --no-clobber
- Do not overwrite existing files
- --threads %d
- Number of threads (default 0 == #cores)
Commands that write images:¶
- -o %s
- Output the current image to the named file
Options that affect subsequent image output:¶
- -d %s
- Set the output data format to one of:
uint8, sint8, uint10, uint12, uint16, sint16, half, float, double
- --scanline
- Output scanline images
- --tile %d %d
- Output tiled images (tilewidth, tileheight)
- --compression %s
- Set the compression method
- --quality %d
- Set the compression quality, 1-100
- --planarconfig %s
- Force planarconfig (contig, separate, default)
- --adjust-time
- Adjust file times to match DateTime metadata
- --noautocrop
- Do not automatically crop images whose formats don't
support separate pixel data and full/display windows
- --attrib %s %s
- Sets metadata attribute (name, value)
- --sattrib %s %s
- Sets string metadata attribute (name, value)
- --caption %s
- Sets caption (ImageDescription metadata)
- --keyword %s
- Add a keyword
- --clear-keywords
- Clear all keywords
- --orientation %d
- Set the assumed orientation
- --rotcw
- Rotate orientation 90 deg clockwise
- --rotccw
- Rotate orientation 90 deg counter-clockwise
- --rot180
- Rotate orientation 180 deg
- --origin %s
- Set the pixel data window origin (e.g. +20+10)
- --fullsize %s
- Set the display window (e.g., 1920x1080, 1024x768+100+0,
-20-30)
- --fullpixels
- Set the 'full' image range to be the pixel data window
Options that affect subsequent actions:¶
- --fail %g
- Failure threshold difference (0.000001)
- --failpercent %g
- Allow this percentage of failures in diff (0)
- --hardfail %g
- Fail diff if any one pixel exceeds this error
(infinity)
- --warn %g
- Warning threshold difference (0.00001)
- --warnpercent %g
- Allow this percentage of warnings in diff (0)
- --hardwarn %g
- Warn if any one pixel difference exceeds this error
(infinity)
Actions:¶
- --create %s %d
- Create a blank image (args: geom, channels)
- --pattern %s %s %d
- Create a patterned image (args: pattern, geom,
channels)
- --unmip
- Discard all but the top level of a MIPmap
- --selectmip %d
- Select just one MIP level (0 = highest res)
- --subimage %d
- Select just one subimage
- --diff
- Print report on the difference of two images (modified by
--fail, --failpercent, --hardfail, --warn, --warnpercent --hardwarn)
- --add
- Add two images
- --sub
- Subtract two images
- --abs
- Take the absolute value of the image pixels
- --flip
- Flip the image vertically (top<->bottom)
- --flop
- Flop the image horizontally (left<->right)
- --flipflop
- Flip and flop the image (180 degree rotation)
- --crop %s
- Set pixel data resolution and offset, cropping or padding
if necessary (WxH+X+Y or xmin,ymin,xmax,ymax)
- --croptofull
- Crop or pad to make pixel data region match the
"full" region
- --resize %s
- Resize (640x480, 50%)
- --fixnan %s
- Fix NaN/Inf values in the image (options: none, black,
box3)
- --pop
- Throw away the current image
- --dup
- Duplicate the current image (push a copy onto the
stack)
Color management:¶
- --iscolorspace %s
- Set the assumed color space (without altering pixels)
- --tocolorspace %s
- Convert the current image's pixels to a named color
space
- --colorconvert %s %s
- Convert pixels from 'src' to 'dst' color space (without
regard to its previous interpretation)
Known color spaces: "linear", "sRGB", "Rec709"
SEE ALSO¶
iconvert(1),
idiff(1),
igrep(1),
iinfo(1),
iprocess(1),
iv(1),
maketx(1).
AUTHOR¶
OpenImageIO was written by Larry Gritz and the other authors and contributors.
This manual page was written by IRIE Shinsuke <irieshinsuke@yahoo.co.jp>,
for the Debian project (and may be used by others).