Skip to content

Commit 31fe2b0

Browse files
lgritzscott-wilson
authored andcommitted
docs: Fix some typos and add missing oiiotool expression explanations (AcademySoftwareFoundation#4169)
Signed-off-by: Larry Gritz <[email protected]> Signed-off-by: Scott Wilson <[email protected]>
1 parent c508734 commit 31fe2b0

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

src/doc/oiiotool.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,8 @@ contents of an expression may be any of:
136136
`ImageDescription`, or `width`)
137137
* `filename` : the name of the file (e.g., `foo.tif`)
138138
* `file_extension` : the extension of the file (e.g., `tif`)
139-
* `full_geom` : the "full" or "display" size)
140-
* `geom` : the pixel data size in the form `640x480+0+0`)
139+
* `full_geom` : the "full" or "display" size
140+
* `geom` : the pixel data size in the form `640x480+0+0`
141141
* `nativeformat` : the pixel data type from the file.
142142
* `MINCOLOR` : the minimum value of each channel over the entire image
143143
(channels are comma-separated)
@@ -221,6 +221,14 @@ contents of an expression may be any of:
221221
retrieved by `OIIO::getattribute(name, ...)`. The `name` may be enclosed
222222
in single or double quotes or be a single unquoted sequence of characters.
223223
(Added in OIIO 2.3.)
224+
* `var(name)` : returns the user variable of the give name. (Added in OIIO
225+
2.4.)
226+
* `eq(a,b)` : returns 1 if `a` is equal to `b`, 0 otherwise. (Added in OIIO
227+
2.4.)
228+
* `neq(a,b)` : returns 1 if `a` is not equal to `b`, 0 otherwise. (Added in
229+
OIIO 2.4.)
230+
* `not(val)` : returns 1 if `val` is a false value, 0 if `val` evaluates
231+
to a true value. (Added in OIIO 2.4.)
224232

225233

226234
To illustrate how this works, consider the following command, which trims

src/include/OpenImageIO/imagebufalgo.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1763,15 +1763,15 @@ enum NonFiniteFixMode
17631763
NONFINITE_BLACK = 1, ///< Replace non-finite values with 0.0.
17641764
NONFINITE_BOX3 = 2, ///< Replace non-finite values with the average
17651765
///< value of any finite pixels in a 3x3 window.
1766-
NONFINITE_ERROR = 100, ///< EReturn false (error), but don't change any
1766+
NONFINITE_ERROR = 100, ///< Return false (error), but don't change any
17671767
///< values, if any nonfinite values are found.
17681768
};
17691769

17701770
/// `fixNonFinite()` returns in image containing the values of `src` (within
1771-
/// the ROI), while repairing any non-finite (NaN/Inf) pixels. If
1772-
/// pixelsFixed is not nullptr, store in it the number of pixels that
1771+
/// the ROI), while repairing any non-finite (NaN/Inf) pixels. If
1772+
/// `pixelsFixed` is not nullptr, store in it the number of pixels that
17731773
/// contained non-finite value. It is permissible to operate in-place (with
1774-
/// `src` and `dst` referring to the same image).
1774+
/// `src` and `dst` referring to the same image).
17751775
///
17761776
/// How the non-finite values are repaired is specified by one of the `mode`
17771777
/// parameter, which is an enum of `NonFiniteFixMode`.

0 commit comments

Comments
 (0)