diff --git a/.buildinfo b/.buildinfo
index 526d9b2..a8b4dd0 100644
--- a/.buildinfo
+++ b/.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: 0288daac08b7cafd3dea53708decbe45
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: b3816660cf59003314b2c6dd096ba710
tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_sources/autoapi/simpunch/level0/index.rst.txt b/_sources/autoapi/simpunch/level0/index.rst.txt
index 8e8fce9..c87988b 100644
--- a/_sources/autoapi/simpunch/level0/index.rst.txt
+++ b/_sources/autoapi/simpunch/level0/index.rst.txt
@@ -25,6 +25,7 @@ Functions
simpunch.level0.uncorrect_psf
simpunch.level0.starfield_misalignment
simpunch.level0.generate_l0_pmzp
+ simpunch.level0.generate_l0_cr
simpunch.level0.generate_l0_all
@@ -56,6 +57,11 @@ Module Contents
Generates level 0 polarized synthetic data
+.. py:function:: generate_l0_cr(input_file, path_output, psf_model, wfi_vignetting_model_path, nfi_vignetting_model_path)
+
+ Generates level 0 polarized synthetic data
+
+
.. py:function:: generate_l0_all(datadir, psf_model_path, wfi_vignetting_model_path, nfi_vignetting_model_path)
Generate all level 0 synthetic data
diff --git a/_sources/autoapi/simpunch/level1/index.rst.txt b/_sources/autoapi/simpunch/level1/index.rst.txt
index bf737ee..f46d162 100644
--- a/_sources/autoapi/simpunch/level1/index.rst.txt
+++ b/_sources/autoapi/simpunch/level1/index.rst.txt
@@ -25,10 +25,12 @@ Functions
simpunch.level1.calculate_pc_matrix
simpunch.level1.generate_spacecraft_wcs
simpunch.level1.deproject
+ simpunch.level1.deproject_clear
simpunch.level1.mark_quality
simpunch.level1.remix_polarization
simpunch.level1.add_distortion
simpunch.level1.generate_l1_pmzp
+ simpunch.level1.generate_l1_cr
simpunch.level1.generate_l1_all
@@ -57,6 +59,11 @@ Module Contents
Data deprojection
+.. py:function:: deproject_clear(input_data, output_wcs, adaptive_reprojection=False)
+
+ Data deprojection
+
+
.. py:function:: mark_quality(input_data)
Data quality marking
@@ -74,6 +81,11 @@ Module Contents
Generates level 1 polarized synthetic data
+.. py:function:: generate_l1_cr(input_file, path_output, rotation_stage, spacecraft_id)
+
+ Generates level 1 clear synthetic data
+
+
.. py:function:: generate_l1_all(datadir)
Generate all level 1 synthetic data
diff --git a/_sources/autoapi/simpunch/level2/index.rst.txt b/_sources/autoapi/simpunch/level2/index.rst.txt
index 560691d..6e59476 100644
--- a/_sources/autoapi/simpunch/level2/index.rst.txt
+++ b/_sources/autoapi/simpunch/level2/index.rst.txt
@@ -27,8 +27,10 @@ Functions
simpunch.level2.add_fcorona
simpunch.level2.gen_starfield
simpunch.level2.add_starfield
+ simpunch.level2.add_starfield_clear
simpunch.level2.remix_polarization
simpunch.level2.generate_l2_ptm
+ simpunch.level2.generate_l2_ctm
simpunch.level2.generate_l2_all
@@ -51,6 +53,11 @@ Module Contents
Adds synthetic starfield
+.. py:function:: add_starfield_clear(input_data)
+
+ Adds synthetic starfield
+
+
.. py:function:: remix_polarization(input_data)
Remix polarization from (B, pB) to (M,Z,P) using solpolpy
@@ -61,6 +68,11 @@ Module Contents
Generates level 2 PTM synthetic data
+.. py:function:: generate_l2_ctm(input_file, path_output)
+
+ Generates level 2 CTM synthetic data
+
+
.. py:function:: generate_l2_all(datadir)
Generate all level 2 synthetic data
diff --git a/_sources/autoapi/simpunch/level3/index.rst.txt b/_sources/autoapi/simpunch/level3/index.rst.txt
index 1b591c5..6de67f7 100644
--- a/_sources/autoapi/simpunch/level3/index.rst.txt
+++ b/_sources/autoapi/simpunch/level3/index.rst.txt
@@ -25,7 +25,9 @@ Functions
simpunch.level3.define_trefoil_mask
simpunch.level3.generate_uncertainty
simpunch.level3.assemble_punchdata
+ simpunch.level3.assemble_punchdata_clear
simpunch.level3.generate_l3_ptm
+ simpunch.level3.generate_l3_ctm
simpunch.level3.generate_l3_pnn
simpunch.level3.generate_l3_pam
simpunch.level3.generate_l3_pan
@@ -58,11 +60,21 @@ Module Contents
Assemble a punchdata object with correct metadata
+.. py:function:: assemble_punchdata_clear(input_tb, wcs, product_code, product_level, mask=None)
+
+ Assemble a punchdata object with correct metadata for a clear data product
+
+
.. py:function:: generate_l3_ptm(input_tb, input_pb, path_output, time_obs, time_delta, rotation_stage)
Generate PTM - PUNCH Level-3 Polarized Mosaic
+.. py:function:: generate_l3_ctm(input_tb, path_output, time_obs, time_delta, rotation_stage)
+
+ Generate CTM - PUNCH Level-3 Clear Mosaic
+
+
.. py:function:: generate_l3_pnn(input_tb, input_pb, path_output, time_obs, time_delta)
Generate PNN - PUNCH Level-3 Polarized NFI Image
diff --git a/_static/basic.css b/_static/basic.css
index 2af6139..2a9e411 100644
--- a/_static/basic.css
+++ b/_static/basic.css
@@ -1,12 +1,5 @@
/*
- * basic.css
- * ~~~~~~~~~
- *
* Sphinx stylesheet -- basic theme.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
*/
/* -- main layout ----------------------------------------------------------- */
@@ -115,15 +108,11 @@ img {
/* -- search page ----------------------------------------------------------- */
ul.search {
- margin: 10px 0 0 20px;
- padding: 0;
+ margin-top: 10px;
}
ul.search li {
- padding: 5px 0 5px 20px;
- background-image: url(file.png);
- background-repeat: no-repeat;
- background-position: 0 7px;
+ padding: 5px 0;
}
ul.search li a {
diff --git a/_static/doctools.js b/_static/doctools.js
index 4d67807..0398ebb 100644
--- a/_static/doctools.js
+++ b/_static/doctools.js
@@ -1,12 +1,5 @@
/*
- * doctools.js
- * ~~~~~~~~~~~
- *
* Base JavaScript utilities for all Sphinx HTML documentation.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
*/
"use strict";
diff --git a/_static/graphviz.css b/_static/graphviz.css
index 027576e..30f3837 100644
--- a/_static/graphviz.css
+++ b/_static/graphviz.css
@@ -1,12 +1,5 @@
/*
- * graphviz.css
- * ~~~~~~~~~~~~
- *
* Sphinx stylesheet -- graphviz extension.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
*/
img.graphviz {
diff --git a/_static/language_data.js b/_static/language_data.js
index 367b8ed..c7fe6c6 100644
--- a/_static/language_data.js
+++ b/_static/language_data.js
@@ -1,13 +1,6 @@
/*
- * language_data.js
- * ~~~~~~~~~~~~~~~~
- *
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
*/
var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
diff --git a/_static/searchtools.js b/_static/searchtools.js
index b08d58c..2c774d1 100644
--- a/_static/searchtools.js
+++ b/_static/searchtools.js
@@ -1,12 +1,5 @@
/*
- * searchtools.js
- * ~~~~~~~~~~~~~~~~
- *
* Sphinx JavaScript utilities for the full-text search.
- *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
*/
"use strict";
@@ -20,7 +13,7 @@ if (typeof Scorer === "undefined") {
// and returns the new score.
/*
score: result => {
- const [docname, title, anchor, descr, score, filename] = result
+ const [docname, title, anchor, descr, score, filename, kind] = result
return score
},
*/
@@ -47,6 +40,14 @@ if (typeof Scorer === "undefined") {
};
}
+// Global search result kind enum, used by themes to style search results.
+class SearchResultKind {
+ static get index() { return "index"; }
+ static get object() { return "object"; }
+ static get text() { return "text"; }
+ static get title() { return "title"; }
+}
+
const _removeChildren = (element) => {
while (element && element.lastChild) element.removeChild(element.lastChild);
};
@@ -64,9 +65,13 @@ const _displayItem = (item, searchTerms, highlightTerms) => {
const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
const contentRoot = document.documentElement.dataset.content_root;
- const [docName, title, anchor, descr, score, _filename] = item;
+ const [docName, title, anchor, descr, score, _filename, kind] = item;
let listItem = document.createElement("li");
+ // Add a class representing the item's type:
+ // can be used by a theme's CSS selector for styling
+ // See SearchResultKind for the class names.
+ listItem.classList.add(`kind-${kind}`);
let requestUrl;
let linkUrl;
if (docBuilder === "dirhtml") {
@@ -115,8 +120,10 @@ const _finishSearch = (resultCount) => {
"Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
);
else
- Search.status.innerText = _(
- "Search finished, found ${resultCount} page(s) matching the search query."
+ Search.status.innerText = Documentation.ngettext(
+ "Search finished, found one page matching the search query.",
+ "Search finished, found ${resultCount} pages matching the search query.",
+ resultCount,
).replace('${resultCount}', resultCount);
};
const _displayNextItem = (
@@ -138,7 +145,7 @@ const _displayNextItem = (
else _finishSearch(resultCount);
};
// Helper function used by query() to order search results.
-// Each input is an array of [docname, title, anchor, descr, score, filename].
+// Each input is an array of [docname, title, anchor, descr, score, filename, kind].
// Order the results by score (in opposite order of appearance, since the
// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically.
const _orderResultsByScoreThenName = (a, b) => {
@@ -248,6 +255,7 @@ const Search = {
searchSummary.classList.add("search-summary");
searchSummary.innerText = "";
const searchList = document.createElement("ul");
+ searchList.setAttribute("role", "list");
searchList.classList.add("search");
const out = document.getElementById("search-results");
@@ -318,7 +326,7 @@ const Search = {
const indexEntries = Search._index.indexentries;
// Collect multiple result groups to be sorted separately and then ordered.
- // Each is an array of [docname, title, anchor, descr, score, filename].
+ // Each is an array of [docname, title, anchor, descr, score, filename, kind].
const normalResults = [];
const nonMainIndexResults = [];
@@ -337,6 +345,7 @@ const Search = {
null,
score + boost,
filenames[file],
+ SearchResultKind.title,
]);
}
}
@@ -354,6 +363,7 @@ const Search = {
null,
score,
filenames[file],
+ SearchResultKind.index,
];
if (isMain) {
normalResults.push(result);
@@ -475,6 +485,7 @@ const Search = {
descr,
score,
filenames[match[0]],
+ SearchResultKind.object,
]);
};
Object.keys(objects).forEach((prefix) =>
@@ -585,6 +596,7 @@ const Search = {
null,
score,
filenames[file],
+ SearchResultKind.text,
]);
}
return results;
diff --git a/autoapi/index.html b/autoapi/index.html
index cd7871b..1ed381c 100644
--- a/autoapi/index.html
+++ b/autoapi/index.html
@@ -29,7 +29,7 @@
-
+
@@ -37,7 +37,7 @@
-
+
@@ -490,7 +490,7 @@ API Reference