Skip to content

Commit 672b3ba

Browse files
authored
Merge pull request #123 from JuliaImages/teh/updates
Various updates
2 parents 84ddeca + c62d868 commit 672b3ba

File tree

8 files changed

+84
-25
lines changed

8 files changed

+84
-25
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ language: julia
33
os:
44
- linux
55
julia:
6-
- 1.0
6+
- 1.3
77
env:
88
- DOCUMENTER_DEBUG=true
99
notifications:

docs/src/api_comparison.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ welcome.
2525
| **Intensity & quantization** | | | |
2626
| Clamping | `clamp01`, `clamp01nan` | | |
2727
| Linear scaling | `scaleminmax`, `scalesigned`, etc. | `rescale_intensity` | `imadjust` |
28-
| Nonlinear scaling | `adjust_gamma`, `imstretch` | `adjust_gamma` | `imadjust` |
29-
| Compute histogram | `imhist` | `histogram` | `imhist` |
30-
| Histogram equalization | `histeq` | `equalize_hist` | `histeq` |
31-
| Adaptive equalization | `clahe` | `equalize_adapthist` | `adapthisteq` |
32-
| Reference histogram matching | `histmatch` | `match_histograms` | `imhistmatch` |
28+
| Nonlinear scaling | `GammaCorrection`, `imstretch` | `adjust_gamma` | `imadjust` |
29+
| Compute histogram | `build_histogram` | `histogram` | `imhist` |
30+
| Histogram equalization | `adjust_histogram` | `equalize_hist` | `histeq` |
31+
| Adaptive equalization | `AdaptiveEqualization` | `equalize_adapthist` | `adapthisteq` |
32+
| Reference histogram matching | `adjust_histogram` | `match_histograms` | `imhistmatch` |
3333
| Quantization | map anonymous function | | `imquantize` |
3434
| Threshold estimation | `otsu_threshold` | `threshold_otsu` etc. | `graythresh` etc. |
3535
| | | | |

docs/src/conversions_views.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -395,12 +395,12 @@ julia> a2 = [1.0,2.0]'
395395
julia> a1p, a2p = paddedviews(0, a1, a2); # 0 is the fill value
396396
397397
julia> a1p
398-
2×2 PaddedViews.PaddedView{Int64,2,Tuple{Base.OneTo{Int64},Base.OneTo{Int64}},Array{Int64,2}}:
398+
2×2 PaddedView(0, ::Array{Int64,2}, (Base.OneTo(2), Base.OneTo(2))) with eltype Int64:
399399
1 0
400400
2 0
401401
402402
julia> a2p
403-
2×2 PaddedViews.PaddedView{Float64,2,Tuple{Base.OneTo{Int64},Base.OneTo{Int64}},LinearAlgebra.Adjoint{Float64,Array{Float64,1}}}:
403+
2×2 PaddedView(0.0, ::LinearAlgebra.Adjoint{Float64,Array{Float64,1}}, (Base.OneTo(2), Base.OneTo(2))) with eltype Float64:
404404
1.0 2.0
405405
0.0 0.0
406406
```

docs/src/function_reference.md

Lines changed: 68 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,10 @@ normedview
3131
rawview
3232
permuteddimsview
3333
StackedView
34+
PaddedView
3435
paddedviews
36+
sym_paddedviews
37+
StreamingContainer
3538
```
3639

