-
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
Feb 6, 2024
1 parent
a02d5d7
commit b4e7d9f
Showing
10 changed files
with
296 additions
and
15 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 |
|---|---|---|
| @@ -1 +1 @@ | ||
| {"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-02-04T16:09:30","documenter_version":"1.2.1"}} | ||
| {"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-02-06T21:03:24","documenter_version":"1.2.1"}} |
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
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,9 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Datasets · SpectralIndices.jl</title><meta name="title" content="Datasets · SpectralIndices.jl"/><meta property="og:title" content="Datasets · SpectralIndices.jl"/><meta property="twitter:title" content="Datasets · 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">Tutorials</span><ul><li><a class="tocitem" href="../../tutorials/basic_types/">Basics</a></li><li><a class="tocitem" href="../../tutorials/dataframes/">DataFrames.jl</a></li><li><a class="tocitem" href="../../tutorials/yaxarrays/">YAXArrays.jl</a></li></ul></li><li><span class="tocitem">API Documentation</span><ul><li><a class="tocitem" href="../axioms/">Axioms</a></li><li><a class="tocitem" href="../compute/">Compute</a></li><li class="is-active"><a class="tocitem" href>Datasets</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>Datasets</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Datasets</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/datasets.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="Datasets"><a class="docs-heading-anchor" href="#Datasets">Datasets</a><a id="Datasets-1"></a><a class="docs-heading-anchor-permalink" href="#Datasets" 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.get_datasets" href="#SpectralIndices.get_datasets"><code>SpectralIndices.get_datasets</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">get_datasets(; datasets=["S2_10m.json", "spectral.json"], data_loc=joinpath(dirname(@__FILE__), "..", "data"))</code></pre><p>Download predefined datasets from a specified remote location and save them to a local directory.</p><p><strong>Keyword Arguments</strong></p><ul><li><code>datasets::Array{String,1}</code>: A list of dataset filenames to download. Defaults to <code>["S2_10m.json", "spectral.json"]</code>.</li><li><code>data_loc::String</code>: The local directory path where the downloaded datasets will be saved. Defaults to a <code>data</code> directory located one level up from the script's directory.</li></ul><p><strong>Description</strong></p><p>This function iterates over a list of dataset filenames, downloads each dataset from a predefined remote URL, and saves them into a specified local directory. The remote URL is currently hardcoded to download specifically the "S2_10m.json" file for any given dataset in the list. Adjust the function or its usage accordingly if different URLs are needed for different datasets.</p><p><strong>Example</strong></p><pre><code class="language-julia hljs">get_datasets() # Downloads the default datasets to the default location | ||
|
|
||
| get_datasets(; datasets=["custom_dataset.json"], data_loc="path/to/custom/directory")</code></pre><p>This is particularly useful for setting up local environments with necessary data files for further processing or analysis.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/awesome-spectral-indices/SpectralIndices.jl/blob/464af2c34a0666c88ebf2a64a2ae27edf090a783/src/datasets.jl#L1-L24">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.load_dataset" href="#SpectralIndices.load_dataset"><code>SpectralIndices.load_dataset</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">load_dataset(dataset::String) -> YAXArray | ||
| load_dataset(dataset::String) -> DataFrame</code></pre><p>Load a specified dataset and convert it into either a YAXArray or a DataFrame, depending on the loaded packages.</p><p><strong>Arguments</strong></p><ul><li><code>dataset::String</code>: The name of the dataset to load. Currently supports <code>"sentinel"</code> and <code>"spectral"</code>.</li></ul><p><strong>Returns</strong></p><ul><li>If YAXArrays is loaded in the namespace, returns a <code>YAXArray</code> object containing the loaded dataset, with dimensions labeled as <code>:x</code>, <code>:y</code>, and <code>:bands</code>. The spatial dimensions (<code>:x</code> and <code>:y</code>) are assumed to have a size of 300 each, and the <code>:bands</code> dimension includes ["B02", "B03", "B04", "B08"] bands.</li><li>If DataFrames is loaded in the namespace, returns a <code>DataFrame</code> with the dataset loaded into it.</li></ul><p><strong>Errors</strong></p><p>Throws an error if the <code>dataset</code> argument does not match one of the predefined dataset names.</p><p><strong>Example</strong></p><pre><code class="language-julia hljs"># Load dataset as YAXArray | ||
| yax_ds = SpectralIndices.load_dataset("sentinel") | ||
|
|
||
| # Load dataset as DataFrame | ||
| df_ds = SpectralIndices.load_dataset("spectral")</code></pre><p>The current implementation expects the JSON files ("S2_10m.json" for "sentinel" and "spectral.json" for "spectral") to follow a specific format: a vector of vectors where each inner vector represents a band's data in a 300x300 spatial grid for the YAXArray version, or a suitable structure that can be directly converted into a DataFrame for the DataFrame version. The files are already provided for examples in the package in the folder <code>data</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/awesome-spectral-indices/SpectralIndices.jl/blob/464af2c34a0666c88ebf2a64a2ae27edf090a783/src/datasets.jl#L43-L74">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" 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="Tuesday 6 February 2024 21:03">Tuesday 6 February 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.