-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Dec 20, 2023
1 parent
d2ec87b
commit 998ca7b
Showing
12 changed files
with
1,100 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-12-20T09:08:53","documenter_version":"1.2.1"}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Axioms · SpectralIndices.jl</title><meta name="title" content="Axioms · SpectralIndices.jl"/><meta property="og:title" content="Axioms · SpectralIndices.jl"/><meta property="twitter:title" content="Axioms · SpectralIndices.jl"/><meta name="description" content="Documentation for SpectralIndices.jl."/><meta property="og:description" content="Documentation for SpectralIndices.jl."/><meta property="twitter:description" content="Documentation for SpectralIndices.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/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="../../search_index.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" data-theme-primary-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"><a class="docs-logo" href="../../"><img src="../../assets/logo.png" alt="SpectralIndices.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">SpectralIndices.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">SpectralIndices.jl</a></li><li><span class="tocitem">API Documentation</span><ul><li class="is-active"><a class="tocitem" href>Axioms</a></li><li><a class="tocitem" href="../compute/">Compute</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"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API Documentation</a></li><li class="is-active"><a href>Axioms</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Axioms</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/awesome-spectral-indices/SpectralIndices.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/awesome-spectral-indices/SpectralIndices.jl/blob/main/docs/src/api/axioms.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Axioms"><a class="docs-heading-anchor" href="#Axioms">Axioms</a><a id="Axioms-1"></a><a class="docs-heading-anchor-permalink" href="#Axioms" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpectralIndices.SpectralIndex" href="#SpectralIndices.SpectralIndex"><code>SpectralIndices.SpectralIndex</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">SpectralIndex(index::Dict{String, Any})</code></pre><p>This object allows interaction with specific Spectral Indices in the Awesome Spectral Indices list. Attributes of the Spectral Index can be accessed and the index itself can be computed.</p><p><strong>Arguments</strong></p><ul><li><p><code>index::Dict{String, Any}</code>: A dictionary with the following keys:</p><ul><li><code>"short_name"</code>: Short name of the spectral index.</li><li><code>"long_name"</code>: Long name or description of the spectral index.</li><li><code>"bands"</code>: List of bands or wavelengths used in the index calculation.</li><li><code>"application_domain"</code>: Application domain or use case of the spectral index.</li><li><code>"reference"</code>: Reference or source of the spectral index formula.</li><li><code>"formula"</code>: Mathematical formula of the spectral index.</li><li><code>"date_of_addition"</code>: Date when the spectral index was added (in "yyyy-mm-dd" format).</li><li><code>"contributor"</code>: Contributor or source of the spectral index information.</li><li><code>"platforms"</code>: Platforms or sensors for which the index is applicable.</li></ul></li></ul><p><strong>Returns</strong></p><p>A <code>SpectralIndex</code> object containing the specified index information.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia> indices["NIRv"] | ||
| </code></pre><p>Or, accessing directly the provided Dict of spectral indices:</p><pre><code class="language-julia-repl hljs">NIRv</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/awesome-spectral-indices/SpectralIndices.jl/blob/43943787917d3c5f76a3714c21e73dde2491fac8/src/axioms.jl#L29-L66">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpectralIndices.compute" href="#SpectralIndices.compute"><code>SpectralIndices.compute</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">compute(si::SpectralIndex, params::Dict=Dict(); kwargs...) -> Any</code></pre><p>Computes a Spectral Index based on the provided <code>SpectralIndex</code> instance, parameters, and optional keyword arguments.</p><p><strong>Parameters</strong></p><ul><li><code>si</code>: An instance of <code>SpectralIndex</code> which includes the name and details of the spectral index to be computed.</li><li><code>params</code>: (Optional) Dictionary of parameters used as inputs for the computation. If not provided, parameters can be passed using keyword arguments.</li><li><code>kwargs</code>: Additional parameters used as inputs for the computation, provided as keyword pairs. These are used if <code>params</code> is empty.</li></ul><p><strong>Returns</strong></p><ul><li>The computed Spectral Index, the type of return value depends on the input parameters and the specific spectral index being computed.</li></ul><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia> compute(NDVI; N=0.643, R=0.175) | ||
| </code></pre><pre><code class="language-julia-repl hljs">julia> compute(NDVI; N=fill(0.643, (5, 5)), R=fill(0.175, (5, 5))) | ||
| </code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/awesome-spectral-indices/SpectralIndices.jl/blob/43943787917d3c5f76a3714c21e73dde2491fac8/src/axioms.jl#L112-L143">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpectralIndices.PlatformBand" href="#SpectralIndices.PlatformBand"><code>SpectralIndices.PlatformBand</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">PlatformBand(platform_band::Dict{String, Any})</code></pre><p>This struct provides information about a specific band for a specific sensor or platform.</p><p><strong>Arguments</strong></p><ul><li><p><code>platform_band::Dict{String, Any}</code>: A dictionary with the following keys:</p><ul><li><code>"platform"</code>: Name of the platform or sensor.</li><li><code>"band"</code>: Band number or name for the specific platform.</li><li><code>"name"</code>: Description or name of the band for the specific platform.</li><li><code>"wavelength"</code>: Center wavelength of the band (in nm) for the specific platform.</li><li><code>"bandwidth"</code>: Bandwidth of the band (in nm) for the specific platform.</li></ul></li></ul><p><strong>Returns</strong></p><p>A <code>PlatformBand</code> object containing the specified band information.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">platform_band_dict = Dict( | ||
| "platform" => "Sentinel-2A", | ||
| "band" => "B2", | ||
| "name" => "Blue", | ||
| "wavelength" => 492.4, | ||
| "bandwidth" => 66.0, | ||
| ) | ||
|
|
||
| platform_band = PlatformBand(platform_band_dict)</code></pre><p>Or, accessing directly the provided Dict of platforms:</p><pre><code class="language-julia-repl hljs">julia> bands["B"].platforms["sentinel2a"] | ||
| </code></pre><pre><code class="language-julia-repl hljs">julia> bands["B"].platforms["sentinel2a"].wavelength | ||
| </code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/awesome-spectral-indices/SpectralIndices.jl/blob/43943787917d3c5f76a3714c21e73dde2491fac8/src/axioms.jl#L165-L210">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpectralIndices.Band" href="#SpectralIndices.Band"><code>SpectralIndices.Band</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Band(band::Dict{String, Any})</code></pre><p>Constructs a <code>Band</code> object to interact with specific bands in the list of required bands for Spectral Indices in the Awesome Spectral Indices list.</p><p><strong>Arguments</strong></p><ul><li><p><code>band::Dict{String, Any}</code>: A dictionary containing band information with the following keys:</p><ul><li><code>"short_name"</code>: Short name of the band.</li><li><code>"long_name"</code>: Description or name of the band.</li><li><code>"common_name"</code>: Common name of the band according to the Electro-Optical Extension Specification for STAC.</li><li><code>"min_wavelength"</code>: Minimum wavelength of the spectral range of the band (in nm).</li><li><code>"max_wavelength"</code>: Maximum wavelength of the spectral range of the band (in nm).</li><li><code>"platforms"</code>: A dictionary of platform information associated with this band.</li></ul></li></ul><p><strong>Returns</strong></p><p>A <code>Band</code> object representing the specified band.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia> bands["B"] | ||
| band_dict = Dict{String, Any}( | ||
| "short_name" => "B", | ||
| "long_name" => "Blue", | ||
| "common_name" => "Blue", | ||
| "min_wavelength" => 450.0, | ||
| "max_wavelength" => 495.0, | ||
| "platforms" => Dict{String, Any}( | ||
| "sentinel2a" => PlatformBand(...), # PlatformBand constructor details here | ||
| "sentinel2b" => PlatformBand(...), # PlatformBand constructor details here | ||
| # Add other platforms as needed | ||
| ) | ||
| ) | ||
|
|
||
| band = Band(band_dict)</code></pre><p>Or, using the provided bands</p><pre><code class="language-julia-repl hljs">julia> bands["B"].long_name | ||
| </code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/awesome-spectral-indices/SpectralIndices.jl/blob/43943787917d3c5f76a3714c21e73dde2491fac8/src/axioms.jl#L250-L296">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« SpectralIndices.jl</a><a class="docs-footer-nextpage" href="../compute/">Compute »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Wednesday 20 December 2023 09:08">Wednesday 20 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.