-
Notifications
You must be signed in to change notification settings - Fork 3
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
Jan 9, 2024
1 parent
1f5f8cd
commit decb28e
Showing
20 changed files
with
2,858 additions
and
2,833 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-01-09T14:32:02","documenter_version":"1.2.1"}} | ||
| {"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-01-09T14:46:38","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.
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 |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>What is a GeoRegion? · GeoRegions.jl</title><meta name="title" content="What is a GeoRegion? · GeoRegions.jl"/><meta property="og:title" content="What is a GeoRegion? · GeoRegions.jl"/><meta property="twitter:title" content="What is a GeoRegion? · GeoRegions.jl"/><meta name="description" content="Documentation for GeoRegions.jl."/><meta property="og:description" content="Documentation for GeoRegions.jl."/><meta property="twitter:description" content="Documentation for GeoRegions.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="../index.html"><img src="../assets/logo.png" alt="GeoRegions.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../index.html">GeoRegions.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="../index.html">Home</a></li><li><input class="collapse-toggle" id="menuitem-2" type="checkbox" checked/><label class="tocitem" for="menuitem-2"><span class="docs-label">What is a GeoRegion: An Overview</span><i class="docs-chevron"></i></label><ul class="collapsed"><li class="is-active"><a class="tocitem" href="intro.html">What is a GeoRegion?</a></li><li><a class="tocitem" href="create.html">Creating GeoRegions</a></li><li><a class="tocitem" href="predefined.html">Predefined GeoRegions</a></li><li><a class="tocitem" href="read.html">Retrieving GeoRegions</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-3" type="checkbox"/><label class="tocitem" for="menuitem-3"><span class="docs-label">What is a RegionGrid: An Overview</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../regiongrids/intro.html">What is a RegionGrid?</a></li><li><a class="tocitem" href="../regiongrids/create.html">Creating RegionGrids</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-4" type="checkbox"/><label class="tocitem" for="menuitem-4"><span class="docs-label">Using GeoRegions.jl: A Tutorial</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../using/isin.html">Is it in a GeoRegion?</a></li><li><a class="tocitem" href="../using/custom.html">Custom GeoRegions</a></li><li><a class="tocitem" href="../using/extract.html">Data Extraction via RegionGrids</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-5" type="checkbox"/><label class="tocitem" for="menuitem-5"><span class="docs-label">LandSea Datasets: ETOPO 2022</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../landsea/intro.html">What is a LandSea Dataset?</a></li><li><a class="tocitem" href="../landsea/create.html">Loading LandSea Datasets</a></li><li><a class="tocitem" href="../landsea/smooth.html">Smoothing LandSea Masks</a></li></ul></li><li><a class="tocitem" href="../example/placeholder.html">Examples</a></li><li><input class="collapse-toggle" id="menuitem-7" type="checkbox"/><label class="tocitem" for="menuitem-7"><span class="docs-label">Lists of GeoRegions</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../lists/api.html">API</a></li><li><a class="tocitem" href="../lists/default.html">Default</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">What is a GeoRegion: An Overview</a></li><li class="is-active"><a href="intro.html">What is a GeoRegion?</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="intro.html">What is a GeoRegion?</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaClimate/GeoRegions.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/JuliaClimate/GeoRegions.jl/blob/main/docs/src/georegions/intro.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="What-is-a-GeoRegion?"><a class="docs-heading-anchor" href="#What-is-a-GeoRegion?">What is a GeoRegion?</a><a id="What-is-a-GeoRegion?-1"></a><a class="docs-heading-anchor-permalink" href="#What-is-a-GeoRegion?" title="Permalink"></a></h1><p>Simply put, a GeoRegion is a geographic region. In v1 of GeoRegions.jl, a GeoRegion could only be rectilinear in shape. However, as of GeoRegions.jl v2, we use Julia <code>types</code> to differentiate between rectilinear GeoRegions, and GeoRegions of arbitrary polygonal shape:</p><ul><li>Rectilinear GeoRegions are denoted by the <code>RectRegion</code> type</li><li>Polygonal GeoRegions are denoted by the <code>PolyRegion</code> type</li></ul><p>The main difference between a <code>PolyRegion</code> and a <code>RectRegion</code>, is that a <code>PolyRegion</code> also contains a <code>mask</code> field which allows us to extract a data field of a polygonal shape from the rectilinear bounds that are the natural result of a rectilinear grid.</p><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="GeoRegions.GeoRegion" href="#GeoRegions.GeoRegion"><code>GeoRegions.GeoRegion</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">GeoRegion</code></pre><p>Abstract supertype for geographical regions, with the following subtypes:</p><pre><code class="nohighlight hljs">RectRegion{ST<:AbstractString, FT<:Real} <: GeoRegion | ||
| PolyRegion{ST<:AbstractString, FT<:Real} <: GeoRegion</code></pre><p>Both <code>RectRegion</code> and <code>PolyRegion</code> types contain the following fields:</p><ul><li><code>ID</code> - A <code>String</code> Type, the identifier for the GeoRegion</li><li><code>pID</code> - A <code>String</code> Type, the identifier for the parent GeoRegion</li><li><code>name</code> - A <code>String</code> Type, the full name of the GeoRegion</li><li><code>N</code> - A <code>Float</code> Type, the north boundary of the GeoRegion</li><li><code>S</code> - A <code>Float</code> Type, the south boundary of the GeoRegion</li><li><code>E</code> - A <code>Float</code> Type, the east boundary of the GeoRegion</li><li><code>W</code> - A <code>Float</code> Type, the est boundary of the GeoRegion</li><li><code>is180</code> - A <code>Bool</code> Type, is <code>W</code> < 0</li><li><code>is360</code> - A <code>Bool</code> Type, is <code>E</code> > 180</li></ul><p>A <code>PolyRegion</code> type will also contain the following field:</p><ul><li><code>shape</code> - A vector of <code>Point2</code> Types, defining a non-rectilinear shape of the GeoRegion</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaClimate/GeoRegions.jl/blob/7b47a0ae0573b2ee9d701068d5b1d6b967705be8/src/GeoRegions.jl#L32-L53">source</a></section></article><p>In essence, a <code>GeoRegion</code> is:</p><ul><li>a geographical region that can be either rectilinear region, or a polygonal shape within a specified rectilinear bound.</li><li>identified by an <code>ID</code></li><li>itself a subregion of a <strong>parent</strong> <code>GeoRegion</code> (identified by <code>pID</code>, which must itself be a valid <code>ID</code>)</li></ul><div class="admonition is-success"><header class="admonition-header">Default GeoRegions</header><div class="admonition-body"><p>When using <code>GeoRegions.jl</code>, the default <code>GeoRegion</code> should generally be the global domain, specified by <code>GLB</code> and given by the <code>[N,S,E,W]</code> coordinates <code>[90,-90,360,0]</code>. The Global GeoRegion <code>GLB</code> is considered to be a subset of itself.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../index.html">« Home</a><a class="docs-footer-nextpage" href="create.html">Creating GeoRegions »</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 9 January 2024 14:31">Tuesday 9 January 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> | ||
| PolyRegion{ST<:AbstractString, FT<:Real} <: GeoRegion</code></pre><p>Both <code>RectRegion</code> and <code>PolyRegion</code> types contain the following fields:</p><ul><li><code>ID</code> - A <code>String</code> Type, the identifier for the GeoRegion</li><li><code>pID</code> - A <code>String</code> Type, the identifier for the parent GeoRegion</li><li><code>name</code> - A <code>String</code> Type, the full name of the GeoRegion</li><li><code>N</code> - A <code>Float</code> Type, the north boundary of the GeoRegion</li><li><code>S</code> - A <code>Float</code> Type, the south boundary of the GeoRegion</li><li><code>E</code> - A <code>Float</code> Type, the east boundary of the GeoRegion</li><li><code>W</code> - A <code>Float</code> Type, the est boundary of the GeoRegion</li><li><code>is180</code> - A <code>Bool</code> Type, is <code>W</code> < 0</li><li><code>is360</code> - A <code>Bool</code> Type, is <code>E</code> > 180</li></ul><p>A <code>PolyRegion</code> type will also contain the following field:</p><ul><li><code>shape</code> - A vector of <code>Point2</code> Types, defining a non-rectilinear shape of the GeoRegion</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaClimate/GeoRegions.jl/blob/6ea80ad958ab53ba6813d380d0e387d4f6c11e9b/src/GeoRegions.jl#L32-L53">source</a></section></article><p>In essence, a <code>GeoRegion</code> is:</p><ul><li>a geographical region that can be either rectilinear region, or a polygonal shape within a specified rectilinear bound.</li><li>identified by an <code>ID</code></li><li>itself a subregion of a <strong>parent</strong> <code>GeoRegion</code> (identified by <code>pID</code>, which must itself be a valid <code>ID</code>)</li></ul><div class="admonition is-success"><header class="admonition-header">Default GeoRegions</header><div class="admonition-body"><p>When using <code>GeoRegions.jl</code>, the default <code>GeoRegion</code> should generally be the global domain, specified by <code>GLB</code> and given by the <code>[N,S,E,W]</code> coordinates <code>[90,-90,360,0]</code>. The Global GeoRegion <code>GLB</code> is considered to be a subset of itself.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../index.html">« Home</a><a class="docs-footer-nextpage" href="create.html">Creating GeoRegions »</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 9 January 2024 14:46">Tuesday 9 January 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.