Skip to content

Commit

Permalink
build based on c1a3025
Browse files Browse the repository at this point in the history
zeptodoctor committed Nov 6, 2024
1 parent 412b325 commit ce9b446
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions dev/reference/index.html
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Reference · ImageCore</title><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit">ImageCore</span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">ImageCore.jl</a></li><li><a class="tocitem" href="../views/">Views</a></li><li><a class="tocitem" href="../map/">Lazy transformation of values</a></li><li><a class="tocitem" href="../traits/">Traits</a></li><li class="is-active"><a class="tocitem" href>Reference</a><ul class="internal"><li><a class="tocitem" href="#List-of-view-types-1"><span>List of view types</span></a></li><li><a class="tocitem" href="#List-of-value-transformations-(map-functions)-1"><span>List of value-transformations (map functions)</span></a></li><li><a class="tocitem" href="#List-of-storage-type-transformations-1"><span>List of storage-type transformations</span></a></li><li><a class="tocitem" href="#List-of-traits-1"><span>List of traits</span></a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Reference</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Reference</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/JuliaImages/ImageCore.jl/blob/master/docs/src/reference.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Reference-1"><a class="docs-heading-anchor" href="#Reference-1">Reference</a><a class="docs-heading-anchor-permalink" href="#Reference-1" title="Permalink"></a></h1><h2 id="List-of-view-types-1"><a class="docs-heading-anchor" href="#List-of-view-types-1">List of view types</a><a class="docs-heading-anchor-permalink" href="#List-of-view-types-1" title="Permalink"></a></h2><p>With that as an introduction, let&#39;s list all the view types supported by this package. <code>channelview</code> and <code>colorview</code> are opposite transformations, as are <code>rawview</code> and <code>normedview</code>. <code>channelview</code> and <code>colorview</code> typically create objects of type <code>ChannelView</code> and <code>ColorView</code>, respectively, unless they are &quot;undoing&quot; a previous view of the opposite type.</p><article class="docstring"><header><a class="docstring-binding" id="ImageCore.channelview" href="#ImageCore.channelview"><code>ImageCore.channelview</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">channelview(A)</code></pre><p>returns a view of <code>A</code>, splitting out (if necessary) the color channels of <code>A</code> into a new first dimension.</p><p>Of relevance for types like RGB and BGR, the channels of the returned array will be in constructor-argument order, not memory order (see <code>reinterpretc</code> if you want to use memory order).</p><p><strong>Example</strong></p><pre><code class="language-julia">img = rand(RGB{N0f8}, 10, 10)
A = channelview(img) # a 3×10×10 array</code></pre><p>See also: <a href="#ImageCore.colorview"><code>colorview</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/colorchannels.jl#L47-L64">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.colorview" href="#ImageCore.colorview"><code>ImageCore.colorview</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">colorview(C, A)</code></pre><p>returns a view of the numeric array <code>A</code>, interpreting successive elements of <code>A</code> as if they were channels of Colorant <code>C</code>.</p><p>Of relevance for types like RGB and BGR, the elements of <code>A</code> are interpreted in constructor-argument order, not memory order (see <code>reinterpretc</code> if you want to use memory order).</p><p><strong>Example</strong></p><pre><code class="language-jl">A = rand(3, 10, 10)
img = colorview(RGB, A)</code></pre><p>See also: <a href="#ImageCore.channelview"><code>channelview</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/colorchannels.jl#L88-L105">source</a></section><section><div><pre><code class="language-none">colorview(C, gray1, gray2, ...) -&gt; imgC</code></pre><p>Combine numeric/grayscale images <code>gray1</code>, <code>gray2</code>, etc., into the separate color channels of an array <code>imgC</code> with element type <code>C&lt;:Colorant</code>.</p><p>As a convenience, the constant <code>zeroarray</code> fills in an array of matched size with all zeros.</p><p><strong>Example</strong></p><pre><code class="language-julia">imgC = colorview(RGB, r, zeroarray, b)</code></pre><p>creates an image with <code>r</code> in the red chanel, <code>b</code> in the blue channel, and nothing in the green channel.</p><p>See also: <a href="#ImageCore.StackedView"><code>StackedView</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/colorchannels.jl#L146-L165">source</a></section><section><div><pre><code class="language-none">colorview(C)</code></pre><p>Create a function that is equivalent to <code>(As...) -&gt; colorview(C, Ax...)</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl">julia&gt; ones(Float32, 2, 2) |&gt; colorview(Gray)
A = channelview(img) # a 3×10×10 array</code></pre><p>See also: <a href="#ImageCore.colorview"><code>colorview</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/colorchannels.jl#L47-L64">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.colorview" href="#ImageCore.colorview"><code>ImageCore.colorview</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">colorview(C, A)</code></pre><p>returns a view of the numeric array <code>A</code>, interpreting successive elements of <code>A</code> as if they were channels of Colorant <code>C</code>.</p><p>Of relevance for types like RGB and BGR, the elements of <code>A</code> are interpreted in constructor-argument order, not memory order (see <code>reinterpretc</code> if you want to use memory order).</p><p><strong>Example</strong></p><pre><code class="language-jl">A = rand(3, 10, 10)
img = colorview(RGB, A)</code></pre><p>See also: <a href="#ImageCore.channelview"><code>channelview</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/colorchannels.jl#L88-L105">source</a></section><section><div><pre><code class="language-none">colorview(C, gray1, gray2, ...) -&gt; imgC</code></pre><p>Combine numeric/grayscale images <code>gray1</code>, <code>gray2</code>, etc., into the separate color channels of an array <code>imgC</code> with element type <code>C&lt;:Colorant</code>.</p><p>As a convenience, the constant <code>zeroarray</code> fills in an array of matched size with all zeros.</p><p><strong>Example</strong></p><pre><code class="language-julia">imgC = colorview(RGB, r, zeroarray, b)</code></pre><p>creates an image with <code>r</code> in the red chanel, <code>b</code> in the blue channel, and nothing in the green channel.</p><p>See also: <a href="#ImageCore.StackedView"><code>StackedView</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/colorchannels.jl#L146-L165">source</a></section><section><div><pre><code class="language-none">colorview(C)</code></pre><p>Create a function that is equivalent to <code>(As...) -&gt; colorview(C, Ax...)</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl">julia&gt; ones(Float32, 2, 2) |&gt; colorview(Gray)
2×2 reinterpret(reshape, Gray{Float32}, ::Matrix{Float32}) with eltype Gray{Float32}:
Gray{Float32}(1.0) Gray{Float32}(1.0)
Gray{Float32}(1.0) Gray{Float32}(1.0)</code></pre><p>This can be slightly convenient when you want to convert a batch of channel data, for example:</p><pre><code class="language-julia">julia&gt; Rs, Gs, Bs = ntuple( i -&gt; [randn(2, 2) for _ in 1:4], 3)

