Skip to content

Commit acf4103

Browse files
committed
Add a bunch of missing docstrings
1 parent a4e28c5 commit acf4103

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

docs/src/function_reference.md

Lines changed: 53 additions & 0 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
@@ -277,6 +318,9 @@ component_subscripts
277318
component_centroids
278319
feature_transform
279320
distance_transform
321+
convexhull
322+
GuoAlgo
323+
thinning
280324
```
281325

282326
### Interpolation
@@ -320,6 +364,7 @@ spatialproperties
320364
```@docs
321365
SegmentedImage
322366
ImageEdge
367+
otsu_threshold
323368
labels_map
324369
segment_labels
325370
segment_pixel_count
@@ -340,6 +385,13 @@ region_splitting
340385

341386
## ImageFeatures
342387

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

345397
```@docs
@@ -351,6 +403,7 @@ BRIEF
351403
ORB
352404
FREAK
353405
BRISK
406+
HOG
354407
```
355408

356409
### Corners

0 commit comments

Comments
 (0)