Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update links and codes in quickstart #122

Merged
merged 1 commit into from
Apr 11, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 12 additions & 14 deletions docs/src/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,25 +84,25 @@ nothing # hide

defines a 4d image (3 space dimensions plus one time dimension) with
the specified name and physical pixel spacing for each coordinate.
The `AxisArrays` package supports rich and efficient operations on such
The [`AxisArrays`](https://github.com/JuliaArrays/AxisArrays.jl) package supports rich and efficient operations on such
arrays, and can be useful to keep track of not just pixel spacing but
the
[orientation convention used for multidimensional images](http://www.grahamwideman.com/gw/brain/orientation/orientterms.htm).

JuliaImages interoperates smoothly with `AxisArrays` and many other
packages. As further examples,

- the `ImageMetadata` package (incorporated into `Images` itself)
- the [`ImageMetadata`](https://github.com/JuliaImages/ImageMetadata.jl) package (incorporated into `Images` itself)
allows you to "tag" images with custom metadata

- the `IndirectArrays` package supports indexed (colormap) images
- the [`IndirectArrays`](https://github.com/JuliaArrays/IndirectArrays.jl) package supports indexed (colormap) images

- the `MappedArrays` package allows you to represent
- the [`MappedArrays`](https://github.com/JuliaArrays/MappedArrays.jl) package allows you to represent
[lazy](https://en.wikipedia.org/wiki/Lazy_evaluation)
value-transformations, facilitating work with images that may be too
large to store in memory at once

- `ImageTransformations` allows you to encode rotations, shears,
- [`ImageTransformations`](https://github.com/JuliaImages/ImageTransformations.jl) allows you to encode rotations, shears,
deformations, etc., either eagerly or lazily

It is very easy to define new array types in Julia--and consequently
Expand Down Expand Up @@ -138,10 +138,8 @@ img_rgb = rand(RGB, 2, 2)
img_lab = rand(Lab, 2, 2)
```
```@example pixel
mosaicview(cat(RGB.(img_gray), # hide
RGB.(img_rgb), # hide
RGB.(img_lab), dims=3), # hide
RGB(1, 1, 1), # hide
mosaicview(RGB.(img_gray), RGB.(img_rgb), RGB.(img_lab), # hide
fillvalue=RGB(1, 1, 1), # hide
nrow=1, npad=2) # hide
```

Expand Down Expand Up @@ -206,7 +204,7 @@ img_rgb = colorview(RGB, img_CHW) # 2 * 2
adjacent storage in memory). For more details, please refer to the performance tip:
[Access arrays in memory order, along columns](https://docs.julialang.org/en/v1/manual/performance-tips/#Access-arrays-in-memory-order,-along-columns-1)

You can use `permuteddimsview` to "reinterpret" the orientation of a
You can use `PermutedDimsArray` to "reinterpret" the orientation of a
chunk of memory without making a copy, or `permutedims` if you want a
copy.

Expand Down Expand Up @@ -263,11 +261,11 @@ img_n0f8_raw = rawview(img_n0f8)
float.(img_n0f8_raw)
```

Conversions between the storage type without changing the color type are supported
by the following functions:
Conversions between the storage type, i.e., the actual numeric type, without changing the color type
are supported by the following functions:

* `float32`, `float64`
* `n0f8`, `n6f10`, `n4f12`, `n2f14`, `n0f16`
* [`float32`](@ref), [`float64`](@ref)
* [`n0f8`](@ref), [`n6f10`](@ref), [`n4f12`](@ref), [`n2f14`](@ref), [`n0f16`](@ref)

```@repl fixedpoint
img = rand(Gray{N0f8}, 2, 2)
Expand Down