3740
Images with defined geometry and axis meaning can be constructed using the [`AxisArrays`](https://github.com/JuliaArrays/AxisArrays.jl) package:
@@ -67,14 +70,22 @@ coords_spatial
6770
size_spatial
6871
indices_spatial
6972
nimages
73+
timeaxis
74+
istimeaxis
75+
timedim
7076
assert_timedim_last
77+
StreamIndexStyle
78+
IndexAny
79+
IndexIncremental
7180
```
7281

7382
## Element transformation and intensity scaling
7483

7584
```@docs
7685
clamp01
86+
clamp01!
7787
clamp01nan
88+
clamp01nan!
7889
scaleminmax
7990
scalesigned
8091
colorsigned
@@ -93,6 +104,26 @@ n2f14
93104
n0f16
94105
```
95106

107+
## Color channels
108+
109+
You can extract the numeric value of particular color channels:
110+
111+
```@docs
112+
gray
113+
red
114+
green
115+
blue
116+
alpha
117+
```
118+
119+
You can also perform operations on channels:
120+
121+
```@docs
122+
mapc
123+
reducec
124+
mapreducec
125+
```
126+
96127
## Color conversion
97128

98129
```julia
@@ -106,6 +137,10 @@ imghsv = HSV.(img)
106137
```
107138
converts to an HSV representation of color information.
108139

140+
The [ColorTypes](https://github.com/JuliaGraphics/ColorTypes.jl)
141+
package has a rich set of traits that allow you to perform generic
142+
operations on color types, see its README for more information.
143+
109144
## Image algorithms
110145

111146
### Linear filtering
@@ -127,7 +162,10 @@ Kernel.ando5
127162
Kernel.gaussian
128163
Kernel.DoG
129164
Kernel.LoG
165+
Kernel.gabor
130166
Kernel.Laplacian
167+
Kernel.bickley
168+
Kernel.scharr
131169
```
132170

133171
#### KernelFactors
@@ -141,6 +179,8 @@ KernelFactors.ando5
141179
KernelFactors.gaussian
142180
KernelFactors.IIRGaussian
143181
KernelFactors.TriggsSdika
182+
KernelFactors.bickley
183+
KernelFactors.scharr
144184
```
145185

146186
#### Kernel utilities
@@ -194,6 +234,7 @@ magnitude_phase
194234
imedge
195235
thin_edges
196236
canny
237+
Percentile
197238
```
198239

199240
### Corner Detection
@@ -208,7 +249,7 @@ fastcorners
208249

209250
### Feature Extraction
210251

211-
See the [ImageFeatures]() package for a much more comprehensive set of tools.
252+
See the [ImageFeatures](https://juliaimages.org/ImageFeatures.jl/stable/) package for a much more comprehensive set of tools.
212253

213254
```@docs
214255
blob_LoG
@@ -220,23 +261,28 @@ findlocalminima
220261
### Exposure
221262

222263
```@docs
223-
imhist
264+
build_histogram
265+
adjust_histogram
266+
adjust_histogram!
224267
cliphist
225-
histeq
226-
adjust_gamma
227268
imstretch
228269
imadjustintensity
229270
complement
230-
histmatch
231-
clahe
271+
AdaptiveEqualization
272+
GammaCorrection
232273
```
233274

234275
### Spatial transformations and resizing
235276

236277
```@docs
237278
imresize
279+
imrotate
238280
restrict
239281
warp
282+
warpedview
283+
invwarpedview
284+
WarpedView
285+
InvWarpedView
240286
```
241287

242288
### Image statistics
@@ -247,9 +293,10 @@ maxfinite
247293
maxabsfinite
248294
meanfinite
249295
ssd
250-
ssdn
296+
mse
251297
sad
252-
sadn
298+
mae
299+
entropy
253300
```
254301

255302
### Morphological operations
@@ -271,6 +318,9 @@ component_subscripts
271318
component_centroids
272319
feature_transform
273320
distance_transform
321+
convexhull
322+
GuoAlgo
323+
thinning
274324
```
275325

276326
### Interpolation
@@ -302,7 +352,7 @@ shepp_logan
302352

303353
```@docs
304354
ImageMeta
305-
data
355+
arraydata
306356
properties
307357
copyproperties
308358
shareproperties
@@ -314,6 +364,7 @@ spatialproperties
314364
```@docs
315365
SegmentedImage
316366
ImageEdge
367+
otsu_threshold
317368
labels_map
318369
segment_labels
319370
segment_pixel_count
@@ -334,6 +385,13 @@ region_splitting
334385

335386
## ImageFeatures
336387

388+
### Geometric features
389+
390+
```@docs
391+
hough_transform_standard
392+
hough_circle_gradient
393+
```
394+
337395
### Types
338396

339397
```@docs
@@ -345,6 +403,7 @@ BRIEF
345403
ORB
346404
FREAK
347405
BRISK
406+
HOG
348407
```
349408

350409
### Corners

docs/src/imagefeatures.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ descriptors in other images or other portions of the same image. This
77
can be useful in many applications, such as object recognition,
88
localization, or image registration.
99

10-
ImagesFeatures has [its own documentation](http://juliaimages.github.io/ImageFeatures.jl/latest/index.html), and you should consult that for a comprehensive overview of the functionality of the package. Here, we'll briefly illustrate one type of feature and its application to image registration, the *BRISK* descriptor.
10+
ImagesFeatures has [its own documentation](https://juliaimages.org/ImageFeatures.jl/stable), and you should consult that for a comprehensive overview of the functionality of the package. Here, we'll briefly illustrate one type of feature and its application to image registration, the *BRISK* descriptor.
1111

1212
The *BRISK* descriptor examines the structure of an image around a
1313
*keypoint*. Given a keypoint, the mean intensity (loosely-speaking) is

docs/src/imagemetadata.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,10 @@ RGB ImageMeta with:
5252
time: evening
5353
```
5454

55-
You can extract the data matrix with `data(img)`:
55+
You can extract the data matrix with `arraydata(img)`:
5656

5757
```jldoctest
58-
julia> data(img)
58+
julia> arraydata(img)
5959
3×2 Array{RGB{N0f8},2} with eltype RGB{FixedPointNumbers.Normed{UInt8,8}}:
6060
RGB{N0f8}(1.0,0.0,0.0) RGB{N0f8}(1.0,0.0,0.0)
6161
RGB{N0f8}(1.0,0.0,0.0) RGB{N0f8}(1.0,0.0,0.0)
@@ -139,14 +139,14 @@ Int64 ImageMeta with:
139139
data: 3×5 reshape(::UnitRange{Int64}, 3, 5) with eltype Int64
140140
properties:
141141
maxsum: [42, 45]
142-
spatialproperties: Set(Symbol[:maxsum])
142+
spatialproperties: Set([:maxsum])
143143
144144
julia> imgp = permutedims(img, (2,1))
145145
Int64 ImageMeta with:
146146
data: 5×3 Array{Int64,2}
147147
properties:
148148
maxsum: [45, 42]
149-
spatialproperties: Set(Symbol[:maxsum])
149+
spatialproperties: Set([:maxsum])
150150
151151
julia> maximum(sum(imgp, dims=1))
152152
45

docs/src/indexing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ julia> summary(img)
3434
"386×386 Array{Gray{N0f8},2} with eltype Gray{Normed{UInt8,8}}"
3535
3636
julia> summary(imgrot)
37-
"OffsetArray(::Array{Gray{N0f8},2}, -59:446, -59:446) with eltype Gray{Normed{UInt8,8}} with indices -59:446×-59:446"
37+
"506×506 OffsetArray(::Array{Gray{N0f8},2}, -59:446, -59:446) with eltype Gray{Normed{UInt8,8}} with indices -59:446×-59:446"
3838
```
3939

4040
While `img` has axes that start with the conventional 1, the

docs/src/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ location across multiple images. More information can be found in
301301

302302
## Examples of usage
303303

304-
If you feel ready to get started, see the [Demonstrations](@ref) page for inspiration.
304+
If you feel ready to get started, see the [Demonstrations](@ref demonstrations) page for inspiration.
305305

306306
## Function categories
307307

@@ -328,7 +328,7 @@ Algorithms:
328328
- Resizing and spatial transformations: `restrict`, `imresize`, `warp`
329329
- Filtering: `imfilter`, `imfilter!`, `imfilter_LoG`, `mapwindow`, `imROF`, `padarray`
330330
- Filtering kernels: `Kernel.` or `KernelFactors.`, followed by `ando[345]`, `guassian2d`, `imaverage`, `imdog`, `imlaplacian`, `prewitt`, `sobel`
331-
- Exposure : `imhist`, `histeq`, `adjust_gamma`, `histmatch`, `imadjustintensity`, `imstretch`, `imcomplement`, `clahe`, `cliphist`
331+
- Exposure : `build_histogram`, `adjust_histogram`, `imadjustintensity`, `imstretch`, `imcomplement`, `AdaptiveEqualization`, `GammaCorrection`, `cliphist`
332332
- Gradients: `backdiffx`, `backdiffy`, `forwarddiffx`, `forwarddiffy`, `imgradients`
333333
- Edge detection: `imedge`, `imgradients`, `thin_edges`, `magnitude`, `phase`, `magnitudephase`, `orientation`, `canny`
334334
- Corner detection: `imcorner`, `harris`, `shi_tomasi`, `kitchen_rosenfeld`, `meancovs`, `gammacovs`, `fastcorners`

0 commit comments

Comments
 (0)