Deploying to gh-pages from @ f6a5741 🚀

nasa-nccs-hpda · Feb 26, 2024 · 7cf91f7 · 7cf91f7
1 parent d27c558
commit 7cf91f7
Show file tree

Hide file tree

Showing 27 changed files with 285 additions and 222 deletions.
diff --git a/latest/.buildinfo b/latest/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: cfbd81c8c4cbbd7793ee945fd0091ebb
+config: 766e59e4d7c4fad973ed90262fdff12e
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/latest/.doctrees/environment.pickle b/latest/.doctrees/environment.pickle
diff --git a/latest/.doctrees/examples.doctree b/latest/.doctrees/examples.doctree
diff --git a/latest/.doctrees/index.doctree b/latest/.doctrees/index.doctree
diff --git a/latest/.doctrees/modules.doctree b/latest/.doctrees/modules.doctree
diff --git a/latest/.doctrees/pytorch_caney.doctree b/latest/.doctrees/pytorch_caney.doctree
diff --git a/latest/.doctrees/readme.doctree b/latest/.doctrees/readme.doctree
diff --git a/latest/.doctrees/source/index.doctree b/latest/.doctrees/source/index.doctree
diff --git a/latest/_modules/index.html b/latest/_modules/index.html
@@ -1,21 +1,22 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="../">
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Overview: module code &mdash; pytorch-caney 0.1.0 documentation</title>
-      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
+
+
   <!--[if lt IE 9]>
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
-        <script src="../_static/jquery.js"></script>
-        <script src="../_static/underscore.js"></script>
-        <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
-        <script src="../_static/doctools.js"></script>
-        <script src="../_static/sphinx_highlight.js"></script>
+        <script src="../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../_static/documentation_options.js?v=01f34227"></script>
+        <script src="../_static/doctools.js?v=888ff710"></script>
+        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />

diff --git a/latest/_modules/pytorch_caney/processing.html b/latest/_modules/pytorch_caney/processing.html
@@ -1,21 +1,22 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="../../">
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>pytorch_caney.processing &mdash; pytorch-caney 0.1.0 documentation</title>
-      <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
+      <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
+
+
   <!--[if lt IE 9]>
     <script src="../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
-        <script src="../../_static/jquery.js"></script>
-        <script src="../../_static/underscore.js"></script>
-        <script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
-        <script src="../../_static/doctools.js"></script>
-        <script src="../../_static/sphinx_highlight.js"></script>
+        <script src="../../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../../_static/documentation_options.js?v=01f34227"></script>
+        <script src="../../_static/doctools.js?v=888ff710"></script>
+        <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script src="../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../genindex.html" />
@@ -108,7 +109,9 @@ <h1>Source code for pytorch_caney.processing</h1><div class="highlight"><pre>
 
 
 <span class="c1"># --------------------------- Normalization Functions ----------------------- #</span>
