Skip to content

Commit 8242889

Browse files
authored
Correct imview function docstring
1 parent 1c1ad7f commit 8242889

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

Diff for: src/imview.jl

+4-3
Original file line numberDiff line numberDiff line change
@@ -183,9 +183,10 @@ to Colors according to `clims`, `stretch`, and `cmap`.
183183
184184
The data is first clamped to `clims`, which can either be a tuple of (min, max)
185185
values or a function accepting an iterator of pixel values that returns (min, max).
186-
By default, `clims=extrema` i.e. the minimum and maximum of `img`.
186+
By default, `clims=Percent(99.5)` which sets the display min and max to the central
187+
99.5 percentile range of pixel values.
187188
Convenient functions to use for `clims` are:
188-
`extrema`, `zscale`, and `percent(p)`
189+
`extrema`, `Zscale`, and `Percent(p)`
189190
190191
Next, the data is rescaled to [0,1] and remapped according to the function `stretch`.
191192
Stretch can be any monotonic fuction mapping values in the range [0,1] to some range [a,b].
@@ -223,7 +224,7 @@ or black if.
223224
The view returned by `imview` can be saved using general `FileIO.save` methods.
224225
Example:
225226
```julia
226-
v = imview(data, cmap=:magma, stretch=asinhstretch, clims=percent(95))
227+
v = imview(data, cmap=:magma, stretch=asinhstretch, clims=Percent(95))
227228
save("output.png", v)
228229
```
229230
"""

0 commit comments

Comments
 (0)