julia&gt; map(colorview(RGB), Rs, Gs, Bs)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/colorchannels.jl#L173-L194">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.rawview" href="#ImageCore.rawview"><code>ImageCore.rawview</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">rawview(img::AbstractArray{FixedPoint})</code></pre><p>returns a &quot;view&quot; of <code>img</code> where the values are interpreted in terms of their raw underlying storage. For example, if <code>img</code> is an <code>Array{N0f8}</code>, the view will act like an <code>Array{UInt8}</code>.</p><p>See also: <a href="#ImageCore.normedview"><code>normedview</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/ImageCore.jl#L95-L103">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.normedview" href="#ImageCore.normedview"><code>ImageCore.normedview</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">normedview([T], img::AbstractArray{Unsigned})</code></pre><p>returns a &quot;view&quot; of <code>img</code> where the values are interpreted in terms of <code>Normed</code> number types. For example, if <code>img</code> is an <code>Array{UInt8}</code>, the view will act like an <code>Array{N0f8}</code>. Supply <code>T</code> if the element type of <code>img</code> is <code>UInt16</code>, to specify whether you want a <code>N6f10</code>, <code>N4f12</code>, <code>N2f14</code>, or <code>N0f16</code> result.</p><p>See also: <a href="#ImageCore.rawview"><code>rawview</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/ImageCore.jl#L108-L118">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.StackedView" href="#ImageCore.StackedView"><code>ImageCore.StackedView</code></a><span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">StackedView(B, C, ...) -&gt; A</code></pre><p>Present arrays <code>B</code>, <code>C</code>, etc, as if they are separate channels along the first dimension of <code>A</code>. In particular,</p><pre><code class="language-none">B == A[1,:,:...]
C == A[2,:,:...]</code></pre><p>and so on. Combined with <code>colorview</code>, this allows one to combine two or more grayscale images into a single color image.</p><p>See also: <a href="#ImageCore.colorview"><code>colorview</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/stackedviews.jl#L14-L27">source</a></section></article><h2 id="List-of-value-transformations-(map-functions)-1"><a class="docs-heading-anchor" href="#List-of-value-transformations-(map-functions)-1">List of value-transformations (map functions)</a><a class="docs-heading-anchor-permalink" href="#List-of-value-transformations-(map-functions)-1" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="ImageCore.clamp01" href="#ImageCore.clamp01"><code>ImageCore.clamp01</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">clamp01(x) -&gt; y</code></pre><p>Produce a value <code>y</code> that lies between 0 and 1, and equal to <code>x</code> when <code>x</code> is already in this range. Equivalent to <code>clamp(x, 0, 1)</code> for numeric values. For colors, this function is applied to each color channel separately.</p><p>See also: <a href="#ImageCore.clamp01!"><code>clamp01!</code></a>, <a href="#ImageCore.clamp01nan"><code>clamp01nan</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/map.jl#L3-L12">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.clamp01!" href="#ImageCore.clamp01!"><code>ImageCore.clamp01!</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">clamp01!(array::AbstractArray)</code></pre><p>Restrict values in array to [0, 1], in-place. See also <a href="#ImageCore.clamp01"><code>clamp01</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/map.jl#L17-L21">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.clamp01nan" href="#ImageCore.clamp01nan"><code>ImageCore.clamp01nan</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">clamp01nan(x) -&gt; y</code></pre><p>Similar to <code>clamp01</code>, except that any <code>NaN</code> values are changed to 0.</p><p>See also: <a href="#ImageCore.clamp01nan!"><code>clamp01nan!</code></a>, <a href="#ImageCore.clamp01"><code>clamp01</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/map.jl#L30-L36">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.clamp01nan!" href="#ImageCore.clamp01nan!"><code>ImageCore.clamp01nan!</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">clamp01nan!(array::AbstractArray)</code></pre><p>Similar to <code>clamp01!</code>, except that any <code>NaN</code> values are changed to 0.</p><p>See also: <a href="#ImageCore.clamp01!"><code>clamp01!</code></a>, <a href="#ImageCore.clamp01nan"><code>clamp01nan</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/map.jl#L41-L47">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.scaleminmax" href="#ImageCore.scaleminmax"><code>ImageCore.scaleminmax</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">scaleminmax(min, max) -&gt; f
julia&gt; map(colorview(RGB), Rs, Gs, Bs)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/colorchannels.jl#L173-L194">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.rawview" href="#ImageCore.rawview"><code>ImageCore.rawview</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">rawview(img::AbstractArray{FixedPoint})</code></pre><p>returns a &quot;view&quot; of <code>img</code> where the values are interpreted in terms of their raw underlying storage. For example, if <code>img</code> is an <code>Array{N0f8}</code>, the view will act like an <code>Array{UInt8}</code>.</p><p>See also: <a href="#ImageCore.normedview"><code>normedview</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/ImageCore.jl#L95-L103">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.normedview" href="#ImageCore.normedview"><code>ImageCore.normedview</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">normedview([T], img::AbstractArray{Unsigned})</code></pre><p>returns a &quot;view&quot; of <code>img</code> where the values are interpreted in terms of <code>Normed</code> number types. For example, if <code>img</code> is an <code>Array{UInt8}</code>, the view will act like an <code>Array{N0f8}</code>. Supply <code>T</code> if the element type of <code>img</code> is <code>UInt16</code>, to specify whether you want a <code>N6f10</code>, <code>N4f12</code>, <code>N2f14</code>, or <code>N0f16</code> result.</p><p>See also: <a href="#ImageCore.rawview"><code>rawview</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/ImageCore.jl#L108-L118">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.StackedView" href="#ImageCore.StackedView"><code>ImageCore.StackedView</code></a><span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">StackedView(B, C, ...) -&gt; A</code></pre><p>Present arrays <code>B</code>, <code>C</code>, etc, as if they are separate channels along the first dimension of <code>A</code>. In particular,</p><pre><code class="language-none">B == A[1,:,:...]
C == A[2,:,:...]</code></pre><p>and so on. Combined with <code>colorview</code>, this allows one to combine two or more grayscale images into a single color image.</p><p>See also: <a href="#ImageCore.colorview"><code>colorview</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/stackedviews.jl#L14-L27">source</a></section></article><h2 id="List-of-value-transformations-(map-functions)-1"><a class="docs-heading-anchor" href="#List-of-value-transformations-(map-functions)-1">List of value-transformations (map functions)</a><a class="docs-heading-anchor-permalink" href="#List-of-value-transformations-(map-functions)-1" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="ImageCore.clamp01" href="#ImageCore.clamp01"><code>ImageCore.clamp01</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">clamp01(x) -&gt; y</code></pre><p>Produce a value <code>y</code> that lies between 0 and 1, and equal to <code>x</code> when <code>x</code> is already in this range. Equivalent to <code>clamp(x, 0, 1)</code> for numeric values. For colors, this function is applied to each color channel separately.</p><p>See also: <a href="#ImageCore.clamp01!"><code>clamp01!</code></a>, <a href="#ImageCore.clamp01nan"><code>clamp01nan</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/map.jl#L3-L12">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.clamp01!" href="#ImageCore.clamp01!"><code>ImageCore.clamp01!</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">clamp01!(array::AbstractArray)</code></pre><p>Restrict values in array to [0, 1], in-place. See also <a href="#ImageCore.clamp01"><code>clamp01</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/map.jl#L17-L21">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.clamp01nan" href="#ImageCore.clamp01nan"><code>ImageCore.clamp01nan</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">clamp01nan(x) -&gt; y</code></pre><p>Similar to <code>clamp01</code>, except that any <code>NaN</code> values are changed to 0.</p><p>See also: <a href="#ImageCore.clamp01nan!"><code>clamp01nan!</code></a>, <a href="#ImageCore.clamp01"><code>clamp01</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/map.jl#L30-L36">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.clamp01nan!" href="#ImageCore.clamp01nan!"><code>ImageCore.clamp01nan!</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">clamp01nan!(array::AbstractArray)</code></pre><p>Similar to <code>clamp01!</code>, except that any <code>NaN</code> values are changed to 0.</p><p>See also: <a href="#ImageCore.clamp01!"><code>clamp01!</code></a>, <a href="#ImageCore.clamp01nan"><code>clamp01nan</code></a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/map.jl#L41-L47">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.scaleminmax" href="#ImageCore.scaleminmax"><code>ImageCore.scaleminmax</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">scaleminmax(min, max) -&gt; f
scaleminmax(T, min, max) -&gt; f</code></pre><p>Return a function <code>f</code> which maps values less than or equal to <code>min</code> to 0, values greater than or equal to <code>max</code> to 1, and uses a linear scale in between. <code>min</code> and <code>max</code> should be real values.</p><p>Optionally specify the return type <code>T</code>. If <code>T</code> is a colorant (e.g., RGB), then scaling is applied to each color channel.</p><p><strong>Examples</strong></p><p><strong>Example 1</strong></p><pre><code class="language-julia">julia&gt; f = scaleminmax(-10, 10)
(::#9) (generic function with 1 method)

@@ -25,9 +25,9 @@
(::#13) (generic function with 1 method)

julia&gt; f(c)
RGB{Float64}(1.0,0.5019607843137255,0.0)</code></pre><p>See also: <a href="#ImageCore.takemap"><code>takemap</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/map.jl#L56-L99">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.scalesigned" href="#ImageCore.scalesigned"><code>ImageCore.scalesigned</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">scalesigned(maxabs) -&gt; f</code></pre><p>Return a function <code>f</code> which scales values in the range <code>[-maxabs, maxabs]</code> (clamping values that lie outside this range) to the range <code>[-1, 1]</code>.</p><p>See also: <a href="#ImageCore.colorsigned"><code>colorsigned</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/map.jl#L155-L163">source</a></section><section><div><pre><code class="language-none">scalesigned(min, center, max) -&gt; f</code></pre><p>Return a function <code>f</code> which scales values in the range <code>[min, center]</code> to <code>[-1,0]</code> and <code>[center,max]</code> to <code>[0,1]</code>. Values smaller than <code>min</code>/<code>max</code> get clamped to <code>min</code>/<code>max</code>, respectively.</p><p>See also: <a href="#ImageCore.colorsigned"><code>colorsigned</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/map.jl#L169-L177">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.colorsigned" href="#ImageCore.colorsigned"><code>ImageCore.colorsigned</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">colorsigned()
RGB{Float64}(1.0,0.5019607843137255,0.0)</code></pre><p>See also: <a href="#ImageCore.takemap"><code>takemap</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/map.jl#L56-L99">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.scalesigned" href="#ImageCore.scalesigned"><code>ImageCore.scalesigned</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">scalesigned(maxabs) -&gt; f</code></pre><p>Return a function <code>f</code> which scales values in the range <code>[-maxabs, maxabs]</code> (clamping values that lie outside this range) to the range <code>[-1, 1]</code>.</p><p>See also: <a href="#ImageCore.colorsigned"><code>colorsigned</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/map.jl#L155-L163">source</a></section><section><div><pre><code class="language-none">scalesigned(min, center, max) -&gt; f</code></pre><p>Return a function <code>f</code> which scales values in the range <code>[min, center]</code> to <code>[-1,0]</code> and <code>[center,max]</code> to <code>[0,1]</code>. Values smaller than <code>min</code>/<code>max</code> get clamped to <code>min</code>/<code>max</code>, respectively.</p><p>See also: <a href="#ImageCore.colorsigned"><code>colorsigned</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/map.jl#L169-L177">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.colorsigned" href="#ImageCore.colorsigned"><code>ImageCore.colorsigned</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">colorsigned()
colorsigned(colorneg, colorpos) -&gt; f
colorsigned(colorneg, colorcenter, colorpos) -&gt; f</code></pre><p>Define a function that maps negative values (in the range [-1,0]) to the linear colormap between <code>colorneg</code> and <code>colorcenter</code>, and positive values (in the range [0,1]) to the linear colormap between <code>colorcenter</code> and <code>colorpos</code>.</p><p>The default colors are:</p><ul><li><code>colorcenter</code>: white</li><li><code>colorneg</code>: green1</li><li><code>colorpos</code>: magenta</li></ul><p>See also: <a href="#ImageCore.scalesigned"><code>scalesigned</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/map.jl#L193-L210">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.takemap" href="#ImageCore.takemap"><code>ImageCore.takemap</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">takemap(f, A) -&gt; fnew
colorsigned(colorneg, colorcenter, colorpos) -&gt; f</code></pre><p>Define a function that maps negative values (in the range [-1,0]) to the linear colormap between <code>colorneg</code> and <code>colorcenter</code>, and positive values (in the range [0,1]) to the linear colormap between <code>colorcenter</code> and <code>colorpos</code>.</p><p>The default colors are:</p><ul><li><code>colorcenter</code>: white</li><li><code>colorneg</code>: green1</li><li><code>colorpos</code>: magenta</li></ul><p>See also: <a href="#ImageCore.scalesigned"><code>scalesigned</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/map.jl#L193-L210">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.takemap" href="#ImageCore.takemap"><code>ImageCore.takemap</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">takemap(f, A) -&gt; fnew
takemap(f, T, A) -&gt; fnew</code></pre><p>Given a value-mapping function <code>f</code> and an array <code>A</code>, return a &quot;concrete&quot; mapping function <code>fnew</code>. When applied to elements of <code>A</code>, <code>fnew</code> should return valid values for storage or display, for example in the range from 0 to 1 (for grayscale) or valid colorants. <code>fnew</code> may be adapted to the actual values present in <code>A</code>, and may not produce valid values for any inputs not in <code>A</code>.</p><p>Optionally one can specify the output type <code>T</code> that <code>fnew</code> should produce.</p><p><strong>Example:</strong></p><pre><code class="language-julia">julia&gt; A = [0, 1, 1000];

julia&gt; f = takemap(scaleminmax, A)
@@ -37,4 +37,4 @@
3-element Array{Float64,1}:
0.0
0.001
1.0</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/map.jl#L225-L251">source</a></section></article><h2 id="List-of-storage-type-transformations-1"><a class="docs-heading-anchor" href="#List-of-storage-type-transformations-1">List of storage-type transformations</a><a class="docs-heading-anchor-permalink" href="#List-of-storage-type-transformations-1" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="ImageCore.float32" href="#ImageCore.float32"><code>ImageCore.float32</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">float32.(img)</code></pre><p>converts the raw storage type of <code>img</code> to <code>Float32</code>, without changing the color space.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/convert_reinterpret.jl#L35-L39">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.float64" href="#ImageCore.float64"><code>ImageCore.float64</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">float64.(img)</code></pre><p>converts the raw storage type of <code>img</code> to <code>Float64</code>, without changing the color space.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/convert_reinterpret.jl#L35-L39">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.n0f8" href="#ImageCore.n0f8"><code>ImageCore.n0f8</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">n0f8.(img)</code></pre><p>converts the raw storage type of <code>img</code> to <code>N0f8</code>, without changing the color space.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/convert_reinterpret.jl#L35-L39">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.n6f10" href="#ImageCore.n6f10"><code>ImageCore.n6f10</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">n6f10.(img)</code></pre><p>converts the raw storage type of <code>img</code> to <code>N6f10</code>, without changing the color space.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/convert_reinterpret.jl#L35-L39">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.n4f12" href="#ImageCore.n4f12"><code>ImageCore.n4f12</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">n4f12.(img)</code></pre><p>converts the raw storage type of <code>img</code> to <code>N4f12</code>, without changing the color space.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/convert_reinterpret.jl#L35-L39">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.n2f14" href="#ImageCore.n2f14"><code>ImageCore.n2f14</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">n2f14.(img)</code></pre><p>converts the raw storage type of <code>img</code> to <code>N2f14</code>, without changing the color space.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/convert_reinterpret.jl#L35-L39">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.n0f16" href="#ImageCore.n0f16"><code>ImageCore.n0f16</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">n0f16.(img)</code></pre><p>converts the raw storage type of <code>img</code> to <code>N0f16</code>, without changing the color space.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/convert_reinterpret.jl#L35-L39">source</a></section></article><h2 id="List-of-traits-1"><a class="docs-heading-anchor" href="#List-of-traits-1">List of traits</a><a class="docs-heading-anchor-permalink" href="#List-of-traits-1" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="ImageCore.pixelspacing" href="#ImageCore.pixelspacing"><code>ImageCore.pixelspacing</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">pixelspacing(img) -&gt; (sx, sy, ...)</code></pre><p>Return a tuple representing the separation between adjacent pixels along each axis of the image. Defaults to (1,1,...). Use ImagesAxes for images with anisotropic spacing or to encode the spacing using physical units.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/traits.jl#L52-L59">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.spacedirections" href="#ImageCore.spacedirections"><code>ImageCore.spacedirections</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">spacedirections(img) -&gt; (axis1, axis2, ...)</code></pre><p>Return a tuple-of-tuples, each <code>axis[i]</code> representing the displacement vector between adjacent pixels along spatial axis <code>i</code> of the image array, relative to some external coordinate system (&quot;physical coordinates&quot;).</p><p>By default this is computed from <code>pixelspacing</code>, but you can set this manually using ImagesMeta.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/traits.jl#L73-L83">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.sdims" href="#ImageCore.sdims"><code>ImageCore.sdims</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">sdims(img)</code></pre><p>Return the number of spatial dimensions in the image. Defaults to the same as <code>ndims</code>, but with ImagesAxes you can specify that some axes correspond to other quantities (e.g., time) and thus not included by <code>sdims</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/traits.jl#L100-L107">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.coords_spatial" href="#ImageCore.coords_spatial"><code>ImageCore.coords_spatial</code></a><span class="docstring-category">Function</span></header><section><div><p>coords_spatial(img)</p><p>Return a tuple listing the spatial dimensions of <code>img</code>.</p><p>Note that a better strategy may be to use ImagesAxes and take slices along the time axis.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/traits.jl#L110-L116">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.size_spatial" href="#ImageCore.size_spatial"><code>ImageCore.size_spatial</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">size_spatial(img)</code></pre><p>Return a tuple listing the sizes of the spatial dimensions of the image. Defaults to the same as <code>size</code>, but using ImagesAxes you can mark some axes as being non-spatial.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/traits.jl#L148-L154">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.indices_spatial" href="#ImageCore.indices_spatial"><code>ImageCore.indices_spatial</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">indices_spatial(img)</code></pre><p>Return a tuple with the indices of the spatial dimensions of the image. Defaults to the same as <code>indices</code>, but using ImagesAxes you can mark some axes as being non-spatial.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/traits.jl#L167-L173">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.nimages" href="#ImageCore.nimages"><code>ImageCore.nimages</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">nimages(img)</code></pre><p>Return the number of time-points in the image array. Defaults to</p><ol><li>Use ImagesAxes if you want to use an explicit time dimension.</li></ol></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/traits.jl#L132-L137">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.assert_timedim_last" href="#ImageCore.assert_timedim_last"><code>ImageCore.assert_timedim_last</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">assert_timedim_last(img)</code></pre><p>Throw an error if the image has a time dimension that is not the last dimension.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/f113cf318f6bfc20d3d384d7c5701fce96af2804/src/traits.jl#L188-L193">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../traits/">« Traits</a></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Wednesday 6 November 2024 21:48">Wednesday 6 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
1.0</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/map.jl#L225-L251">source</a></section></article><h2 id="List-of-storage-type-transformations-1"><a class="docs-heading-anchor" href="#List-of-storage-type-transformations-1">List of storage-type transformations</a><a class="docs-heading-anchor-permalink" href="#List-of-storage-type-transformations-1" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="ImageCore.float32" href="#ImageCore.float32"><code>ImageCore.float32</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">float32.(img)</code></pre><p>converts the raw storage type of <code>img</code> to <code>Float32</code>, without changing the color space.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/convert_reinterpret.jl#L35-L39">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.float64" href="#ImageCore.float64"><code>ImageCore.float64</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">float64.(img)</code></pre><p>converts the raw storage type of <code>img</code> to <code>Float64</code>, without changing the color space.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/convert_reinterpret.jl#L35-L39">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.n0f8" href="#ImageCore.n0f8"><code>ImageCore.n0f8</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">n0f8.(img)</code></pre><p>converts the raw storage type of <code>img</code> to <code>N0f8</code>, without changing the color space.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/convert_reinterpret.jl#L35-L39">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.n6f10" href="#ImageCore.n6f10"><code>ImageCore.n6f10</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">n6f10.(img)</code></pre><p>converts the raw storage type of <code>img</code> to <code>N6f10</code>, without changing the color space.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/convert_reinterpret.jl#L35-L39">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.n4f12" href="#ImageCore.n4f12"><code>ImageCore.n4f12</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">n4f12.(img)</code></pre><p>converts the raw storage type of <code>img</code> to <code>N4f12</code>, without changing the color space.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/convert_reinterpret.jl#L35-L39">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.n2f14" href="#ImageCore.n2f14"><code>ImageCore.n2f14</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">n2f14.(img)</code></pre><p>converts the raw storage type of <code>img</code> to <code>N2f14</code>, without changing the color space.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/convert_reinterpret.jl#L35-L39">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.n0f16" href="#ImageCore.n0f16"><code>ImageCore.n0f16</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">n0f16.(img)</code></pre><p>converts the raw storage type of <code>img</code> to <code>N0f16</code>, without changing the color space.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/convert_reinterpret.jl#L35-L39">source</a></section></article><h2 id="List-of-traits-1"><a class="docs-heading-anchor" href="#List-of-traits-1">List of traits</a><a class="docs-heading-anchor-permalink" href="#List-of-traits-1" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="ImageCore.pixelspacing" href="#ImageCore.pixelspacing"><code>ImageCore.pixelspacing</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">pixelspacing(img) -&gt; (sx, sy, ...)</code></pre><p>Return a tuple representing the separation between adjacent pixels along each axis of the image. Defaults to (1,1,...). Use ImagesAxes for images with anisotropic spacing or to encode the spacing using physical units.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/traits.jl#L52-L59">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.spacedirections" href="#ImageCore.spacedirections"><code>ImageCore.spacedirections</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">spacedirections(img) -&gt; (axis1, axis2, ...)</code></pre><p>Return a tuple-of-tuples, each <code>axis[i]</code> representing the displacement vector between adjacent pixels along spatial axis <code>i</code> of the image array, relative to some external coordinate system (&quot;physical coordinates&quot;).</p><p>By default this is computed from <code>pixelspacing</code>, but you can set this manually using ImagesMeta.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/traits.jl#L73-L83">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.sdims" href="#ImageCore.sdims"><code>ImageCore.sdims</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">sdims(img)</code></pre><p>Return the number of spatial dimensions in the image. Defaults to the same as <code>ndims</code>, but with ImagesAxes you can specify that some axes correspond to other quantities (e.g., time) and thus not included by <code>sdims</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/traits.jl#L100-L107">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.coords_spatial" href="#ImageCore.coords_spatial"><code>ImageCore.coords_spatial</code></a><span class="docstring-category">Function</span></header><section><div><p>coords_spatial(img)</p><p>Return a tuple listing the spatial dimensions of <code>img</code>.</p><p>Note that a better strategy may be to use ImagesAxes and take slices along the time axis.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/traits.jl#L110-L116">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.size_spatial" href="#ImageCore.size_spatial"><code>ImageCore.size_spatial</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">size_spatial(img)</code></pre><p>Return a tuple listing the sizes of the spatial dimensions of the image. Defaults to the same as <code>size</code>, but using ImagesAxes you can mark some axes as being non-spatial.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/traits.jl#L148-L154">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.indices_spatial" href="#ImageCore.indices_spatial"><code>ImageCore.indices_spatial</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">indices_spatial(img)</code></pre><p>Return a tuple with the indices of the spatial dimensions of the image. Defaults to the same as <code>indices</code>, but using ImagesAxes you can mark some axes as being non-spatial.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/traits.jl#L167-L173">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.nimages" href="#ImageCore.nimages"><code>ImageCore.nimages</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">nimages(img)</code></pre><p>Return the number of time-points in the image array. Defaults to</p><ol><li>Use ImagesAxes if you want to use an explicit time dimension.</li></ol></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/traits.jl#L132-L137">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ImageCore.assert_timedim_last" href="#ImageCore.assert_timedim_last"><code>ImageCore.assert_timedim_last</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">assert_timedim_last(img)</code></pre><p>Throw an error if the image has a time dimension that is not the last dimension.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaImages/ImageCore.jl/blob/c1a3025a11beb4eac740168fae8c195d68be7f9c/src/traits.jl#L188-L193">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../traits/">« Traits</a></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Wednesday 6 November 2024 21:48">Wednesday 6 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 comments on commit ce9b446

Please sign in to comment.