-<div class="viewcode-block" id="normalize"><a class="viewcode-back" href="../../modules.html#pytorch_caney.processing.normalize">[docs]</a><span class="k">def</span> <span class="nf">normalize</span><span class="p">(</span><span class="n">images</span><span class="p">,</span> <span class="n">factor</span><span class="o">=</span><span class="mf">65535.0</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">:</span>
+<div class="viewcode-block" id="normalize">
+<a class="viewcode-back" href="../../modules.html#pytorch_caney.processing.normalize">[docs]</a>
+<span class="k">def</span> <span class="nf">normalize</span><span class="p">(</span><span class="n">images</span><span class="p">,</span> <span class="n">factor</span><span class="o">=</span><span class="mf">65535.0</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Normalize numpy array in the range of [0,1]</span>
 <span class="sd">    :param images: numpy array in the format (n,w,h,c).</span>
@@ -118,8 +121,11 @@ <h1>Source code for pytorch_caney.processing</h1><div class="highlight"><pre>
     <span class="k">return</span> <span class="n">images</span> <span class="o">/</span> <span class="n">factor</span></div>
 
 
+
 <span class="c1"># ------------------------ Standardization Functions ----------------------- #</span>
-<div class="viewcode-block" id="global_standardization"><a class="viewcode-back" href="../../modules.html#pytorch_caney.processing.global_standardization">[docs]</a><span class="k">def</span> <span class="nf">global_standardization</span><span class="p">(</span><span class="n">images</span><span class="p">,</span> <span class="n">strategy</span><span class="o">=</span><span class="s1">&#39;per-batch&#39;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">:</span>
+<div class="viewcode-block" id="global_standardization">
+<a class="viewcode-back" href="../../modules.html#pytorch_caney.processing.global_standardization">[docs]</a>
+<span class="k">def</span> <span class="nf">global_standardization</span><span class="p">(</span><span class="n">images</span><span class="p">,</span> <span class="n">strategy</span><span class="o">=</span><span class="s1">&#39;per-batch&#39;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Standardize numpy array using global standardization.</span>
 <span class="sd">    :param images: numpy array in the format (n,w,h,c).</span>
@@ -139,7 +145,10 @@ <h1>Source code for pytorch_caney.processing</h1><div class="highlight"><pre>
     <span class="k">return</span> <span class="n">images</span></div>
 
 
-<div class="viewcode-block" id="local_standardization"><a class="viewcode-back" href="../../modules.html#pytorch_caney.processing.local_standardization">[docs]</a><span class="k">def</span> <span class="nf">local_standardization</span><span class="p">(</span><span class="n">images</span><span class="p">,</span> <span class="n">filename</span><span class="o">=</span><span class="s1">&#39;normalization_data&#39;</span><span class="p">,</span>
+
+<div class="viewcode-block" id="local_standardization">
+<a class="viewcode-back" href="../../modules.html#pytorch_caney.processing.local_standardization">[docs]</a>
+<span class="k">def</span> <span class="nf">local_standardization</span><span class="p">(</span><span class="n">images</span><span class="p">,</span> <span class="n">filename</span><span class="o">=</span><span class="s1">&#39;normalization_data&#39;</span><span class="p">,</span>
                           <span class="n">ndata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">strategy</span><span class="o">=</span><span class="s1">&#39;per-batch&#39;</span>
                           <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
@@ -189,7 +198,10 @@ <h1>Source code for pytorch_caney.processing</h1><div class="highlight"><pre>
     <span class="k">return</span> <span class="n">images</span></div>
 
 
-<div class="viewcode-block" id="standardize_image"><a class="viewcode-back" href="../../modules.html#pytorch_caney.processing.standardize_image">[docs]</a><span class="k">def</span> <span class="nf">standardize_image</span><span class="p">(</span>
+
+<div class="viewcode-block" id="standardize_image">
+<a class="viewcode-back" href="../../modules.html#pytorch_caney.processing.standardize_image">[docs]</a>
+<span class="k">def</span> <span class="nf">standardize_image</span><span class="p">(</span>
     <span class="n">image</span><span class="p">,</span>
     <span class="n">standardization_type</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
     <span class="n">mean</span><span class="p">:</span> <span class="nb">list</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
@@ -225,7 +237,10 @@ <h1>Source code for pytorch_caney.processing</h1><div class="highlight"><pre>
     <span class="k">return</span> <span class="n">image</span></div>
 
 
-<div class="viewcode-block" id="standardize_batch"><a class="viewcode-back" href="../../modules.html#pytorch_caney.processing.standardize_batch">[docs]</a><span class="k">def</span> <span class="nf">standardize_batch</span><span class="p">(</span>
+
+<div class="viewcode-block" id="standardize_batch">
+<a class="viewcode-back" href="../../modules.html#pytorch_caney.processing.standardize_batch">[docs]</a>
+<span class="k">def</span> <span class="nf">standardize_batch</span><span class="p">(</span>
     <span class="n">image_batch</span><span class="p">,</span>
     <span class="n">standardization_type</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
     <span class="n">mean</span><span class="p">:</span> <span class="nb">list</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
@@ -240,10 +255,13 @@ <h1>Source code for pytorch_caney.processing</h1><div class="highlight"><pre>
             <span class="n">image_batch</span><span class="p">[</span><span class="n">item</span><span class="p">,</span> <span class="p">:,</span> <span class="p">:,</span> <span class="p">:],</span> <span class="n">standardization_type</span><span class="p">,</span> <span class="n">mean</span><span class="p">,</span> <span class="n">std</span><span class="p">)</span>
     <span class="k">return</span> <span class="n">image_batch</span></div>
 
+
 <span class="c1"># ------------------------ Data Preparation Functions ----------------------- #</span>
 
 
-<div class="viewcode-block" id="get_rand_patches_rand_cond"><a class="viewcode-back" href="../../modules.html#pytorch_caney.processing.get_rand_patches_rand_cond">[docs]</a><span class="k">def</span> <span class="nf">get_rand_patches_rand_cond</span><span class="p">(</span><span class="n">img</span><span class="p">,</span> <span class="n">mask</span><span class="p">,</span> <span class="n">n_patches</span><span class="o">=</span><span class="mi">16000</span><span class="p">,</span> <span class="n">sz</span><span class="o">=</span><span class="mi">160</span><span class="p">,</span> <span class="n">nclasses</span><span class="o">=</span><span class="mi">6</span><span class="p">,</span>
+<div class="viewcode-block" id="get_rand_patches_rand_cond">
+<a class="viewcode-back" href="../../modules.html#pytorch_caney.processing.get_rand_patches_rand_cond">[docs]</a>
+<span class="k">def</span> <span class="nf">get_rand_patches_rand_cond</span><span class="p">(</span><span class="n">img</span><span class="p">,</span> <span class="n">mask</span><span class="p">,</span> <span class="n">n_patches</span><span class="o">=</span><span class="mi">16000</span><span class="p">,</span> <span class="n">sz</span><span class="o">=</span><span class="mi">160</span><span class="p">,</span> <span class="n">nclasses</span><span class="o">=</span><span class="mi">6</span><span class="p">,</span>
                                <span class="n">nodata_ascloud</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s1">&#39;rand&#39;</span>
                                <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
@@ -321,7 +339,10 @@ <h1>Source code for pytorch_caney.processing</h1><div class="highlight"><pre>
     <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">patches</span><span class="p">),</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">labels</span><span class="p">)</span></div>
 
 
-<div class="viewcode-block" id="get_rand_patches_aug_augcond"><a class="viewcode-back" href="../../modules.html#pytorch_caney.processing.get_rand_patches_aug_augcond">[docs]</a><span class="k">def</span> <span class="nf">get_rand_patches_aug_augcond</span><span class="p">(</span><span class="n">img</span><span class="p">,</span> <span class="n">mask</span><span class="p">,</span> <span class="n">n_patches</span><span class="o">=</span><span class="mi">16000</span><span class="p">,</span> <span class="n">sz</span><span class="o">=</span><span class="mi">256</span><span class="p">,</span>
+
+<div class="viewcode-block" id="get_rand_patches_aug_augcond">
+<a class="viewcode-back" href="../../modules.html#pytorch_caney.processing.get_rand_patches_aug_augcond">[docs]</a>
+<span class="k">def</span> <span class="nf">get_rand_patches_aug_augcond</span><span class="p">(</span><span class="n">img</span><span class="p">,</span> <span class="n">mask</span><span class="p">,</span> <span class="n">n_patches</span><span class="o">=</span><span class="mi">16000</span><span class="p">,</span> <span class="n">sz</span><span class="o">=</span><span class="mi">256</span><span class="p">,</span>
                                  <span class="n">nclasses</span><span class="o">=</span><span class="mi">6</span><span class="p">,</span> <span class="n">over</span><span class="o">=</span><span class="mi">50</span><span class="p">,</span> <span class="n">nodata_ascloud</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
                                  <span class="n">nodata</span><span class="o">=-</span><span class="mi">9999</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s1">&#39;augcond&#39;</span>
                                  <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">:</span>
@@ -421,6 +442,7 @@ <h1>Source code for pytorch_caney.processing</h1><div class="highlight"><pre>
     <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">patches</span><span class="p">),</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">labels</span><span class="p">)</span></div>
 
 
+
 <span class="c1"># ------------------------ Artifact Removal Functions ----------------------- #</span>
 
 <span class="k">def</span> <span class="nf">_2d_spline</span><span class="p">(</span><span class="n">window_size</span><span class="o">=</span><span class="mi">128</span><span class="p">,</span> <span class="n">power</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">:</span>

diff --git a/latest/_static/_sphinx_javascript_frameworks_compat.js b/latest/_static/_sphinx_javascript_frameworks_compat.js
@@ -1,20 +1,9 @@
-/*
- * _sphinx_javascript_frameworks_compat.js
- * ~~~~~~~~~~
- *
- * Compatability shim for jQuery and underscores.js.
- *
- * WILL BE REMOVED IN Sphinx 6.0
- * xref RemovedInSphinx60Warning
+/* Compatability shim for jQuery and underscores.js.
  *
+ * Copyright Sphinx contributors
+ * Released under the two clause BSD licence
  */
 
-/**
- * select a different prefix for underscore
- */
-$u = _.noConflict();
-
-
 /**
  * small helper function to urldecode strings
  *

diff --git a/latest/_static/basic.css b/latest/_static/basic.css
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -237,6 +237,10 @@ a.headerlink {
     visibility: hidden;
 }
 
+a:visited {
+    color: #551A8B;
+}
+
 h1:hover > a.headerlink,
 h2:hover > a.headerlink,
 h3:hover > a.headerlink,
@@ -324,13 +328,15 @@ aside.sidebar {
 p.sidebar-title {
     font-weight: bold;
 }
+
 nav.contents,
 aside.topic,
 div.admonition, div.topic, blockquote {
     clear: left;
 }
 
 /* -- topics ---------------------------------------------------------------- */
+
 nav.contents,
 aside.topic,
 div.topic {
@@ -606,6 +612,7 @@ ol.simple p,
 ul.simple p {
     margin-bottom: 0;
 }
+
 aside.footnote > span,
 div.citation > span {
     float: left;
@@ -667,6 +674,16 @@ dd {
     margin-left: 30px;
 }
 
+.sig dd {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+.sig dl {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
     margin-bottom: 0;
@@ -735,6 +752,14 @@ abbr, acronym {
     cursor: help;
 }
 
+.translated {
+    background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+    background-color: rgba(255, 207, 207, 0.2)
+}
+
 /* -- code displays --------------------------------------------------------- */
 
 pre {

diff --git a/latest/_static/doctools.js b/latest/_static/doctools.js
@@ -4,7 +4,7 @@
  *
  * Base JavaScript utilities for all Sphinx HTML documentation.
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/latest/_static/documentation_options.js b/latest/_static/documentation_options.js
@@ -1,5 +1,4 @@
-var DOCUMENTATION_OPTIONS = {
-    URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
+const DOCUMENTATION_OPTIONS = {
     VERSION: '0.1.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,

diff --git a/latest/_static/language_data.js b/latest/_static/language_data.js
@@ -5,7 +5,7 @@
  * This script contains the language-specific data used by searchtools.js,
  * namely the list of stopwords, stemmer, scorer and splitter.
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */