From daf5e27db8331709c936af6fe84f51fce90f11a4 Mon Sep 17 00:00:00 2001 From: <> Date: Fri, 19 Jul 2024 09:50:21 +0000 Subject: [PATCH] Deployed 1b1214f with MkDocs version: 1.6.0 --- .nojekyll | 0 404.html | 641 ++ CNAME | 1 + assets/images/favicon.png | Bin 0 -> 1870 bytes assets/javascripts/bundle.fe8b6f2b.min.js | 29 + assets/javascripts/bundle.fe8b6f2b.min.js.map | 7 + assets/javascripts/lunr/min/lunr.ar.min.js | 1 + assets/javascripts/lunr/min/lunr.da.min.js | 18 + assets/javascripts/lunr/min/lunr.de.min.js | 18 + assets/javascripts/lunr/min/lunr.du.min.js | 18 + assets/javascripts/lunr/min/lunr.el.min.js | 1 + assets/javascripts/lunr/min/lunr.es.min.js | 18 + assets/javascripts/lunr/min/lunr.fi.min.js | 18 + assets/javascripts/lunr/min/lunr.fr.min.js | 18 + assets/javascripts/lunr/min/lunr.he.min.js | 1 + assets/javascripts/lunr/min/lunr.hi.min.js | 1 + assets/javascripts/lunr/min/lunr.hu.min.js | 18 + assets/javascripts/lunr/min/lunr.hy.min.js | 1 + assets/javascripts/lunr/min/lunr.it.min.js | 18 + assets/javascripts/lunr/min/lunr.ja.min.js | 1 + assets/javascripts/lunr/min/lunr.jp.min.js | 1 + assets/javascripts/lunr/min/lunr.kn.min.js | 1 + assets/javascripts/lunr/min/lunr.ko.min.js | 1 + assets/javascripts/lunr/min/lunr.multi.min.js | 1 + assets/javascripts/lunr/min/lunr.nl.min.js | 18 + assets/javascripts/lunr/min/lunr.no.min.js | 18 + assets/javascripts/lunr/min/lunr.pt.min.js | 18 + assets/javascripts/lunr/min/lunr.ro.min.js | 18 + assets/javascripts/lunr/min/lunr.ru.min.js | 18 + assets/javascripts/lunr/min/lunr.sa.min.js | 1 + .../lunr/min/lunr.stemmer.support.min.js | 1 + assets/javascripts/lunr/min/lunr.sv.min.js | 18 + assets/javascripts/lunr/min/lunr.ta.min.js | 1 + assets/javascripts/lunr/min/lunr.te.min.js | 1 + assets/javascripts/lunr/min/lunr.th.min.js | 1 + assets/javascripts/lunr/min/lunr.tr.min.js | 18 + assets/javascripts/lunr/min/lunr.vi.min.js | 1 + assets/javascripts/lunr/min/lunr.zh.min.js | 1 + assets/javascripts/lunr/tinyseg.js | 206 + assets/javascripts/lunr/wordcut.js | 6708 +++++++++++++++++ .../workers/search.b8dbb3d2.min.js | 42 + .../workers/search.b8dbb3d2.min.js.map | 7 + assets/stylesheets/home.css | 389 + assets/stylesheets/main.76a95c52.min.css | 1 + assets/stylesheets/main.76a95c52.min.css.map | 1 + assets/stylesheets/palette.06af60db.min.css | 1 + .../stylesheets/palette.06af60db.min.css.map | 1 + contributing/index.html | 809 ++ customization/index.html | 892 +++ deployment/index.html | 932 +++ img/NASA_SunEarth.jpg | Bin 0 -> 375710 bytes img/aws_logo.svg | 38 + img/devseed_logo.svg | 17 + img/downloaddeploy.png | Bin 0 -> 56199 bytes img/earth.jpg | Bin 0 -> 511634 bytes img/eoAPI.png | Bin 0 -> 170909 bytes img/eoapi_veda.png | Bin 0 -> 4641009 bytes img/favicon.ico | Bin 0 -> 4945 bytes img/ingestdata.png | Bin 0 -> 172322 bytes img/logo.png | Bin 0 -> 10091 bytes img/msft_logo.svg | 8 + img/nasa_logo.svg | 52 + img/pgstac_logo.png | Bin 0 -> 26708 bytes img/sharevisualize.png | Bin 0 -> 234400 bytes img/stacfastapi_logo.png | Bin 0 -> 39474 bytes img/tipg_logo.png | Bin 0 -> 15166 bytes img/titilerpgstac_logo.png | Bin 0 -> 39080 bytes index.html | 895 +++ intro/index.html | 967 +++ notebooks/eoAPI_Maxar_Hawaii_demo.ipynb | 2971 ++++++++ .../eoAPI_Maxar_Kahramanmaras_demo.ipynb | 1644 ++++ notebooks/getting-started.ipynb | 1678 +++++ overrides/assets/stylesheets/home.css | 389 + overrides/home.html | 312 + overrides/main.html | 8 + overrides/stylesheets/extra.css | 41 + search/search_index.json | 1 + services/index.html | 989 +++ sitemap.xml | 3 + sitemap.xml.gz | Bin 0 -> 127 bytes stylesheets/extra.css | 41 + 81 files changed, 21008 insertions(+) create mode 100644 .nojekyll create mode 100644 404.html create mode 100644 CNAME create mode 100644 assets/images/favicon.png create mode 100644 assets/javascripts/bundle.fe8b6f2b.min.js create mode 100644 assets/javascripts/bundle.fe8b6f2b.min.js.map create mode 100644 assets/javascripts/lunr/min/lunr.ar.min.js create mode 100644 assets/javascripts/lunr/min/lunr.da.min.js create mode 100644 assets/javascripts/lunr/min/lunr.de.min.js create mode 100644 assets/javascripts/lunr/min/lunr.du.min.js create mode 100644 assets/javascripts/lunr/min/lunr.el.min.js create mode 100644 assets/javascripts/lunr/min/lunr.es.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.he.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hu.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hy.min.js create mode 100644 assets/javascripts/lunr/min/lunr.it.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ja.min.js create mode 100644 assets/javascripts/lunr/min/lunr.jp.min.js create mode 100644 assets/javascripts/lunr/min/lunr.kn.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ko.min.js create mode 100644 assets/javascripts/lunr/min/lunr.multi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.nl.min.js create mode 100644 assets/javascripts/lunr/min/lunr.no.min.js create mode 100644 assets/javascripts/lunr/min/lunr.pt.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ro.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ru.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sa.min.js create mode 100644 assets/javascripts/lunr/min/lunr.stemmer.support.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sv.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ta.min.js create mode 100644 assets/javascripts/lunr/min/lunr.te.min.js create mode 100644 assets/javascripts/lunr/min/lunr.th.min.js create mode 100644 assets/javascripts/lunr/min/lunr.tr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.vi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.zh.min.js create mode 100644 assets/javascripts/lunr/tinyseg.js create mode 100644 assets/javascripts/lunr/wordcut.js create mode 100644 assets/javascripts/workers/search.b8dbb3d2.min.js create mode 100644 assets/javascripts/workers/search.b8dbb3d2.min.js.map create mode 100644 assets/stylesheets/home.css create mode 100644 assets/stylesheets/main.76a95c52.min.css create mode 100644 assets/stylesheets/main.76a95c52.min.css.map create mode 100644 assets/stylesheets/palette.06af60db.min.css create mode 100644 assets/stylesheets/palette.06af60db.min.css.map create mode 100644 contributing/index.html create mode 100644 customization/index.html create mode 100644 deployment/index.html create mode 100644 img/NASA_SunEarth.jpg create mode 100644 img/aws_logo.svg create mode 100644 img/devseed_logo.svg create mode 100644 img/downloaddeploy.png create mode 100644 img/earth.jpg create mode 100644 img/eoAPI.png create mode 100644 img/eoapi_veda.png create mode 100644 img/favicon.ico create mode 100644 img/ingestdata.png create mode 100644 img/logo.png create mode 100644 img/msft_logo.svg create mode 100644 img/nasa_logo.svg create mode 100644 img/pgstac_logo.png create mode 100644 img/sharevisualize.png create mode 100644 img/stacfastapi_logo.png create mode 100644 img/tipg_logo.png create mode 100644 img/titilerpgstac_logo.png create mode 100644 index.html create mode 100644 intro/index.html create mode 100644 notebooks/eoAPI_Maxar_Hawaii_demo.ipynb create mode 100644 notebooks/eoAPI_Maxar_Kahramanmaras_demo.ipynb create mode 100644 notebooks/getting-started.ipynb create mode 100644 overrides/assets/stylesheets/home.css create mode 100644 overrides/home.html create mode 100644 overrides/main.html create mode 100644 overrides/stylesheets/extra.css create mode 100644 search/search_index.json create mode 100644 services/index.html create mode 100644 sitemap.xml create mode 100644 sitemap.xml.gz create mode 100644 stylesheets/extra.css diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/404.html b/404.html new file mode 100644 index 0000000..e2e88ac --- /dev/null +++ b/404.html @@ -0,0 +1,641 @@ + + + + + + + + + + + + + + + + + + + + + The Earth Observation API + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + + + +
+ + + + + + + +
+ +
+ + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ +

404 - Not found

+ +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/CNAME b/CNAME new file mode 100644 index 0000000..8e9f447 --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +eoapi.dev diff --git a/assets/images/favicon.png b/assets/images/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..1cf13b9f9d978896599290a74f77d5dbe7d1655c GIT binary patch literal 1870 zcmV-U2eJ5xP)Gc)JR9QMau)O=X#!i9;T z37kk-upj^(fsR36MHs_+1RCI)NNu9}lD0S{B^g8PN?Ww(5|~L#Ng*g{WsqleV}|#l zz8@ri&cTzw_h33bHI+12+kK6WN$h#n5cD8OQt`5kw6p~9H3()bUQ8OS4Q4HTQ=1Ol z_JAocz`fLbT2^{`8n~UAo=#AUOf=SOq4pYkt;XbC&f#7lb$*7=$na!mWCQ`dBQsO0 zLFBSPj*N?#u5&pf2t4XjEGH|=pPQ8xh7tpx;US5Cx_Ju;!O`ya-yF`)b%TEt5>eP1ZX~}sjjA%FJF?h7cX8=b!DZl<6%Cv z*G0uvvU+vmnpLZ2paivG-(cd*y3$hCIcsZcYOGh{$&)A6*XX&kXZd3G8m)G$Zz-LV z^GF3VAW^Mdv!)4OM8EgqRiz~*Cji;uzl2uC9^=8I84vNp;ltJ|q-*uQwGp2ma6cY7 z;`%`!9UXO@fr&Ebapfs34OmS9^u6$)bJxrucutf>`dKPKT%%*d3XlFVKunp9 zasduxjrjs>f8V=D|J=XNZp;_Zy^WgQ$9WDjgY=z@stwiEBm9u5*|34&1Na8BMjjgf3+SHcr`5~>oz1Y?SW^=K z^bTyO6>Gar#P_W2gEMwq)ot3; zREHn~U&Dp0l6YT0&k-wLwYjb?5zGK`W6S2v+K>AM(95m2C20L|3m~rN8dprPr@t)5lsk9Hu*W z?pS990s;Ez=+Rj{x7p``4>+c0G5^pYnB1^!TL=(?HLHZ+HicG{~4F1d^5Awl_2!1jICM-!9eoLhbbT^;yHcefyTAaqRcY zmuctDopPT!%k+}x%lZRKnzykr2}}XfG_ne?nRQO~?%hkzo;@RN{P6o`&mMUWBYMTe z6i8ChtjX&gXl`nvrU>jah)2iNM%JdjqoaeaU%yVn!^70x-flljp6Q5tK}5}&X8&&G zX3fpb3E(!rH=zVI_9Gjl45w@{(ITqngWFe7@9{mX;tO25Z_8 zQHEpI+FkTU#4xu>RkN>b3Tnc3UpWzPXWm#o55GKF09j^Mh~)K7{QqbO_~(@CVq! zS<8954|P8mXN2MRs86xZ&Q4EfM@JB94b=(YGuk)s&^jiSF=t3*oNK3`rD{H`yQ?d; ztE=laAUoZx5?RC8*WKOj`%LXEkgDd>&^Q4M^z`%u0rg-It=hLCVsq!Z%^6eB-OvOT zFZ28TN&cRmgU}Elrnk43)!>Z1FCPL2K$7}gwzIc48NX}#!A1BpJP?#v5wkNprhV** z?Cpalt1oH&{r!o3eSKc&ap)iz2BTn_VV`4>9M^b3;(YY}4>#ML6{~(4mH+?%07*qo IM6N<$f(jP3KmY&$ literal 0 HcmV?d00001 diff --git a/assets/javascripts/bundle.fe8b6f2b.min.js b/assets/javascripts/bundle.fe8b6f2b.min.js new file mode 100644 index 0000000..cf778d4 --- /dev/null +++ b/assets/javascripts/bundle.fe8b6f2b.min.js @@ -0,0 +1,29 @@ +"use strict";(()=>{var Fi=Object.create;var gr=Object.defineProperty;var ji=Object.getOwnPropertyDescriptor;var Wi=Object.getOwnPropertyNames,Dt=Object.getOwnPropertySymbols,Ui=Object.getPrototypeOf,xr=Object.prototype.hasOwnProperty,no=Object.prototype.propertyIsEnumerable;var oo=(e,t,r)=>t in e?gr(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,R=(e,t)=>{for(var r in t||(t={}))xr.call(t,r)&&oo(e,r,t[r]);if(Dt)for(var r of Dt(t))no.call(t,r)&&oo(e,r,t[r]);return e};var io=(e,t)=>{var r={};for(var o in e)xr.call(e,o)&&t.indexOf(o)<0&&(r[o]=e[o]);if(e!=null&&Dt)for(var o of Dt(e))t.indexOf(o)<0&&no.call(e,o)&&(r[o]=e[o]);return r};var yr=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var Di=(e,t,r,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of Wi(t))!xr.call(e,n)&&n!==r&&gr(e,n,{get:()=>t[n],enumerable:!(o=ji(t,n))||o.enumerable});return e};var Vt=(e,t,r)=>(r=e!=null?Fi(Ui(e)):{},Di(t||!e||!e.__esModule?gr(r,"default",{value:e,enumerable:!0}):r,e));var ao=(e,t,r)=>new Promise((o,n)=>{var i=p=>{try{s(r.next(p))}catch(c){n(c)}},a=p=>{try{s(r.throw(p))}catch(c){n(c)}},s=p=>p.done?o(p.value):Promise.resolve(p.value).then(i,a);s((r=r.apply(e,t)).next())});var co=yr((Er,so)=>{(function(e,t){typeof Er=="object"&&typeof so!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(Er,function(){"use strict";function e(r){var o=!0,n=!1,i=null,a={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function s(H){return!!(H&&H!==document&&H.nodeName!=="HTML"&&H.nodeName!=="BODY"&&"classList"in H&&"contains"in H.classList)}function p(H){var mt=H.type,ze=H.tagName;return!!(ze==="INPUT"&&a[mt]&&!H.readOnly||ze==="TEXTAREA"&&!H.readOnly||H.isContentEditable)}function c(H){H.classList.contains("focus-visible")||(H.classList.add("focus-visible"),H.setAttribute("data-focus-visible-added",""))}function l(H){H.hasAttribute("data-focus-visible-added")&&(H.classList.remove("focus-visible"),H.removeAttribute("data-focus-visible-added"))}function f(H){H.metaKey||H.altKey||H.ctrlKey||(s(r.activeElement)&&c(r.activeElement),o=!0)}function u(H){o=!1}function h(H){s(H.target)&&(o||p(H.target))&&c(H.target)}function w(H){s(H.target)&&(H.target.classList.contains("focus-visible")||H.target.hasAttribute("data-focus-visible-added"))&&(n=!0,window.clearTimeout(i),i=window.setTimeout(function(){n=!1},100),l(H.target))}function A(H){document.visibilityState==="hidden"&&(n&&(o=!0),te())}function te(){document.addEventListener("mousemove",J),document.addEventListener("mousedown",J),document.addEventListener("mouseup",J),document.addEventListener("pointermove",J),document.addEventListener("pointerdown",J),document.addEventListener("pointerup",J),document.addEventListener("touchmove",J),document.addEventListener("touchstart",J),document.addEventListener("touchend",J)}function ie(){document.removeEventListener("mousemove",J),document.removeEventListener("mousedown",J),document.removeEventListener("mouseup",J),document.removeEventListener("pointermove",J),document.removeEventListener("pointerdown",J),document.removeEventListener("pointerup",J),document.removeEventListener("touchmove",J),document.removeEventListener("touchstart",J),document.removeEventListener("touchend",J)}function J(H){H.target.nodeName&&H.target.nodeName.toLowerCase()==="html"||(o=!1,ie())}document.addEventListener("keydown",f,!0),document.addEventListener("mousedown",u,!0),document.addEventListener("pointerdown",u,!0),document.addEventListener("touchstart",u,!0),document.addEventListener("visibilitychange",A,!0),te(),r.addEventListener("focus",h,!0),r.addEventListener("blur",w,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)})});var Yr=yr((Rt,Kr)=>{/*! + * clipboard.js v2.0.11 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */(function(t,r){typeof Rt=="object"&&typeof Kr=="object"?Kr.exports=r():typeof define=="function"&&define.amd?define([],r):typeof Rt=="object"?Rt.ClipboardJS=r():t.ClipboardJS=r()})(Rt,function(){return function(){var e={686:function(o,n,i){"use strict";i.d(n,{default:function(){return Ii}});var a=i(279),s=i.n(a),p=i(370),c=i.n(p),l=i(817),f=i.n(l);function u(V){try{return document.execCommand(V)}catch(_){return!1}}var h=function(_){var M=f()(_);return u("cut"),M},w=h;function A(V){var _=document.documentElement.getAttribute("dir")==="rtl",M=document.createElement("textarea");M.style.fontSize="12pt",M.style.border="0",M.style.padding="0",M.style.margin="0",M.style.position="absolute",M.style[_?"right":"left"]="-9999px";var j=window.pageYOffset||document.documentElement.scrollTop;return M.style.top="".concat(j,"px"),M.setAttribute("readonly",""),M.value=V,M}var te=function(_,M){var j=A(_);M.container.appendChild(j);var D=f()(j);return u("copy"),j.remove(),D},ie=function(_){var M=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},j="";return typeof _=="string"?j=te(_,M):_ instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(_==null?void 0:_.type)?j=te(_.value,M):(j=f()(_),u("copy")),j},J=ie;function H(V){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?H=function(M){return typeof M}:H=function(M){return M&&typeof Symbol=="function"&&M.constructor===Symbol&&M!==Symbol.prototype?"symbol":typeof M},H(V)}var mt=function(){var _=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},M=_.action,j=M===void 0?"copy":M,D=_.container,Y=_.target,ke=_.text;if(j!=="copy"&&j!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(Y!==void 0)if(Y&&H(Y)==="object"&&Y.nodeType===1){if(j==="copy"&&Y.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(j==="cut"&&(Y.hasAttribute("readonly")||Y.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if(ke)return J(ke,{container:D});if(Y)return j==="cut"?w(Y):J(Y,{container:D})},ze=mt;function Ie(V){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?Ie=function(M){return typeof M}:Ie=function(M){return M&&typeof Symbol=="function"&&M.constructor===Symbol&&M!==Symbol.prototype?"symbol":typeof M},Ie(V)}function _i(V,_){if(!(V instanceof _))throw new TypeError("Cannot call a class as a function")}function ro(V,_){for(var M=0;M<_.length;M++){var j=_[M];j.enumerable=j.enumerable||!1,j.configurable=!0,"value"in j&&(j.writable=!0),Object.defineProperty(V,j.key,j)}}function Ai(V,_,M){return _&&ro(V.prototype,_),M&&ro(V,M),V}function Ci(V,_){if(typeof _!="function"&&_!==null)throw new TypeError("Super expression must either be null or a function");V.prototype=Object.create(_&&_.prototype,{constructor:{value:V,writable:!0,configurable:!0}}),_&&br(V,_)}function br(V,_){return br=Object.setPrototypeOf||function(j,D){return j.__proto__=D,j},br(V,_)}function Hi(V){var _=Pi();return function(){var j=Wt(V),D;if(_){var Y=Wt(this).constructor;D=Reflect.construct(j,arguments,Y)}else D=j.apply(this,arguments);return ki(this,D)}}function ki(V,_){return _&&(Ie(_)==="object"||typeof _=="function")?_:$i(V)}function $i(V){if(V===void 0)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return V}function Pi(){if(typeof Reflect=="undefined"||!Reflect.construct||Reflect.construct.sham)return!1;if(typeof Proxy=="function")return!0;try{return Date.prototype.toString.call(Reflect.construct(Date,[],function(){})),!0}catch(V){return!1}}function Wt(V){return Wt=Object.setPrototypeOf?Object.getPrototypeOf:function(M){return M.__proto__||Object.getPrototypeOf(M)},Wt(V)}function vr(V,_){var M="data-clipboard-".concat(V);if(_.hasAttribute(M))return _.getAttribute(M)}var Ri=function(V){Ci(M,V);var _=Hi(M);function M(j,D){var Y;return _i(this,M),Y=_.call(this),Y.resolveOptions(D),Y.listenClick(j),Y}return Ai(M,[{key:"resolveOptions",value:function(){var D=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof D.action=="function"?D.action:this.defaultAction,this.target=typeof D.target=="function"?D.target:this.defaultTarget,this.text=typeof D.text=="function"?D.text:this.defaultText,this.container=Ie(D.container)==="object"?D.container:document.body}},{key:"listenClick",value:function(D){var Y=this;this.listener=c()(D,"click",function(ke){return Y.onClick(ke)})}},{key:"onClick",value:function(D){var Y=D.delegateTarget||D.currentTarget,ke=this.action(Y)||"copy",Ut=ze({action:ke,container:this.container,target:this.target(Y),text:this.text(Y)});this.emit(Ut?"success":"error",{action:ke,text:Ut,trigger:Y,clearSelection:function(){Y&&Y.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(D){return vr("action",D)}},{key:"defaultTarget",value:function(D){var Y=vr("target",D);if(Y)return document.querySelector(Y)}},{key:"defaultText",value:function(D){return vr("text",D)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(D){var Y=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return J(D,Y)}},{key:"cut",value:function(D){return w(D)}},{key:"isSupported",value:function(){var D=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],Y=typeof D=="string"?[D]:D,ke=!!document.queryCommandSupported;return Y.forEach(function(Ut){ke=ke&&!!document.queryCommandSupported(Ut)}),ke}}]),M}(s()),Ii=Ri},828:function(o){var n=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function a(s,p){for(;s&&s.nodeType!==n;){if(typeof s.matches=="function"&&s.matches(p))return s;s=s.parentNode}}o.exports=a},438:function(o,n,i){var a=i(828);function s(l,f,u,h,w){var A=c.apply(this,arguments);return l.addEventListener(u,A,w),{destroy:function(){l.removeEventListener(u,A,w)}}}function p(l,f,u,h,w){return typeof l.addEventListener=="function"?s.apply(null,arguments):typeof u=="function"?s.bind(null,document).apply(null,arguments):(typeof l=="string"&&(l=document.querySelectorAll(l)),Array.prototype.map.call(l,function(A){return s(A,f,u,h,w)}))}function c(l,f,u,h){return function(w){w.delegateTarget=a(w.target,f),w.delegateTarget&&h.call(l,w)}}o.exports=p},879:function(o,n){n.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},n.nodeList=function(i){var a=Object.prototype.toString.call(i);return i!==void 0&&(a==="[object NodeList]"||a==="[object HTMLCollection]")&&"length"in i&&(i.length===0||n.node(i[0]))},n.string=function(i){return typeof i=="string"||i instanceof String},n.fn=function(i){var a=Object.prototype.toString.call(i);return a==="[object Function]"}},370:function(o,n,i){var a=i(879),s=i(438);function p(u,h,w){if(!u&&!h&&!w)throw new Error("Missing required arguments");if(!a.string(h))throw new TypeError("Second argument must be a String");if(!a.fn(w))throw new TypeError("Third argument must be a Function");if(a.node(u))return c(u,h,w);if(a.nodeList(u))return l(u,h,w);if(a.string(u))return f(u,h,w);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function c(u,h,w){return u.addEventListener(h,w),{destroy:function(){u.removeEventListener(h,w)}}}function l(u,h,w){return Array.prototype.forEach.call(u,function(A){A.addEventListener(h,w)}),{destroy:function(){Array.prototype.forEach.call(u,function(A){A.removeEventListener(h,w)})}}}function f(u,h,w){return s(document.body,u,h,w)}o.exports=p},817:function(o){function n(i){var a;if(i.nodeName==="SELECT")i.focus(),a=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var s=i.hasAttribute("readonly");s||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),s||i.removeAttribute("readonly"),a=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var p=window.getSelection(),c=document.createRange();c.selectNodeContents(i),p.removeAllRanges(),p.addRange(c),a=p.toString()}return a}o.exports=n},279:function(o){function n(){}n.prototype={on:function(i,a,s){var p=this.e||(this.e={});return(p[i]||(p[i]=[])).push({fn:a,ctx:s}),this},once:function(i,a,s){var p=this;function c(){p.off(i,c),a.apply(s,arguments)}return c._=a,this.on(i,c,s)},emit:function(i){var a=[].slice.call(arguments,1),s=((this.e||(this.e={}))[i]||[]).slice(),p=0,c=s.length;for(p;p{"use strict";/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */var ts=/["'&<>]/;ei.exports=rs;function rs(e){var t=""+e,r=ts.exec(t);if(!r)return t;var o,n="",i=0,a=0;for(i=r.index;i0&&i[i.length-1])&&(c[0]===6||c[0]===2)){r=0;continue}if(c[0]===3&&(!i||c[1]>i[0]&&c[1]=e.length&&(e=void 0),{value:e&&e[o++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function N(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var o=r.call(e),n,i=[],a;try{for(;(t===void 0||t-- >0)&&!(n=o.next()).done;)i.push(n.value)}catch(s){a={error:s}}finally{try{n&&!n.done&&(r=o.return)&&r.call(o)}finally{if(a)throw a.error}}return i}function q(e,t,r){if(r||arguments.length===2)for(var o=0,n=t.length,i;o1||s(u,h)})})}function s(u,h){try{p(o[u](h))}catch(w){f(i[0][3],w)}}function p(u){u.value instanceof nt?Promise.resolve(u.value.v).then(c,l):f(i[0][2],u)}function c(u){s("next",u)}function l(u){s("throw",u)}function f(u,h){u(h),i.shift(),i.length&&s(i[0][0],i[0][1])}}function mo(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof de=="function"?de(e):e[Symbol.iterator](),r={},o("next"),o("throw"),o("return"),r[Symbol.asyncIterator]=function(){return this},r);function o(i){r[i]=e[i]&&function(a){return new Promise(function(s,p){a=e[i](a),n(s,p,a.done,a.value)})}}function n(i,a,s,p){Promise.resolve(p).then(function(c){i({value:c,done:s})},a)}}function k(e){return typeof e=="function"}function ft(e){var t=function(o){Error.call(o),o.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var zt=ft(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: +`+r.map(function(o,n){return n+1+") "+o.toString()}).join(` + `):"",this.name="UnsubscriptionError",this.errors=r}});function qe(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var Fe=function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,o,n,i;if(!this.closed){this.closed=!0;var a=this._parentage;if(a)if(this._parentage=null,Array.isArray(a))try{for(var s=de(a),p=s.next();!p.done;p=s.next()){var c=p.value;c.remove(this)}}catch(A){t={error:A}}finally{try{p&&!p.done&&(r=s.return)&&r.call(s)}finally{if(t)throw t.error}}else a.remove(this);var l=this.initialTeardown;if(k(l))try{l()}catch(A){i=A instanceof zt?A.errors:[A]}var f=this._finalizers;if(f){this._finalizers=null;try{for(var u=de(f),h=u.next();!h.done;h=u.next()){var w=h.value;try{fo(w)}catch(A){i=i!=null?i:[],A instanceof zt?i=q(q([],N(i)),N(A.errors)):i.push(A)}}}catch(A){o={error:A}}finally{try{h&&!h.done&&(n=u.return)&&n.call(u)}finally{if(o)throw o.error}}}if(i)throw new zt(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)fo(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&qe(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&qe(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=function(){var t=new e;return t.closed=!0,t}(),e}();var Tr=Fe.EMPTY;function qt(e){return e instanceof Fe||e&&"closed"in e&&k(e.remove)&&k(e.add)&&k(e.unsubscribe)}function fo(e){k(e)?e():e.unsubscribe()}var $e={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var ut={setTimeout:function(e,t){for(var r=[],o=2;o0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var o=this,n=this,i=n.hasError,a=n.isStopped,s=n.observers;return i||a?Tr:(this.currentObservers=null,s.push(r),new Fe(function(){o.currentObservers=null,qe(s,r)}))},t.prototype._checkFinalizedStatuses=function(r){var o=this,n=o.hasError,i=o.thrownError,a=o.isStopped;n?r.error(i):a&&r.complete()},t.prototype.asObservable=function(){var r=new F;return r.source=this,r},t.create=function(r,o){return new Eo(r,o)},t}(F);var Eo=function(e){re(t,e);function t(r,o){var n=e.call(this)||this;return n.destination=r,n.source=o,n}return t.prototype.next=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.next)===null||n===void 0||n.call(o,r)},t.prototype.error=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.error)===null||n===void 0||n.call(o,r)},t.prototype.complete=function(){var r,o;(o=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||o===void 0||o.call(r)},t.prototype._subscribe=function(r){var o,n;return(n=(o=this.source)===null||o===void 0?void 0:o.subscribe(r))!==null&&n!==void 0?n:Tr},t}(g);var _r=function(e){re(t,e);function t(r){var o=e.call(this)||this;return o._value=r,o}return Object.defineProperty(t.prototype,"value",{get:function(){return this.getValue()},enumerable:!1,configurable:!0}),t.prototype._subscribe=function(r){var o=e.prototype._subscribe.call(this,r);return!o.closed&&r.next(this._value),o},t.prototype.getValue=function(){var r=this,o=r.hasError,n=r.thrownError,i=r._value;if(o)throw n;return this._throwIfClosed(),i},t.prototype.next=function(r){e.prototype.next.call(this,this._value=r)},t}(g);var Lt={now:function(){return(Lt.delegate||Date).now()},delegate:void 0};var _t=function(e){re(t,e);function t(r,o,n){r===void 0&&(r=1/0),o===void 0&&(o=1/0),n===void 0&&(n=Lt);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=o,i._timestampProvider=n,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=o===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,o),i}return t.prototype.next=function(r){var o=this,n=o.isStopped,i=o._buffer,a=o._infiniteTimeWindow,s=o._timestampProvider,p=o._windowTime;n||(i.push(r),!a&&i.push(s.now()+p)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var o=this._innerSubscribe(r),n=this,i=n._infiniteTimeWindow,a=n._buffer,s=a.slice(),p=0;p0?e.prototype.schedule.call(this,r,o):(this.delay=o,this.state=r,this.scheduler.flush(this),this)},t.prototype.execute=function(r,o){return o>0||this.closed?e.prototype.execute.call(this,r,o):this._execute(r,o)},t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!=null&&n>0||n==null&&this.delay>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.flush(this),0)},t}(vt);var So=function(e){re(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t}(gt);var Hr=new So(To);var Oo=function(e){re(t,e);function t(r,o){var n=e.call(this,r,o)||this;return n.scheduler=r,n.work=o,n}return t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!==null&&n>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.actions.push(this),r._scheduled||(r._scheduled=bt.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,o,n){var i;if(n===void 0&&(n=0),n!=null?n>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,o,n);var a=r.actions;o!=null&&((i=a[a.length-1])===null||i===void 0?void 0:i.id)!==o&&(bt.cancelAnimationFrame(o),r._scheduled=void 0)},t}(vt);var Mo=function(e){re(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var o=this._scheduled;this._scheduled=void 0;var n=this.actions,i;r=r||n.shift();do if(i=r.execute(r.state,r.delay))break;while((r=n[0])&&r.id===o&&n.shift());if(this._active=!1,i){for(;(r=n[0])&&r.id===o&&n.shift();)r.unsubscribe();throw i}},t}(gt);var me=new Mo(Oo);var O=new F(function(e){return e.complete()});function Yt(e){return e&&k(e.schedule)}function kr(e){return e[e.length-1]}function Xe(e){return k(kr(e))?e.pop():void 0}function He(e){return Yt(kr(e))?e.pop():void 0}function Bt(e,t){return typeof kr(e)=="number"?e.pop():t}var xt=function(e){return e&&typeof e.length=="number"&&typeof e!="function"};function Gt(e){return k(e==null?void 0:e.then)}function Jt(e){return k(e[ht])}function Xt(e){return Symbol.asyncIterator&&k(e==null?void 0:e[Symbol.asyncIterator])}function Zt(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function Gi(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var er=Gi();function tr(e){return k(e==null?void 0:e[er])}function rr(e){return lo(this,arguments,function(){var r,o,n,i;return Nt(this,function(a){switch(a.label){case 0:r=e.getReader(),a.label=1;case 1:a.trys.push([1,,9,10]),a.label=2;case 2:return[4,nt(r.read())];case 3:return o=a.sent(),n=o.value,i=o.done,i?[4,nt(void 0)]:[3,5];case 4:return[2,a.sent()];case 5:return[4,nt(n)];case 6:return[4,a.sent()];case 7:return a.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function or(e){return k(e==null?void 0:e.getReader)}function W(e){if(e instanceof F)return e;if(e!=null){if(Jt(e))return Ji(e);if(xt(e))return Xi(e);if(Gt(e))return Zi(e);if(Xt(e))return Lo(e);if(tr(e))return ea(e);if(or(e))return ta(e)}throw Zt(e)}function Ji(e){return new F(function(t){var r=e[ht]();if(k(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function Xi(e){return new F(function(t){for(var r=0;r=2;return function(o){return o.pipe(e?b(function(n,i){return e(n,i,o)}):le,Te(1),r?Be(t):zo(function(){return new ir}))}}function Fr(e){return e<=0?function(){return O}:y(function(t,r){var o=[];t.subscribe(T(r,function(n){o.push(n),e=2,!0))}function pe(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new g}:t,o=e.resetOnError,n=o===void 0?!0:o,i=e.resetOnComplete,a=i===void 0?!0:i,s=e.resetOnRefCountZero,p=s===void 0?!0:s;return function(c){var l,f,u,h=0,w=!1,A=!1,te=function(){f==null||f.unsubscribe(),f=void 0},ie=function(){te(),l=u=void 0,w=A=!1},J=function(){var H=l;ie(),H==null||H.unsubscribe()};return y(function(H,mt){h++,!A&&!w&&te();var ze=u=u!=null?u:r();mt.add(function(){h--,h===0&&!A&&!w&&(f=Wr(J,p))}),ze.subscribe(mt),!l&&h>0&&(l=new at({next:function(Ie){return ze.next(Ie)},error:function(Ie){A=!0,te(),f=Wr(ie,n,Ie),ze.error(Ie)},complete:function(){w=!0,te(),f=Wr(ie,a),ze.complete()}}),W(H).subscribe(l))})(c)}}function Wr(e,t){for(var r=[],o=2;oe.next(document)),e}function $(e,t=document){return Array.from(t.querySelectorAll(e))}function P(e,t=document){let r=fe(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function fe(e,t=document){return t.querySelector(e)||void 0}function Re(){var e,t,r,o;return(o=(r=(t=(e=document.activeElement)==null?void 0:e.shadowRoot)==null?void 0:t.activeElement)!=null?r:document.activeElement)!=null?o:void 0}var xa=S(d(document.body,"focusin"),d(document.body,"focusout")).pipe(_e(1),Q(void 0),m(()=>Re()||document.body),G(1));function et(e){return xa.pipe(m(t=>e.contains(t)),K())}function kt(e,t){return C(()=>S(d(e,"mouseenter").pipe(m(()=>!0)),d(e,"mouseleave").pipe(m(()=>!1))).pipe(t?Ht(r=>Me(+!r*t)):le,Q(e.matches(":hover"))))}function Bo(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)Bo(e,r)}function x(e,t,...r){let o=document.createElement(e);if(t)for(let n of Object.keys(t))typeof t[n]!="undefined"&&(typeof t[n]!="boolean"?o.setAttribute(n,t[n]):o.setAttribute(n,""));for(let n of r)Bo(o,n);return o}function sr(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function wt(e){let t=x("script",{src:e});return C(()=>(document.head.appendChild(t),S(d(t,"load"),d(t,"error").pipe(v(()=>$r(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(m(()=>{}),L(()=>document.head.removeChild(t)),Te(1))))}var Go=new g,ya=C(()=>typeof ResizeObserver=="undefined"?wt("https://unpkg.com/resize-observer-polyfill"):I(void 0)).pipe(m(()=>new ResizeObserver(e=>e.forEach(t=>Go.next(t)))),v(e=>S(Ke,I(e)).pipe(L(()=>e.disconnect()))),G(1));function ce(e){return{width:e.offsetWidth,height:e.offsetHeight}}function ge(e){let t=e;for(;t.clientWidth===0&&t.parentElement;)t=t.parentElement;return ya.pipe(E(r=>r.observe(t)),v(r=>Go.pipe(b(o=>o.target===t),L(()=>r.unobserve(t)))),m(()=>ce(e)),Q(ce(e)))}function Tt(e){return{width:e.scrollWidth,height:e.scrollHeight}}function cr(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}function Jo(e){let t=[],r=e.parentElement;for(;r;)(e.clientWidth>r.clientWidth||e.clientHeight>r.clientHeight)&&t.push(r),r=(e=r).parentElement;return t.length===0&&t.push(document.documentElement),t}function Ue(e){return{x:e.offsetLeft,y:e.offsetTop}}function Xo(e){let t=e.getBoundingClientRect();return{x:t.x+window.scrollX,y:t.y+window.scrollY}}function Zo(e){return S(d(window,"load"),d(window,"resize")).pipe(Le(0,me),m(()=>Ue(e)),Q(Ue(e)))}function pr(e){return{x:e.scrollLeft,y:e.scrollTop}}function De(e){return S(d(e,"scroll"),d(window,"scroll"),d(window,"resize")).pipe(Le(0,me),m(()=>pr(e)),Q(pr(e)))}var en=new g,Ea=C(()=>I(new IntersectionObserver(e=>{for(let t of e)en.next(t)},{threshold:0}))).pipe(v(e=>S(Ke,I(e)).pipe(L(()=>e.disconnect()))),G(1));function tt(e){return Ea.pipe(E(t=>t.observe(e)),v(t=>en.pipe(b(({target:r})=>r===e),L(()=>t.unobserve(e)),m(({isIntersecting:r})=>r))))}function tn(e,t=16){return De(e).pipe(m(({y:r})=>{let o=ce(e),n=Tt(e);return r>=n.height-o.height-t}),K())}var lr={drawer:P("[data-md-toggle=drawer]"),search:P("[data-md-toggle=search]")};function rn(e){return lr[e].checked}function Je(e,t){lr[e].checked!==t&&lr[e].click()}function Ve(e){let t=lr[e];return d(t,"change").pipe(m(()=>t.checked),Q(t.checked))}function wa(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function Ta(){return S(d(window,"compositionstart").pipe(m(()=>!0)),d(window,"compositionend").pipe(m(()=>!1))).pipe(Q(!1))}function on(){let e=d(window,"keydown").pipe(b(t=>!(t.metaKey||t.ctrlKey)),m(t=>({mode:rn("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),b(({mode:t,type:r})=>{if(t==="global"){let o=Re();if(typeof o!="undefined")return!wa(o,r)}return!0}),pe());return Ta().pipe(v(t=>t?O:e))}function xe(){return new URL(location.href)}function pt(e,t=!1){if(B("navigation.instant")&&!t){let r=x("a",{href:e.href});document.body.appendChild(r),r.click(),r.remove()}else location.href=e.href}function nn(){return new g}function an(){return location.hash.slice(1)}function sn(e){let t=x("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function Sa(e){return S(d(window,"hashchange"),e).pipe(m(an),Q(an()),b(t=>t.length>0),G(1))}function cn(e){return Sa(e).pipe(m(t=>fe(`[id="${t}"]`)),b(t=>typeof t!="undefined"))}function $t(e){let t=matchMedia(e);return ar(r=>t.addListener(()=>r(t.matches))).pipe(Q(t.matches))}function pn(){let e=matchMedia("print");return S(d(window,"beforeprint").pipe(m(()=>!0)),d(window,"afterprint").pipe(m(()=>!1))).pipe(Q(e.matches))}function Nr(e,t){return e.pipe(v(r=>r?t():O))}function zr(e,t){return new F(r=>{let o=new XMLHttpRequest;return o.open("GET",`${e}`),o.responseType="blob",o.addEventListener("load",()=>{o.status>=200&&o.status<300?(r.next(o.response),r.complete()):r.error(new Error(o.statusText))}),o.addEventListener("error",()=>{r.error(new Error("Network error"))}),o.addEventListener("abort",()=>{r.complete()}),typeof(t==null?void 0:t.progress$)!="undefined"&&(o.addEventListener("progress",n=>{var i;if(n.lengthComputable)t.progress$.next(n.loaded/n.total*100);else{let a=(i=o.getResponseHeader("Content-Length"))!=null?i:0;t.progress$.next(n.loaded/+a*100)}}),t.progress$.next(5)),o.send(),()=>o.abort()})}function Ne(e,t){return zr(e,t).pipe(v(r=>r.text()),m(r=>JSON.parse(r)),G(1))}function ln(e,t){let r=new DOMParser;return zr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/html")),G(1))}function mn(e,t){let r=new DOMParser;return zr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/xml")),G(1))}function fn(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function un(){return S(d(window,"scroll",{passive:!0}),d(window,"resize",{passive:!0})).pipe(m(fn),Q(fn()))}function dn(){return{width:innerWidth,height:innerHeight}}function hn(){return d(window,"resize",{passive:!0}).pipe(m(dn),Q(dn()))}function bn(){return z([un(),hn()]).pipe(m(([e,t])=>({offset:e,size:t})),G(1))}function mr(e,{viewport$:t,header$:r}){let o=t.pipe(Z("size")),n=z([o,r]).pipe(m(()=>Ue(e)));return z([r,t,n]).pipe(m(([{height:i},{offset:a,size:s},{x:p,y:c}])=>({offset:{x:a.x-p,y:a.y-c+i},size:s})))}function Oa(e){return d(e,"message",t=>t.data)}function Ma(e){let t=new g;return t.subscribe(r=>e.postMessage(r)),t}function vn(e,t=new Worker(e)){let r=Oa(t),o=Ma(t),n=new g;n.subscribe(o);let i=o.pipe(X(),ne(!0));return n.pipe(X(),Pe(r.pipe(U(i))),pe())}var La=P("#__config"),St=JSON.parse(La.textContent);St.base=`${new URL(St.base,xe())}`;function ye(){return St}function B(e){return St.features.includes(e)}function Ee(e,t){return typeof t!="undefined"?St.translations[e].replace("#",t.toString()):St.translations[e]}function Se(e,t=document){return P(`[data-md-component=${e}]`,t)}function ae(e,t=document){return $(`[data-md-component=${e}]`,t)}function _a(e){let t=P(".md-typeset > :first-child",e);return d(t,"click",{once:!0}).pipe(m(()=>P(".md-typeset",e)),m(r=>({hash:__md_hash(r.innerHTML)})))}function gn(e){if(!B("announce.dismiss")||!e.childElementCount)return O;if(!e.hidden){let t=P(".md-typeset",e);__md_hash(t.innerHTML)===__md_get("__announce")&&(e.hidden=!0)}return C(()=>{let t=new g;return t.subscribe(({hash:r})=>{e.hidden=!0,__md_set("__announce",r)}),_a(e).pipe(E(r=>t.next(r)),L(()=>t.complete()),m(r=>R({ref:e},r)))})}function Aa(e,{target$:t}){return t.pipe(m(r=>({hidden:r!==e})))}function xn(e,t){let r=new g;return r.subscribe(({hidden:o})=>{e.hidden=o}),Aa(e,t).pipe(E(o=>r.next(o)),L(()=>r.complete()),m(o=>R({ref:e},o)))}function Pt(e,t){return t==="inline"?x("div",{class:"md-tooltip md-tooltip--inline",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"})):x("div",{class:"md-tooltip",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"}))}function yn(...e){return x("div",{class:"md-tooltip2",role:"tooltip"},x("div",{class:"md-tooltip2__inner md-typeset"},e))}function En(e,t){if(t=t?`${t}_annotation_${e}`:void 0,t){let r=t?`#${t}`:void 0;return x("aside",{class:"md-annotation",tabIndex:0},Pt(t),x("a",{href:r,class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}else return x("aside",{class:"md-annotation",tabIndex:0},Pt(t),x("span",{class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}function wn(e){return x("button",{class:"md-clipboard md-icon",title:Ee("clipboard.copy"),"data-clipboard-target":`#${e} > code`})}function qr(e,t){let r=t&2,o=t&1,n=Object.keys(e.terms).filter(p=>!e.terms[p]).reduce((p,c)=>[...p,x("del",null,c)," "],[]).slice(0,-1),i=ye(),a=new URL(e.location,i.base);B("search.highlight")&&a.searchParams.set("h",Object.entries(e.terms).filter(([,p])=>p).reduce((p,[c])=>`${p} ${c}`.trim(),""));let{tags:s}=ye();return x("a",{href:`${a}`,class:"md-search-result__link",tabIndex:-1},x("article",{class:"md-search-result__article md-typeset","data-md-score":e.score.toFixed(2)},r>0&&x("div",{class:"md-search-result__icon md-icon"}),r>0&&x("h1",null,e.title),r<=0&&x("h2",null,e.title),o>0&&e.text.length>0&&e.text,e.tags&&e.tags.map(p=>{let c=s?p in s?`md-tag-icon md-tag--${s[p]}`:"md-tag-icon":"";return x("span",{class:`md-tag ${c}`},p)}),o>0&&n.length>0&&x("p",{class:"md-search-result__terms"},Ee("search.result.term.missing"),": ",...n)))}function Tn(e){let t=e[0].score,r=[...e],o=ye(),n=r.findIndex(l=>!`${new URL(l.location,o.base)}`.includes("#")),[i]=r.splice(n,1),a=r.findIndex(l=>l.scoreqr(l,1)),...p.length?[x("details",{class:"md-search-result__more"},x("summary",{tabIndex:-1},x("div",null,p.length>0&&p.length===1?Ee("search.result.more.one"):Ee("search.result.more.other",p.length))),...p.map(l=>qr(l,1)))]:[]];return x("li",{class:"md-search-result__item"},c)}function Sn(e){return x("ul",{class:"md-source__facts"},Object.entries(e).map(([t,r])=>x("li",{class:`md-source__fact md-source__fact--${t}`},typeof r=="number"?sr(r):r)))}function Qr(e){let t=`tabbed-control tabbed-control--${e}`;return x("div",{class:t,hidden:!0},x("button",{class:"tabbed-button",tabIndex:-1,"aria-hidden":"true"}))}function On(e){return x("div",{class:"md-typeset__scrollwrap"},x("div",{class:"md-typeset__table"},e))}function Ca(e){var o;let t=ye(),r=new URL(`../${e.version}/`,t.base);return x("li",{class:"md-version__item"},x("a",{href:`${r}`,class:"md-version__link"},e.title,((o=t.version)==null?void 0:o.alias)&&e.aliases.length>0&&x("span",{class:"md-version__alias"},e.aliases[0])))}function Mn(e,t){var o;let r=ye();return e=e.filter(n=>{var i;return!((i=n.properties)!=null&&i.hidden)}),x("div",{class:"md-version"},x("button",{class:"md-version__current","aria-label":Ee("select.version")},t.title,((o=r.version)==null?void 0:o.alias)&&t.aliases.length>0&&x("span",{class:"md-version__alias"},t.aliases[0])),x("ul",{class:"md-version__list"},e.map(Ca)))}var Ha=0;function ka(e){let t=z([et(e),kt(e)]).pipe(m(([o,n])=>o||n),K()),r=C(()=>Jo(e)).pipe(oe(De),ct(1),m(()=>Xo(e)));return t.pipe(Ae(o=>o),v(()=>z([t,r])),m(([o,n])=>({active:o,offset:n})),pe())}function $a(e,t){let{content$:r,viewport$:o}=t,n=`__tooltip2_${Ha++}`;return C(()=>{let i=new g,a=new _r(!1);i.pipe(X(),ne(!1)).subscribe(a);let s=a.pipe(Ht(c=>Me(+!c*250,Hr)),K(),v(c=>c?r:O),E(c=>c.id=n),pe());z([i.pipe(m(({active:c})=>c)),s.pipe(v(c=>kt(c,250)),Q(!1))]).pipe(m(c=>c.some(l=>l))).subscribe(a);let p=a.pipe(b(c=>c),ee(s,o),m(([c,l,{size:f}])=>{let u=e.getBoundingClientRect(),h=u.width/2;if(l.role==="tooltip")return{x:h,y:8+u.height};if(u.y>=f.height/2){let{height:w}=ce(l);return{x:h,y:-16-w}}else return{x:h,y:16+u.height}}));return z([s,i,p]).subscribe(([c,{offset:l},f])=>{c.style.setProperty("--md-tooltip-host-x",`${l.x}px`),c.style.setProperty("--md-tooltip-host-y",`${l.y}px`),c.style.setProperty("--md-tooltip-x",`${f.x}px`),c.style.setProperty("--md-tooltip-y",`${f.y}px`),c.classList.toggle("md-tooltip2--top",f.y<0),c.classList.toggle("md-tooltip2--bottom",f.y>=0)}),a.pipe(b(c=>c),ee(s,(c,l)=>l),b(c=>c.role==="tooltip")).subscribe(c=>{let l=ce(P(":scope > *",c));c.style.setProperty("--md-tooltip-width",`${l.width}px`),c.style.setProperty("--md-tooltip-tail","0px")}),a.pipe(K(),be(me),ee(s)).subscribe(([c,l])=>{l.classList.toggle("md-tooltip2--active",c)}),z([a.pipe(b(c=>c)),s]).subscribe(([c,l])=>{l.role==="dialog"?(e.setAttribute("aria-controls",n),e.setAttribute("aria-haspopup","dialog")):e.setAttribute("aria-describedby",n)}),a.pipe(b(c=>!c)).subscribe(()=>{e.removeAttribute("aria-controls"),e.removeAttribute("aria-describedby"),e.removeAttribute("aria-haspopup")}),ka(e).pipe(E(c=>i.next(c)),L(()=>i.complete()),m(c=>R({ref:e},c)))})}function lt(e,{viewport$:t},r=document.body){return $a(e,{content$:new F(o=>{let n=e.title,i=yn(n);return o.next(i),e.removeAttribute("title"),r.append(i),()=>{i.remove(),e.setAttribute("title",n)}}),viewport$:t})}function Pa(e,t){let r=C(()=>z([Zo(e),De(t)])).pipe(m(([{x:o,y:n},i])=>{let{width:a,height:s}=ce(e);return{x:o-i.x+a/2,y:n-i.y+s/2}}));return et(e).pipe(v(o=>r.pipe(m(n=>({active:o,offset:n})),Te(+!o||1/0))))}function Ln(e,t,{target$:r}){let[o,n]=Array.from(e.children);return C(()=>{let i=new g,a=i.pipe(X(),ne(!0));return i.subscribe({next({offset:s}){e.style.setProperty("--md-tooltip-x",`${s.x}px`),e.style.setProperty("--md-tooltip-y",`${s.y}px`)},complete(){e.style.removeProperty("--md-tooltip-x"),e.style.removeProperty("--md-tooltip-y")}}),tt(e).pipe(U(a)).subscribe(s=>{e.toggleAttribute("data-md-visible",s)}),S(i.pipe(b(({active:s})=>s)),i.pipe(_e(250),b(({active:s})=>!s))).subscribe({next({active:s}){s?e.prepend(o):o.remove()},complete(){e.prepend(o)}}),i.pipe(Le(16,me)).subscribe(({active:s})=>{o.classList.toggle("md-tooltip--active",s)}),i.pipe(ct(125,me),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:s})=>s)).subscribe({next(s){s?e.style.setProperty("--md-tooltip-0",`${-s}px`):e.style.removeProperty("--md-tooltip-0")},complete(){e.style.removeProperty("--md-tooltip-0")}}),d(n,"click").pipe(U(a),b(s=>!(s.metaKey||s.ctrlKey))).subscribe(s=>{s.stopPropagation(),s.preventDefault()}),d(n,"mousedown").pipe(U(a),ee(i)).subscribe(([s,{active:p}])=>{var c;if(s.button!==0||s.metaKey||s.ctrlKey)s.preventDefault();else if(p){s.preventDefault();let l=e.parentElement.closest(".md-annotation");l instanceof HTMLElement?l.focus():(c=Re())==null||c.blur()}}),r.pipe(U(a),b(s=>s===o),Ge(125)).subscribe(()=>e.focus()),Pa(e,t).pipe(E(s=>i.next(s)),L(()=>i.complete()),m(s=>R({ref:e},s)))})}function Ra(e){return e.tagName==="CODE"?$(".c, .c1, .cm",e):[e]}function Ia(e){let t=[];for(let r of Ra(e)){let o=[],n=document.createNodeIterator(r,NodeFilter.SHOW_TEXT);for(let i=n.nextNode();i;i=n.nextNode())o.push(i);for(let i of o){let a;for(;a=/(\(\d+\))(!)?/.exec(i.textContent);){let[,s,p]=a;if(typeof p=="undefined"){let c=i.splitText(a.index);i=c.splitText(s.length),t.push(c)}else{i.textContent=s,t.push(i);break}}}}return t}function _n(e,t){t.append(...Array.from(e.childNodes))}function fr(e,t,{target$:r,print$:o}){let n=t.closest("[id]"),i=n==null?void 0:n.id,a=new Map;for(let s of Ia(t)){let[,p]=s.textContent.match(/\((\d+)\)/);fe(`:scope > li:nth-child(${p})`,e)&&(a.set(p,En(p,i)),s.replaceWith(a.get(p)))}return a.size===0?O:C(()=>{let s=new g,p=s.pipe(X(),ne(!0)),c=[];for(let[l,f]of a)c.push([P(".md-typeset",f),P(`:scope > li:nth-child(${l})`,e)]);return o.pipe(U(p)).subscribe(l=>{e.hidden=!l,e.classList.toggle("md-annotation-list",l);for(let[f,u]of c)l?_n(f,u):_n(u,f)}),S(...[...a].map(([,l])=>Ln(l,t,{target$:r}))).pipe(L(()=>s.complete()),pe())})}function An(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return An(t)}}function Cn(e,t){return C(()=>{let r=An(e);return typeof r!="undefined"?fr(r,e,t):O})}var Hn=Vt(Yr());var Fa=0;function kn(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return kn(t)}}function ja(e){return ge(e).pipe(m(({width:t})=>({scrollable:Tt(e).width>t})),Z("scrollable"))}function $n(e,t){let{matches:r}=matchMedia("(hover)"),o=C(()=>{let n=new g,i=n.pipe(Fr(1));n.subscribe(({scrollable:c})=>{c&&r?e.setAttribute("tabindex","0"):e.removeAttribute("tabindex")});let a=[];if(Hn.default.isSupported()&&(e.closest(".copy")||B("content.code.copy")&&!e.closest(".no-copy"))){let c=e.closest("pre");c.id=`__code_${Fa++}`;let l=wn(c.id);c.insertBefore(l,e),B("content.tooltips")&&a.push(lt(l,{viewport$}))}let s=e.closest(".highlight");if(s instanceof HTMLElement){let c=kn(s);if(typeof c!="undefined"&&(s.classList.contains("annotate")||B("content.code.annotate"))){let l=fr(c,e,t);a.push(ge(s).pipe(U(i),m(({width:f,height:u})=>f&&u),K(),v(f=>f?l:O)))}}return $(":scope > span[id]",e).length&&e.classList.add("md-code__content"),ja(e).pipe(E(c=>n.next(c)),L(()=>n.complete()),m(c=>R({ref:e},c)),Pe(...a))});return B("content.lazy")?tt(e).pipe(b(n=>n),Te(1),v(()=>o)):o}function Wa(e,{target$:t,print$:r}){let o=!0;return S(t.pipe(m(n=>n.closest("details:not([open])")),b(n=>e===n),m(()=>({action:"open",reveal:!0}))),r.pipe(b(n=>n||!o),E(()=>o=e.open),m(n=>({action:n?"open":"close"}))))}function Pn(e,t){return C(()=>{let r=new g;return r.subscribe(({action:o,reveal:n})=>{e.toggleAttribute("open",o==="open"),n&&e.scrollIntoView()}),Wa(e,t).pipe(E(o=>r.next(o)),L(()=>r.complete()),m(o=>R({ref:e},o)))})}var Rn=".node circle,.node ellipse,.node path,.node polygon,.node rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}marker{fill:var(--md-mermaid-edge-color)!important}.edgeLabel .label rect{fill:#0000}.label{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.label foreignObject{line-height:normal;overflow:visible}.label div .edgeLabel{color:var(--md-mermaid-label-fg-color)}.edgeLabel,.edgeLabel rect,.label div .edgeLabel{background-color:var(--md-mermaid-label-bg-color)}.edgeLabel,.edgeLabel rect{fill:var(--md-mermaid-label-bg-color);color:var(--md-mermaid-edge-color)}.edgePath .path,.flowchart-link{stroke:var(--md-mermaid-edge-color);stroke-width:.05rem}.edgePath .arrowheadPath{fill:var(--md-mermaid-edge-color);stroke:none}.cluster rect{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}.cluster span{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}g #flowchart-circleEnd,g #flowchart-circleStart,g #flowchart-crossEnd,g #flowchart-crossStart,g #flowchart-pointEnd,g #flowchart-pointStart{stroke:none}g.classGroup line,g.classGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.classGroup text{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.classLabel .box{fill:var(--md-mermaid-label-bg-color);background-color:var(--md-mermaid-label-bg-color);opacity:1}.classLabel .label{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node .divider{stroke:var(--md-mermaid-node-fg-color)}.relation{stroke:var(--md-mermaid-edge-color)}.cardinality{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.cardinality text{fill:inherit!important}defs #classDiagram-compositionEnd,defs #classDiagram-compositionStart,defs #classDiagram-dependencyEnd,defs #classDiagram-dependencyStart,defs #classDiagram-extensionEnd,defs #classDiagram-extensionStart{fill:var(--md-mermaid-edge-color)!important;stroke:var(--md-mermaid-edge-color)!important}defs #classDiagram-aggregationEnd,defs #classDiagram-aggregationStart{fill:var(--md-mermaid-label-bg-color)!important;stroke:var(--md-mermaid-edge-color)!important}g.stateGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.stateGroup .state-title{fill:var(--md-mermaid-label-fg-color)!important;font-family:var(--md-mermaid-font-family)}g.stateGroup .composit{fill:var(--md-mermaid-label-bg-color)}.nodeLabel,.nodeLabel p{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}a .nodeLabel{text-decoration:underline}.node circle.state-end,.node circle.state-start,.start-state{fill:var(--md-mermaid-edge-color);stroke:none}.end-state-inner,.end-state-outer{fill:var(--md-mermaid-edge-color)}.end-state-inner,.node circle.state-end{stroke:var(--md-mermaid-label-bg-color)}.transition{stroke:var(--md-mermaid-edge-color)}[id^=state-fork] rect,[id^=state-join] rect{fill:var(--md-mermaid-edge-color)!important;stroke:none!important}.statediagram-cluster.statediagram-cluster .inner{fill:var(--md-default-bg-color)}.statediagram-cluster rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.statediagram-state rect.divider{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}defs #statediagram-barbEnd{stroke:var(--md-mermaid-edge-color)}.attributeBoxEven,.attributeBoxOdd{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityBox{fill:var(--md-mermaid-label-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityLabel{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.relationshipLabelBox{fill:var(--md-mermaid-label-bg-color);fill-opacity:1;background-color:var(--md-mermaid-label-bg-color);opacity:1}.relationshipLabel{fill:var(--md-mermaid-label-fg-color)}.relationshipLine{stroke:var(--md-mermaid-edge-color)}defs #ONE_OR_MORE_END *,defs #ONE_OR_MORE_START *,defs #ONLY_ONE_END *,defs #ONLY_ONE_START *,defs #ZERO_OR_MORE_END *,defs #ZERO_OR_MORE_START *,defs #ZERO_OR_ONE_END *,defs #ZERO_OR_ONE_START *{stroke:var(--md-mermaid-edge-color)!important}defs #ZERO_OR_MORE_END circle,defs #ZERO_OR_MORE_START circle{fill:var(--md-mermaid-label-bg-color)}.actor{fill:var(--md-mermaid-sequence-actor-bg-color);stroke:var(--md-mermaid-sequence-actor-border-color)}text.actor>tspan{fill:var(--md-mermaid-sequence-actor-fg-color);font-family:var(--md-mermaid-font-family)}line{stroke:var(--md-mermaid-sequence-actor-line-color)}.actor-man circle,.actor-man line{fill:var(--md-mermaid-sequence-actorman-bg-color);stroke:var(--md-mermaid-sequence-actorman-line-color)}.messageLine0,.messageLine1{stroke:var(--md-mermaid-sequence-message-line-color)}.note{fill:var(--md-mermaid-sequence-note-bg-color);stroke:var(--md-mermaid-sequence-note-border-color)}.loopText,.loopText>tspan,.messageText,.noteText>tspan{stroke:none;font-family:var(--md-mermaid-font-family)!important}.messageText{fill:var(--md-mermaid-sequence-message-fg-color)}.loopText,.loopText>tspan{fill:var(--md-mermaid-sequence-loop-fg-color)}.noteText>tspan{fill:var(--md-mermaid-sequence-note-fg-color)}#arrowhead path{fill:var(--md-mermaid-sequence-message-line-color);stroke:none}.loopLine{fill:var(--md-mermaid-sequence-loop-bg-color);stroke:var(--md-mermaid-sequence-loop-border-color)}.labelBox{fill:var(--md-mermaid-sequence-label-bg-color);stroke:none}.labelText,.labelText>span{fill:var(--md-mermaid-sequence-label-fg-color);font-family:var(--md-mermaid-font-family)}.sequenceNumber{fill:var(--md-mermaid-sequence-number-fg-color)}rect.rect{fill:var(--md-mermaid-sequence-box-bg-color);stroke:none}rect.rect+text.text{fill:var(--md-mermaid-sequence-box-fg-color)}defs #sequencenumber{fill:var(--md-mermaid-sequence-number-bg-color)!important}";var Br,Da=0;function Va(){return typeof mermaid=="undefined"||mermaid instanceof Element?wt("https://unpkg.com/mermaid@10/dist/mermaid.min.js"):I(void 0)}function In(e){return e.classList.remove("mermaid"),Br||(Br=Va().pipe(E(()=>mermaid.initialize({startOnLoad:!1,themeCSS:Rn,sequence:{actorFontSize:"16px",messageFontSize:"16px",noteFontSize:"16px"}})),m(()=>{}),G(1))),Br.subscribe(()=>ao(this,null,function*(){e.classList.add("mermaid");let t=`__mermaid_${Da++}`,r=x("div",{class:"mermaid"}),o=e.textContent,{svg:n,fn:i}=yield mermaid.render(t,o),a=r.attachShadow({mode:"closed"});a.innerHTML=n,e.replaceWith(r),i==null||i(a)})),Br.pipe(m(()=>({ref:e})))}var Fn=x("table");function jn(e){return e.replaceWith(Fn),Fn.replaceWith(On(e)),I({ref:e})}function Na(e){let t=e.find(r=>r.checked)||e[0];return S(...e.map(r=>d(r,"change").pipe(m(()=>P(`label[for="${r.id}"]`))))).pipe(Q(P(`label[for="${t.id}"]`)),m(r=>({active:r})))}function Wn(e,{viewport$:t,target$:r}){let o=P(".tabbed-labels",e),n=$(":scope > input",e),i=Qr("prev");e.append(i);let a=Qr("next");return e.append(a),C(()=>{let s=new g,p=s.pipe(X(),ne(!0));z([s,ge(e),tt(e)]).pipe(U(p),Le(1,me)).subscribe({next([{active:c},l]){let f=Ue(c),{width:u}=ce(c);e.style.setProperty("--md-indicator-x",`${f.x}px`),e.style.setProperty("--md-indicator-width",`${u}px`);let h=pr(o);(f.xh.x+l.width)&&o.scrollTo({left:Math.max(0,f.x-16),behavior:"smooth"})},complete(){e.style.removeProperty("--md-indicator-x"),e.style.removeProperty("--md-indicator-width")}}),z([De(o),ge(o)]).pipe(U(p)).subscribe(([c,l])=>{let f=Tt(o);i.hidden=c.x<16,a.hidden=c.x>f.width-l.width-16}),S(d(i,"click").pipe(m(()=>-1)),d(a,"click").pipe(m(()=>1))).pipe(U(p)).subscribe(c=>{let{width:l}=ce(o);o.scrollBy({left:l*c,behavior:"smooth"})}),r.pipe(U(p),b(c=>n.includes(c))).subscribe(c=>c.click()),o.classList.add("tabbed-labels--linked");for(let c of n){let l=P(`label[for="${c.id}"]`);l.replaceChildren(x("a",{href:`#${l.htmlFor}`,tabIndex:-1},...Array.from(l.childNodes))),d(l.firstElementChild,"click").pipe(U(p),b(f=>!(f.metaKey||f.ctrlKey)),E(f=>{f.preventDefault(),f.stopPropagation()})).subscribe(()=>{history.replaceState({},"",`#${l.htmlFor}`),l.click()})}return B("content.tabs.link")&&s.pipe(Ce(1),ee(t)).subscribe(([{active:c},{offset:l}])=>{let f=c.innerText.trim();if(c.hasAttribute("data-md-switching"))c.removeAttribute("data-md-switching");else{let u=e.offsetTop-l.y;for(let w of $("[data-tabs]"))for(let A of $(":scope > input",w)){let te=P(`label[for="${A.id}"]`);if(te!==c&&te.innerText.trim()===f){te.setAttribute("data-md-switching",""),A.click();break}}window.scrollTo({top:e.offsetTop-u});let h=__md_get("__tabs")||[];__md_set("__tabs",[...new Set([f,...h])])}}),s.pipe(U(p)).subscribe(()=>{for(let c of $("audio, video",e))c.pause()}),Na(n).pipe(E(c=>s.next(c)),L(()=>s.complete()),m(c=>R({ref:e},c)))}).pipe(Qe(se))}function Un(e,{viewport$:t,target$:r,print$:o}){return S(...$(".annotate:not(.highlight)",e).map(n=>Cn(n,{target$:r,print$:o})),...$("pre:not(.mermaid) > code",e).map(n=>$n(n,{target$:r,print$:o})),...$("pre.mermaid",e).map(n=>In(n)),...$("table:not([class])",e).map(n=>jn(n)),...$("details",e).map(n=>Pn(n,{target$:r,print$:o})),...$("[data-tabs]",e).map(n=>Wn(n,{viewport$:t,target$:r})),...$("[title]",e).filter(()=>B("content.tooltips")).map(n=>lt(n,{viewport$:t})))}function za(e,{alert$:t}){return t.pipe(v(r=>S(I(!0),I(!1).pipe(Ge(2e3))).pipe(m(o=>({message:r,active:o})))))}function Dn(e,t){let r=P(".md-typeset",e);return C(()=>{let o=new g;return o.subscribe(({message:n,active:i})=>{e.classList.toggle("md-dialog--active",i),r.textContent=n}),za(e,t).pipe(E(n=>o.next(n)),L(()=>o.complete()),m(n=>R({ref:e},n)))})}var qa=0;function Qa(e,t){document.body.append(e);let{width:r}=ce(e);e.style.setProperty("--md-tooltip-width",`${r}px`),e.remove();let o=cr(t),n=typeof o!="undefined"?De(o):I({x:0,y:0}),i=S(et(t),kt(t)).pipe(K());return z([i,n]).pipe(m(([a,s])=>{let{x:p,y:c}=Ue(t),l=ce(t),f=t.closest("table");return f&&t.parentElement&&(p+=f.offsetLeft+t.parentElement.offsetLeft,c+=f.offsetTop+t.parentElement.offsetTop),{active:a,offset:{x:p-s.x+l.width/2-r/2,y:c-s.y+l.height+8}}}))}function Vn(e){let t=e.title;if(!t.length)return O;let r=`__tooltip_${qa++}`,o=Pt(r,"inline"),n=P(".md-typeset",o);return n.innerHTML=t,C(()=>{let i=new g;return i.subscribe({next({offset:a}){o.style.setProperty("--md-tooltip-x",`${a.x}px`),o.style.setProperty("--md-tooltip-y",`${a.y}px`)},complete(){o.style.removeProperty("--md-tooltip-x"),o.style.removeProperty("--md-tooltip-y")}}),S(i.pipe(b(({active:a})=>a)),i.pipe(_e(250),b(({active:a})=>!a))).subscribe({next({active:a}){a?(e.insertAdjacentElement("afterend",o),e.setAttribute("aria-describedby",r),e.removeAttribute("title")):(o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t))},complete(){o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t)}}),i.pipe(Le(16,me)).subscribe(({active:a})=>{o.classList.toggle("md-tooltip--active",a)}),i.pipe(ct(125,me),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:a})=>a)).subscribe({next(a){a?o.style.setProperty("--md-tooltip-0",`${-a}px`):o.style.removeProperty("--md-tooltip-0")},complete(){o.style.removeProperty("--md-tooltip-0")}}),Qa(o,e).pipe(E(a=>i.next(a)),L(()=>i.complete()),m(a=>R({ref:e},a)))}).pipe(Qe(se))}function Ka({viewport$:e}){if(!B("header.autohide"))return I(!1);let t=e.pipe(m(({offset:{y:n}})=>n),Ye(2,1),m(([n,i])=>[nMath.abs(i-n.y)>100),m(([,[n]])=>n),K()),o=Ve("search");return z([e,o]).pipe(m(([{offset:n},i])=>n.y>400&&!i),K(),v(n=>n?r:I(!1)),Q(!1))}function Nn(e,t){return C(()=>z([ge(e),Ka(t)])).pipe(m(([{height:r},o])=>({height:r,hidden:o})),K((r,o)=>r.height===o.height&&r.hidden===o.hidden),G(1))}function zn(e,{header$:t,main$:r}){return C(()=>{let o=new g,n=o.pipe(X(),ne(!0));o.pipe(Z("active"),We(t)).subscribe(([{active:a},{hidden:s}])=>{e.classList.toggle("md-header--shadow",a&&!s),e.hidden=s});let i=ue($("[title]",e)).pipe(b(()=>B("content.tooltips")),oe(a=>Vn(a)));return r.subscribe(o),t.pipe(U(n),m(a=>R({ref:e},a)),Pe(i.pipe(U(n))))})}function Ya(e,{viewport$:t,header$:r}){return mr(e,{viewport$:t,header$:r}).pipe(m(({offset:{y:o}})=>{let{height:n}=ce(e);return{active:o>=n}}),Z("active"))}function qn(e,t){return C(()=>{let r=new g;r.subscribe({next({active:n}){e.classList.toggle("md-header__title--active",n)},complete(){e.classList.remove("md-header__title--active")}});let o=fe(".md-content h1");return typeof o=="undefined"?O:Ya(o,t).pipe(E(n=>r.next(n)),L(()=>r.complete()),m(n=>R({ref:e},n)))})}function Qn(e,{viewport$:t,header$:r}){let o=r.pipe(m(({height:i})=>i),K()),n=o.pipe(v(()=>ge(e).pipe(m(({height:i})=>({top:e.offsetTop,bottom:e.offsetTop+i})),Z("bottom"))));return z([o,n,t]).pipe(m(([i,{top:a,bottom:s},{offset:{y:p},size:{height:c}}])=>(c=Math.max(0,c-Math.max(0,a-p,i)-Math.max(0,c+p-s)),{offset:a-i,height:c,active:a-i<=p})),K((i,a)=>i.offset===a.offset&&i.height===a.height&&i.active===a.active))}function Ba(e){let t=__md_get("__palette")||{index:e.findIndex(o=>matchMedia(o.getAttribute("data-md-color-media")).matches)},r=Math.max(0,Math.min(t.index,e.length-1));return I(...e).pipe(oe(o=>d(o,"change").pipe(m(()=>o))),Q(e[r]),m(o=>({index:e.indexOf(o),color:{media:o.getAttribute("data-md-color-media"),scheme:o.getAttribute("data-md-color-scheme"),primary:o.getAttribute("data-md-color-primary"),accent:o.getAttribute("data-md-color-accent")}})),G(1))}function Kn(e){let t=$("input",e),r=x("meta",{name:"theme-color"});document.head.appendChild(r);let o=x("meta",{name:"color-scheme"});document.head.appendChild(o);let n=$t("(prefers-color-scheme: light)");return C(()=>{let i=new g;return i.subscribe(a=>{if(document.body.setAttribute("data-md-color-switching",""),a.color.media==="(prefers-color-scheme)"){let s=matchMedia("(prefers-color-scheme: light)"),p=document.querySelector(s.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");a.color.scheme=p.getAttribute("data-md-color-scheme"),a.color.primary=p.getAttribute("data-md-color-primary"),a.color.accent=p.getAttribute("data-md-color-accent")}for(let[s,p]of Object.entries(a.color))document.body.setAttribute(`data-md-color-${s}`,p);for(let s=0;sa.key==="Enter"),ee(i,(a,s)=>s)).subscribe(({index:a})=>{a=(a+1)%t.length,t[a].click(),t[a].focus()}),i.pipe(m(()=>{let a=Se("header"),s=window.getComputedStyle(a);return o.content=s.colorScheme,s.backgroundColor.match(/\d+/g).map(p=>(+p).toString(16).padStart(2,"0")).join("")})).subscribe(a=>r.content=`#${a}`),i.pipe(be(se)).subscribe(()=>{document.body.removeAttribute("data-md-color-switching")}),Ba(t).pipe(U(n.pipe(Ce(1))),st(),E(a=>i.next(a)),L(()=>i.complete()),m(a=>R({ref:e},a)))})}function Yn(e,{progress$:t}){return C(()=>{let r=new g;return r.subscribe(({value:o})=>{e.style.setProperty("--md-progress-value",`${o}`)}),t.pipe(E(o=>r.next({value:o})),L(()=>r.complete()),m(o=>({ref:e,value:o})))})}var Gr=Vt(Yr());function Ga(e){e.setAttribute("data-md-copying","");let t=e.closest("[data-copy]"),r=t?t.getAttribute("data-copy"):e.innerText;return e.removeAttribute("data-md-copying"),r.trimEnd()}function Bn({alert$:e}){Gr.default.isSupported()&&new F(t=>{new Gr.default("[data-clipboard-target], [data-clipboard-text]",{text:r=>r.getAttribute("data-clipboard-text")||Ga(P(r.getAttribute("data-clipboard-target")))}).on("success",r=>t.next(r))}).pipe(E(t=>{t.trigger.focus()}),m(()=>Ee("clipboard.copied"))).subscribe(e)}function Gn(e,t){return e.protocol=t.protocol,e.hostname=t.hostname,e}function Ja(e,t){let r=new Map;for(let o of $("url",e)){let n=P("loc",o),i=[Gn(new URL(n.textContent),t)];r.set(`${i[0]}`,i);for(let a of $("[rel=alternate]",o)){let s=a.getAttribute("href");s!=null&&i.push(Gn(new URL(s),t))}}return r}function ur(e){return mn(new URL("sitemap.xml",e)).pipe(m(t=>Ja(t,new URL(e))),ve(()=>I(new Map)))}function Xa(e,t){if(!(e.target instanceof Element))return O;let r=e.target.closest("a");if(r===null)return O;if(r.target||e.metaKey||e.ctrlKey)return O;let o=new URL(r.href);return o.search=o.hash="",t.has(`${o}`)?(e.preventDefault(),I(new URL(r.href))):O}function Jn(e){let t=new Map;for(let r of $(":scope > *",e.head))t.set(r.outerHTML,r);return t}function Xn(e){for(let t of $("[href], [src]",e))for(let r of["href","src"]){let o=t.getAttribute(r);if(o&&!/^(?:[a-z]+:)?\/\//i.test(o)){t[r]=t[r];break}}return I(e)}function Za(e){for(let o of["[data-md-component=announce]","[data-md-component=container]","[data-md-component=header-topic]","[data-md-component=outdated]","[data-md-component=logo]","[data-md-component=skip]",...B("navigation.tabs.sticky")?["[data-md-component=tabs]"]:[]]){let n=fe(o),i=fe(o,e);typeof n!="undefined"&&typeof i!="undefined"&&n.replaceWith(i)}let t=Jn(document);for(let[o,n]of Jn(e))t.has(o)?t.delete(o):document.head.appendChild(n);for(let o of t.values()){let n=o.getAttribute("name");n!=="theme-color"&&n!=="color-scheme"&&o.remove()}let r=Se("container");return je($("script",r)).pipe(v(o=>{let n=e.createElement("script");if(o.src){for(let i of o.getAttributeNames())n.setAttribute(i,o.getAttribute(i));return o.replaceWith(n),new F(i=>{n.onload=()=>i.complete()})}else return n.textContent=o.textContent,o.replaceWith(n),O}),X(),ne(document))}function Zn({location$:e,viewport$:t,progress$:r}){let o=ye();if(location.protocol==="file:")return O;let n=ur(o.base);I(document).subscribe(Xn);let i=d(document.body,"click").pipe(We(n),v(([p,c])=>Xa(p,c)),pe()),a=d(window,"popstate").pipe(m(xe),pe());i.pipe(ee(t)).subscribe(([p,{offset:c}])=>{history.replaceState(c,""),history.pushState(null,"",p)}),S(i,a).subscribe(e);let s=e.pipe(Z("pathname"),v(p=>ln(p,{progress$:r}).pipe(ve(()=>(pt(p,!0),O)))),v(Xn),v(Za),pe());return S(s.pipe(ee(e,(p,c)=>c)),s.pipe(v(()=>e),Z("pathname"),v(()=>e),Z("hash")),e.pipe(K((p,c)=>p.pathname===c.pathname&&p.hash===c.hash),v(()=>i),E(()=>history.back()))).subscribe(p=>{var c,l;history.state!==null||!p.hash?window.scrollTo(0,(l=(c=history.state)==null?void 0:c.y)!=null?l:0):(history.scrollRestoration="auto",sn(p.hash),history.scrollRestoration="manual")}),e.subscribe(()=>{history.scrollRestoration="manual"}),d(window,"beforeunload").subscribe(()=>{history.scrollRestoration="auto"}),t.pipe(Z("offset"),_e(100)).subscribe(({offset:p})=>{history.replaceState(p,"")}),s}var ri=Vt(ti());function oi(e){let t=e.separator.split("|").map(n=>n.replace(/(\(\?[!=<][^)]+\))/g,"").length===0?"\uFFFD":n).join("|"),r=new RegExp(t,"img"),o=(n,i,a)=>`${i}${a}`;return n=>{n=n.replace(/[\s*+\-:~^]+/g," ").trim();let i=new RegExp(`(^|${e.separator}|)(${n.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&").replace(r,"|")})`,"img");return a=>(0,ri.default)(a).replace(i,o).replace(/<\/mark>(\s+)]*>/img,"$1")}}function It(e){return e.type===1}function dr(e){return e.type===3}function ni(e,t){let r=vn(e);return S(I(location.protocol!=="file:"),Ve("search")).pipe(Ae(o=>o),v(()=>t)).subscribe(({config:o,docs:n})=>r.next({type:0,data:{config:o,docs:n,options:{suggest:B("search.suggest")}}})),r}function ii({document$:e}){let t=ye(),r=Ne(new URL("../versions.json",t.base)).pipe(ve(()=>O)),o=r.pipe(m(n=>{let[,i]=t.base.match(/([^/]+)\/?$/);return n.find(({version:a,aliases:s})=>a===i||s.includes(i))||n[0]}));r.pipe(m(n=>new Map(n.map(i=>[`${new URL(`../${i.version}/`,t.base)}`,i]))),v(n=>d(document.body,"click").pipe(b(i=>!i.metaKey&&!i.ctrlKey),ee(o),v(([i,a])=>{if(i.target instanceof Element){let s=i.target.closest("a");if(s&&!s.target&&n.has(s.href)){let p=s.href;return!i.target.closest(".md-version")&&n.get(p)===a?O:(i.preventDefault(),I(p))}}return O}),v(i=>ur(new URL(i)).pipe(m(a=>{let p=xe().href.replace(t.base,i);return a.has(p.split("#")[0])?new URL(p):new URL(i)})))))).subscribe(n=>pt(n,!0)),z([r,o]).subscribe(([n,i])=>{P(".md-header__topic").appendChild(Mn(n,i))}),e.pipe(v(()=>o)).subscribe(n=>{var a;let i=__md_get("__outdated",sessionStorage);if(i===null){i=!0;let s=((a=t.version)==null?void 0:a.default)||"latest";Array.isArray(s)||(s=[s]);e:for(let p of s)for(let c of n.aliases.concat(n.version))if(new RegExp(p,"i").test(c)){i=!1;break e}__md_set("__outdated",i,sessionStorage)}if(i)for(let s of ae("outdated"))s.hidden=!1})}function ns(e,{worker$:t}){let{searchParams:r}=xe();r.has("q")&&(Je("search",!0),e.value=r.get("q"),e.focus(),Ve("search").pipe(Ae(i=>!i)).subscribe(()=>{let i=xe();i.searchParams.delete("q"),history.replaceState({},"",`${i}`)}));let o=et(e),n=S(t.pipe(Ae(It)),d(e,"keyup"),o).pipe(m(()=>e.value),K());return z([n,o]).pipe(m(([i,a])=>({value:i,focus:a})),G(1))}function ai(e,{worker$:t}){let r=new g,o=r.pipe(X(),ne(!0));z([t.pipe(Ae(It)),r],(i,a)=>a).pipe(Z("value")).subscribe(({value:i})=>t.next({type:2,data:i})),r.pipe(Z("focus")).subscribe(({focus:i})=>{i&&Je("search",i)}),d(e.form,"reset").pipe(U(o)).subscribe(()=>e.focus());let n=P("header [for=__search]");return d(n,"click").subscribe(()=>e.focus()),ns(e,{worker$:t}).pipe(E(i=>r.next(i)),L(()=>r.complete()),m(i=>R({ref:e},i)),G(1))}function si(e,{worker$:t,query$:r}){let o=new g,n=tn(e.parentElement).pipe(b(Boolean)),i=e.parentElement,a=P(":scope > :first-child",e),s=P(":scope > :last-child",e);Ve("search").subscribe(l=>s.setAttribute("role",l?"list":"presentation")),o.pipe(ee(r),Ur(t.pipe(Ae(It)))).subscribe(([{items:l},{value:f}])=>{switch(l.length){case 0:a.textContent=f.length?Ee("search.result.none"):Ee("search.result.placeholder");break;case 1:a.textContent=Ee("search.result.one");break;default:let u=sr(l.length);a.textContent=Ee("search.result.other",u)}});let p=o.pipe(E(()=>s.innerHTML=""),v(({items:l})=>S(I(...l.slice(0,10)),I(...l.slice(10)).pipe(Ye(4),Vr(n),v(([f])=>f)))),m(Tn),pe());return p.subscribe(l=>s.appendChild(l)),p.pipe(oe(l=>{let f=fe("details",l);return typeof f=="undefined"?O:d(f,"toggle").pipe(U(o),m(()=>f))})).subscribe(l=>{l.open===!1&&l.offsetTop<=i.scrollTop&&i.scrollTo({top:l.offsetTop})}),t.pipe(b(dr),m(({data:l})=>l)).pipe(E(l=>o.next(l)),L(()=>o.complete()),m(l=>R({ref:e},l)))}function is(e,{query$:t}){return t.pipe(m(({value:r})=>{let o=xe();return o.hash="",r=r.replace(/\s+/g,"+").replace(/&/g,"%26").replace(/=/g,"%3D"),o.search=`q=${r}`,{url:o}}))}function ci(e,t){let r=new g,o=r.pipe(X(),ne(!0));return r.subscribe(({url:n})=>{e.setAttribute("data-clipboard-text",e.href),e.href=`${n}`}),d(e,"click").pipe(U(o)).subscribe(n=>n.preventDefault()),is(e,t).pipe(E(n=>r.next(n)),L(()=>r.complete()),m(n=>R({ref:e},n)))}function pi(e,{worker$:t,keyboard$:r}){let o=new g,n=Se("search-query"),i=S(d(n,"keydown"),d(n,"focus")).pipe(be(se),m(()=>n.value),K());return o.pipe(We(i),m(([{suggest:s},p])=>{let c=p.split(/([\s-]+)/);if(s!=null&&s.length&&c[c.length-1]){let l=s[s.length-1];l.startsWith(c[c.length-1])&&(c[c.length-1]=l)}else c.length=0;return c})).subscribe(s=>e.innerHTML=s.join("").replace(/\s/g," ")),r.pipe(b(({mode:s})=>s==="search")).subscribe(s=>{switch(s.type){case"ArrowRight":e.innerText.length&&n.selectionStart===n.value.length&&(n.value=e.innerText);break}}),t.pipe(b(dr),m(({data:s})=>s)).pipe(E(s=>o.next(s)),L(()=>o.complete()),m(()=>({ref:e})))}function li(e,{index$:t,keyboard$:r}){let o=ye();try{let n=ni(o.search,t),i=Se("search-query",e),a=Se("search-result",e);d(e,"click").pipe(b(({target:p})=>p instanceof Element&&!!p.closest("a"))).subscribe(()=>Je("search",!1)),r.pipe(b(({mode:p})=>p==="search")).subscribe(p=>{let c=Re();switch(p.type){case"Enter":if(c===i){let l=new Map;for(let f of $(":first-child [href]",a)){let u=f.firstElementChild;l.set(f,parseFloat(u.getAttribute("data-md-score")))}if(l.size){let[[f]]=[...l].sort(([,u],[,h])=>h-u);f.click()}p.claim()}break;case"Escape":case"Tab":Je("search",!1),i.blur();break;case"ArrowUp":case"ArrowDown":if(typeof c=="undefined")i.focus();else{let l=[i,...$(":not(details) > [href], summary, details[open] [href]",a)],f=Math.max(0,(Math.max(0,l.indexOf(c))+l.length+(p.type==="ArrowUp"?-1:1))%l.length);l[f].focus()}p.claim();break;default:i!==Re()&&i.focus()}}),r.pipe(b(({mode:p})=>p==="global")).subscribe(p=>{switch(p.type){case"f":case"s":case"/":i.focus(),i.select(),p.claim();break}});let s=ai(i,{worker$:n});return S(s,si(a,{worker$:n,query$:s})).pipe(Pe(...ae("search-share",e).map(p=>ci(p,{query$:s})),...ae("search-suggest",e).map(p=>pi(p,{worker$:n,keyboard$:r}))))}catch(n){return e.hidden=!0,Ke}}function mi(e,{index$:t,location$:r}){return z([t,r.pipe(Q(xe()),b(o=>!!o.searchParams.get("h")))]).pipe(m(([o,n])=>oi(o.config)(n.searchParams.get("h"))),m(o=>{var a;let n=new Map,i=document.createNodeIterator(e,NodeFilter.SHOW_TEXT);for(let s=i.nextNode();s;s=i.nextNode())if((a=s.parentElement)!=null&&a.offsetHeight){let p=s.textContent,c=o(p);c.length>p.length&&n.set(s,c)}for(let[s,p]of n){let{childNodes:c}=x("span",null,p);s.replaceWith(...Array.from(c))}return{ref:e,nodes:n}}))}function as(e,{viewport$:t,main$:r}){let o=e.closest(".md-grid"),n=o.offsetTop-o.parentElement.offsetTop;return z([r,t]).pipe(m(([{offset:i,height:a},{offset:{y:s}}])=>(a=a+Math.min(n,Math.max(0,s-i))-n,{height:a,locked:s>=i+n})),K((i,a)=>i.height===a.height&&i.locked===a.locked))}function Jr(e,o){var n=o,{header$:t}=n,r=io(n,["header$"]);let i=P(".md-sidebar__scrollwrap",e),{y:a}=Ue(i);return C(()=>{let s=new g,p=s.pipe(X(),ne(!0)),c=s.pipe(Le(0,me));return c.pipe(ee(t)).subscribe({next([{height:l},{height:f}]){i.style.height=`${l-2*a}px`,e.style.top=`${f}px`},complete(){i.style.height="",e.style.top=""}}),c.pipe(Ae()).subscribe(()=>{for(let l of $(".md-nav__link--active[href]",e)){if(!l.clientHeight)continue;let f=l.closest(".md-sidebar__scrollwrap");if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:h}=ce(f);f.scrollTo({top:u-h/2})}}}),ue($("label[tabindex]",e)).pipe(oe(l=>d(l,"click").pipe(be(se),m(()=>l),U(p)))).subscribe(l=>{let f=P(`[id="${l.htmlFor}"]`);P(`[aria-labelledby="${l.id}"]`).setAttribute("aria-expanded",`${f.checked}`)}),as(e,r).pipe(E(l=>s.next(l)),L(()=>s.complete()),m(l=>R({ref:e},l)))})}function fi(e,t){if(typeof t!="undefined"){let r=`https://api.github.com/repos/${e}/${t}`;return Ct(Ne(`${r}/releases/latest`).pipe(ve(()=>O),m(o=>({version:o.tag_name})),Be({})),Ne(r).pipe(ve(()=>O),m(o=>({stars:o.stargazers_count,forks:o.forks_count})),Be({}))).pipe(m(([o,n])=>R(R({},o),n)))}else{let r=`https://api.github.com/users/${e}`;return Ne(r).pipe(m(o=>({repositories:o.public_repos})),Be({}))}}function ui(e,t){let r=`https://${e}/api/v4/projects/${encodeURIComponent(t)}`;return Ne(r).pipe(ve(()=>O),m(({star_count:o,forks_count:n})=>({stars:o,forks:n})),Be({}))}function di(e){let t=e.match(/^.+github\.com\/([^/]+)\/?([^/]+)?/i);if(t){let[,r,o]=t;return fi(r,o)}if(t=e.match(/^.+?([^/]*gitlab[^/]+)\/(.+?)\/?$/i),t){let[,r,o]=t;return ui(r,o)}return O}var ss;function cs(e){return ss||(ss=C(()=>{let t=__md_get("__source",sessionStorage);if(t)return I(t);if(ae("consent").length){let o=__md_get("__consent");if(!(o&&o.github))return O}return di(e.href).pipe(E(o=>__md_set("__source",o,sessionStorage)))}).pipe(ve(()=>O),b(t=>Object.keys(t).length>0),m(t=>({facts:t})),G(1)))}function hi(e){let t=P(":scope > :last-child",e);return C(()=>{let r=new g;return r.subscribe(({facts:o})=>{t.appendChild(Sn(o)),t.classList.add("md-source__repository--active")}),cs(e).pipe(E(o=>r.next(o)),L(()=>r.complete()),m(o=>R({ref:e},o)))})}function ps(e,{viewport$:t,header$:r}){return ge(document.body).pipe(v(()=>mr(e,{header$:r,viewport$:t})),m(({offset:{y:o}})=>({hidden:o>=10})),Z("hidden"))}function bi(e,t){return C(()=>{let r=new g;return r.subscribe({next({hidden:o}){e.hidden=o},complete(){e.hidden=!1}}),(B("navigation.tabs.sticky")?I({hidden:!1}):ps(e,t)).pipe(E(o=>r.next(o)),L(()=>r.complete()),m(o=>R({ref:e},o)))})}function ls(e,{viewport$:t,header$:r}){let o=new Map,n=$(".md-nav__link",e);for(let s of n){let p=decodeURIComponent(s.hash.substring(1)),c=fe(`[id="${p}"]`);typeof c!="undefined"&&o.set(s,c)}let i=r.pipe(Z("height"),m(({height:s})=>{let p=Se("main"),c=P(":scope > :first-child",p);return s+.8*(c.offsetTop-p.offsetTop)}),pe());return ge(document.body).pipe(Z("height"),v(s=>C(()=>{let p=[];return I([...o].reduce((c,[l,f])=>{for(;p.length&&o.get(p[p.length-1]).tagName>=f.tagName;)p.pop();let u=f.offsetTop;for(;!u&&f.parentElement;)f=f.parentElement,u=f.offsetTop;let h=f.offsetParent;for(;h;h=h.offsetParent)u+=h.offsetTop;return c.set([...p=[...p,l]].reverse(),u)},new Map))}).pipe(m(p=>new Map([...p].sort(([,c],[,l])=>c-l))),We(i),v(([p,c])=>t.pipe(jr(([l,f],{offset:{y:u},size:h})=>{let w=u+h.height>=Math.floor(s.height);for(;f.length;){let[,A]=f[0];if(A-c=u&&!w)f=[l.pop(),...f];else break}return[l,f]},[[],[...p]]),K((l,f)=>l[0]===f[0]&&l[1]===f[1])))))).pipe(m(([s,p])=>({prev:s.map(([c])=>c),next:p.map(([c])=>c)})),Q({prev:[],next:[]}),Ye(2,1),m(([s,p])=>s.prev.length{let i=new g,a=i.pipe(X(),ne(!0));if(i.subscribe(({prev:s,next:p})=>{for(let[c]of p)c.classList.remove("md-nav__link--passed"),c.classList.remove("md-nav__link--active");for(let[c,[l]]of s.entries())l.classList.add("md-nav__link--passed"),l.classList.toggle("md-nav__link--active",c===s.length-1)}),B("toc.follow")){let s=S(t.pipe(_e(1),m(()=>{})),t.pipe(_e(250),m(()=>"smooth")));i.pipe(b(({prev:p})=>p.length>0),We(o.pipe(be(se))),ee(s)).subscribe(([[{prev:p}],c])=>{let[l]=p[p.length-1];if(l.offsetHeight){let f=cr(l);if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:h}=ce(f);f.scrollTo({top:u-h/2,behavior:c})}}})}return B("navigation.tracking")&&t.pipe(U(a),Z("offset"),_e(250),Ce(1),U(n.pipe(Ce(1))),st({delay:250}),ee(i)).subscribe(([,{prev:s}])=>{let p=xe(),c=s[s.length-1];if(c&&c.length){let[l]=c,{hash:f}=new URL(l.href);p.hash!==f&&(p.hash=f,history.replaceState({},"",`${p}`))}else p.hash="",history.replaceState({},"",`${p}`)}),ls(e,{viewport$:t,header$:r}).pipe(E(s=>i.next(s)),L(()=>i.complete()),m(s=>R({ref:e},s)))})}function ms(e,{viewport$:t,main$:r,target$:o}){let n=t.pipe(m(({offset:{y:a}})=>a),Ye(2,1),m(([a,s])=>a>s&&s>0),K()),i=r.pipe(m(({active:a})=>a));return z([i,n]).pipe(m(([a,s])=>!(a&&s)),K(),U(o.pipe(Ce(1))),ne(!0),st({delay:250}),m(a=>({hidden:a})))}function gi(e,{viewport$:t,header$:r,main$:o,target$:n}){let i=new g,a=i.pipe(X(),ne(!0));return i.subscribe({next({hidden:s}){e.hidden=s,s?(e.setAttribute("tabindex","-1"),e.blur()):e.removeAttribute("tabindex")},complete(){e.style.top="",e.hidden=!0,e.removeAttribute("tabindex")}}),r.pipe(U(a),Z("height")).subscribe(({height:s})=>{e.style.top=`${s+16}px`}),d(e,"click").subscribe(s=>{s.preventDefault(),window.scrollTo({top:0})}),ms(e,{viewport$:t,main$:o,target$:n}).pipe(E(s=>i.next(s)),L(()=>i.complete()),m(s=>R({ref:e},s)))}function xi({document$:e,viewport$:t}){e.pipe(v(()=>$(".md-ellipsis")),oe(r=>tt(r).pipe(U(e.pipe(Ce(1))),b(o=>o),m(()=>r),Te(1))),b(r=>r.offsetWidth{let o=r.innerText,n=r.closest("a")||r;return n.title=o,B("content.tooltips")?lt(n,{viewport$:t}).pipe(U(e.pipe(Ce(1))),L(()=>n.removeAttribute("title"))):O})).subscribe(),B("content.tooltips")&&e.pipe(v(()=>$(".md-status")),oe(r=>lt(r,{viewport$:t}))).subscribe()}function yi({document$:e,tablet$:t}){e.pipe(v(()=>$(".md-toggle--indeterminate")),E(r=>{r.indeterminate=!0,r.checked=!1}),oe(r=>d(r,"change").pipe(Dr(()=>r.classList.contains("md-toggle--indeterminate")),m(()=>r))),ee(t)).subscribe(([r,o])=>{r.classList.remove("md-toggle--indeterminate"),o&&(r.checked=!1)})}function fs(){return/(iPad|iPhone|iPod)/.test(navigator.userAgent)}function Ei({document$:e}){e.pipe(v(()=>$("[data-md-scrollfix]")),E(t=>t.removeAttribute("data-md-scrollfix")),b(fs),oe(t=>d(t,"touchstart").pipe(m(()=>t)))).subscribe(t=>{let r=t.scrollTop;r===0?t.scrollTop=1:r+t.offsetHeight===t.scrollHeight&&(t.scrollTop=r-1)})}function wi({viewport$:e,tablet$:t}){z([Ve("search"),t]).pipe(m(([r,o])=>r&&!o),v(r=>I(r).pipe(Ge(r?400:100))),ee(e)).subscribe(([r,{offset:{y:o}}])=>{if(r)document.body.setAttribute("data-md-scrolllock",""),document.body.style.top=`-${o}px`;else{let n=-1*parseInt(document.body.style.top,10);document.body.removeAttribute("data-md-scrolllock"),document.body.style.top="",n&&window.scrollTo(0,n)}})}Object.entries||(Object.entries=function(e){let t=[];for(let r of Object.keys(e))t.push([r,e[r]]);return t});Object.values||(Object.values=function(e){let t=[];for(let r of Object.keys(e))t.push(e[r]);return t});typeof Element!="undefined"&&(Element.prototype.scrollTo||(Element.prototype.scrollTo=function(e,t){typeof e=="object"?(this.scrollLeft=e.left,this.scrollTop=e.top):(this.scrollLeft=e,this.scrollTop=t)}),Element.prototype.replaceWith||(Element.prototype.replaceWith=function(...e){let t=this.parentNode;if(t){e.length===0&&t.removeChild(this);for(let r=e.length-1;r>=0;r--){let o=e[r];typeof o=="string"?o=document.createTextNode(o):o.parentNode&&o.parentNode.removeChild(o),r?t.insertBefore(this.previousSibling,o):t.replaceChild(o,this)}}}));function us(){return location.protocol==="file:"?wt(`${new URL("search/search_index.js",Xr.base)}`).pipe(m(()=>__index),G(1)):Ne(new URL("search/search_index.json",Xr.base))}document.documentElement.classList.remove("no-js");document.documentElement.classList.add("js");var ot=Yo(),jt=nn(),Ot=cn(jt),Zr=on(),Oe=bn(),hr=$t("(min-width: 960px)"),Si=$t("(min-width: 1220px)"),Oi=pn(),Xr=ye(),Mi=document.forms.namedItem("search")?us():Ke,eo=new g;Bn({alert$:eo});var to=new g;B("navigation.instant")&&Zn({location$:jt,viewport$:Oe,progress$:to}).subscribe(ot);var Ti;((Ti=Xr.version)==null?void 0:Ti.provider)==="mike"&&ii({document$:ot});S(jt,Ot).pipe(Ge(125)).subscribe(()=>{Je("drawer",!1),Je("search",!1)});Zr.pipe(b(({mode:e})=>e==="global")).subscribe(e=>{switch(e.type){case"p":case",":let t=fe("link[rel=prev]");typeof t!="undefined"&&pt(t);break;case"n":case".":let r=fe("link[rel=next]");typeof r!="undefined"&&pt(r);break;case"Enter":let o=Re();o instanceof HTMLLabelElement&&o.click()}});xi({viewport$:Oe,document$:ot});yi({document$:ot,tablet$:hr});Ei({document$:ot});wi({viewport$:Oe,tablet$:hr});var rt=Nn(Se("header"),{viewport$:Oe}),Ft=ot.pipe(m(()=>Se("main")),v(e=>Qn(e,{viewport$:Oe,header$:rt})),G(1)),ds=S(...ae("consent").map(e=>xn(e,{target$:Ot})),...ae("dialog").map(e=>Dn(e,{alert$:eo})),...ae("header").map(e=>zn(e,{viewport$:Oe,header$:rt,main$:Ft})),...ae("palette").map(e=>Kn(e)),...ae("progress").map(e=>Yn(e,{progress$:to})),...ae("search").map(e=>li(e,{index$:Mi,keyboard$:Zr})),...ae("source").map(e=>hi(e))),hs=C(()=>S(...ae("announce").map(e=>gn(e)),...ae("content").map(e=>Un(e,{viewport$:Oe,target$:Ot,print$:Oi})),...ae("content").map(e=>B("search.highlight")?mi(e,{index$:Mi,location$:jt}):O),...ae("header-title").map(e=>qn(e,{viewport$:Oe,header$:rt})),...ae("sidebar").map(e=>e.getAttribute("data-md-type")==="navigation"?Nr(Si,()=>Jr(e,{viewport$:Oe,header$:rt,main$:Ft})):Nr(hr,()=>Jr(e,{viewport$:Oe,header$:rt,main$:Ft}))),...ae("tabs").map(e=>bi(e,{viewport$:Oe,header$:rt})),...ae("toc").map(e=>vi(e,{viewport$:Oe,header$:rt,main$:Ft,target$:Ot})),...ae("top").map(e=>gi(e,{viewport$:Oe,header$:rt,main$:Ft,target$:Ot})))),Li=ot.pipe(v(()=>hs),Pe(ds),G(1));Li.subscribe();window.document$=ot;window.location$=jt;window.target$=Ot;window.keyboard$=Zr;window.viewport$=Oe;window.tablet$=hr;window.screen$=Si;window.print$=Oi;window.alert$=eo;window.progress$=to;window.component$=Li;})(); +//# sourceMappingURL=bundle.fe8b6f2b.min.js.map + diff --git a/assets/javascripts/bundle.fe8b6f2b.min.js.map b/assets/javascripts/bundle.fe8b6f2b.min.js.map new file mode 100644 index 0000000..8263585 --- /dev/null +++ b/assets/javascripts/bundle.fe8b6f2b.min.js.map @@ -0,0 +1,7 @@ +{ + "version": 3, + "sources": ["node_modules/focus-visible/dist/focus-visible.js", "node_modules/clipboard/dist/clipboard.js", "node_modules/escape-html/index.js", "src/templates/assets/javascripts/bundle.ts", "node_modules/rxjs/node_modules/tslib/tslib.es6.js", "node_modules/rxjs/src/internal/util/isFunction.ts", "node_modules/rxjs/src/internal/util/createErrorClass.ts", "node_modules/rxjs/src/internal/util/UnsubscriptionError.ts", "node_modules/rxjs/src/internal/util/arrRemove.ts", "node_modules/rxjs/src/internal/Subscription.ts", "node_modules/rxjs/src/internal/config.ts", "node_modules/rxjs/src/internal/scheduler/timeoutProvider.ts", "node_modules/rxjs/src/internal/util/reportUnhandledError.ts", "node_modules/rxjs/src/internal/util/noop.ts", "node_modules/rxjs/src/internal/NotificationFactories.ts", "node_modules/rxjs/src/internal/util/errorContext.ts", "node_modules/rxjs/src/internal/Subscriber.ts", "node_modules/rxjs/src/internal/symbol/observable.ts", "node_modules/rxjs/src/internal/util/identity.ts", "node_modules/rxjs/src/internal/util/pipe.ts", "node_modules/rxjs/src/internal/Observable.ts", "node_modules/rxjs/src/internal/util/lift.ts", "node_modules/rxjs/src/internal/operators/OperatorSubscriber.ts", "node_modules/rxjs/src/internal/scheduler/animationFrameProvider.ts", "node_modules/rxjs/src/internal/util/ObjectUnsubscribedError.ts", "node_modules/rxjs/src/internal/Subject.ts", "node_modules/rxjs/src/internal/BehaviorSubject.ts", "node_modules/rxjs/src/internal/scheduler/dateTimestampProvider.ts", "node_modules/rxjs/src/internal/ReplaySubject.ts", "node_modules/rxjs/src/internal/scheduler/Action.ts", "node_modules/rxjs/src/internal/scheduler/intervalProvider.ts", "node_modules/rxjs/src/internal/scheduler/AsyncAction.ts", "node_modules/rxjs/src/internal/Scheduler.ts", "node_modules/rxjs/src/internal/scheduler/AsyncScheduler.ts", "node_modules/rxjs/src/internal/scheduler/async.ts", "node_modules/rxjs/src/internal/scheduler/QueueAction.ts", "node_modules/rxjs/src/internal/scheduler/QueueScheduler.ts", "node_modules/rxjs/src/internal/scheduler/queue.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameAction.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameScheduler.ts", "node_modules/rxjs/src/internal/scheduler/animationFrame.ts", "node_modules/rxjs/src/internal/observable/empty.ts", "node_modules/rxjs/src/internal/util/isScheduler.ts", "node_modules/rxjs/src/internal/util/args.ts", "node_modules/rxjs/src/internal/util/isArrayLike.ts", "node_modules/rxjs/src/internal/util/isPromise.ts", "node_modules/rxjs/src/internal/util/isInteropObservable.ts", "node_modules/rxjs/src/internal/util/isAsyncIterable.ts", "node_modules/rxjs/src/internal/util/throwUnobservableError.ts", "node_modules/rxjs/src/internal/symbol/iterator.ts", "node_modules/rxjs/src/internal/util/isIterable.ts", "node_modules/rxjs/src/internal/util/isReadableStreamLike.ts", "node_modules/rxjs/src/internal/observable/innerFrom.ts", "node_modules/rxjs/src/internal/util/executeSchedule.ts", "node_modules/rxjs/src/internal/operators/observeOn.ts", "node_modules/rxjs/src/internal/operators/subscribeOn.ts", "node_modules/rxjs/src/internal/scheduled/scheduleObservable.ts", "node_modules/rxjs/src/internal/scheduled/schedulePromise.ts", "node_modules/rxjs/src/internal/scheduled/scheduleArray.ts", "node_modules/rxjs/src/internal/scheduled/scheduleIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleAsyncIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleReadableStreamLike.ts", "node_modules/rxjs/src/internal/scheduled/scheduled.ts", "node_modules/rxjs/src/internal/observable/from.ts", "node_modules/rxjs/src/internal/observable/of.ts", "node_modules/rxjs/src/internal/observable/throwError.ts", "node_modules/rxjs/src/internal/util/EmptyError.ts", "node_modules/rxjs/src/internal/util/isDate.ts", "node_modules/rxjs/src/internal/operators/map.ts", "node_modules/rxjs/src/internal/util/mapOneOrManyArgs.ts", "node_modules/rxjs/src/internal/util/argsArgArrayOrObject.ts", "node_modules/rxjs/src/internal/util/createObject.ts", "node_modules/rxjs/src/internal/observable/combineLatest.ts", "node_modules/rxjs/src/internal/operators/mergeInternals.ts", "node_modules/rxjs/src/internal/operators/mergeMap.ts", "node_modules/rxjs/src/internal/operators/mergeAll.ts", "node_modules/rxjs/src/internal/operators/concatAll.ts", "node_modules/rxjs/src/internal/observable/concat.ts", "node_modules/rxjs/src/internal/observable/defer.ts", "node_modules/rxjs/src/internal/observable/fromEvent.ts", "node_modules/rxjs/src/internal/observable/fromEventPattern.ts", "node_modules/rxjs/src/internal/observable/timer.ts", "node_modules/rxjs/src/internal/observable/merge.ts", "node_modules/rxjs/src/internal/observable/never.ts", "node_modules/rxjs/src/internal/util/argsOrArgArray.ts", "node_modules/rxjs/src/internal/operators/filter.ts", "node_modules/rxjs/src/internal/observable/zip.ts", "node_modules/rxjs/src/internal/operators/audit.ts", "node_modules/rxjs/src/internal/operators/auditTime.ts", "node_modules/rxjs/src/internal/operators/bufferCount.ts", "node_modules/rxjs/src/internal/operators/catchError.ts", "node_modules/rxjs/src/internal/operators/scanInternals.ts", "node_modules/rxjs/src/internal/operators/combineLatest.ts", "node_modules/rxjs/src/internal/operators/combineLatestWith.ts", "node_modules/rxjs/src/internal/operators/debounce.ts", "node_modules/rxjs/src/internal/operators/debounceTime.ts", "node_modules/rxjs/src/internal/operators/defaultIfEmpty.ts", "node_modules/rxjs/src/internal/operators/take.ts", "node_modules/rxjs/src/internal/operators/ignoreElements.ts", "node_modules/rxjs/src/internal/operators/mapTo.ts", "node_modules/rxjs/src/internal/operators/delayWhen.ts", "node_modules/rxjs/src/internal/operators/delay.ts", "node_modules/rxjs/src/internal/operators/distinctUntilChanged.ts", "node_modules/rxjs/src/internal/operators/distinctUntilKeyChanged.ts", "node_modules/rxjs/src/internal/operators/throwIfEmpty.ts", "node_modules/rxjs/src/internal/operators/endWith.ts", "node_modules/rxjs/src/internal/operators/finalize.ts", "node_modules/rxjs/src/internal/operators/first.ts", "node_modules/rxjs/src/internal/operators/takeLast.ts", "node_modules/rxjs/src/internal/operators/merge.ts", "node_modules/rxjs/src/internal/operators/mergeWith.ts", "node_modules/rxjs/src/internal/operators/repeat.ts", "node_modules/rxjs/src/internal/operators/scan.ts", "node_modules/rxjs/src/internal/operators/share.ts", "node_modules/rxjs/src/internal/operators/shareReplay.ts", "node_modules/rxjs/src/internal/operators/skip.ts", "node_modules/rxjs/src/internal/operators/skipUntil.ts", "node_modules/rxjs/src/internal/operators/startWith.ts", "node_modules/rxjs/src/internal/operators/switchMap.ts", "node_modules/rxjs/src/internal/operators/takeUntil.ts", "node_modules/rxjs/src/internal/operators/takeWhile.ts", "node_modules/rxjs/src/internal/operators/tap.ts", "node_modules/rxjs/src/internal/operators/throttle.ts", "node_modules/rxjs/src/internal/operators/throttleTime.ts", "node_modules/rxjs/src/internal/operators/withLatestFrom.ts", "node_modules/rxjs/src/internal/operators/zip.ts", "node_modules/rxjs/src/internal/operators/zipWith.ts", "src/templates/assets/javascripts/browser/document/index.ts", "src/templates/assets/javascripts/browser/element/_/index.ts", "src/templates/assets/javascripts/browser/element/focus/index.ts", "src/templates/assets/javascripts/browser/element/hover/index.ts", "src/templates/assets/javascripts/utilities/h/index.ts", "src/templates/assets/javascripts/utilities/round/index.ts", "src/templates/assets/javascripts/browser/script/index.ts", "src/templates/assets/javascripts/browser/element/size/_/index.ts", "src/templates/assets/javascripts/browser/element/size/content/index.ts", "src/templates/assets/javascripts/browser/element/offset/_/index.ts", "src/templates/assets/javascripts/browser/element/offset/content/index.ts", "src/templates/assets/javascripts/browser/element/visibility/index.ts", "src/templates/assets/javascripts/browser/toggle/index.ts", "src/templates/assets/javascripts/browser/keyboard/index.ts", "src/templates/assets/javascripts/browser/location/_/index.ts", "src/templates/assets/javascripts/browser/location/hash/index.ts", "src/templates/assets/javascripts/browser/media/index.ts", "src/templates/assets/javascripts/browser/request/index.ts", "src/templates/assets/javascripts/browser/viewport/offset/index.ts", "src/templates/assets/javascripts/browser/viewport/size/index.ts", "src/templates/assets/javascripts/browser/viewport/_/index.ts", "src/templates/assets/javascripts/browser/viewport/at/index.ts", "src/templates/assets/javascripts/browser/worker/index.ts", "src/templates/assets/javascripts/_/index.ts", "src/templates/assets/javascripts/components/_/index.ts", "src/templates/assets/javascripts/components/announce/index.ts", "src/templates/assets/javascripts/components/consent/index.ts", "src/templates/assets/javascripts/templates/tooltip/index.tsx", "src/templates/assets/javascripts/templates/annotation/index.tsx", "src/templates/assets/javascripts/templates/clipboard/index.tsx", "src/templates/assets/javascripts/templates/search/index.tsx", "src/templates/assets/javascripts/templates/source/index.tsx", "src/templates/assets/javascripts/templates/tabbed/index.tsx", "src/templates/assets/javascripts/templates/table/index.tsx", "src/templates/assets/javascripts/templates/version/index.tsx", "src/templates/assets/javascripts/components/tooltip2/index.ts", "src/templates/assets/javascripts/components/content/annotation/_/index.ts", "src/templates/assets/javascripts/components/content/annotation/list/index.ts", "src/templates/assets/javascripts/components/content/annotation/block/index.ts", "src/templates/assets/javascripts/components/content/code/_/index.ts", "src/templates/assets/javascripts/components/content/details/index.ts", "src/templates/assets/javascripts/components/content/mermaid/index.css", "src/templates/assets/javascripts/components/content/mermaid/index.ts", "src/templates/assets/javascripts/components/content/table/index.ts", "src/templates/assets/javascripts/components/content/tabs/index.ts", "src/templates/assets/javascripts/components/content/_/index.ts", "src/templates/assets/javascripts/components/dialog/index.ts", "src/templates/assets/javascripts/components/tooltip/index.ts", "src/templates/assets/javascripts/components/header/_/index.ts", "src/templates/assets/javascripts/components/header/title/index.ts", "src/templates/assets/javascripts/components/main/index.ts", "src/templates/assets/javascripts/components/palette/index.ts", "src/templates/assets/javascripts/components/progress/index.ts", "src/templates/assets/javascripts/integrations/clipboard/index.ts", "src/templates/assets/javascripts/integrations/sitemap/index.ts", "src/templates/assets/javascripts/integrations/instant/index.ts", "src/templates/assets/javascripts/integrations/search/highlighter/index.ts", "src/templates/assets/javascripts/integrations/search/worker/message/index.ts", "src/templates/assets/javascripts/integrations/search/worker/_/index.ts", "src/templates/assets/javascripts/integrations/version/index.ts", "src/templates/assets/javascripts/components/search/query/index.ts", "src/templates/assets/javascripts/components/search/result/index.ts", "src/templates/assets/javascripts/components/search/share/index.ts", "src/templates/assets/javascripts/components/search/suggest/index.ts", "src/templates/assets/javascripts/components/search/_/index.ts", "src/templates/assets/javascripts/components/search/highlight/index.ts", "src/templates/assets/javascripts/components/sidebar/index.ts", "src/templates/assets/javascripts/components/source/facts/github/index.ts", "src/templates/assets/javascripts/components/source/facts/gitlab/index.ts", "src/templates/assets/javascripts/components/source/facts/_/index.ts", "src/templates/assets/javascripts/components/source/_/index.ts", "src/templates/assets/javascripts/components/tabs/index.ts", "src/templates/assets/javascripts/components/toc/index.ts", "src/templates/assets/javascripts/components/top/index.ts", "src/templates/assets/javascripts/patches/ellipsis/index.ts", "src/templates/assets/javascripts/patches/indeterminate/index.ts", "src/templates/assets/javascripts/patches/scrollfix/index.ts", "src/templates/assets/javascripts/patches/scrolllock/index.ts", "src/templates/assets/javascripts/polyfills/index.ts"], + "sourcesContent": ["(function (global, factory) {\n typeof exports === 'object' && typeof module !== 'undefined' ? factory() :\n typeof define === 'function' && define.amd ? define(factory) :\n (factory());\n}(this, (function () { 'use strict';\n\n /**\n * Applies the :focus-visible polyfill at the given scope.\n * A scope in this case is either the top-level Document or a Shadow Root.\n *\n * @param {(Document|ShadowRoot)} scope\n * @see https://github.com/WICG/focus-visible\n */\n function applyFocusVisiblePolyfill(scope) {\n var hadKeyboardEvent = true;\n var hadFocusVisibleRecently = false;\n var hadFocusVisibleRecentlyTimeout = null;\n\n var inputTypesAllowlist = {\n text: true,\n search: true,\n url: true,\n tel: true,\n email: true,\n password: true,\n number: true,\n date: true,\n month: true,\n week: true,\n time: true,\n datetime: true,\n 'datetime-local': true\n };\n\n /**\n * Helper function for legacy browsers and iframes which sometimes focus\n * elements like document, body, and non-interactive SVG.\n * @param {Element} el\n */\n function isValidFocusTarget(el) {\n if (\n el &&\n el !== document &&\n el.nodeName !== 'HTML' &&\n el.nodeName !== 'BODY' &&\n 'classList' in el &&\n 'contains' in el.classList\n ) {\n return true;\n }\n return false;\n }\n\n /**\n * Computes whether the given element should automatically trigger the\n * `focus-visible` class being added, i.e. whether it should always match\n * `:focus-visible` when focused.\n * @param {Element} el\n * @return {boolean}\n */\n function focusTriggersKeyboardModality(el) {\n var type = el.type;\n var tagName = el.tagName;\n\n if (tagName === 'INPUT' && inputTypesAllowlist[type] && !el.readOnly) {\n return true;\n }\n\n if (tagName === 'TEXTAREA' && !el.readOnly) {\n return true;\n }\n\n if (el.isContentEditable) {\n return true;\n }\n\n return false;\n }\n\n /**\n * Add the `focus-visible` class to the given element if it was not added by\n * the author.\n * @param {Element} el\n */\n function addFocusVisibleClass(el) {\n if (el.classList.contains('focus-visible')) {\n return;\n }\n el.classList.add('focus-visible');\n el.setAttribute('data-focus-visible-added', '');\n }\n\n /**\n * Remove the `focus-visible` class from the given element if it was not\n * originally added by the author.\n * @param {Element} el\n */\n function removeFocusVisibleClass(el) {\n if (!el.hasAttribute('data-focus-visible-added')) {\n return;\n }\n el.classList.remove('focus-visible');\n el.removeAttribute('data-focus-visible-added');\n }\n\n /**\n * If the most recent user interaction was via the keyboard;\n * and the key press did not include a meta, alt/option, or control key;\n * then the modality is keyboard. Otherwise, the modality is not keyboard.\n * Apply `focus-visible` to any current active element and keep track\n * of our keyboard modality state with `hadKeyboardEvent`.\n * @param {KeyboardEvent} e\n */\n function onKeyDown(e) {\n if (e.metaKey || e.altKey || e.ctrlKey) {\n return;\n }\n\n if (isValidFocusTarget(scope.activeElement)) {\n addFocusVisibleClass(scope.activeElement);\n }\n\n hadKeyboardEvent = true;\n }\n\n /**\n * If at any point a user clicks with a pointing device, ensure that we change\n * the modality away from keyboard.\n * This avoids the situation where a user presses a key on an already focused\n * element, and then clicks on a different element, focusing it with a\n * pointing device, while we still think we're in keyboard modality.\n * @param {Event} e\n */\n function onPointerDown(e) {\n hadKeyboardEvent = false;\n }\n\n /**\n * On `focus`, add the `focus-visible` class to the target if:\n * - the target received focus as a result of keyboard navigation, or\n * - the event target is an element that will likely require interaction\n * via the keyboard (e.g. a text box)\n * @param {Event} e\n */\n function onFocus(e) {\n // Prevent IE from focusing the document or HTML element.\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (hadKeyboardEvent || focusTriggersKeyboardModality(e.target)) {\n addFocusVisibleClass(e.target);\n }\n }\n\n /**\n * On `blur`, remove the `focus-visible` class from the target.\n * @param {Event} e\n */\n function onBlur(e) {\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (\n e.target.classList.contains('focus-visible') ||\n e.target.hasAttribute('data-focus-visible-added')\n ) {\n // To detect a tab/window switch, we look for a blur event followed\n // rapidly by a visibility change.\n // If we don't see a visibility change within 100ms, it's probably a\n // regular focus change.\n hadFocusVisibleRecently = true;\n window.clearTimeout(hadFocusVisibleRecentlyTimeout);\n hadFocusVisibleRecentlyTimeout = window.setTimeout(function() {\n hadFocusVisibleRecently = false;\n }, 100);\n removeFocusVisibleClass(e.target);\n }\n }\n\n /**\n * If the user changes tabs, keep track of whether or not the previously\n * focused element had .focus-visible.\n * @param {Event} e\n */\n function onVisibilityChange(e) {\n if (document.visibilityState === 'hidden') {\n // If the tab becomes active again, the browser will handle calling focus\n // on the element (Safari actually calls it twice).\n // If this tab change caused a blur on an element with focus-visible,\n // re-apply the class when the user switches back to the tab.\n if (hadFocusVisibleRecently) {\n hadKeyboardEvent = true;\n }\n addInitialPointerMoveListeners();\n }\n }\n\n /**\n * Add a group of listeners to detect usage of any pointing devices.\n * These listeners will be added when the polyfill first loads, and anytime\n * the window is blurred, so that they are active when the window regains\n * focus.\n */\n function addInitialPointerMoveListeners() {\n document.addEventListener('mousemove', onInitialPointerMove);\n document.addEventListener('mousedown', onInitialPointerMove);\n document.addEventListener('mouseup', onInitialPointerMove);\n document.addEventListener('pointermove', onInitialPointerMove);\n document.addEventListener('pointerdown', onInitialPointerMove);\n document.addEventListener('pointerup', onInitialPointerMove);\n document.addEventListener('touchmove', onInitialPointerMove);\n document.addEventListener('touchstart', onInitialPointerMove);\n document.addEventListener('touchend', onInitialPointerMove);\n }\n\n function removeInitialPointerMoveListeners() {\n document.removeEventListener('mousemove', onInitialPointerMove);\n document.removeEventListener('mousedown', onInitialPointerMove);\n document.removeEventListener('mouseup', onInitialPointerMove);\n document.removeEventListener('pointermove', onInitialPointerMove);\n document.removeEventListener('pointerdown', onInitialPointerMove);\n document.removeEventListener('pointerup', onInitialPointerMove);\n document.removeEventListener('touchmove', onInitialPointerMove);\n document.removeEventListener('touchstart', onInitialPointerMove);\n document.removeEventListener('touchend', onInitialPointerMove);\n }\n\n /**\n * When the polfyill first loads, assume the user is in keyboard modality.\n * If any event is received from a pointing device (e.g. mouse, pointer,\n * touch), turn off keyboard modality.\n * This accounts for situations where focus enters the page from the URL bar.\n * @param {Event} e\n */\n function onInitialPointerMove(e) {\n // Work around a Safari quirk that fires a mousemove on whenever the\n // window blurs, even if you're tabbing out of the page. \u00AF\\_(\u30C4)_/\u00AF\n if (e.target.nodeName && e.target.nodeName.toLowerCase() === 'html') {\n return;\n }\n\n hadKeyboardEvent = false;\n removeInitialPointerMoveListeners();\n }\n\n // For some kinds of state, we are interested in changes at the global scope\n // only. For example, global pointer input, global key presses and global\n // visibility change should affect the state at every scope:\n document.addEventListener('keydown', onKeyDown, true);\n document.addEventListener('mousedown', onPointerDown, true);\n document.addEventListener('pointerdown', onPointerDown, true);\n document.addEventListener('touchstart', onPointerDown, true);\n document.addEventListener('visibilitychange', onVisibilityChange, true);\n\n addInitialPointerMoveListeners();\n\n // For focus and blur, we specifically care about state changes in the local\n // scope. This is because focus / blur events that originate from within a\n // shadow root are not re-dispatched from the host element if it was already\n // the active element in its own scope:\n scope.addEventListener('focus', onFocus, true);\n scope.addEventListener('blur', onBlur, true);\n\n // We detect that a node is a ShadowRoot by ensuring that it is a\n // DocumentFragment and also has a host property. This check covers native\n // implementation and polyfill implementation transparently. If we only cared\n // about the native implementation, we could just check if the scope was\n // an instance of a ShadowRoot.\n if (scope.nodeType === Node.DOCUMENT_FRAGMENT_NODE && scope.host) {\n // Since a ShadowRoot is a special kind of DocumentFragment, it does not\n // have a root element to add a class to. So, we add this attribute to the\n // host element instead:\n scope.host.setAttribute('data-js-focus-visible', '');\n } else if (scope.nodeType === Node.DOCUMENT_NODE) {\n document.documentElement.classList.add('js-focus-visible');\n document.documentElement.setAttribute('data-js-focus-visible', '');\n }\n }\n\n // It is important to wrap all references to global window and document in\n // these checks to support server-side rendering use cases\n // @see https://github.com/WICG/focus-visible/issues/199\n if (typeof window !== 'undefined' && typeof document !== 'undefined') {\n // Make the polyfill helper globally available. This can be used as a signal\n // to interested libraries that wish to coordinate with the polyfill for e.g.,\n // applying the polyfill to a shadow root:\n window.applyFocusVisiblePolyfill = applyFocusVisiblePolyfill;\n\n // Notify interested libraries of the polyfill's presence, in case the\n // polyfill was loaded lazily:\n var event;\n\n try {\n event = new CustomEvent('focus-visible-polyfill-ready');\n } catch (error) {\n // IE11 does not support using CustomEvent as a constructor directly:\n event = document.createEvent('CustomEvent');\n event.initCustomEvent('focus-visible-polyfill-ready', false, false, {});\n }\n\n window.dispatchEvent(event);\n }\n\n if (typeof document !== 'undefined') {\n // Apply the polyfill to the global document, so that no JavaScript\n // coordination is required to use the polyfill in the top-level document:\n applyFocusVisiblePolyfill(document);\n }\n\n})));\n", "/*!\n * clipboard.js v2.0.11\n * https://clipboardjs.com/\n *\n * Licensed MIT \u00A9 Zeno Rocha\n */\n(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"ClipboardJS\"] = factory();\n\telse\n\t\troot[\"ClipboardJS\"] = factory();\n})(this, function() {\nreturn /******/ (function() { // webpackBootstrap\n/******/ \tvar __webpack_modules__ = ({\n\n/***/ 686:\n/***/ (function(__unused_webpack_module, __webpack_exports__, __webpack_require__) {\n\n\"use strict\";\n\n// EXPORTS\n__webpack_require__.d(__webpack_exports__, {\n \"default\": function() { return /* binding */ clipboard; }\n});\n\n// EXTERNAL MODULE: ./node_modules/tiny-emitter/index.js\nvar tiny_emitter = __webpack_require__(279);\nvar tiny_emitter_default = /*#__PURE__*/__webpack_require__.n(tiny_emitter);\n// EXTERNAL MODULE: ./node_modules/good-listener/src/listen.js\nvar listen = __webpack_require__(370);\nvar listen_default = /*#__PURE__*/__webpack_require__.n(listen);\n// EXTERNAL MODULE: ./node_modules/select/src/select.js\nvar src_select = __webpack_require__(817);\nvar select_default = /*#__PURE__*/__webpack_require__.n(src_select);\n;// CONCATENATED MODULE: ./src/common/command.js\n/**\n * Executes a given operation type.\n * @param {String} type\n * @return {Boolean}\n */\nfunction command(type) {\n try {\n return document.execCommand(type);\n } catch (err) {\n return false;\n }\n}\n;// CONCATENATED MODULE: ./src/actions/cut.js\n\n\n/**\n * Cut action wrapper.\n * @param {String|HTMLElement} target\n * @return {String}\n */\n\nvar ClipboardActionCut = function ClipboardActionCut(target) {\n var selectedText = select_default()(target);\n command('cut');\n return selectedText;\n};\n\n/* harmony default export */ var actions_cut = (ClipboardActionCut);\n;// CONCATENATED MODULE: ./src/common/create-fake-element.js\n/**\n * Creates a fake textarea element with a value.\n * @param {String} value\n * @return {HTMLElement}\n */\nfunction createFakeElement(value) {\n var isRTL = document.documentElement.getAttribute('dir') === 'rtl';\n var fakeElement = document.createElement('textarea'); // Prevent zooming on iOS\n\n fakeElement.style.fontSize = '12pt'; // Reset box model\n\n fakeElement.style.border = '0';\n fakeElement.style.padding = '0';\n fakeElement.style.margin = '0'; // Move element out of screen horizontally\n\n fakeElement.style.position = 'absolute';\n fakeElement.style[isRTL ? 'right' : 'left'] = '-9999px'; // Move element to the same position vertically\n\n var yPosition = window.pageYOffset || document.documentElement.scrollTop;\n fakeElement.style.top = \"\".concat(yPosition, \"px\");\n fakeElement.setAttribute('readonly', '');\n fakeElement.value = value;\n return fakeElement;\n}\n;// CONCATENATED MODULE: ./src/actions/copy.js\n\n\n\n/**\n * Create fake copy action wrapper using a fake element.\n * @param {String} target\n * @param {Object} options\n * @return {String}\n */\n\nvar fakeCopyAction = function fakeCopyAction(value, options) {\n var fakeElement = createFakeElement(value);\n options.container.appendChild(fakeElement);\n var selectedText = select_default()(fakeElement);\n command('copy');\n fakeElement.remove();\n return selectedText;\n};\n/**\n * Copy action wrapper.\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @return {String}\n */\n\n\nvar ClipboardActionCopy = function ClipboardActionCopy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n var selectedText = '';\n\n if (typeof target === 'string') {\n selectedText = fakeCopyAction(target, options);\n } else if (target instanceof HTMLInputElement && !['text', 'search', 'url', 'tel', 'password'].includes(target === null || target === void 0 ? void 0 : target.type)) {\n // If input type doesn't support `setSelectionRange`. Simulate it. https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange\n selectedText = fakeCopyAction(target.value, options);\n } else {\n selectedText = select_default()(target);\n command('copy');\n }\n\n return selectedText;\n};\n\n/* harmony default export */ var actions_copy = (ClipboardActionCopy);\n;// CONCATENATED MODULE: ./src/actions/default.js\nfunction _typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return _typeof(obj); }\n\n\n\n/**\n * Inner function which performs selection from either `text` or `target`\n * properties and then executes copy or cut operations.\n * @param {Object} options\n */\n\nvar ClipboardActionDefault = function ClipboardActionDefault() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n // Defines base properties passed from constructor.\n var _options$action = options.action,\n action = _options$action === void 0 ? 'copy' : _options$action,\n container = options.container,\n target = options.target,\n text = options.text; // Sets the `action` to be performed which can be either 'copy' or 'cut'.\n\n if (action !== 'copy' && action !== 'cut') {\n throw new Error('Invalid \"action\" value, use either \"copy\" or \"cut\"');\n } // Sets the `target` property using an element that will be have its content copied.\n\n\n if (target !== undefined) {\n if (target && _typeof(target) === 'object' && target.nodeType === 1) {\n if (action === 'copy' && target.hasAttribute('disabled')) {\n throw new Error('Invalid \"target\" attribute. Please use \"readonly\" instead of \"disabled\" attribute');\n }\n\n if (action === 'cut' && (target.hasAttribute('readonly') || target.hasAttribute('disabled'))) {\n throw new Error('Invalid \"target\" attribute. You can\\'t cut text from elements with \"readonly\" or \"disabled\" attributes');\n }\n } else {\n throw new Error('Invalid \"target\" value, use a valid Element');\n }\n } // Define selection strategy based on `text` property.\n\n\n if (text) {\n return actions_copy(text, {\n container: container\n });\n } // Defines which selection strategy based on `target` property.\n\n\n if (target) {\n return action === 'cut' ? actions_cut(target) : actions_copy(target, {\n container: container\n });\n }\n};\n\n/* harmony default export */ var actions_default = (ClipboardActionDefault);\n;// CONCATENATED MODULE: ./src/clipboard.js\nfunction clipboard_typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { clipboard_typeof = function _typeof(obj) { return typeof obj; }; } else { clipboard_typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return clipboard_typeof(obj); }\n\nfunction _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError(\"Cannot call a class as a function\"); } }\n\nfunction _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if (\"value\" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }\n\nfunction _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }\n\nfunction _inherits(subClass, superClass) { if (typeof superClass !== \"function\" && superClass !== null) { throw new TypeError(\"Super expression must either be null or a function\"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }\n\nfunction _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }\n\nfunction _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }\n\nfunction _possibleConstructorReturn(self, call) { if (call && (clipboard_typeof(call) === \"object\" || typeof call === \"function\")) { return call; } return _assertThisInitialized(self); }\n\nfunction _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError(\"this hasn't been initialised - super() hasn't been called\"); } return self; }\n\nfunction _isNativeReflectConstruct() { if (typeof Reflect === \"undefined\" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === \"function\") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }\n\nfunction _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }\n\n\n\n\n\n\n/**\n * Helper function to retrieve attribute value.\n * @param {String} suffix\n * @param {Element} element\n */\n\nfunction getAttributeValue(suffix, element) {\n var attribute = \"data-clipboard-\".concat(suffix);\n\n if (!element.hasAttribute(attribute)) {\n return;\n }\n\n return element.getAttribute(attribute);\n}\n/**\n * Base class which takes one or more elements, adds event listeners to them,\n * and instantiates a new `ClipboardAction` on each click.\n */\n\n\nvar Clipboard = /*#__PURE__*/function (_Emitter) {\n _inherits(Clipboard, _Emitter);\n\n var _super = _createSuper(Clipboard);\n\n /**\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n * @param {Object} options\n */\n function Clipboard(trigger, options) {\n var _this;\n\n _classCallCheck(this, Clipboard);\n\n _this = _super.call(this);\n\n _this.resolveOptions(options);\n\n _this.listenClick(trigger);\n\n return _this;\n }\n /**\n * Defines if attributes would be resolved using internal setter functions\n * or custom functions that were passed in the constructor.\n * @param {Object} options\n */\n\n\n _createClass(Clipboard, [{\n key: \"resolveOptions\",\n value: function resolveOptions() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n this.action = typeof options.action === 'function' ? options.action : this.defaultAction;\n this.target = typeof options.target === 'function' ? options.target : this.defaultTarget;\n this.text = typeof options.text === 'function' ? options.text : this.defaultText;\n this.container = clipboard_typeof(options.container) === 'object' ? options.container : document.body;\n }\n /**\n * Adds a click event listener to the passed trigger.\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n */\n\n }, {\n key: \"listenClick\",\n value: function listenClick(trigger) {\n var _this2 = this;\n\n this.listener = listen_default()(trigger, 'click', function (e) {\n return _this2.onClick(e);\n });\n }\n /**\n * Defines a new `ClipboardAction` on each click event.\n * @param {Event} e\n */\n\n }, {\n key: \"onClick\",\n value: function onClick(e) {\n var trigger = e.delegateTarget || e.currentTarget;\n var action = this.action(trigger) || 'copy';\n var text = actions_default({\n action: action,\n container: this.container,\n target: this.target(trigger),\n text: this.text(trigger)\n }); // Fires an event based on the copy operation result.\n\n this.emit(text ? 'success' : 'error', {\n action: action,\n text: text,\n trigger: trigger,\n clearSelection: function clearSelection() {\n if (trigger) {\n trigger.focus();\n }\n\n window.getSelection().removeAllRanges();\n }\n });\n }\n /**\n * Default `action` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultAction\",\n value: function defaultAction(trigger) {\n return getAttributeValue('action', trigger);\n }\n /**\n * Default `target` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultTarget\",\n value: function defaultTarget(trigger) {\n var selector = getAttributeValue('target', trigger);\n\n if (selector) {\n return document.querySelector(selector);\n }\n }\n /**\n * Allow fire programmatically a copy action\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @returns Text copied.\n */\n\n }, {\n key: \"defaultText\",\n\n /**\n * Default `text` lookup function.\n * @param {Element} trigger\n */\n value: function defaultText(trigger) {\n return getAttributeValue('text', trigger);\n }\n /**\n * Destroy lifecycle.\n */\n\n }, {\n key: \"destroy\",\n value: function destroy() {\n this.listener.destroy();\n }\n }], [{\n key: \"copy\",\n value: function copy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n return actions_copy(target, options);\n }\n /**\n * Allow fire programmatically a cut action\n * @param {String|HTMLElement} target\n * @returns Text cutted.\n */\n\n }, {\n key: \"cut\",\n value: function cut(target) {\n return actions_cut(target);\n }\n /**\n * Returns the support of the given action, or all actions if no action is\n * given.\n * @param {String} [action]\n */\n\n }, {\n key: \"isSupported\",\n value: function isSupported() {\n var action = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : ['copy', 'cut'];\n var actions = typeof action === 'string' ? [action] : action;\n var support = !!document.queryCommandSupported;\n actions.forEach(function (action) {\n support = support && !!document.queryCommandSupported(action);\n });\n return support;\n }\n }]);\n\n return Clipboard;\n}((tiny_emitter_default()));\n\n/* harmony default export */ var clipboard = (Clipboard);\n\n/***/ }),\n\n/***/ 828:\n/***/ (function(module) {\n\nvar DOCUMENT_NODE_TYPE = 9;\n\n/**\n * A polyfill for Element.matches()\n */\nif (typeof Element !== 'undefined' && !Element.prototype.matches) {\n var proto = Element.prototype;\n\n proto.matches = proto.matchesSelector ||\n proto.mozMatchesSelector ||\n proto.msMatchesSelector ||\n proto.oMatchesSelector ||\n proto.webkitMatchesSelector;\n}\n\n/**\n * Finds the closest parent that matches a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @return {Function}\n */\nfunction closest (element, selector) {\n while (element && element.nodeType !== DOCUMENT_NODE_TYPE) {\n if (typeof element.matches === 'function' &&\n element.matches(selector)) {\n return element;\n }\n element = element.parentNode;\n }\n}\n\nmodule.exports = closest;\n\n\n/***/ }),\n\n/***/ 438:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar closest = __webpack_require__(828);\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction _delegate(element, selector, type, callback, useCapture) {\n var listenerFn = listener.apply(this, arguments);\n\n element.addEventListener(type, listenerFn, useCapture);\n\n return {\n destroy: function() {\n element.removeEventListener(type, listenerFn, useCapture);\n }\n }\n}\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element|String|Array} [elements]\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction delegate(elements, selector, type, callback, useCapture) {\n // Handle the regular Element usage\n if (typeof elements.addEventListener === 'function') {\n return _delegate.apply(null, arguments);\n }\n\n // Handle Element-less usage, it defaults to global delegation\n if (typeof type === 'function') {\n // Use `document` as the first parameter, then apply arguments\n // This is a short way to .unshift `arguments` without running into deoptimizations\n return _delegate.bind(null, document).apply(null, arguments);\n }\n\n // Handle Selector-based usage\n if (typeof elements === 'string') {\n elements = document.querySelectorAll(elements);\n }\n\n // Handle Array-like based usage\n return Array.prototype.map.call(elements, function (element) {\n return _delegate(element, selector, type, callback, useCapture);\n });\n}\n\n/**\n * Finds closest match and invokes callback.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Function}\n */\nfunction listener(element, selector, type, callback) {\n return function(e) {\n e.delegateTarget = closest(e.target, selector);\n\n if (e.delegateTarget) {\n callback.call(element, e);\n }\n }\n}\n\nmodule.exports = delegate;\n\n\n/***/ }),\n\n/***/ 879:\n/***/ (function(__unused_webpack_module, exports) {\n\n/**\n * Check if argument is a HTML element.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.node = function(value) {\n return value !== undefined\n && value instanceof HTMLElement\n && value.nodeType === 1;\n};\n\n/**\n * Check if argument is a list of HTML elements.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.nodeList = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return value !== undefined\n && (type === '[object NodeList]' || type === '[object HTMLCollection]')\n && ('length' in value)\n && (value.length === 0 || exports.node(value[0]));\n};\n\n/**\n * Check if argument is a string.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.string = function(value) {\n return typeof value === 'string'\n || value instanceof String;\n};\n\n/**\n * Check if argument is a function.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.fn = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return type === '[object Function]';\n};\n\n\n/***/ }),\n\n/***/ 370:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar is = __webpack_require__(879);\nvar delegate = __webpack_require__(438);\n\n/**\n * Validates all params and calls the right\n * listener function based on its target type.\n *\n * @param {String|HTMLElement|HTMLCollection|NodeList} target\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listen(target, type, callback) {\n if (!target && !type && !callback) {\n throw new Error('Missing required arguments');\n }\n\n if (!is.string(type)) {\n throw new TypeError('Second argument must be a String');\n }\n\n if (!is.fn(callback)) {\n throw new TypeError('Third argument must be a Function');\n }\n\n if (is.node(target)) {\n return listenNode(target, type, callback);\n }\n else if (is.nodeList(target)) {\n return listenNodeList(target, type, callback);\n }\n else if (is.string(target)) {\n return listenSelector(target, type, callback);\n }\n else {\n throw new TypeError('First argument must be a String, HTMLElement, HTMLCollection, or NodeList');\n }\n}\n\n/**\n * Adds an event listener to a HTML element\n * and returns a remove listener function.\n *\n * @param {HTMLElement} node\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNode(node, type, callback) {\n node.addEventListener(type, callback);\n\n return {\n destroy: function() {\n node.removeEventListener(type, callback);\n }\n }\n}\n\n/**\n * Add an event listener to a list of HTML elements\n * and returns a remove listener function.\n *\n * @param {NodeList|HTMLCollection} nodeList\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNodeList(nodeList, type, callback) {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.addEventListener(type, callback);\n });\n\n return {\n destroy: function() {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.removeEventListener(type, callback);\n });\n }\n }\n}\n\n/**\n * Add an event listener to a selector\n * and returns a remove listener function.\n *\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenSelector(selector, type, callback) {\n return delegate(document.body, selector, type, callback);\n}\n\nmodule.exports = listen;\n\n\n/***/ }),\n\n/***/ 817:\n/***/ (function(module) {\n\nfunction select(element) {\n var selectedText;\n\n if (element.nodeName === 'SELECT') {\n element.focus();\n\n selectedText = element.value;\n }\n else if (element.nodeName === 'INPUT' || element.nodeName === 'TEXTAREA') {\n var isReadOnly = element.hasAttribute('readonly');\n\n if (!isReadOnly) {\n element.setAttribute('readonly', '');\n }\n\n element.select();\n element.setSelectionRange(0, element.value.length);\n\n if (!isReadOnly) {\n element.removeAttribute('readonly');\n }\n\n selectedText = element.value;\n }\n else {\n if (element.hasAttribute('contenteditable')) {\n element.focus();\n }\n\n var selection = window.getSelection();\n var range = document.createRange();\n\n range.selectNodeContents(element);\n selection.removeAllRanges();\n selection.addRange(range);\n\n selectedText = selection.toString();\n }\n\n return selectedText;\n}\n\nmodule.exports = select;\n\n\n/***/ }),\n\n/***/ 279:\n/***/ (function(module) {\n\nfunction E () {\n // Keep this empty so it's easier to inherit from\n // (via https://github.com/lipsmack from https://github.com/scottcorgan/tiny-emitter/issues/3)\n}\n\nE.prototype = {\n on: function (name, callback, ctx) {\n var e = this.e || (this.e = {});\n\n (e[name] || (e[name] = [])).push({\n fn: callback,\n ctx: ctx\n });\n\n return this;\n },\n\n once: function (name, callback, ctx) {\n var self = this;\n function listener () {\n self.off(name, listener);\n callback.apply(ctx, arguments);\n };\n\n listener._ = callback\n return this.on(name, listener, ctx);\n },\n\n emit: function (name) {\n var data = [].slice.call(arguments, 1);\n var evtArr = ((this.e || (this.e = {}))[name] || []).slice();\n var i = 0;\n var len = evtArr.length;\n\n for (i; i < len; i++) {\n evtArr[i].fn.apply(evtArr[i].ctx, data);\n }\n\n return this;\n },\n\n off: function (name, callback) {\n var e = this.e || (this.e = {});\n var evts = e[name];\n var liveEvents = [];\n\n if (evts && callback) {\n for (var i = 0, len = evts.length; i < len; i++) {\n if (evts[i].fn !== callback && evts[i].fn._ !== callback)\n liveEvents.push(evts[i]);\n }\n }\n\n // Remove event from queue to prevent memory leak\n // Suggested by https://github.com/lazd\n // Ref: https://github.com/scottcorgan/tiny-emitter/commit/c6ebfaa9bc973b33d110a84a307742b7cf94c953#commitcomment-5024910\n\n (liveEvents.length)\n ? e[name] = liveEvents\n : delete e[name];\n\n return this;\n }\n};\n\nmodule.exports = E;\nmodule.exports.TinyEmitter = E;\n\n\n/***/ })\n\n/******/ \t});\n/************************************************************************/\n/******/ \t// The module cache\n/******/ \tvar __webpack_module_cache__ = {};\n/******/ \t\n/******/ \t// The require function\n/******/ \tfunction __webpack_require__(moduleId) {\n/******/ \t\t// Check if module is in cache\n/******/ \t\tif(__webpack_module_cache__[moduleId]) {\n/******/ \t\t\treturn __webpack_module_cache__[moduleId].exports;\n/******/ \t\t}\n/******/ \t\t// Create a new module (and put it into the cache)\n/******/ \t\tvar module = __webpack_module_cache__[moduleId] = {\n/******/ \t\t\t// no module.id needed\n/******/ \t\t\t// no module.loaded needed\n/******/ \t\t\texports: {}\n/******/ \t\t};\n/******/ \t\n/******/ \t\t// Execute the module function\n/******/ \t\t__webpack_modules__[moduleId](module, module.exports, __webpack_require__);\n/******/ \t\n/******/ \t\t// Return the exports of the module\n/******/ \t\treturn module.exports;\n/******/ \t}\n/******/ \t\n/************************************************************************/\n/******/ \t/* webpack/runtime/compat get default export */\n/******/ \t!function() {\n/******/ \t\t// getDefaultExport function for compatibility with non-harmony modules\n/******/ \t\t__webpack_require__.n = function(module) {\n/******/ \t\t\tvar getter = module && module.__esModule ?\n/******/ \t\t\t\tfunction() { return module['default']; } :\n/******/ \t\t\t\tfunction() { return module; };\n/******/ \t\t\t__webpack_require__.d(getter, { a: getter });\n/******/ \t\t\treturn getter;\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/define property getters */\n/******/ \t!function() {\n/******/ \t\t// define getter functions for harmony exports\n/******/ \t\t__webpack_require__.d = function(exports, definition) {\n/******/ \t\t\tfor(var key in definition) {\n/******/ \t\t\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n/******/ \t\t\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n/******/ \t\t\t\t}\n/******/ \t\t\t}\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/hasOwnProperty shorthand */\n/******/ \t!function() {\n/******/ \t\t__webpack_require__.o = function(obj, prop) { return Object.prototype.hasOwnProperty.call(obj, prop); }\n/******/ \t}();\n/******/ \t\n/************************************************************************/\n/******/ \t// module exports must be returned from runtime so entry inlining is disabled\n/******/ \t// startup\n/******/ \t// Load entry module and return exports\n/******/ \treturn __webpack_require__(686);\n/******/ })()\n.default;\n});", "/*!\n * escape-html\n * Copyright(c) 2012-2013 TJ Holowaychuk\n * Copyright(c) 2015 Andreas Lubbe\n * Copyright(c) 2015 Tiancheng \"Timothy\" Gu\n * MIT Licensed\n */\n\n'use strict';\n\n/**\n * Module variables.\n * @private\n */\n\nvar matchHtmlRegExp = /[\"'&<>]/;\n\n/**\n * Module exports.\n * @public\n */\n\nmodule.exports = escapeHtml;\n\n/**\n * Escape special characters in the given string of html.\n *\n * @param {string} string The string to escape for inserting into HTML\n * @return {string}\n * @public\n */\n\nfunction escapeHtml(string) {\n var str = '' + string;\n var match = matchHtmlRegExp.exec(str);\n\n if (!match) {\n return str;\n }\n\n var escape;\n var html = '';\n var index = 0;\n var lastIndex = 0;\n\n for (index = match.index; index < str.length; index++) {\n switch (str.charCodeAt(index)) {\n case 34: // \"\n escape = '"';\n break;\n case 38: // &\n escape = '&';\n break;\n case 39: // '\n escape = ''';\n break;\n case 60: // <\n escape = '<';\n break;\n case 62: // >\n escape = '>';\n break;\n default:\n continue;\n }\n\n if (lastIndex !== index) {\n html += str.substring(lastIndex, index);\n }\n\n lastIndex = index + 1;\n html += escape;\n }\n\n return lastIndex !== index\n ? html + str.substring(lastIndex, index)\n : html;\n}\n", "/*\n * Copyright (c) 2016-2024 Martin Donath \n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to\n * deal in the Software without restriction, including without limitation the\n * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or\n * sell copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\n * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\n * IN THE SOFTWARE.\n */\n\nimport \"focus-visible\"\n\nimport {\n EMPTY,\n NEVER,\n Observable,\n Subject,\n defer,\n delay,\n filter,\n map,\n merge,\n mergeWith,\n shareReplay,\n switchMap\n} from \"rxjs\"\n\nimport { configuration, feature } from \"./_\"\nimport {\n at,\n getActiveElement,\n getOptionalElement,\n requestJSON,\n setLocation,\n setToggle,\n watchDocument,\n watchKeyboard,\n watchLocation,\n watchLocationTarget,\n watchMedia,\n watchPrint,\n watchScript,\n watchViewport\n} from \"./browser\"\nimport {\n getComponentElement,\n getComponentElements,\n mountAnnounce,\n mountBackToTop,\n mountConsent,\n mountContent,\n mountDialog,\n mountHeader,\n mountHeaderTitle,\n mountPalette,\n mountProgress,\n mountSearch,\n mountSearchHiglight,\n mountSidebar,\n mountSource,\n mountTableOfContents,\n mountTabs,\n watchHeader,\n watchMain\n} from \"./components\"\nimport {\n SearchIndex,\n setupClipboardJS,\n setupInstantNavigation,\n setupVersionSelector\n} from \"./integrations\"\nimport {\n patchEllipsis,\n patchIndeterminate,\n patchScrollfix,\n patchScrolllock\n} from \"./patches\"\nimport \"./polyfills\"\n\n/* ----------------------------------------------------------------------------\n * Functions - @todo refactor\n * ------------------------------------------------------------------------- */\n\n/**\n * Fetch search index\n *\n * @returns Search index observable\n */\nfunction fetchSearchIndex(): Observable {\n if (location.protocol === \"file:\") {\n return watchScript(\n `${new URL(\"search/search_index.js\", config.base)}`\n )\n .pipe(\n // @ts-ignore - @todo fix typings\n map(() => __index),\n shareReplay(1)\n )\n } else {\n return requestJSON(\n new URL(\"search/search_index.json\", config.base)\n )\n }\n}\n\n/* ----------------------------------------------------------------------------\n * Application\n * ------------------------------------------------------------------------- */\n\n/* Yay, JavaScript is available */\ndocument.documentElement.classList.remove(\"no-js\")\ndocument.documentElement.classList.add(\"js\")\n\n/* Set up navigation observables and subjects */\nconst document$ = watchDocument()\nconst location$ = watchLocation()\nconst target$ = watchLocationTarget(location$)\nconst keyboard$ = watchKeyboard()\n\n/* Set up media observables */\nconst viewport$ = watchViewport()\nconst tablet$ = watchMedia(\"(min-width: 960px)\")\nconst screen$ = watchMedia(\"(min-width: 1220px)\")\nconst print$ = watchPrint()\n\n/* Retrieve search index, if search is enabled */\nconst config = configuration()\nconst index$ = document.forms.namedItem(\"search\")\n ? fetchSearchIndex()\n : NEVER\n\n/* Set up Clipboard.js integration */\nconst alert$ = new Subject()\nsetupClipboardJS({ alert$ })\n\n/* Set up progress indicator */\nconst progress$ = new Subject()\n\n/* Set up instant navigation, if enabled */\nif (feature(\"navigation.instant\"))\n setupInstantNavigation({ location$, viewport$, progress$ })\n .subscribe(document$)\n\n/* Set up version selector */\nif (config.version?.provider === \"mike\")\n setupVersionSelector({ document$ })\n\n/* Always close drawer and search on navigation */\nmerge(location$, target$)\n .pipe(\n delay(125)\n )\n .subscribe(() => {\n setToggle(\"drawer\", false)\n setToggle(\"search\", false)\n })\n\n/* Set up global keyboard handlers */\nkeyboard$\n .pipe(\n filter(({ mode }) => mode === \"global\")\n )\n .subscribe(key => {\n switch (key.type) {\n\n /* Go to previous page */\n case \"p\":\n case \",\":\n const prev = getOptionalElement(\"link[rel=prev]\")\n if (typeof prev !== \"undefined\")\n setLocation(prev)\n break\n\n /* Go to next page */\n case \"n\":\n case \".\":\n const next = getOptionalElement(\"link[rel=next]\")\n if (typeof next !== \"undefined\")\n setLocation(next)\n break\n\n /* Expand navigation, see https://bit.ly/3ZjG5io */\n case \"Enter\":\n const active = getActiveElement()\n if (active instanceof HTMLLabelElement)\n active.click()\n }\n })\n\n/* Set up patches */\npatchEllipsis({ viewport$, document$ })\npatchIndeterminate({ document$, tablet$ })\npatchScrollfix({ document$ })\npatchScrolllock({ viewport$, tablet$ })\n\n/* Set up header and main area observable */\nconst header$ = watchHeader(getComponentElement(\"header\"), { viewport$ })\nconst main$ = document$\n .pipe(\n map(() => getComponentElement(\"main\")),\n switchMap(el => watchMain(el, { viewport$, header$ })),\n shareReplay(1)\n )\n\n/* Set up control component observables */\nconst control$ = merge(\n\n /* Consent */\n ...getComponentElements(\"consent\")\n .map(el => mountConsent(el, { target$ })),\n\n /* Dialog */\n ...getComponentElements(\"dialog\")\n .map(el => mountDialog(el, { alert$ })),\n\n /* Header */\n ...getComponentElements(\"header\")\n .map(el => mountHeader(el, { viewport$, header$, main$ })),\n\n /* Color palette */\n ...getComponentElements(\"palette\")\n .map(el => mountPalette(el)),\n\n /* Progress bar */\n ...getComponentElements(\"progress\")\n .map(el => mountProgress(el, { progress$ })),\n\n /* Search */\n ...getComponentElements(\"search\")\n .map(el => mountSearch(el, { index$, keyboard$ })),\n\n /* Repository information */\n ...getComponentElements(\"source\")\n .map(el => mountSource(el))\n)\n\n/* Set up content component observables */\nconst content$ = defer(() => merge(\n\n /* Announcement bar */\n ...getComponentElements(\"announce\")\n .map(el => mountAnnounce(el)),\n\n /* Content */\n ...getComponentElements(\"content\")\n .map(el => mountContent(el, { viewport$, target$, print$ })),\n\n /* Search highlighting */\n ...getComponentElements(\"content\")\n .map(el => feature(\"search.highlight\")\n ? mountSearchHiglight(el, { index$, location$ })\n : EMPTY\n ),\n\n /* Header title */\n ...getComponentElements(\"header-title\")\n .map(el => mountHeaderTitle(el, { viewport$, header$ })),\n\n /* Sidebar */\n ...getComponentElements(\"sidebar\")\n .map(el => el.getAttribute(\"data-md-type\") === \"navigation\"\n ? at(screen$, () => mountSidebar(el, { viewport$, header$, main$ }))\n : at(tablet$, () => mountSidebar(el, { viewport$, header$, main$ }))\n ),\n\n /* Navigation tabs */\n ...getComponentElements(\"tabs\")\n .map(el => mountTabs(el, { viewport$, header$ })),\n\n /* Table of contents */\n ...getComponentElements(\"toc\")\n .map(el => mountTableOfContents(el, {\n viewport$, header$, main$, target$\n })),\n\n /* Back-to-top button */\n ...getComponentElements(\"top\")\n .map(el => mountBackToTop(el, { viewport$, header$, main$, target$ }))\n))\n\n/* Set up component observables */\nconst component$ = document$\n .pipe(\n switchMap(() => content$),\n mergeWith(control$),\n shareReplay(1)\n )\n\n/* Subscribe to all components */\ncomponent$.subscribe()\n\n/* ----------------------------------------------------------------------------\n * Exports\n * ------------------------------------------------------------------------- */\n\nwindow.document$ = document$ /* Document observable */\nwindow.location$ = location$ /* Location subject */\nwindow.target$ = target$ /* Location target observable */\nwindow.keyboard$ = keyboard$ /* Keyboard observable */\nwindow.viewport$ = viewport$ /* Viewport observable */\nwindow.tablet$ = tablet$ /* Media tablet observable */\nwindow.screen$ = screen$ /* Media screen observable */\nwindow.print$ = print$ /* Media print observable */\nwindow.alert$ = alert$ /* Alert subject */\nwindow.progress$ = progress$ /* Progress indicator subject */\nwindow.component$ = component$ /* Component observable */\n", "/*! *****************************************************************************\r\nCopyright (c) Microsoft Corporation.\r\n\r\nPermission to use, copy, modify, and/or distribute this software for any\r\npurpose with or without fee is hereby granted.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\r\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\r\nAND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\r\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\r\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\r\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\r\nPERFORMANCE OF THIS SOFTWARE.\r\n***************************************************************************** */\r\n/* global Reflect, Promise */\r\n\r\nvar extendStatics = function(d, b) {\r\n extendStatics = Object.setPrototypeOf ||\r\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\r\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\r\n return extendStatics(d, b);\r\n};\r\n\r\nexport function __extends(d, b) {\r\n if (typeof b !== \"function\" && b !== null)\r\n throw new TypeError(\"Class extends value \" + String(b) + \" is not a constructor or null\");\r\n extendStatics(d, b);\r\n function __() { this.constructor = d; }\r\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\r\n}\r\n\r\nexport var __assign = function() {\r\n __assign = Object.assign || function __assign(t) {\r\n for (var s, i = 1, n = arguments.length; i < n; i++) {\r\n s = arguments[i];\r\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];\r\n }\r\n return t;\r\n }\r\n return __assign.apply(this, arguments);\r\n}\r\n\r\nexport function __rest(s, e) {\r\n var t = {};\r\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)\r\n t[p] = s[p];\r\n if (s != null && typeof Object.getOwnPropertySymbols === \"function\")\r\n for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {\r\n if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))\r\n t[p[i]] = s[p[i]];\r\n }\r\n return t;\r\n}\r\n\r\nexport function __decorate(decorators, target, key, desc) {\r\n var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;\r\n if (typeof Reflect === \"object\" && typeof Reflect.decorate === \"function\") r = Reflect.decorate(decorators, target, key, desc);\r\n else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;\r\n return c > 3 && r && Object.defineProperty(target, key, r), r;\r\n}\r\n\r\nexport function __param(paramIndex, decorator) {\r\n return function (target, key) { decorator(target, key, paramIndex); }\r\n}\r\n\r\nexport function __metadata(metadataKey, metadataValue) {\r\n if (typeof Reflect === \"object\" && typeof Reflect.metadata === \"function\") return Reflect.metadata(metadataKey, metadataValue);\r\n}\r\n\r\nexport function __awaiter(thisArg, _arguments, P, generator) {\r\n function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }\r\n return new (P || (P = Promise))(function (resolve, reject) {\r\n function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }\r\n function rejected(value) { try { step(generator[\"throw\"](value)); } catch (e) { reject(e); } }\r\n function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }\r\n step((generator = generator.apply(thisArg, _arguments || [])).next());\r\n });\r\n}\r\n\r\nexport function __generator(thisArg, body) {\r\n var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;\r\n return g = { next: verb(0), \"throw\": verb(1), \"return\": verb(2) }, typeof Symbol === \"function\" && (g[Symbol.iterator] = function() { return this; }), g;\r\n function verb(n) { return function (v) { return step([n, v]); }; }\r\n function step(op) {\r\n if (f) throw new TypeError(\"Generator is already executing.\");\r\n while (_) try {\r\n if (f = 1, y && (t = op[0] & 2 ? y[\"return\"] : op[0] ? y[\"throw\"] || ((t = y[\"return\"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;\r\n if (y = 0, t) op = [op[0] & 2, t.value];\r\n switch (op[0]) {\r\n case 0: case 1: t = op; break;\r\n case 4: _.label++; return { value: op[1], done: false };\r\n case 5: _.label++; y = op[1]; op = [0]; continue;\r\n case 7: op = _.ops.pop(); _.trys.pop(); continue;\r\n default:\r\n if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }\r\n if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }\r\n if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }\r\n if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }\r\n if (t[2]) _.ops.pop();\r\n _.trys.pop(); continue;\r\n }\r\n op = body.call(thisArg, _);\r\n } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }\r\n if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };\r\n }\r\n}\r\n\r\nexport var __createBinding = Object.create ? (function(o, m, k, k2) {\r\n if (k2 === undefined) k2 = k;\r\n Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });\r\n}) : (function(o, m, k, k2) {\r\n if (k2 === undefined) k2 = k;\r\n o[k2] = m[k];\r\n});\r\n\r\nexport function __exportStar(m, o) {\r\n for (var p in m) if (p !== \"default\" && !Object.prototype.hasOwnProperty.call(o, p)) __createBinding(o, m, p);\r\n}\r\n\r\nexport function __values(o) {\r\n var s = typeof Symbol === \"function\" && Symbol.iterator, m = s && o[s], i = 0;\r\n if (m) return m.call(o);\r\n if (o && typeof o.length === \"number\") return {\r\n next: function () {\r\n if (o && i >= o.length) o = void 0;\r\n return { value: o && o[i++], done: !o };\r\n }\r\n };\r\n throw new TypeError(s ? \"Object is not iterable.\" : \"Symbol.iterator is not defined.\");\r\n}\r\n\r\nexport function __read(o, n) {\r\n var m = typeof Symbol === \"function\" && o[Symbol.iterator];\r\n if (!m) return o;\r\n var i = m.call(o), r, ar = [], e;\r\n try {\r\n while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);\r\n }\r\n catch (error) { e = { error: error }; }\r\n finally {\r\n try {\r\n if (r && !r.done && (m = i[\"return\"])) m.call(i);\r\n }\r\n finally { if (e) throw e.error; }\r\n }\r\n return ar;\r\n}\r\n\r\n/** @deprecated */\r\nexport function __spread() {\r\n for (var ar = [], i = 0; i < arguments.length; i++)\r\n ar = ar.concat(__read(arguments[i]));\r\n return ar;\r\n}\r\n\r\n/** @deprecated */\r\nexport function __spreadArrays() {\r\n for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;\r\n for (var r = Array(s), k = 0, i = 0; i < il; i++)\r\n for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)\r\n r[k] = a[j];\r\n return r;\r\n}\r\n\r\nexport function __spreadArray(to, from, pack) {\r\n if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {\r\n if (ar || !(i in from)) {\r\n if (!ar) ar = Array.prototype.slice.call(from, 0, i);\r\n ar[i] = from[i];\r\n }\r\n }\r\n return to.concat(ar || Array.prototype.slice.call(from));\r\n}\r\n\r\nexport function __await(v) {\r\n return this instanceof __await ? (this.v = v, this) : new __await(v);\r\n}\r\n\r\nexport function __asyncGenerator(thisArg, _arguments, generator) {\r\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\r\n var g = generator.apply(thisArg, _arguments || []), i, q = [];\r\n return i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i;\r\n function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }\r\n function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }\r\n function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }\r\n function fulfill(value) { resume(\"next\", value); }\r\n function reject(value) { resume(\"throw\", value); }\r\n function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }\r\n}\r\n\r\nexport function __asyncDelegator(o) {\r\n var i, p;\r\n return i = {}, verb(\"next\"), verb(\"throw\", function (e) { throw e; }), verb(\"return\"), i[Symbol.iterator] = function () { return this; }, i;\r\n function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: n === \"return\" } : f ? f(v) : v; } : f; }\r\n}\r\n\r\nexport function __asyncValues(o) {\r\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\r\n var m = o[Symbol.asyncIterator], i;\r\n return m ? m.call(o) : (o = typeof __values === \"function\" ? __values(o) : o[Symbol.iterator](), i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i);\r\n function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }\r\n function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }\r\n}\r\n\r\nexport function __makeTemplateObject(cooked, raw) {\r\n if (Object.defineProperty) { Object.defineProperty(cooked, \"raw\", { value: raw }); } else { cooked.raw = raw; }\r\n return cooked;\r\n};\r\n\r\nvar __setModuleDefault = Object.create ? (function(o, v) {\r\n Object.defineProperty(o, \"default\", { enumerable: true, value: v });\r\n}) : function(o, v) {\r\n o[\"default\"] = v;\r\n};\r\n\r\nexport function __importStar(mod) {\r\n if (mod && mod.__esModule) return mod;\r\n var result = {};\r\n if (mod != null) for (var k in mod) if (k !== \"default\" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);\r\n __setModuleDefault(result, mod);\r\n return result;\r\n}\r\n\r\nexport function __importDefault(mod) {\r\n return (mod && mod.__esModule) ? mod : { default: mod };\r\n}\r\n\r\nexport function __classPrivateFieldGet(receiver, state, kind, f) {\r\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a getter\");\r\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot read private member from an object whose class did not declare it\");\r\n return kind === \"m\" ? f : kind === \"a\" ? f.call(receiver) : f ? f.value : state.get(receiver);\r\n}\r\n\r\nexport function __classPrivateFieldSet(receiver, state, value, kind, f) {\r\n if (kind === \"m\") throw new TypeError(\"Private method is not writable\");\r\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a setter\");\r\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot write private member to an object whose class did not declare it\");\r\n return (kind === \"a\" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;\r\n}\r\n", "/**\n * Returns true if the object is a function.\n * @param value The value to check\n */\nexport function isFunction(value: any): value is (...args: any[]) => any {\n return typeof value === 'function';\n}\n", "/**\n * Used to create Error subclasses until the community moves away from ES5.\n *\n * This is because compiling from TypeScript down to ES5 has issues with subclassing Errors\n * as well as other built-in types: https://github.com/Microsoft/TypeScript/issues/12123\n *\n * @param createImpl A factory function to create the actual constructor implementation. The returned\n * function should be a named function that calls `_super` internally.\n */\nexport function createErrorClass(createImpl: (_super: any) => any): T {\n const _super = (instance: any) => {\n Error.call(instance);\n instance.stack = new Error().stack;\n };\n\n const ctorFunc = createImpl(_super);\n ctorFunc.prototype = Object.create(Error.prototype);\n ctorFunc.prototype.constructor = ctorFunc;\n return ctorFunc;\n}\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface UnsubscriptionError extends Error {\n readonly errors: any[];\n}\n\nexport interface UnsubscriptionErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (errors: any[]): UnsubscriptionError;\n}\n\n/**\n * An error thrown when one or more errors have occurred during the\n * `unsubscribe` of a {@link Subscription}.\n */\nexport const UnsubscriptionError: UnsubscriptionErrorCtor = createErrorClass(\n (_super) =>\n function UnsubscriptionErrorImpl(this: any, errors: (Error | string)[]) {\n _super(this);\n this.message = errors\n ? `${errors.length} errors occurred during unsubscription:\n${errors.map((err, i) => `${i + 1}) ${err.toString()}`).join('\\n ')}`\n : '';\n this.name = 'UnsubscriptionError';\n this.errors = errors;\n }\n);\n", "/**\n * Removes an item from an array, mutating it.\n * @param arr The array to remove the item from\n * @param item The item to remove\n */\nexport function arrRemove(arr: T[] | undefined | null, item: T) {\n if (arr) {\n const index = arr.indexOf(item);\n 0 <= index && arr.splice(index, 1);\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { UnsubscriptionError } from './util/UnsubscriptionError';\nimport { SubscriptionLike, TeardownLogic, Unsubscribable } from './types';\nimport { arrRemove } from './util/arrRemove';\n\n/**\n * Represents a disposable resource, such as the execution of an Observable. A\n * Subscription has one important method, `unsubscribe`, that takes no argument\n * and just disposes the resource held by the subscription.\n *\n * Additionally, subscriptions may be grouped together through the `add()`\n * method, which will attach a child Subscription to the current Subscription.\n * When a Subscription is unsubscribed, all its children (and its grandchildren)\n * will be unsubscribed as well.\n *\n * @class Subscription\n */\nexport class Subscription implements SubscriptionLike {\n /** @nocollapse */\n public static EMPTY = (() => {\n const empty = new Subscription();\n empty.closed = true;\n return empty;\n })();\n\n /**\n * A flag to indicate whether this Subscription has already been unsubscribed.\n */\n public closed = false;\n\n private _parentage: Subscription[] | Subscription | null = null;\n\n /**\n * The list of registered finalizers to execute upon unsubscription. Adding and removing from this\n * list occurs in the {@link #add} and {@link #remove} methods.\n */\n private _finalizers: Exclude[] | null = null;\n\n /**\n * @param initialTeardown A function executed first as part of the finalization\n * process that is kicked off when {@link #unsubscribe} is called.\n */\n constructor(private initialTeardown?: () => void) {}\n\n /**\n * Disposes the resources held by the subscription. May, for instance, cancel\n * an ongoing Observable execution or cancel any other type of work that\n * started when the Subscription was created.\n * @return {void}\n */\n unsubscribe(): void {\n let errors: any[] | undefined;\n\n if (!this.closed) {\n this.closed = true;\n\n // Remove this from it's parents.\n const { _parentage } = this;\n if (_parentage) {\n this._parentage = null;\n if (Array.isArray(_parentage)) {\n for (const parent of _parentage) {\n parent.remove(this);\n }\n } else {\n _parentage.remove(this);\n }\n }\n\n const { initialTeardown: initialFinalizer } = this;\n if (isFunction(initialFinalizer)) {\n try {\n initialFinalizer();\n } catch (e) {\n errors = e instanceof UnsubscriptionError ? e.errors : [e];\n }\n }\n\n const { _finalizers } = this;\n if (_finalizers) {\n this._finalizers = null;\n for (const finalizer of _finalizers) {\n try {\n execFinalizer(finalizer);\n } catch (err) {\n errors = errors ?? [];\n if (err instanceof UnsubscriptionError) {\n errors = [...errors, ...err.errors];\n } else {\n errors.push(err);\n }\n }\n }\n }\n\n if (errors) {\n throw new UnsubscriptionError(errors);\n }\n }\n }\n\n /**\n * Adds a finalizer to this subscription, so that finalization will be unsubscribed/called\n * when this subscription is unsubscribed. If this subscription is already {@link #closed},\n * because it has already been unsubscribed, then whatever finalizer is passed to it\n * will automatically be executed (unless the finalizer itself is also a closed subscription).\n *\n * Closed Subscriptions cannot be added as finalizers to any subscription. Adding a closed\n * subscription to a any subscription will result in no operation. (A noop).\n *\n * Adding a subscription to itself, or adding `null` or `undefined` will not perform any\n * operation at all. (A noop).\n *\n * `Subscription` instances that are added to this instance will automatically remove themselves\n * if they are unsubscribed. Functions and {@link Unsubscribable} objects that you wish to remove\n * will need to be removed manually with {@link #remove}\n *\n * @param teardown The finalization logic to add to this subscription.\n */\n add(teardown: TeardownLogic): void {\n // Only add the finalizer if it's not undefined\n // and don't add a subscription to itself.\n if (teardown && teardown !== this) {\n if (this.closed) {\n // If this subscription is already closed,\n // execute whatever finalizer is handed to it automatically.\n execFinalizer(teardown);\n } else {\n if (teardown instanceof Subscription) {\n // We don't add closed subscriptions, and we don't add the same subscription\n // twice. Subscription unsubscribe is idempotent.\n if (teardown.closed || teardown._hasParent(this)) {\n return;\n }\n teardown._addParent(this);\n }\n (this._finalizers = this._finalizers ?? []).push(teardown);\n }\n }\n }\n\n /**\n * Checks to see if a this subscription already has a particular parent.\n * This will signal that this subscription has already been added to the parent in question.\n * @param parent the parent to check for\n */\n private _hasParent(parent: Subscription) {\n const { _parentage } = this;\n return _parentage === parent || (Array.isArray(_parentage) && _parentage.includes(parent));\n }\n\n /**\n * Adds a parent to this subscription so it can be removed from the parent if it\n * unsubscribes on it's own.\n *\n * NOTE: THIS ASSUMES THAT {@link _hasParent} HAS ALREADY BEEN CHECKED.\n * @param parent The parent subscription to add\n */\n private _addParent(parent: Subscription) {\n const { _parentage } = this;\n this._parentage = Array.isArray(_parentage) ? (_parentage.push(parent), _parentage) : _parentage ? [_parentage, parent] : parent;\n }\n\n /**\n * Called on a child when it is removed via {@link #remove}.\n * @param parent The parent to remove\n */\n private _removeParent(parent: Subscription) {\n const { _parentage } = this;\n if (_parentage === parent) {\n this._parentage = null;\n } else if (Array.isArray(_parentage)) {\n arrRemove(_parentage, parent);\n }\n }\n\n /**\n * Removes a finalizer from this subscription that was previously added with the {@link #add} method.\n *\n * Note that `Subscription` instances, when unsubscribed, will automatically remove themselves\n * from every other `Subscription` they have been added to. This means that using the `remove` method\n * is not a common thing and should be used thoughtfully.\n *\n * If you add the same finalizer instance of a function or an unsubscribable object to a `Subscription` instance\n * more than once, you will need to call `remove` the same number of times to remove all instances.\n *\n * All finalizer instances are removed to free up memory upon unsubscription.\n *\n * @param teardown The finalizer to remove from this subscription\n */\n remove(teardown: Exclude): void {\n const { _finalizers } = this;\n _finalizers && arrRemove(_finalizers, teardown);\n\n if (teardown instanceof Subscription) {\n teardown._removeParent(this);\n }\n }\n}\n\nexport const EMPTY_SUBSCRIPTION = Subscription.EMPTY;\n\nexport function isSubscription(value: any): value is Subscription {\n return (\n value instanceof Subscription ||\n (value && 'closed' in value && isFunction(value.remove) && isFunction(value.add) && isFunction(value.unsubscribe))\n );\n}\n\nfunction execFinalizer(finalizer: Unsubscribable | (() => void)) {\n if (isFunction(finalizer)) {\n finalizer();\n } else {\n finalizer.unsubscribe();\n }\n}\n", "import { Subscriber } from './Subscriber';\nimport { ObservableNotification } from './types';\n\n/**\n * The {@link GlobalConfig} object for RxJS. It is used to configure things\n * like how to react on unhandled errors.\n */\nexport const config: GlobalConfig = {\n onUnhandledError: null,\n onStoppedNotification: null,\n Promise: undefined,\n useDeprecatedSynchronousErrorHandling: false,\n useDeprecatedNextContext: false,\n};\n\n/**\n * The global configuration object for RxJS, used to configure things\n * like how to react on unhandled errors. Accessible via {@link config}\n * object.\n */\nexport interface GlobalConfig {\n /**\n * A registration point for unhandled errors from RxJS. These are errors that\n * cannot were not handled by consuming code in the usual subscription path. For\n * example, if you have this configured, and you subscribe to an observable without\n * providing an error handler, errors from that subscription will end up here. This\n * will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onUnhandledError: ((err: any) => void) | null;\n\n /**\n * A registration point for notifications that cannot be sent to subscribers because they\n * have completed, errored or have been explicitly unsubscribed. By default, next, complete\n * and error notifications sent to stopped subscribers are noops. However, sometimes callers\n * might want a different behavior. For example, with sources that attempt to report errors\n * to stopped subscribers, a caller can configure RxJS to throw an unhandled error instead.\n * This will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onStoppedNotification: ((notification: ObservableNotification, subscriber: Subscriber) => void) | null;\n\n /**\n * The promise constructor used by default for {@link Observable#toPromise toPromise} and {@link Observable#forEach forEach}\n * methods.\n *\n * @deprecated As of version 8, RxJS will no longer support this sort of injection of a\n * Promise constructor. If you need a Promise implementation other than native promises,\n * please polyfill/patch Promise as you see appropriate. Will be removed in v8.\n */\n Promise?: PromiseConstructorLike;\n\n /**\n * If true, turns on synchronous error rethrowing, which is a deprecated behavior\n * in v6 and higher. This behavior enables bad patterns like wrapping a subscribe\n * call in a try/catch block. It also enables producer interference, a nasty bug\n * where a multicast can be broken for all observers by a downstream consumer with\n * an unhandled error. DO NOT USE THIS FLAG UNLESS IT'S NEEDED TO BUY TIME\n * FOR MIGRATION REASONS.\n *\n * @deprecated As of version 8, RxJS will no longer support synchronous throwing\n * of unhandled errors. All errors will be thrown on a separate call stack to prevent bad\n * behaviors described above. Will be removed in v8.\n */\n useDeprecatedSynchronousErrorHandling: boolean;\n\n /**\n * If true, enables an as-of-yet undocumented feature from v5: The ability to access\n * `unsubscribe()` via `this` context in `next` functions created in observers passed\n * to `subscribe`.\n *\n * This is being removed because the performance was severely problematic, and it could also cause\n * issues when types other than POJOs are passed to subscribe as subscribers, as they will likely have\n * their `this` context overwritten.\n *\n * @deprecated As of version 8, RxJS will no longer support altering the\n * context of next functions provided as part of an observer to Subscribe. Instead,\n * you will have access to a subscription or a signal or token that will allow you to do things like\n * unsubscribe and test closed status. Will be removed in v8.\n */\n useDeprecatedNextContext: boolean;\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetTimeoutFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearTimeoutFunction = (handle: TimerHandle) => void;\n\ninterface TimeoutProvider {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n delegate:\n | {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n }\n | undefined;\n}\n\nexport const timeoutProvider: TimeoutProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setTimeout(handler: () => void, timeout?: number, ...args) {\n const { delegate } = timeoutProvider;\n if (delegate?.setTimeout) {\n return delegate.setTimeout(handler, timeout, ...args);\n }\n return setTimeout(handler, timeout, ...args);\n },\n clearTimeout(handle) {\n const { delegate } = timeoutProvider;\n return (delegate?.clearTimeout || clearTimeout)(handle as any);\n },\n delegate: undefined,\n};\n", "import { config } from '../config';\nimport { timeoutProvider } from '../scheduler/timeoutProvider';\n\n/**\n * Handles an error on another job either with the user-configured {@link onUnhandledError},\n * or by throwing it on that new job so it can be picked up by `window.onerror`, `process.on('error')`, etc.\n *\n * This should be called whenever there is an error that is out-of-band with the subscription\n * or when an error hits a terminal boundary of the subscription and no error handler was provided.\n *\n * @param err the error to report\n */\nexport function reportUnhandledError(err: any) {\n timeoutProvider.setTimeout(() => {\n const { onUnhandledError } = config;\n if (onUnhandledError) {\n // Execute the user-configured error handler.\n onUnhandledError(err);\n } else {\n // Throw so it is picked up by the runtime's uncaught error mechanism.\n throw err;\n }\n });\n}\n", "/* tslint:disable:no-empty */\nexport function noop() { }\n", "import { CompleteNotification, NextNotification, ErrorNotification } from './types';\n\n/**\n * A completion object optimized for memory use and created to be the\n * same \"shape\" as other notifications in v8.\n * @internal\n */\nexport const COMPLETE_NOTIFICATION = (() => createNotification('C', undefined, undefined) as CompleteNotification)();\n\n/**\n * Internal use only. Creates an optimized error notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function errorNotification(error: any): ErrorNotification {\n return createNotification('E', undefined, error) as any;\n}\n\n/**\n * Internal use only. Creates an optimized next notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function nextNotification(value: T) {\n return createNotification('N', value, undefined) as NextNotification;\n}\n\n/**\n * Ensures that all notifications created internally have the same \"shape\" in v8.\n *\n * TODO: This is only exported to support a crazy legacy test in `groupBy`.\n * @internal\n */\nexport function createNotification(kind: 'N' | 'E' | 'C', value: any, error: any) {\n return {\n kind,\n value,\n error,\n };\n}\n", "import { config } from '../config';\n\nlet context: { errorThrown: boolean; error: any } | null = null;\n\n/**\n * Handles dealing with errors for super-gross mode. Creates a context, in which\n * any synchronously thrown errors will be passed to {@link captureError}. Which\n * will record the error such that it will be rethrown after the call back is complete.\n * TODO: Remove in v8\n * @param cb An immediately executed function.\n */\nexport function errorContext(cb: () => void) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n const isRoot = !context;\n if (isRoot) {\n context = { errorThrown: false, error: null };\n }\n cb();\n if (isRoot) {\n const { errorThrown, error } = context!;\n context = null;\n if (errorThrown) {\n throw error;\n }\n }\n } else {\n // This is the general non-deprecated path for everyone that\n // isn't crazy enough to use super-gross mode (useDeprecatedSynchronousErrorHandling)\n cb();\n }\n}\n\n/**\n * Captures errors only in super-gross mode.\n * @param err the error to capture\n */\nexport function captureError(err: any) {\n if (config.useDeprecatedSynchronousErrorHandling && context) {\n context.errorThrown = true;\n context.error = err;\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { Observer, ObservableNotification } from './types';\nimport { isSubscription, Subscription } from './Subscription';\nimport { config } from './config';\nimport { reportUnhandledError } from './util/reportUnhandledError';\nimport { noop } from './util/noop';\nimport { nextNotification, errorNotification, COMPLETE_NOTIFICATION } from './NotificationFactories';\nimport { timeoutProvider } from './scheduler/timeoutProvider';\nimport { captureError } from './util/errorContext';\n\n/**\n * Implements the {@link Observer} interface and extends the\n * {@link Subscription} class. While the {@link Observer} is the public API for\n * consuming the values of an {@link Observable}, all Observers get converted to\n * a Subscriber, in order to provide Subscription-like capabilities such as\n * `unsubscribe`. Subscriber is a common type in RxJS, and crucial for\n * implementing operators, but it is rarely used as a public API.\n *\n * @class Subscriber\n */\nexport class Subscriber extends Subscription implements Observer {\n /**\n * A static factory for a Subscriber, given a (potentially partial) definition\n * of an Observer.\n * @param next The `next` callback of an Observer.\n * @param error The `error` callback of an\n * Observer.\n * @param complete The `complete` callback of an\n * Observer.\n * @return A Subscriber wrapping the (partially defined)\n * Observer represented by the given arguments.\n * @nocollapse\n * @deprecated Do not use. Will be removed in v8. There is no replacement for this\n * method, and there is no reason to be creating instances of `Subscriber` directly.\n * If you have a specific use case, please file an issue.\n */\n static create(next?: (x?: T) => void, error?: (e?: any) => void, complete?: () => void): Subscriber {\n return new SafeSubscriber(next, error, complete);\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected isStopped: boolean = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected destination: Subscriber | Observer; // this `any` is the escape hatch to erase extra type param (e.g. R)\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * There is no reason to directly create an instance of Subscriber. This type is exported for typings reasons.\n */\n constructor(destination?: Subscriber | Observer) {\n super();\n if (destination) {\n this.destination = destination;\n // Automatically chain subscriptions together here.\n // if destination is a Subscription, then it is a Subscriber.\n if (isSubscription(destination)) {\n destination.add(this);\n }\n } else {\n this.destination = EMPTY_OBSERVER;\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `next` from\n * the Observable, with a value. The Observable may call this method 0 or more\n * times.\n * @param {T} [value] The `next` value.\n * @return {void}\n */\n next(value?: T): void {\n if (this.isStopped) {\n handleStoppedNotification(nextNotification(value), this);\n } else {\n this._next(value!);\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `error` from\n * the Observable, with an attached `Error`. Notifies the Observer that\n * the Observable has experienced an error condition.\n * @param {any} [err] The `error` exception.\n * @return {void}\n */\n error(err?: any): void {\n if (this.isStopped) {\n handleStoppedNotification(errorNotification(err), this);\n } else {\n this.isStopped = true;\n this._error(err);\n }\n }\n\n /**\n * The {@link Observer} callback to receive a valueless notification of type\n * `complete` from the Observable. Notifies the Observer that the Observable\n * has finished sending push-based notifications.\n * @return {void}\n */\n complete(): void {\n if (this.isStopped) {\n handleStoppedNotification(COMPLETE_NOTIFICATION, this);\n } else {\n this.isStopped = true;\n this._complete();\n }\n }\n\n unsubscribe(): void {\n if (!this.closed) {\n this.isStopped = true;\n super.unsubscribe();\n this.destination = null!;\n }\n }\n\n protected _next(value: T): void {\n this.destination.next(value);\n }\n\n protected _error(err: any): void {\n try {\n this.destination.error(err);\n } finally {\n this.unsubscribe();\n }\n }\n\n protected _complete(): void {\n try {\n this.destination.complete();\n } finally {\n this.unsubscribe();\n }\n }\n}\n\n/**\n * This bind is captured here because we want to be able to have\n * compatibility with monoid libraries that tend to use a method named\n * `bind`. In particular, a library called Monio requires this.\n */\nconst _bind = Function.prototype.bind;\n\nfunction bind any>(fn: Fn, thisArg: any): Fn {\n return _bind.call(fn, thisArg);\n}\n\n/**\n * Internal optimization only, DO NOT EXPOSE.\n * @internal\n */\nclass ConsumerObserver implements Observer {\n constructor(private partialObserver: Partial>) {}\n\n next(value: T): void {\n const { partialObserver } = this;\n if (partialObserver.next) {\n try {\n partialObserver.next(value);\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n\n error(err: any): void {\n const { partialObserver } = this;\n if (partialObserver.error) {\n try {\n partialObserver.error(err);\n } catch (error) {\n handleUnhandledError(error);\n }\n } else {\n handleUnhandledError(err);\n }\n }\n\n complete(): void {\n const { partialObserver } = this;\n if (partialObserver.complete) {\n try {\n partialObserver.complete();\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n}\n\nexport class SafeSubscriber extends Subscriber {\n constructor(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((e?: any) => void) | null,\n complete?: (() => void) | null\n ) {\n super();\n\n let partialObserver: Partial>;\n if (isFunction(observerOrNext) || !observerOrNext) {\n // The first argument is a function, not an observer. The next\n // two arguments *could* be observers, or they could be empty.\n partialObserver = {\n next: (observerOrNext ?? undefined) as (((value: T) => void) | undefined),\n error: error ?? undefined,\n complete: complete ?? undefined,\n };\n } else {\n // The first argument is a partial observer.\n let context: any;\n if (this && config.useDeprecatedNextContext) {\n // This is a deprecated path that made `this.unsubscribe()` available in\n // next handler functions passed to subscribe. This only exists behind a flag\n // now, as it is *very* slow.\n context = Object.create(observerOrNext);\n context.unsubscribe = () => this.unsubscribe();\n partialObserver = {\n next: observerOrNext.next && bind(observerOrNext.next, context),\n error: observerOrNext.error && bind(observerOrNext.error, context),\n complete: observerOrNext.complete && bind(observerOrNext.complete, context),\n };\n } else {\n // The \"normal\" path. Just use the partial observer directly.\n partialObserver = observerOrNext;\n }\n }\n\n // Wrap the partial observer to ensure it's a full observer, and\n // make sure proper error handling is accounted for.\n this.destination = new ConsumerObserver(partialObserver);\n }\n}\n\nfunction handleUnhandledError(error: any) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n captureError(error);\n } else {\n // Ideal path, we report this as an unhandled error,\n // which is thrown on a new call stack.\n reportUnhandledError(error);\n }\n}\n\n/**\n * An error handler used when no error handler was supplied\n * to the SafeSubscriber -- meaning no error handler was supplied\n * do the `subscribe` call on our observable.\n * @param err The error to handle\n */\nfunction defaultErrorHandler(err: any) {\n throw err;\n}\n\n/**\n * A handler for notifications that cannot be sent to a stopped subscriber.\n * @param notification The notification being sent\n * @param subscriber The stopped subscriber\n */\nfunction handleStoppedNotification(notification: ObservableNotification, subscriber: Subscriber) {\n const { onStoppedNotification } = config;\n onStoppedNotification && timeoutProvider.setTimeout(() => onStoppedNotification(notification, subscriber));\n}\n\n/**\n * The observer used as a stub for subscriptions where the user did not\n * pass any arguments to `subscribe`. Comes with the default error handling\n * behavior.\n */\nexport const EMPTY_OBSERVER: Readonly> & { closed: true } = {\n closed: true,\n next: noop,\n error: defaultErrorHandler,\n complete: noop,\n};\n", "/**\n * Symbol.observable or a string \"@@observable\". Used for interop\n *\n * @deprecated We will no longer be exporting this symbol in upcoming versions of RxJS.\n * Instead polyfill and use Symbol.observable directly *or* use https://www.npmjs.com/package/symbol-observable\n */\nexport const observable: string | symbol = (() => (typeof Symbol === 'function' && Symbol.observable) || '@@observable')();\n", "/**\n * This function takes one parameter and just returns it. Simply put,\n * this is like `(x: T): T => x`.\n *\n * ## Examples\n *\n * This is useful in some cases when using things like `mergeMap`\n *\n * ```ts\n * import { interval, take, map, range, mergeMap, identity } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(5));\n *\n * const result$ = source$.pipe(\n * map(i => range(i)),\n * mergeMap(identity) // same as mergeMap(x => x)\n * );\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * Or when you want to selectively apply an operator\n *\n * ```ts\n * import { interval, take, identity } from 'rxjs';\n *\n * const shouldLimit = () => Math.random() < 0.5;\n *\n * const source$ = interval(1000);\n *\n * const result$ = source$.pipe(shouldLimit() ? take(5) : identity);\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * @param x Any value that is returned by this function\n * @returns The value passed as the first parameter to this function\n */\nexport function identity(x: T): T {\n return x;\n}\n", "import { identity } from './identity';\nimport { UnaryFunction } from '../types';\n\nexport function pipe(): typeof identity;\nexport function pipe(fn1: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction, fn3: UnaryFunction): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction,\n ...fns: UnaryFunction[]\n): UnaryFunction;\n\n/**\n * pipe() can be called on one or more functions, each of which can take one argument (\"UnaryFunction\")\n * and uses it to return a value.\n * It returns a function that takes one argument, passes it to the first UnaryFunction, and then\n * passes the result to the next one, passes that result to the next one, and so on. \n */\nexport function pipe(...fns: Array>): UnaryFunction {\n return pipeFromArray(fns);\n}\n\n/** @internal */\nexport function pipeFromArray(fns: Array>): UnaryFunction {\n if (fns.length === 0) {\n return identity as UnaryFunction;\n }\n\n if (fns.length === 1) {\n return fns[0];\n }\n\n return function piped(input: T): R {\n return fns.reduce((prev: any, fn: UnaryFunction) => fn(prev), input as any);\n };\n}\n", "import { Operator } from './Operator';\nimport { SafeSubscriber, Subscriber } from './Subscriber';\nimport { isSubscription, Subscription } from './Subscription';\nimport { TeardownLogic, OperatorFunction, Subscribable, Observer } from './types';\nimport { observable as Symbol_observable } from './symbol/observable';\nimport { pipeFromArray } from './util/pipe';\nimport { config } from './config';\nimport { isFunction } from './util/isFunction';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A representation of any set of values over any amount of time. This is the most basic building block\n * of RxJS.\n *\n * @class Observable\n */\nexport class Observable implements Subscribable {\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n source: Observable | undefined;\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n operator: Operator | undefined;\n\n /**\n * @constructor\n * @param {Function} subscribe the function that is called when the Observable is\n * initially subscribed to. This function is given a Subscriber, to which new values\n * can be `next`ed, or an `error` method can be called to raise an error, or\n * `complete` can be called to notify of a successful completion.\n */\n constructor(subscribe?: (this: Observable, subscriber: Subscriber) => TeardownLogic) {\n if (subscribe) {\n this._subscribe = subscribe;\n }\n }\n\n // HACK: Since TypeScript inherits static properties too, we have to\n // fight against TypeScript here so Subject can have a different static create signature\n /**\n * Creates a new Observable by calling the Observable constructor\n * @owner Observable\n * @method create\n * @param {Function} subscribe? the subscriber function to be passed to the Observable constructor\n * @return {Observable} a new observable\n * @nocollapse\n * @deprecated Use `new Observable()` instead. Will be removed in v8.\n */\n static create: (...args: any[]) => any = (subscribe?: (subscriber: Subscriber) => TeardownLogic) => {\n return new Observable(subscribe);\n };\n\n /**\n * Creates a new Observable, with this Observable instance as the source, and the passed\n * operator defined as the new observable's operator.\n * @method lift\n * @param operator the operator defining the operation to take on the observable\n * @return a new observable with the Operator applied\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * If you have implemented an operator using `lift`, it is recommended that you create an\n * operator by simply returning `new Observable()` directly. See \"Creating new operators from\n * scratch\" section here: https://rxjs.dev/guide/operators\n */\n lift(operator?: Operator): Observable {\n const observable = new Observable();\n observable.source = this;\n observable.operator = operator;\n return observable;\n }\n\n subscribe(observerOrNext?: Partial> | ((value: T) => void)): Subscription;\n /** @deprecated Instead of passing separate callback arguments, use an observer argument. Signatures taking separate callback arguments will be removed in v8. Details: https://rxjs.dev/deprecations/subscribe-arguments */\n subscribe(next?: ((value: T) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription;\n /**\n * Invokes an execution of an Observable and registers Observer handlers for notifications it will emit.\n *\n * Use it when you have all these Observables, but still nothing is happening.\n *\n * `subscribe` is not a regular operator, but a method that calls Observable's internal `subscribe` function. It\n * might be for example a function that you passed to Observable's constructor, but most of the time it is\n * a library implementation, which defines what will be emitted by an Observable, and when it be will emitted. This means\n * that calling `subscribe` is actually the moment when Observable starts its work, not when it is created, as it is often\n * the thought.\n *\n * Apart from starting the execution of an Observable, this method allows you to listen for values\n * that an Observable emits, as well as for when it completes or errors. You can achieve this in two\n * of the following ways.\n *\n * The first way is creating an object that implements {@link Observer} interface. It should have methods\n * defined by that interface, but note that it should be just a regular JavaScript object, which you can create\n * yourself in any way you want (ES6 class, classic function constructor, object literal etc.). In particular, do\n * not attempt to use any RxJS implementation details to create Observers - you don't need them. Remember also\n * that your object does not have to implement all methods. If you find yourself creating a method that doesn't\n * do anything, you can simply omit it. Note however, if the `error` method is not provided and an error happens,\n * it will be thrown asynchronously. Errors thrown asynchronously cannot be caught using `try`/`catch`. Instead,\n * use the {@link onUnhandledError} configuration option or use a runtime handler (like `window.onerror` or\n * `process.on('error)`) to be notified of unhandled errors. Because of this, it's recommended that you provide\n * an `error` method to avoid missing thrown errors.\n *\n * The second way is to give up on Observer object altogether and simply provide callback functions in place of its methods.\n * This means you can provide three functions as arguments to `subscribe`, where the first function is equivalent\n * of a `next` method, the second of an `error` method and the third of a `complete` method. Just as in case of an Observer,\n * if you do not need to listen for something, you can omit a function by passing `undefined` or `null`,\n * since `subscribe` recognizes these functions by where they were placed in function call. When it comes\n * to the `error` function, as with an Observer, if not provided, errors emitted by an Observable will be thrown asynchronously.\n *\n * You can, however, subscribe with no parameters at all. This may be the case where you're not interested in terminal events\n * and you also handled emissions internally by using operators (e.g. using `tap`).\n *\n * Whichever style of calling `subscribe` you use, in both cases it returns a Subscription object.\n * This object allows you to call `unsubscribe` on it, which in turn will stop the work that an Observable does and will clean\n * up all resources that an Observable used. Note that cancelling a subscription will not call `complete` callback\n * provided to `subscribe` function, which is reserved for a regular completion signal that comes from an Observable.\n *\n * Remember that callbacks provided to `subscribe` are not guaranteed to be called asynchronously.\n * It is an Observable itself that decides when these functions will be called. For example {@link of}\n * by default emits all its values synchronously. Always check documentation for how given Observable\n * will behave when subscribed and if its default behavior can be modified with a `scheduler`.\n *\n * #### Examples\n *\n * Subscribe with an {@link guide/observer Observer}\n *\n * ```ts\n * import { of } from 'rxjs';\n *\n * const sumObserver = {\n * sum: 0,\n * next(value) {\n * console.log('Adding: ' + value);\n * this.sum = this.sum + value;\n * },\n * error() {\n * // We actually could just remove this method,\n * // since we do not really care about errors right now.\n * },\n * complete() {\n * console.log('Sum equals: ' + this.sum);\n * }\n * };\n *\n * of(1, 2, 3) // Synchronously emits 1, 2, 3 and then completes.\n * .subscribe(sumObserver);\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Subscribe with functions ({@link deprecations/subscribe-arguments deprecated})\n *\n * ```ts\n * import { of } from 'rxjs'\n *\n * let sum = 0;\n *\n * of(1, 2, 3).subscribe(\n * value => {\n * console.log('Adding: ' + value);\n * sum = sum + value;\n * },\n * undefined,\n * () => console.log('Sum equals: ' + sum)\n * );\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Cancel a subscription\n *\n * ```ts\n * import { interval } from 'rxjs';\n *\n * const subscription = interval(1000).subscribe({\n * next(num) {\n * console.log(num)\n * },\n * complete() {\n * // Will not be called, even when cancelling subscription.\n * console.log('completed!');\n * }\n * });\n *\n * setTimeout(() => {\n * subscription.unsubscribe();\n * console.log('unsubscribed!');\n * }, 2500);\n *\n * // Logs:\n * // 0 after 1s\n * // 1 after 2s\n * // 'unsubscribed!' after 2.5s\n * ```\n *\n * @param {Observer|Function} observerOrNext (optional) Either an observer with methods to be called,\n * or the first of three possible handlers, which is the handler for each value emitted from the subscribed\n * Observable.\n * @param {Function} error (optional) A handler for a terminal event resulting from an error. If no error handler is provided,\n * the error will be thrown asynchronously as unhandled.\n * @param {Function} complete (optional) A handler for a terminal event resulting from successful completion.\n * @return {Subscription} a subscription reference to the registered handlers\n * @method subscribe\n */\n subscribe(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((error: any) => void) | null,\n complete?: (() => void) | null\n ): Subscription {\n const subscriber = isSubscriber(observerOrNext) ? observerOrNext : new SafeSubscriber(observerOrNext, error, complete);\n\n errorContext(() => {\n const { operator, source } = this;\n subscriber.add(\n operator\n ? // We're dealing with a subscription in the\n // operator chain to one of our lifted operators.\n operator.call(subscriber, source)\n : source\n ? // If `source` has a value, but `operator` does not, something that\n // had intimate knowledge of our API, like our `Subject`, must have\n // set it. We're going to just call `_subscribe` directly.\n this._subscribe(subscriber)\n : // In all other cases, we're likely wrapping a user-provided initializer\n // function, so we need to catch errors and handle them appropriately.\n this._trySubscribe(subscriber)\n );\n });\n\n return subscriber;\n }\n\n /** @internal */\n protected _trySubscribe(sink: Subscriber): TeardownLogic {\n try {\n return this._subscribe(sink);\n } catch (err) {\n // We don't need to return anything in this case,\n // because it's just going to try to `add()` to a subscription\n // above.\n sink.error(err);\n }\n }\n\n /**\n * Used as a NON-CANCELLABLE means of subscribing to an observable, for use with\n * APIs that expect promises, like `async/await`. You cannot unsubscribe from this.\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * #### Example\n *\n * ```ts\n * import { interval, take } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(4));\n *\n * async function getTotal() {\n * let total = 0;\n *\n * await source$.forEach(value => {\n * total += value;\n * console.log('observable -> ' + value);\n * });\n *\n * return total;\n * }\n *\n * getTotal().then(\n * total => console.log('Total: ' + total)\n * );\n *\n * // Expected:\n * // 'observable -> 0'\n * // 'observable -> 1'\n * // 'observable -> 2'\n * // 'observable -> 3'\n * // 'Total: 6'\n * ```\n *\n * @param next a handler for each value emitted by the observable\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n */\n forEach(next: (value: T) => void): Promise;\n\n /**\n * @param next a handler for each value emitted by the observable\n * @param promiseCtor a constructor function used to instantiate the Promise\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n * @deprecated Passing a Promise constructor will no longer be available\n * in upcoming versions of RxJS. This is because it adds weight to the library, for very\n * little benefit. If you need this functionality, it is recommended that you either\n * polyfill Promise, or you create an adapter to convert the returned native promise\n * to whatever promise implementation you wanted. Will be removed in v8.\n */\n forEach(next: (value: T) => void, promiseCtor: PromiseConstructorLike): Promise;\n\n forEach(next: (value: T) => void, promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n const subscriber = new SafeSubscriber({\n next: (value) => {\n try {\n next(value);\n } catch (err) {\n reject(err);\n subscriber.unsubscribe();\n }\n },\n error: reject,\n complete: resolve,\n });\n this.subscribe(subscriber);\n }) as Promise;\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): TeardownLogic {\n return this.source?.subscribe(subscriber);\n }\n\n /**\n * An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable\n * @method Symbol.observable\n * @return {Observable} this instance of the observable\n */\n [Symbol_observable]() {\n return this;\n }\n\n /* tslint:disable:max-line-length */\n pipe(): Observable;\n pipe(op1: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction,\n ...operations: OperatorFunction[]\n ): Observable;\n /* tslint:enable:max-line-length */\n\n /**\n * Used to stitch together functional operators into a chain.\n * @method pipe\n * @return {Observable} the Observable result of all of the operators having\n * been called in the order they were passed in.\n *\n * ## Example\n *\n * ```ts\n * import { interval, filter, map, scan } from 'rxjs';\n *\n * interval(1000)\n * .pipe(\n * filter(x => x % 2 === 0),\n * map(x => x + x),\n * scan((acc, x) => acc + x)\n * )\n * .subscribe(x => console.log(x));\n * ```\n */\n pipe(...operations: OperatorFunction[]): Observable {\n return pipeFromArray(operations)(this);\n }\n\n /* tslint:disable:max-line-length */\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: typeof Promise): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: PromiseConstructorLike): Promise;\n /* tslint:enable:max-line-length */\n\n /**\n * Subscribe to this Observable and get a Promise resolving on\n * `complete` with the last emission (if any).\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * @method toPromise\n * @param [promiseCtor] a constructor function used to instantiate\n * the Promise\n * @return A Promise that resolves with the last value emit, or\n * rejects on an error. If there were no emissions, Promise\n * resolves with undefined.\n * @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise\n */\n toPromise(promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n let value: T | undefined;\n this.subscribe(\n (x: T) => (value = x),\n (err: any) => reject(err),\n () => resolve(value)\n );\n }) as Promise;\n }\n}\n\n/**\n * Decides between a passed promise constructor from consuming code,\n * A default configured promise constructor, and the native promise\n * constructor and returns it. If nothing can be found, it will throw\n * an error.\n * @param promiseCtor The optional promise constructor to passed by consuming code\n */\nfunction getPromiseCtor(promiseCtor: PromiseConstructorLike | undefined) {\n return promiseCtor ?? config.Promise ?? Promise;\n}\n\nfunction isObserver(value: any): value is Observer {\n return value && isFunction(value.next) && isFunction(value.error) && isFunction(value.complete);\n}\n\nfunction isSubscriber(value: any): value is Subscriber {\n return (value && value instanceof Subscriber) || (isObserver(value) && isSubscription(value));\n}\n", "import { Observable } from '../Observable';\nimport { Subscriber } from '../Subscriber';\nimport { OperatorFunction } from '../types';\nimport { isFunction } from './isFunction';\n\n/**\n * Used to determine if an object is an Observable with a lift function.\n */\nexport function hasLift(source: any): source is { lift: InstanceType['lift'] } {\n return isFunction(source?.lift);\n}\n\n/**\n * Creates an `OperatorFunction`. Used to define operators throughout the library in a concise way.\n * @param init The logic to connect the liftedSource to the subscriber at the moment of subscription.\n */\nexport function operate(\n init: (liftedSource: Observable, subscriber: Subscriber) => (() => void) | void\n): OperatorFunction {\n return (source: Observable) => {\n if (hasLift(source)) {\n return source.lift(function (this: Subscriber, liftedSource: Observable) {\n try {\n return init(liftedSource, this);\n } catch (err) {\n this.error(err);\n }\n });\n }\n throw new TypeError('Unable to lift unknown Observable type');\n };\n}\n", "import { Subscriber } from '../Subscriber';\n\n/**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional teardown logic here. This will only be called on teardown if the\n * subscriber itself is not already closed. This is called after all other teardown logic is executed.\n */\nexport function createOperatorSubscriber(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n onFinalize?: () => void\n): Subscriber {\n return new OperatorSubscriber(destination, onNext, onComplete, onError, onFinalize);\n}\n\n/**\n * A generic helper for allowing operators to be created with a Subscriber and\n * use closures to capture necessary state from the operator function itself.\n */\nexport class OperatorSubscriber extends Subscriber {\n /**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional finalization logic here. This will only be called on finalization if the\n * subscriber itself is not already closed. This is called after all other finalization logic is executed.\n * @param shouldUnsubscribe An optional check to see if an unsubscribe call should truly unsubscribe.\n * NOTE: This currently **ONLY** exists to support the strange behavior of {@link groupBy}, where unsubscription\n * to the resulting observable does not actually disconnect from the source if there are active subscriptions\n * to any grouped observable. (DO NOT EXPOSE OR USE EXTERNALLY!!!)\n */\n constructor(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n private onFinalize?: () => void,\n private shouldUnsubscribe?: () => boolean\n ) {\n // It's important - for performance reasons - that all of this class's\n // members are initialized and that they are always initialized in the same\n // order. This will ensure that all OperatorSubscriber instances have the\n // same hidden class in V8. This, in turn, will help keep the number of\n // hidden classes involved in property accesses within the base class as\n // low as possible. If the number of hidden classes involved exceeds four,\n // the property accesses will become megamorphic and performance penalties\n // will be incurred - i.e. inline caches won't be used.\n //\n // The reasons for ensuring all instances have the same hidden class are\n // further discussed in this blog post from Benedikt Meurer:\n // https://benediktmeurer.de/2018/03/23/impact-of-polymorphism-on-component-based-frameworks-like-react/\n super(destination);\n this._next = onNext\n ? function (this: OperatorSubscriber, value: T) {\n try {\n onNext(value);\n } catch (err) {\n destination.error(err);\n }\n }\n : super._next;\n this._error = onError\n ? function (this: OperatorSubscriber, err: any) {\n try {\n onError(err);\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._error;\n this._complete = onComplete\n ? function (this: OperatorSubscriber) {\n try {\n onComplete();\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._complete;\n }\n\n unsubscribe() {\n if (!this.shouldUnsubscribe || this.shouldUnsubscribe()) {\n const { closed } = this;\n super.unsubscribe();\n // Execute additional teardown if we have any and we didn't already do so.\n !closed && this.onFinalize?.();\n }\n }\n}\n", "import { Subscription } from '../Subscription';\n\ninterface AnimationFrameProvider {\n schedule(callback: FrameRequestCallback): Subscription;\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n delegate:\n | {\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n }\n | undefined;\n}\n\nexport const animationFrameProvider: AnimationFrameProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n schedule(callback) {\n let request = requestAnimationFrame;\n let cancel: typeof cancelAnimationFrame | undefined = cancelAnimationFrame;\n const { delegate } = animationFrameProvider;\n if (delegate) {\n request = delegate.requestAnimationFrame;\n cancel = delegate.cancelAnimationFrame;\n }\n const handle = request((timestamp) => {\n // Clear the cancel function. The request has been fulfilled, so\n // attempting to cancel the request upon unsubscription would be\n // pointless.\n cancel = undefined;\n callback(timestamp);\n });\n return new Subscription(() => cancel?.(handle));\n },\n requestAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.requestAnimationFrame || requestAnimationFrame)(...args);\n },\n cancelAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.cancelAnimationFrame || cancelAnimationFrame)(...args);\n },\n delegate: undefined,\n};\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface ObjectUnsubscribedError extends Error {}\n\nexport interface ObjectUnsubscribedErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (): ObjectUnsubscribedError;\n}\n\n/**\n * An error thrown when an action is invalid because the object has been\n * unsubscribed.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n *\n * @class ObjectUnsubscribedError\n */\nexport const ObjectUnsubscribedError: ObjectUnsubscribedErrorCtor = createErrorClass(\n (_super) =>\n function ObjectUnsubscribedErrorImpl(this: any) {\n _super(this);\n this.name = 'ObjectUnsubscribedError';\n this.message = 'object unsubscribed';\n }\n);\n", "import { Operator } from './Operator';\nimport { Observable } from './Observable';\nimport { Subscriber } from './Subscriber';\nimport { Subscription, EMPTY_SUBSCRIPTION } from './Subscription';\nimport { Observer, SubscriptionLike, TeardownLogic } from './types';\nimport { ObjectUnsubscribedError } from './util/ObjectUnsubscribedError';\nimport { arrRemove } from './util/arrRemove';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A Subject is a special type of Observable that allows values to be\n * multicasted to many Observers. Subjects are like EventEmitters.\n *\n * Every Subject is an Observable and an Observer. You can subscribe to a\n * Subject, and you can call next to feed values as well as error and complete.\n */\nexport class Subject extends Observable implements SubscriptionLike {\n closed = false;\n\n private currentObservers: Observer[] | null = null;\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n observers: Observer[] = [];\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n isStopped = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n hasError = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n thrownError: any = null;\n\n /**\n * Creates a \"subject\" by basically gluing an observer to an observable.\n *\n * @nocollapse\n * @deprecated Recommended you do not use. Will be removed at some point in the future. Plans for replacement still under discussion.\n */\n static create: (...args: any[]) => any = (destination: Observer, source: Observable): AnonymousSubject => {\n return new AnonymousSubject(destination, source);\n };\n\n constructor() {\n // NOTE: This must be here to obscure Observable's constructor.\n super();\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n lift(operator: Operator): Observable {\n const subject = new AnonymousSubject(this, this);\n subject.operator = operator as any;\n return subject as any;\n }\n\n /** @internal */\n protected _throwIfClosed() {\n if (this.closed) {\n throw new ObjectUnsubscribedError();\n }\n }\n\n next(value: T) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n if (!this.currentObservers) {\n this.currentObservers = Array.from(this.observers);\n }\n for (const observer of this.currentObservers) {\n observer.next(value);\n }\n }\n });\n }\n\n error(err: any) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.hasError = this.isStopped = true;\n this.thrownError = err;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.error(err);\n }\n }\n });\n }\n\n complete() {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.isStopped = true;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.complete();\n }\n }\n });\n }\n\n unsubscribe() {\n this.isStopped = this.closed = true;\n this.observers = this.currentObservers = null!;\n }\n\n get observed() {\n return this.observers?.length > 0;\n }\n\n /** @internal */\n protected _trySubscribe(subscriber: Subscriber): TeardownLogic {\n this._throwIfClosed();\n return super._trySubscribe(subscriber);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._checkFinalizedStatuses(subscriber);\n return this._innerSubscribe(subscriber);\n }\n\n /** @internal */\n protected _innerSubscribe(subscriber: Subscriber) {\n const { hasError, isStopped, observers } = this;\n if (hasError || isStopped) {\n return EMPTY_SUBSCRIPTION;\n }\n this.currentObservers = null;\n observers.push(subscriber);\n return new Subscription(() => {\n this.currentObservers = null;\n arrRemove(observers, subscriber);\n });\n }\n\n /** @internal */\n protected _checkFinalizedStatuses(subscriber: Subscriber) {\n const { hasError, thrownError, isStopped } = this;\n if (hasError) {\n subscriber.error(thrownError);\n } else if (isStopped) {\n subscriber.complete();\n }\n }\n\n /**\n * Creates a new Observable with this Subject as the source. You can do this\n * to create custom Observer-side logic of the Subject and conceal it from\n * code that uses the Observable.\n * @return {Observable} Observable that the Subject casts to\n */\n asObservable(): Observable {\n const observable: any = new Observable();\n observable.source = this;\n return observable;\n }\n}\n\n/**\n * @class AnonymousSubject\n */\nexport class AnonymousSubject extends Subject {\n constructor(\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n public destination?: Observer,\n source?: Observable\n ) {\n super();\n this.source = source;\n }\n\n next(value: T) {\n this.destination?.next?.(value);\n }\n\n error(err: any) {\n this.destination?.error?.(err);\n }\n\n complete() {\n this.destination?.complete?.();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n return this.source?.subscribe(subscriber) ?? EMPTY_SUBSCRIPTION;\n }\n}\n", "import { Subject } from './Subject';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\n\n/**\n * A variant of Subject that requires an initial value and emits its current\n * value whenever it is subscribed to.\n *\n * @class BehaviorSubject\n */\nexport class BehaviorSubject extends Subject {\n constructor(private _value: T) {\n super();\n }\n\n get value(): T {\n return this.getValue();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n const subscription = super._subscribe(subscriber);\n !subscription.closed && subscriber.next(this._value);\n return subscription;\n }\n\n getValue(): T {\n const { hasError, thrownError, _value } = this;\n if (hasError) {\n throw thrownError;\n }\n this._throwIfClosed();\n return _value;\n }\n\n next(value: T): void {\n super.next((this._value = value));\n }\n}\n", "import { TimestampProvider } from '../types';\n\ninterface DateTimestampProvider extends TimestampProvider {\n delegate: TimestampProvider | undefined;\n}\n\nexport const dateTimestampProvider: DateTimestampProvider = {\n now() {\n // Use the variable rather than `this` so that the function can be called\n // without being bound to the provider.\n return (dateTimestampProvider.delegate || Date).now();\n },\n delegate: undefined,\n};\n", "import { Subject } from './Subject';\nimport { TimestampProvider } from './types';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * A variant of {@link Subject} that \"replays\" old values to new subscribers by emitting them when they first subscribe.\n *\n * `ReplaySubject` has an internal buffer that will store a specified number of values that it has observed. Like `Subject`,\n * `ReplaySubject` \"observes\" values by having them passed to its `next` method. When it observes a value, it will store that\n * value for a time determined by the configuration of the `ReplaySubject`, as passed to its constructor.\n *\n * When a new subscriber subscribes to the `ReplaySubject` instance, it will synchronously emit all values in its buffer in\n * a First-In-First-Out (FIFO) manner. The `ReplaySubject` will also complete, if it has observed completion; and it will\n * error if it has observed an error.\n *\n * There are two main configuration items to be concerned with:\n *\n * 1. `bufferSize` - This will determine how many items are stored in the buffer, defaults to infinite.\n * 2. `windowTime` - The amount of time to hold a value in the buffer before removing it from the buffer.\n *\n * Both configurations may exist simultaneously. So if you would like to buffer a maximum of 3 values, as long as the values\n * are less than 2 seconds old, you could do so with a `new ReplaySubject(3, 2000)`.\n *\n * ### Differences with BehaviorSubject\n *\n * `BehaviorSubject` is similar to `new ReplaySubject(1)`, with a couple of exceptions:\n *\n * 1. `BehaviorSubject` comes \"primed\" with a single value upon construction.\n * 2. `ReplaySubject` will replay values, even after observing an error, where `BehaviorSubject` will not.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n * @see {@link shareReplay}\n */\nexport class ReplaySubject extends Subject {\n private _buffer: (T | number)[] = [];\n private _infiniteTimeWindow = true;\n\n /**\n * @param bufferSize The size of the buffer to replay on subscription\n * @param windowTime The amount of time the buffered items will stay buffered\n * @param timestampProvider An object with a `now()` method that provides the current timestamp. This is used to\n * calculate the amount of time something has been buffered.\n */\n constructor(\n private _bufferSize = Infinity,\n private _windowTime = Infinity,\n private _timestampProvider: TimestampProvider = dateTimestampProvider\n ) {\n super();\n this._infiniteTimeWindow = _windowTime === Infinity;\n this._bufferSize = Math.max(1, _bufferSize);\n this._windowTime = Math.max(1, _windowTime);\n }\n\n next(value: T): void {\n const { isStopped, _buffer, _infiniteTimeWindow, _timestampProvider, _windowTime } = this;\n if (!isStopped) {\n _buffer.push(value);\n !_infiniteTimeWindow && _buffer.push(_timestampProvider.now() + _windowTime);\n }\n this._trimBuffer();\n super.next(value);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._trimBuffer();\n\n const subscription = this._innerSubscribe(subscriber);\n\n const { _infiniteTimeWindow, _buffer } = this;\n // We use a copy here, so reentrant code does not mutate our array while we're\n // emitting it to a new subscriber.\n const copy = _buffer.slice();\n for (let i = 0; i < copy.length && !subscriber.closed; i += _infiniteTimeWindow ? 1 : 2) {\n subscriber.next(copy[i] as T);\n }\n\n this._checkFinalizedStatuses(subscriber);\n\n return subscription;\n }\n\n private _trimBuffer() {\n const { _bufferSize, _timestampProvider, _buffer, _infiniteTimeWindow } = this;\n // If we don't have an infinite buffer size, and we're over the length,\n // use splice to truncate the old buffer values off. Note that we have to\n // double the size for instances where we're not using an infinite time window\n // because we're storing the values and the timestamps in the same array.\n const adjustedBufferSize = (_infiniteTimeWindow ? 1 : 2) * _bufferSize;\n _bufferSize < Infinity && adjustedBufferSize < _buffer.length && _buffer.splice(0, _buffer.length - adjustedBufferSize);\n\n // Now, if we're not in an infinite time window, remove all values where the time is\n // older than what is allowed.\n if (!_infiniteTimeWindow) {\n const now = _timestampProvider.now();\n let last = 0;\n // Search the array for the first timestamp that isn't expired and\n // truncate the buffer up to that point.\n for (let i = 1; i < _buffer.length && (_buffer[i] as number) <= now; i += 2) {\n last = i;\n }\n last && _buffer.splice(0, last + 1);\n }\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Subscription } from '../Subscription';\nimport { SchedulerAction } from '../types';\n\n/**\n * A unit of work to be executed in a `scheduler`. An action is typically\n * created from within a {@link SchedulerLike} and an RxJS user does not need to concern\n * themselves about creating and manipulating an Action.\n *\n * ```ts\n * class Action extends Subscription {\n * new (scheduler: Scheduler, work: (state?: T) => void);\n * schedule(state?: T, delay: number = 0): Subscription;\n * }\n * ```\n *\n * @class Action\n */\nexport class Action extends Subscription {\n constructor(scheduler: Scheduler, work: (this: SchedulerAction, state?: T) => void) {\n super();\n }\n /**\n * Schedules this action on its parent {@link SchedulerLike} for execution. May be passed\n * some context object, `state`. May happen at some point in the future,\n * according to the `delay` parameter, if specified.\n * @param {T} [state] Some contextual data that the `work` function uses when\n * called by the Scheduler.\n * @param {number} [delay] Time to wait before executing the work, where the\n * time unit is implicit and defined by the Scheduler.\n * @return {void}\n */\n public schedule(state?: T, delay: number = 0): Subscription {\n return this;\n }\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetIntervalFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearIntervalFunction = (handle: TimerHandle) => void;\n\ninterface IntervalProvider {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n delegate:\n | {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n }\n | undefined;\n}\n\nexport const intervalProvider: IntervalProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setInterval(handler: () => void, timeout?: number, ...args) {\n const { delegate } = intervalProvider;\n if (delegate?.setInterval) {\n return delegate.setInterval(handler, timeout, ...args);\n }\n return setInterval(handler, timeout, ...args);\n },\n clearInterval(handle) {\n const { delegate } = intervalProvider;\n return (delegate?.clearInterval || clearInterval)(handle as any);\n },\n delegate: undefined,\n};\n", "import { Action } from './Action';\nimport { SchedulerAction } from '../types';\nimport { Subscription } from '../Subscription';\nimport { AsyncScheduler } from './AsyncScheduler';\nimport { intervalProvider } from './intervalProvider';\nimport { arrRemove } from '../util/arrRemove';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncAction extends Action {\n public id: TimerHandle | undefined;\n public state?: T;\n // @ts-ignore: Property has no initializer and is not definitely assigned\n public delay: number;\n protected pending: boolean = false;\n\n constructor(protected scheduler: AsyncScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (this.closed) {\n return this;\n }\n\n // Always replace the current state with the new state.\n this.state = state;\n\n const id = this.id;\n const scheduler = this.scheduler;\n\n //\n // Important implementation note:\n //\n // Actions only execute once by default, unless rescheduled from within the\n // scheduled callback. This allows us to implement single and repeat\n // actions via the same code path, without adding API surface area, as well\n // as mimic traditional recursion but across asynchronous boundaries.\n //\n // However, JS runtimes and timers distinguish between intervals achieved by\n // serial `setTimeout` calls vs. a single `setInterval` call. An interval of\n // serial `setTimeout` calls can be individually delayed, which delays\n // scheduling the next `setTimeout`, and so on. `setInterval` attempts to\n // guarantee the interval callback will be invoked more precisely to the\n // interval period, regardless of load.\n //\n // Therefore, we use `setInterval` to schedule single and repeat actions.\n // If the action reschedules itself with the same delay, the interval is not\n // canceled. If the action doesn't reschedule, or reschedules with a\n // different delay, the interval will be canceled after scheduled callback\n // execution.\n //\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, delay);\n }\n\n // Set the pending flag indicating that this action has been scheduled, or\n // has recursively rescheduled itself.\n this.pending = true;\n\n this.delay = delay;\n // If this action has already an async Id, don't request a new one.\n this.id = this.id ?? this.requestAsyncId(scheduler, this.id, delay);\n\n return this;\n }\n\n protected requestAsyncId(scheduler: AsyncScheduler, _id?: TimerHandle, delay: number = 0): TimerHandle {\n return intervalProvider.setInterval(scheduler.flush.bind(scheduler, this), delay);\n }\n\n protected recycleAsyncId(_scheduler: AsyncScheduler, id?: TimerHandle, delay: number | null = 0): TimerHandle | undefined {\n // If this action is rescheduled with the same delay time, don't clear the interval id.\n if (delay != null && this.delay === delay && this.pending === false) {\n return id;\n }\n // Otherwise, if the action's delay time is different from the current delay,\n // or the action has been rescheduled before it's executed, clear the interval id\n if (id != null) {\n intervalProvider.clearInterval(id);\n }\n\n return undefined;\n }\n\n /**\n * Immediately executes this action and the `work` it contains.\n * @return {any}\n */\n public execute(state: T, delay: number): any {\n if (this.closed) {\n return new Error('executing a cancelled action');\n }\n\n this.pending = false;\n const error = this._execute(state, delay);\n if (error) {\n return error;\n } else if (this.pending === false && this.id != null) {\n // Dequeue if the action didn't reschedule itself. Don't call\n // unsubscribe(), because the action could reschedule later.\n // For example:\n // ```\n // scheduler.schedule(function doWork(counter) {\n // /* ... I'm a busy worker bee ... */\n // var originalAction = this;\n // /* wait 100ms before rescheduling the action */\n // setTimeout(function () {\n // originalAction.schedule(counter + 1);\n // }, 100);\n // }, 1000);\n // ```\n this.id = this.recycleAsyncId(this.scheduler, this.id, null);\n }\n }\n\n protected _execute(state: T, _delay: number): any {\n let errored: boolean = false;\n let errorValue: any;\n try {\n this.work(state);\n } catch (e) {\n errored = true;\n // HACK: Since code elsewhere is relying on the \"truthiness\" of the\n // return here, we can't have it return \"\" or 0 or false.\n // TODO: Clean this up when we refactor schedulers mid-version-8 or so.\n errorValue = e ? e : new Error('Scheduled action threw falsy error');\n }\n if (errored) {\n this.unsubscribe();\n return errorValue;\n }\n }\n\n unsubscribe() {\n if (!this.closed) {\n const { id, scheduler } = this;\n const { actions } = scheduler;\n\n this.work = this.state = this.scheduler = null!;\n this.pending = false;\n\n arrRemove(actions, this);\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, null);\n }\n\n this.delay = null!;\n super.unsubscribe();\n }\n }\n}\n", "import { Action } from './scheduler/Action';\nimport { Subscription } from './Subscription';\nimport { SchedulerLike, SchedulerAction } from './types';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * An execution context and a data structure to order tasks and schedule their\n * execution. Provides a notion of (potentially virtual) time, through the\n * `now()` getter method.\n *\n * Each unit of work in a Scheduler is called an `Action`.\n *\n * ```ts\n * class Scheduler {\n * now(): number;\n * schedule(work, delay?, state?): Subscription;\n * }\n * ```\n *\n * @class Scheduler\n * @deprecated Scheduler is an internal implementation detail of RxJS, and\n * should not be used directly. Rather, create your own class and implement\n * {@link SchedulerLike}. Will be made internal in v8.\n */\nexport class Scheduler implements SchedulerLike {\n public static now: () => number = dateTimestampProvider.now;\n\n constructor(private schedulerActionCtor: typeof Action, now: () => number = Scheduler.now) {\n this.now = now;\n }\n\n /**\n * A getter method that returns a number representing the current time\n * (at the time this function was called) according to the scheduler's own\n * internal clock.\n * @return {number} A number that represents the current time. May or may not\n * have a relation to wall-clock time. May or may not refer to a time unit\n * (e.g. milliseconds).\n */\n public now: () => number;\n\n /**\n * Schedules a function, `work`, for execution. May happen at some point in\n * the future, according to the `delay` parameter, if specified. May be passed\n * some context object, `state`, which will be passed to the `work` function.\n *\n * The given arguments will be processed an stored as an Action object in a\n * queue of actions.\n *\n * @param {function(state: ?T): ?Subscription} work A function representing a\n * task, or some unit of work to be executed by the Scheduler.\n * @param {number} [delay] Time to wait before executing the work, where the\n * time unit is implicit and defined by the Scheduler itself.\n * @param {T} [state] Some contextual data that the `work` function uses when\n * called by the Scheduler.\n * @return {Subscription} A subscription in order to be able to unsubscribe\n * the scheduled work.\n */\n public schedule(work: (this: SchedulerAction, state?: T) => void, delay: number = 0, state?: T): Subscription {\n return new this.schedulerActionCtor(this, work).schedule(state, delay);\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Action } from './Action';\nimport { AsyncAction } from './AsyncAction';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncScheduler extends Scheduler {\n public actions: Array> = [];\n /**\n * A flag to indicate whether the Scheduler is currently executing a batch of\n * queued actions.\n * @type {boolean}\n * @internal\n */\n public _active: boolean = false;\n /**\n * An internal ID used to track the latest asynchronous task such as those\n * coming from `setTimeout`, `setInterval`, `requestAnimationFrame`, and\n * others.\n * @type {any}\n * @internal\n */\n public _scheduled: TimerHandle | undefined;\n\n constructor(SchedulerAction: typeof Action, now: () => number = Scheduler.now) {\n super(SchedulerAction, now);\n }\n\n public flush(action: AsyncAction): void {\n const { actions } = this;\n\n if (this._active) {\n actions.push(action);\n return;\n }\n\n let error: any;\n this._active = true;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions.shift()!)); // exhaust the scheduler queue\n\n this._active = false;\n\n if (error) {\n while ((action = actions.shift()!)) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\n/**\n *\n * Async Scheduler\n *\n * Schedule task as if you used setTimeout(task, duration)\n *\n * `async` scheduler schedules tasks asynchronously, by putting them on the JavaScript\n * event loop queue. It is best used to delay tasks in time or to schedule tasks repeating\n * in intervals.\n *\n * If you just want to \"defer\" task, that is to perform it right after currently\n * executing synchronous code ends (commonly achieved by `setTimeout(deferredTask, 0)`),\n * better choice will be the {@link asapScheduler} scheduler.\n *\n * ## Examples\n * Use async scheduler to delay task\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * const task = () => console.log('it works!');\n *\n * asyncScheduler.schedule(task, 2000);\n *\n * // After 2 seconds logs:\n * // \"it works!\"\n * ```\n *\n * Use async scheduler to repeat task in intervals\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * function task(state) {\n * console.log(state);\n * this.schedule(state + 1, 1000); // `this` references currently executing Action,\n * // which we reschedule with new state and delay\n * }\n *\n * asyncScheduler.schedule(task, 3000, 0);\n *\n * // Logs:\n * // 0 after 3s\n * // 1 after 4s\n * // 2 after 5s\n * // 3 after 6s\n * ```\n */\n\nexport const asyncScheduler = new AsyncScheduler(AsyncAction);\n\n/**\n * @deprecated Renamed to {@link asyncScheduler}. Will be removed in v8.\n */\nexport const async = asyncScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { Subscription } from '../Subscription';\nimport { QueueScheduler } from './QueueScheduler';\nimport { SchedulerAction } from '../types';\nimport { TimerHandle } from './timerHandle';\n\nexport class QueueAction extends AsyncAction {\n constructor(protected scheduler: QueueScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (delay > 0) {\n return super.schedule(state, delay);\n }\n this.delay = delay;\n this.state = state;\n this.scheduler.flush(this);\n return this;\n }\n\n public execute(state: T, delay: number): any {\n return delay > 0 || this.closed ? super.execute(state, delay) : this._execute(state, delay);\n }\n\n protected requestAsyncId(scheduler: QueueScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n\n if ((delay != null && delay > 0) || (delay == null && this.delay > 0)) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n\n // Otherwise flush the scheduler starting with this action.\n scheduler.flush(this);\n\n // HACK: In the past, this was returning `void`. However, `void` isn't a valid\n // `TimerHandle`, and generally the return value here isn't really used. So the\n // compromise is to return `0` which is both \"falsy\" and a valid `TimerHandle`,\n // as opposed to refactoring every other instanceo of `requestAsyncId`.\n return 0;\n }\n}\n", "import { AsyncScheduler } from './AsyncScheduler';\n\nexport class QueueScheduler extends AsyncScheduler {\n}\n", "import { QueueAction } from './QueueAction';\nimport { QueueScheduler } from './QueueScheduler';\n\n/**\n *\n * Queue Scheduler\n *\n * Put every next task on a queue, instead of executing it immediately\n *\n * `queue` scheduler, when used with delay, behaves the same as {@link asyncScheduler} scheduler.\n *\n * When used without delay, it schedules given task synchronously - executes it right when\n * it is scheduled. However when called recursively, that is when inside the scheduled task,\n * another task is scheduled with queue scheduler, instead of executing immediately as well,\n * that task will be put on a queue and wait for current one to finish.\n *\n * This means that when you execute task with `queue` scheduler, you are sure it will end\n * before any other task scheduled with that scheduler will start.\n *\n * ## Examples\n * Schedule recursively first, then do something\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(() => {\n * queueScheduler.schedule(() => console.log('second')); // will not happen now, but will be put on a queue\n *\n * console.log('first');\n * });\n *\n * // Logs:\n * // \"first\"\n * // \"second\"\n * ```\n *\n * Reschedule itself recursively\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(function(state) {\n * if (state !== 0) {\n * console.log('before', state);\n * this.schedule(state - 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * console.log('after', state);\n * }\n * }, 0, 3);\n *\n * // In scheduler that runs recursively, you would expect:\n * // \"before\", 3\n * // \"before\", 2\n * // \"before\", 1\n * // \"after\", 1\n * // \"after\", 2\n * // \"after\", 3\n *\n * // But with queue it logs:\n * // \"before\", 3\n * // \"after\", 3\n * // \"before\", 2\n * // \"after\", 2\n * // \"before\", 1\n * // \"after\", 1\n * ```\n */\n\nexport const queueScheduler = new QueueScheduler(QueueAction);\n\n/**\n * @deprecated Renamed to {@link queueScheduler}. Will be removed in v8.\n */\nexport const queue = queueScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\nimport { SchedulerAction } from '../types';\nimport { animationFrameProvider } from './animationFrameProvider';\nimport { TimerHandle } from './timerHandle';\n\nexport class AnimationFrameAction extends AsyncAction {\n constructor(protected scheduler: AnimationFrameScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n protected requestAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay is greater than 0, request as an async action.\n if (delay !== null && delay > 0) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n // Push the action to the end of the scheduler queue.\n scheduler.actions.push(this);\n // If an animation frame has already been requested, don't request another\n // one. If an animation frame hasn't been requested yet, request one. Return\n // the current animation frame request id.\n return scheduler._scheduled || (scheduler._scheduled = animationFrameProvider.requestAnimationFrame(() => scheduler.flush(undefined)));\n }\n\n protected recycleAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle | undefined {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n if (delay != null ? delay > 0 : this.delay > 0) {\n return super.recycleAsyncId(scheduler, id, delay);\n }\n // If the scheduler queue has no remaining actions with the same async id,\n // cancel the requested animation frame and set the scheduled flag to\n // undefined so the next AnimationFrameAction will request its own.\n const { actions } = scheduler;\n if (id != null && actions[actions.length - 1]?.id !== id) {\n animationFrameProvider.cancelAnimationFrame(id as number);\n scheduler._scheduled = undefined;\n }\n // Return undefined so the action knows to request a new async id if it's rescheduled.\n return undefined;\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\nexport class AnimationFrameScheduler extends AsyncScheduler {\n public flush(action?: AsyncAction): void {\n this._active = true;\n // The async id that effects a call to flush is stored in _scheduled.\n // Before executing an action, it's necessary to check the action's async\n // id to determine whether it's supposed to be executed in the current\n // flush.\n // Previous implementations of this method used a count to determine this,\n // but that was unsound, as actions that are unsubscribed - i.e. cancelled -\n // are removed from the actions array and that can shift actions that are\n // scheduled to be executed in a subsequent flush into positions at which\n // they are executed within the current flush.\n const flushId = this._scheduled;\n this._scheduled = undefined;\n\n const { actions } = this;\n let error: any;\n action = action || actions.shift()!;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions[0]) && action.id === flushId && actions.shift());\n\n this._active = false;\n\n if (error) {\n while ((action = actions[0]) && action.id === flushId && actions.shift()) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AnimationFrameAction } from './AnimationFrameAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\n\n/**\n *\n * Animation Frame Scheduler\n *\n * Perform task when `window.requestAnimationFrame` would fire\n *\n * When `animationFrame` scheduler is used with delay, it will fall back to {@link asyncScheduler} scheduler\n * behaviour.\n *\n * Without delay, `animationFrame` scheduler can be used to create smooth browser animations.\n * It makes sure scheduled task will happen just before next browser content repaint,\n * thus performing animations as efficiently as possible.\n *\n * ## Example\n * Schedule div height animation\n * ```ts\n * // html:
\n * import { animationFrameScheduler } from 'rxjs';\n *\n * const div = document.querySelector('div');\n *\n * animationFrameScheduler.schedule(function(height) {\n * div.style.height = height + \"px\";\n *\n * this.schedule(height + 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * }, 0, 0);\n *\n * // You will see a div element growing in height\n * ```\n */\n\nexport const animationFrameScheduler = new AnimationFrameScheduler(AnimationFrameAction);\n\n/**\n * @deprecated Renamed to {@link animationFrameScheduler}. Will be removed in v8.\n */\nexport const animationFrame = animationFrameScheduler;\n", "import { Observable } from '../Observable';\nimport { SchedulerLike } from '../types';\n\n/**\n * A simple Observable that emits no items to the Observer and immediately\n * emits a complete notification.\n *\n * Just emits 'complete', and nothing else.\n *\n * ![](empty.png)\n *\n * A simple Observable that only emits the complete notification. It can be used\n * for composing with other Observables, such as in a {@link mergeMap}.\n *\n * ## Examples\n *\n * Log complete notification\n *\n * ```ts\n * import { EMPTY } from 'rxjs';\n *\n * EMPTY.subscribe({\n * next: () => console.log('Next'),\n * complete: () => console.log('Complete!')\n * });\n *\n * // Outputs\n * // Complete!\n * ```\n *\n * Emit the number 7, then complete\n *\n * ```ts\n * import { EMPTY, startWith } from 'rxjs';\n *\n * const result = EMPTY.pipe(startWith(7));\n * result.subscribe(x => console.log(x));\n *\n * // Outputs\n * // 7\n * ```\n *\n * Map and flatten only odd numbers to the sequence `'a'`, `'b'`, `'c'`\n *\n * ```ts\n * import { interval, mergeMap, of, EMPTY } from 'rxjs';\n *\n * const interval$ = interval(1000);\n * const result = interval$.pipe(\n * mergeMap(x => x % 2 === 1 ? of('a', 'b', 'c') : EMPTY),\n * );\n * result.subscribe(x => console.log(x));\n *\n * // Results in the following to the console:\n * // x is equal to the count on the interval, e.g. (0, 1, 2, 3, ...)\n * // x will occur every 1000ms\n * // if x % 2 is equal to 1, print a, b, c (each on its own)\n * // if x % 2 is not equal to 1, nothing will be output\n * ```\n *\n * @see {@link Observable}\n * @see {@link NEVER}\n * @see {@link of}\n * @see {@link throwError}\n */\nexport const EMPTY = new Observable((subscriber) => subscriber.complete());\n\n/**\n * @param scheduler A {@link SchedulerLike} to use for scheduling\n * the emission of the complete notification.\n * @deprecated Replaced with the {@link EMPTY} constant or {@link scheduled} (e.g. `scheduled([], scheduler)`). Will be removed in v8.\n */\nexport function empty(scheduler?: SchedulerLike) {\n return scheduler ? emptyScheduled(scheduler) : EMPTY;\n}\n\nfunction emptyScheduled(scheduler: SchedulerLike) {\n return new Observable((subscriber) => scheduler.schedule(() => subscriber.complete()));\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport function isScheduler(value: any): value is SchedulerLike {\n return value && isFunction(value.schedule);\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\nimport { isScheduler } from './isScheduler';\n\nfunction last(arr: T[]): T | undefined {\n return arr[arr.length - 1];\n}\n\nexport function popResultSelector(args: any[]): ((...args: unknown[]) => unknown) | undefined {\n return isFunction(last(args)) ? args.pop() : undefined;\n}\n\nexport function popScheduler(args: any[]): SchedulerLike | undefined {\n return isScheduler(last(args)) ? args.pop() : undefined;\n}\n\nexport function popNumber(args: any[], defaultValue: number): number {\n return typeof last(args) === 'number' ? args.pop()! : defaultValue;\n}\n", "export const isArrayLike = ((x: any): x is ArrayLike => x && typeof x.length === 'number' && typeof x !== 'function');", "import { isFunction } from \"./isFunction\";\n\n/**\n * Tests to see if the object is \"thennable\".\n * @param value the object to test\n */\nexport function isPromise(value: any): value is PromiseLike {\n return isFunction(value?.then);\n}\n", "import { InteropObservable } from '../types';\nimport { observable as Symbol_observable } from '../symbol/observable';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being Observable (but not necessary an Rx Observable) */\nexport function isInteropObservable(input: any): input is InteropObservable {\n return isFunction(input[Symbol_observable]);\n}\n", "import { isFunction } from './isFunction';\n\nexport function isAsyncIterable(obj: any): obj is AsyncIterable {\n return Symbol.asyncIterator && isFunction(obj?.[Symbol.asyncIterator]);\n}\n", "/**\n * Creates the TypeError to throw if an invalid object is passed to `from` or `scheduled`.\n * @param input The object that was passed.\n */\nexport function createInvalidObservableTypeError(input: any) {\n // TODO: We should create error codes that can be looked up, so this can be less verbose.\n return new TypeError(\n `You provided ${\n input !== null && typeof input === 'object' ? 'an invalid object' : `'${input}'`\n } where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.`\n );\n}\n", "export function getSymbolIterator(): symbol {\n if (typeof Symbol !== 'function' || !Symbol.iterator) {\n return '@@iterator' as any;\n }\n\n return Symbol.iterator;\n}\n\nexport const iterator = getSymbolIterator();\n", "import { iterator as Symbol_iterator } from '../symbol/iterator';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being an Iterable */\nexport function isIterable(input: any): input is Iterable {\n return isFunction(input?.[Symbol_iterator]);\n}\n", "import { ReadableStreamLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport async function* readableStreamLikeToAsyncGenerator(readableStream: ReadableStreamLike): AsyncGenerator {\n const reader = readableStream.getReader();\n try {\n while (true) {\n const { value, done } = await reader.read();\n if (done) {\n return;\n }\n yield value!;\n }\n } finally {\n reader.releaseLock();\n }\n}\n\nexport function isReadableStreamLike(obj: any): obj is ReadableStreamLike {\n // We don't want to use instanceof checks because they would return\n // false for instances from another Realm, like an " + ], + "text/plain": [ + "" + ] + }, + "execution_count": 6, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "collections_geojson = {\n", + " \"type\": \"FeatureCollection\",\n", + " \"features\": [\n", + " {\n", + " 'type': 'Feature',\n", + " 'geometry': {\n", + " 'type': 'Polygon',\n", + " 'coordinates': [[\n", + " [c[\"extent\"][\"spatial\"][\"bbox\"][0][0], c[\"extent\"][\"spatial\"][\"bbox\"][0][1]],\n", + " [c[\"extent\"][\"spatial\"][\"bbox\"][0][2], c[\"extent\"][\"spatial\"][\"bbox\"][0][1]],\n", + " [c[\"extent\"][\"spatial\"][\"bbox\"][0][2], c[\"extent\"][\"spatial\"][\"bbox\"][0][3]],\n", + " [c[\"extent\"][\"spatial\"][\"bbox\"][0][0], c[\"extent\"][\"spatial\"][\"bbox\"][0][3]],\n", + " [c[\"extent\"][\"spatial\"][\"bbox\"][0][0], c[\"extent\"][\"spatial\"][\"bbox\"][0][1]],\n", + " ]]\n", + " },\n", + " 'properties': {}\n", + " }\n", + " for c in collections[\"collections\"]\n", + " ]\n", + "}\n", + "\n", + "m = Map(\n", + " tiles=\"OpenStreetMap\",\n", + " location=(0, 0),\n", + " zoom_start=1\n", + ")\n", + "\n", + "geo_json = GeoJson(data=collections_geojson)\n", + "geo_json.add_to(m)\n", + "m" + ] + }, + { + "cell_type": "markdown", + "id": "146cfd71", + "metadata": {}, + "source": [ + "As mentioned, the collection's spatial extent can be a combination of multiple bbox, let's visualize all the spatial extent for one collection (`MAXAR_Maui_Hawaii_fires_Aug_23`)\n", + "\n", + "\n", + "Note: we will use the `/collections/{collectionId}` endpoint to get the collection metadata but it should be the same returned by the `/collections` endpoint.\n", + "\n", + "Collection specification: https://github.com/radiantearth/stac-spec/blob/master/collection-spec/collection-spec.md" + ] + }, + { + "cell_type": "code", + "execution_count": 7, + "id": "02f9b550", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
Make this Notebook Trusted to load map: File -> Trust Notebook
" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 7, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "collection_id = \"MAXAR_Maui_Hawaii_fires_Aug_23\"\n", + "\n", + "collection_info = httpx.get(f\"https://stac.eoapi.dev/collections/{collection_id}\").json()\n", + "\n", + "geojson = {\n", + " \"type\": \"FeatureCollection\",\n", + " \"features\": [\n", + " {\n", + " 'type': 'Feature',\n", + " 'geometry': {\n", + " 'type': 'Polygon',\n", + " 'coordinates': [[\n", + " [bbox[0], bbox[1]],\n", + " [bbox[2], bbox[1]],\n", + " [bbox[2], bbox[3]],\n", + " [bbox[0], bbox[3]],\n", + " [bbox[0], bbox[1]],\n", + " ]]\n", + " },\n", + " 'properties': {}\n", + " }\n", + " for bbox in collection_info[\"extent\"][\"spatial\"][\"bbox\"]\n", + " ]\n", + "}\n", + "\n", + "mainbbox = collection_info[\"extent\"][\"spatial\"][\"bbox\"][0]\n", + "m = Map(\n", + " tiles=\"OpenStreetMap\",\n", + " location=((mainbbox[1] + mainbbox[3]) / 2,(mainbbox[0] + mainbbox[2]) / 2),\n", + " zoom_start=9\n", + ")\n", + "\n", + "geo_json = GeoJson(data=geojson)\n", + "geo_json.add_to(m)\n", + "m" + ] + }, + { + "cell_type": "markdown", + "id": "5fd7a387", + "metadata": {}, + "source": [ + "#### Temporal Extent\n", + "\n", + "Each collection can have spatial and temporal extents. As for the spatial extent, a collection can have multiple temporal extents but with its first one representing the combined min/max of all the intervals." + ] + }, + { + "cell_type": "code", + "execution_count": 8, + "id": "f425070c", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "{'interval': [['2023-08-09T21:10:34Z', '2023-08-12T21:18:20Z']]}\n" + ] + } + ], + "source": [ + "print(collection_info[\"extent\"][\"temporal\"])" + ] + }, + { + "cell_type": "markdown", + "id": "0fa1db99", + "metadata": {}, + "source": [ + "## Items\n", + "Let's check the items for the Hawaii Fire collections: `MAXAR_Maui_Hawaii_fires_Aug_23`\n", + "\n", + "In this section, we will:\n", + "\n", + "- List all items for a specific collection using the `/collections/{collection_id}/items` endpoint\n", + "- Talk about the `limit` parameter\n", + "- Visualize all items on a map\n", + "- Talk about the item metadata\n", + "- List the Assets available for one Item" + ] + }, + { + "cell_type": "code", + "execution_count": 9, + "id": "0870f7df", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Nb Items in Db: 123\n", + "Returned 10 Items\n" + ] + } + ], + "source": [ + "items = httpx.get(f\"https://stac.eoapi.dev/collections/{collection_id}/items\").json()\n", + " \n", + "print(f\"Nb Items in Db: {items['context']['matched']}\")\n", + "print(f\"Returned {len(items['features'])} Items\")" + ] + }, + { + "cell_type": "markdown", + "id": "ad0efb74", + "metadata": {}, + "source": [ + "As you can see below, the `/items` endpoints returned only 10 items. To return more data we need to either use the `paging` mechanism or use the `limit` query parameter to get more items per request." + ] + }, + { + "cell_type": "code", + "execution_count": 10, + "id": "992501d7", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Nb Items in Db: 123\n", + "Returned 123 Items\n" + ] + } + ], + "source": [ + "items = httpx.get(\n", + " f\"https://stac.eoapi.dev/collections/{collection_id}/items\",\n", + " params={\n", + " \"limit\": 200,\n", + " }\n", + ").json()\n", + "\n", + " \n", + "print(f\"Nb Items in Db: {items['context']['matched']}\")\n", + "print(f\"Returned {len(items['features'])} Items\")" + ] + }, + { + "cell_type": "code", + "execution_count": 11, + "id": "7f77306d", + "metadata": { + "scrolled": false + }, + "outputs": [ + { + "data": { + "text/html": [ + "
Make this Notebook Trusted to load map: File -> Trust Notebook
" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 11, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "m = Map(\n", + " tiles=\"OpenStreetMap\",\n", + " # Note: we re-use the `mainbbox` variable from previous cell\n", + " location=((mainbbox[1] + mainbbox[3]) / 2,(mainbbox[0] + mainbbox[2]) / 2),\n", + " zoom_start=9\n", + ")\n", + "\n", + "geo_json = GeoJson(data=items)\n", + "geo_json.add_to(m)\n", + "m" + ] + }, + { + "cell_type": "markdown", + "id": "ec55f253", + "metadata": {}, + "source": [ + "##### Item metadata \n", + "\n", + "Each item should have an `id`, a `geometry`, some links to `Assets` and a set of properties.\n", + "\n", + "Item specification: https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md" + ] + }, + { + "cell_type": "code", + "execution_count": 12, + "id": "56ba6e0c", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Item example:\n", + "{\n", + " \"id\": \"4_122000331020_105001003590C300\",\n", + " \"bbox\": [\n", + " -156.31126031485115,\n", + " 20.82185619107944,\n", + " -156.267548,\n", + " 20.846008751160078\n", + " ],\n", + " \"type\": \"Feature\",\n", + " \"links\": [\n", + " {\n", + " \"rel\": \"collection\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://stac.eoapi.dev/collections/MAXAR_Maui_Hawaii_fires_Aug_23\"\n", + " },\n", + " {\n", + " \"rel\": \"parent\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://stac.eoapi.dev/collections/MAXAR_Maui_Hawaii_fires_Aug_23\"\n", + " },\n", + " {\n", + " \"rel\": \"root\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://stac.eoapi.dev/\"\n", + " },\n", + " {\n", + " \"rel\": \"self\",\n", + " \"type\": \"application/geo+json\",\n", + " \"href\": \"https://stac.eoapi.dev/collections/MAXAR_Maui_Hawaii_fires_Aug_23/items/4_122000331020_105001003590C300\"\n", + " }\n", + " ],\n", + " \"assets\": {\n", + " \"visual\": {\n", + " \"href\": \"s3://maxar-opendata/events/Maui-Hawaii-fires-Aug-23/ard/04/122000331020/2023-08-12/105001003590C300-visual.tif\",\n", + " \"type\": \"image/tiff; application=geotiff; profile=cloud-optimized\",\n", + " \"roles\": [\n", + " \"visual\"\n", + " ],\n", + " \"title\": \"Visual Image\",\n", + " \"eo:bands\": [\n", + " {\n", + " \"name\": \"BAND_R\",\n", + " \"common_name\": \"red\",\n", + " \"description\": \"Red\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_G\",\n", + " \"common_name\": \"green\",\n", + " \"description\": \"Green\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_B\",\n", + " \"common_name\": \"blue\",\n", + " \"description\": \"Blue\"\n", + " }\n", + " ],\n", + " \"alternate\": {\n", + " \"public\": {\n", + " \"href\": \"https://maxar-opendata.s3.amazonaws.com/events/Maui-Hawaii-fires-Aug-23/ard/04/122000331020/2023-08-12/105001003590C300-visual.tif\",\n", + " \"title\": \"Public Access\"\n", + " }\n", + " },\n", + " \"proj:bbox\": [\n", + " 779843.75,\n", + " 2304843.75,\n", + " 785156.25,\n", + " 2310156.25\n", + " ],\n", + " \"proj:shape\": [\n", + " 17408,\n", + " 17408\n", + " ],\n", + " \"proj:transform\": [\n", + " 0.30517578125,\n", + " 0.0,\n", + " 779843.75,\n", + " 0.0,\n", + " -0.30517578125,\n", + " 2310156.25,\n", + " 0.0,\n", + " 0.0,\n", + " 1.0\n", + " ]\n", + " },\n", + " \"data-mask\": {\n", + " \"href\": \"s3://maxar-opendata/events/Maui-Hawaii-fires-Aug-23/ard/04/122000331020/2023-08-12/105001003590C300-data-mask.gpkg\",\n", + " \"type\": \"application/geopackage+sqlite3\",\n", + " \"roles\": [\n", + " \"data-mask\"\n", + " ],\n", + " \"title\": \"Data Mask\",\n", + " \"alternate\": {\n", + " \"public\": {\n", + " \"href\": \"https://maxar-opendata.s3.amazonaws.com/events/Maui-Hawaii-fires-Aug-23/ard/04/122000331020/2023-08-12/105001003590C300-data-mask.gpkg\",\n", + " \"title\": \"Public Access\"\n", + " }\n", + " }\n", + " },\n", + " \"ms_analytic\": {\n", + " \"href\": \"s3://maxar-opendata/events/Maui-Hawaii-fires-Aug-23/ard/04/122000331020/2023-08-12/105001003590C300-ms.tif\",\n", + " \"type\": \"image/tiff; application=geotiff; profile=cloud-optimized\",\n", + " \"roles\": [\n", + " \"data\"\n", + " ],\n", + " \"title\": \"Multispectral Image\",\n", + " \"eo:bands\": [\n", + " {\n", + " \"name\": \"BAND_B\",\n", + " \"common_name\": \"blue\",\n", + " \"description\": \"Blue\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_G\",\n", + " \"common_name\": \"green\",\n", + " \"description\": \"Green\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_R\",\n", + " \"common_name\": \"red\",\n", + " \"description\": \"Red\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_N\",\n", + " \"common_name\": \"nir08\",\n", + " \"description\": \"Near Infrared 1\"\n", + " }\n", + " ],\n", + " \"alternate\": {\n", + " \"public\": {\n", + " \"href\": \"https://maxar-opendata.s3.amazonaws.com/events/Maui-Hawaii-fires-Aug-23/ard/04/122000331020/2023-08-12/105001003590C300-ms.tif\",\n", + " \"title\": \"Public Access\"\n", + " }\n", + " },\n", + " \"proj:bbox\": [\n", + " 779843.75,\n", + " 2304843.75,\n", + " 785156.25,\n", + " 2310156.25\n", + " ],\n", + " \"proj:shape\": [\n", + " 2777,\n", + " 2777\n", + " ],\n", + " \"proj:transform\": [\n", + " 1.913035649981995,\n", + " 0.0,\n", + " 779843.75,\n", + " 0.0,\n", + " -1.913035649981995,\n", + " 2310156.25,\n", + " 0.0,\n", + " 0.0,\n", + " 1.0\n", + " ]\n", + " },\n", + " \"pan_analytic\": {\n", + " \"href\": \"s3://maxar-opendata/events/Maui-Hawaii-fires-Aug-23/ard/04/122000331020/2023-08-12/105001003590C300-pan.tif\",\n", + " \"type\": \"image/tiff; application=geotiff; profile=cloud-optimized\",\n", + " \"roles\": [\n", + " \"data\"\n", + " ],\n", + " \"title\": \"Panchromatic Image\",\n", + " \"eo:bands\": [\n", + " {\n", + " \"name\": \"BAND_P\",\n", + " \"description\": \"Pan\"\n", + " }\n", + " ],\n", + " \"alternate\": {\n", + " \"public\": {\n", + " \"href\": \"https://maxar-opendata.s3.amazonaws.com/events/Maui-Hawaii-fires-Aug-23/ard/04/122000331020/2023-08-12/105001003590C300-pan.tif\",\n", + " \"title\": \"Public Access\"\n", + " }\n", + " },\n", + " \"proj:bbox\": [\n", + " 779843.75,\n", + " 2304843.75,\n", + " 785156.25,\n", + " 2310156.25\n", + " ],\n", + " \"proj:shape\": [\n", + " 11108,\n", + " 11108\n", + " ],\n", + " \"proj:transform\": [\n", + " 0.47825891249549873,\n", + " 0.0,\n", + " 779843.75,\n", + " 0.0,\n", + " -0.47825891249549873,\n", + " 2310156.25,\n", + " 0.0,\n", + " 0.0,\n", + " 1.0\n", + " ]\n", + " }\n", + " },\n", + " \"geometry\": {\n", + " \"type\": \"Polygon\",\n", + " \"coordinates\": [\n", + " [\n", + " [\n", + " -156.31126031485115,\n", + " 20.822545360957477\n", + " ],\n", + " [\n", + " -156.3108433527224,\n", + " 20.846008751160078\n", + " ],\n", + " [\n", + " -156.267548,\n", + " 20.843703\n", + " ],\n", + " [\n", + " -156.26776389363278,\n", + " 20.82185619107944\n", + " ],\n", + " [\n", + " -156.31126031485115,\n", + " 20.822545360957477\n", + " ]\n", + " ]\n", + " ]\n", + " },\n", + " \"collection\": \"MAXAR_Maui_Hawaii_fires_Aug_23\",\n", + " \"properties\": {\n", + " \"gsd\": 0.5,\n", + " \"quadkey\": \"122000331020\",\n", + " \"datetime\": \"2023-08-12T21:18:20Z\",\n", + " \"platform\": \"GE01\",\n", + " \"utm_zone\": 4,\n", + " \"grid:code\": \"MXRA-Z4-122000331020\",\n", + " \"proj:bbox\": [\n", + " 779843.75,\n", + " 2304843.75,\n", + " 784374.5983184774,\n", + " 2307445.5041471347\n", + " ],\n", + " \"proj:epsg\": 32604,\n", + " \"catalog_id\": \"105001003590C300\",\n", + " \"view:azimuth\": 298.0,\n", + " \"proj:geometry\": {\n", + " \"type\": \"Polygon\",\n", + " \"coordinates\": [\n", + " [\n", + " [\n", + " 779843.75,\n", + " 2304843.75\n", + " ],\n", + " [\n", + " 779843.75,\n", + " 2307445.5041471347\n", + " ],\n", + " [\n", + " 784356.1192933423,\n", + " 2307263.893928079\n", + " ],\n", + " [\n", + " 784374.5983184774,\n", + " 2304843.75\n", + " ],\n", + " [\n", + " 779843.75,\n", + " 2304843.75\n", + " ]\n", + " ]\n", + " ]\n", + " },\n", + " \"tile:data_area\": 11.3,\n", + " \"view:off_nadir\": 26.4,\n", + " \"tile:clouds_area\": 0.0,\n", + " \"view:sun_azimuth\": 105.8,\n", + " \"view:sun_elevation\": 71.9,\n", + " \"tile:clouds_percent\": 0,\n", + " \"ard_metadata_version\": \"0.0.1\",\n", + " \"view:incidence_angle\": 60.5\n", + " },\n", + " \"stac_version\": \"1.0.0\",\n", + " \"stac_extensions\": [\n", + " \"https://stac-extensions.github.io/view/v1.0.0/schema.json\",\n", + " \"https://stac-extensions.github.io/projection/v1.1.0/schema.json\",\n", + " \"https://stac-extensions.github.io/eo/v1.1.0/schema.json\",\n", + " \"https://stac-extensions.github.io/raster/v1.1.0/schema.json\",\n", + " \"https://stac-extensions.github.io/grid/v1.1.0/schema.json\",\n", + " \"https://stac-extensions.github.io/alternate-assets/v1.1.0/schema.json\"\n", + " ]\n", + "}\n" + ] + } + ], + "source": [ + "item = items[\"features\"][0]\n", + "print(\"Item example:\")\n", + "print(json.dumps(item, indent=4))" + ] + }, + { + "cell_type": "code", + "execution_count": 13, + "id": "7f632955", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Item Id 4_122000331020_105001003590C300\n", + "Item Assets: ['visual', 'data-mask', 'ms_analytic', 'pan_analytic']\n", + "Item Properties:\n", + "{\n", + " \"gsd\": 0.5,\n", + " \"quadkey\": \"122000331020\",\n", + " \"datetime\": \"2023-08-12T21:18:20Z\",\n", + " \"platform\": \"GE01\",\n", + " \"utm_zone\": 4,\n", + " \"grid:code\": \"MXRA-Z4-122000331020\",\n", + " \"proj:bbox\": [\n", + " 779843.75,\n", + " 2304843.75,\n", + " 784374.5983184774,\n", + " 2307445.5041471347\n", + " ],\n", + " \"proj:epsg\": 32604,\n", + " \"catalog_id\": \"105001003590C300\",\n", + " \"view:azimuth\": 298.0,\n", + " \"proj:geometry\": {\n", + " \"type\": \"Polygon\",\n", + " \"coordinates\": [\n", + " [\n", + " [\n", + " 779843.75,\n", + " 2304843.75\n", + " ],\n", + " [\n", + " 779843.75,\n", + " 2307445.5041471347\n", + " ],\n", + " [\n", + " 784356.1192933423,\n", + " 2307263.893928079\n", + " ],\n", + " [\n", + " 784374.5983184774,\n", + " 2304843.75\n", + " ],\n", + " [\n", + " 779843.75,\n", + " 2304843.75\n", + " ]\n", + " ]\n", + " ]\n", + " },\n", + " \"tile:data_area\": 11.3,\n", + " \"view:off_nadir\": 26.4,\n", + " \"tile:clouds_area\": 0.0,\n", + " \"view:sun_azimuth\": 105.8,\n", + " \"view:sun_elevation\": 71.9,\n", + " \"tile:clouds_percent\": 0,\n", + " \"ard_metadata_version\": \"0.0.1\",\n", + " \"view:incidence_angle\": 60.5\n", + "}\n" + ] + } + ], + "source": [ + "print(\"Item Id\", item[\"id\"])\n", + "print(\"Item Assets:\", list(item[\"assets\"].keys()))\n", + "print(\"Item Properties:\")\n", + "print(json.dumps(item[\"properties\"], indent=4))" + ] + }, + { + "cell_type": "markdown", + "id": "844f4575", + "metadata": {}, + "source": [ + "#### Find acquisition times\n", + "\n", + "By definition, every item should have either a `datetime` or a `start/end_datetime` property. For the Maxar dataset, we are assuming that `datetime` is acquisition times." + ] + }, + { + "cell_type": "code", + "execution_count": 14, + "id": "0d9013bb", + "metadata": { + "scrolled": true + }, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Dates: ['2023-08-09T21:10:34Z', '2023-08-09T21:10:35Z', '2023-08-09T21:20:30Z', '2023-08-09T21:20:31Z', '2023-08-12T21:11:16Z', '2023-08-12T21:11:17Z', '2023-08-12T21:12:48Z', '2023-08-12T21:12:49Z', '2023-08-12T21:18:17Z', '2023-08-12T21:18:18Z', '2023-08-12T21:18:19Z', '2023-08-12T21:18:20Z']\n" + ] + } + ], + "source": [ + "datetimes = {item[\"properties\"][\"datetime\"] for item in items[\"features\"]}\n", + "print(\"Dates:\", sorted(list(datetimes)))" + ] + }, + { + "cell_type": "markdown", + "id": "02869b48", + "metadata": {}, + "source": [ + "##### Other metadata" + ] + }, + { + "cell_type": "code", + "execution_count": 15, + "id": "29652a32", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Maxar Catalog Id: ['10300100EB15FF00', '10300100EB592000', '10300100EC8B7900', '105001003590C300', '10503F0006FE4B00']\n", + "Maxar Platform: ['GE01', 'WV02']\n" + ] + } + ], + "source": [ + "catalog_id = {item[\"properties\"][\"catalog_id\"] for item in items[\"features\"]}\n", + "print(\"Maxar Catalog Id:\", sorted(list(catalog_id)))\n", + "\n", + "platform = {item[\"properties\"][\"platform\"] for item in items[\"features\"]}\n", + "print(\"Maxar Platform: \", sorted(list(platform)))" + ] + }, + { + "cell_type": "markdown", + "id": "2693e87a", + "metadata": {}, + "source": [ + "Note: The `catalog_id` represents a unique acquisition ID. In our case, this means that all items are derived from 5 different acquisitions. \n", + "\n", + "> The unique identifier for the item, as assigned by the provider, Maxar. This is also referred to as the \"acquisition ID\".\n", + "\n", + "ref: https://ard.maxar.com/docs/select-and-order/select-stac-collection-file/#properties-object\n", + "\n", + "\n", + "Let's look back at the item's datetime. If we remove the `seconds`:" + ] + }, + { + "cell_type": "code", + "execution_count": 16, + "id": "f9430fa2", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Dates (without seconds): ['2023-08-09T21:10', '2023-08-09T21:20', '2023-08-12T21:11', '2023-08-12T21:12', '2023-08-12T21:18']\n" + ] + } + ], + "source": [ + "datetimes = {item[\"properties\"][\"datetime\"][:-4] for item in items[\"features\"]}\n", + "print(\"Dates (without seconds):\", sorted(list(datetimes)))" + ] + }, + { + "cell_type": "markdown", + "id": "7de68313", + "metadata": {}, + "source": [ + "We get 5 different dates, which might correspond to 5 different acquisitions (keep this in mind for later)." + ] + }, + { + "cell_type": "markdown", + "id": "4ca2e374", + "metadata": {}, + "source": [ + "## Assets \n", + "\n", + "So we have **123** items for the `MAXAR_Maui_Hawaii_fires_Aug_23` collection, and each item has **4** assets (this is also found at the collection level in the `item_assets extension`)." + ] + }, + { + "cell_type": "code", + "execution_count": 17, + "id": "aca07238", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "{\n", + " \"href\": \"s3://maxar-opendata/events/Maui-Hawaii-fires-Aug-23/ard/04/122000331020/2023-08-12/105001003590C300-visual.tif\",\n", + " \"type\": \"image/tiff; application=geotiff; profile=cloud-optimized\",\n", + " \"roles\": [\n", + " \"visual\"\n", + " ],\n", + " \"title\": \"Visual Image\",\n", + " \"eo:bands\": [\n", + " {\n", + " \"name\": \"BAND_R\",\n", + " \"common_name\": \"red\",\n", + " \"description\": \"Red\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_G\",\n", + " \"common_name\": \"green\",\n", + " \"description\": \"Green\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_B\",\n", + " \"common_name\": \"blue\",\n", + " \"description\": \"Blue\"\n", + " }\n", + " ],\n", + " \"alternate\": {\n", + " \"public\": {\n", + " \"href\": \"https://maxar-opendata.s3.amazonaws.com/events/Maui-Hawaii-fires-Aug-23/ard/04/122000331020/2023-08-12/105001003590C300-visual.tif\",\n", + " \"title\": \"Public Access\"\n", + " }\n", + " },\n", + " \"proj:bbox\": [\n", + " 779843.75,\n", + " 2304843.75,\n", + " 785156.25,\n", + " 2310156.25\n", + " ],\n", + " \"proj:shape\": [\n", + " 17408,\n", + " 17408\n", + " ],\n", + " \"proj:transform\": [\n", + " 0.30517578125,\n", + " 0.0,\n", + " 779843.75,\n", + " 0.0,\n", + " -0.30517578125,\n", + " 2310156.25,\n", + " 0.0,\n", + " 0.0,\n", + " 1.0\n", + " ]\n", + "}\n", + "visual : image/tiff; application=geotiff; profile=cloud-optimized\n", + "data-mask : application/geopackage+sqlite3\n", + "ms_analytic : image/tiff; application=geotiff; profile=cloud-optimized\n", + "pan_analytic : image/tiff; application=geotiff; profile=cloud-optimized\n" + ] + } + ], + "source": [ + "print(json.dumps(item[\"assets\"][\"visual\"], indent=4))\n", + "\n", + "for name, asset in item[\"assets\"].items():\n", + " print(name, \": \", asset[\"type\"])" + ] + }, + { + "cell_type": "markdown", + "id": "7bc1a304", + "metadata": {}, + "source": [ + "# Raster\n", + "\n", + "In eoAPI, we have a raster API connected to the PgSTAC database. The service is built using [titiler-pgstac](http://github.com/stac-utils/titiler-pgstac) and can be used to visualize `Item` or `Mosaics` (multiple items).\n", + "\n", + "\n", + "Endpoint: https://raster.eoapi.dev\n", + "\n", + "\n", + "In this section, we will:\n", + "\n", + "- Learn how to visualize Assets for one Item\n", + "- Create mosaic to visualize multiple Items " + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "id": "acc2e254", + "metadata": {}, + "source": [ + "## Asset visualization\n", + "\n", + "We know we have 4 assets for each item, and 3 are of `Cloud-Optimized` type. Let's use the raster API to visualize them.\n", + "\n", + "\n", + "First, let's get the Raster metadata for each `raster` asset. The raster API will use the asset's `type` metadata to filter non-raster datasets (e.g. `application/geopackage+sqlite3`).\n" + ] + }, + { + "cell_type": "code", + "execution_count": 18, + "id": "e2a45bf1", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Fetching Raster info for Item 4_122000331020_105001003590C300\n" + ] + } + ], + "source": [ + "# fetching Raster information for all the `raster` assets\n", + "item_id = item[\"id\"]\n", + "\n", + "print(f\"Fetching Raster info for Item {item_id}\")\n", + "info = httpx.get(f\"https://raster.eoapi.dev/collections/{collection_id}/items/{item_id}/info\").json()" + ] + }, + { + "cell_type": "code", + "execution_count": 19, + "id": "481a9cae", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Returned metadata for Assets: ['visual', 'ms_analytic', 'pan_analytic']\n" + ] + } + ], + "source": [ + "print(\"Returned metadata for Assets:\", list(info.keys()))" + ] + }, + { + "cell_type": "code", + "execution_count": 20, + "id": "8641fff2", + "metadata": { + "scrolled": false + }, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "{\n", + " \"bounds\": [\n", + " -156.31126031485115,\n", + " 20.821737319524217,\n", + " -156.259392685322,\n", + " 20.870494972421625\n", + " ],\n", + " \"minzoom\": 12,\n", + " \"maxzoom\": 19,\n", + " \"band_metadata\": [\n", + " [\n", + " \"b1\",\n", + " {}\n", + " ],\n", + " [\n", + " \"b2\",\n", + " {}\n", + " ],\n", + " [\n", + " \"b3\",\n", + " {}\n", + " ]\n", + " ],\n", + " \"band_descriptions\": [\n", + " [\n", + " \"b1\",\n", + " \"\"\n", + " ],\n", + " [\n", + " \"b2\",\n", + " \"\"\n", + " ],\n", + " [\n", + " \"b3\",\n", + " \"\"\n", + " ]\n", + " ],\n", + " \"dtype\": \"uint8\",\n", + " \"nodata_type\": \"Mask\",\n", + " \"colorinterp\": [\n", + " \"red\",\n", + " \"green\",\n", + " \"blue\"\n", + " ],\n", + " \"driver\": \"GTiff\",\n", + " \"count\": 3,\n", + " \"width\": 17408,\n", + " \"height\": 17408,\n", + " \"overviews\": [\n", + " 2,\n", + " 4,\n", + " 8,\n", + " 16,\n", + " 32,\n", + " 64\n", + " ]\n", + "}\n" + ] + } + ], + "source": [ + "print(json.dumps(info[\"visual\"], indent=4))" + ] + }, + { + "cell_type": "markdown", + "id": "3a87b045", + "metadata": {}, + "source": [ + "The `/collections/{collectionId}/items/{itemId}/info` endpoint returned metadata for 3 assets (the raster ones). We now know a bit more about each asset (datatype, zoom levels, number of bands), which can help us create tiles urls.\n", + "\n", + "\n", + "##### Asset on Map\n", + "\n", + "To visualize an asset on a Map, we need to construct a `Tile URL`. To ease the task we can use the raster's service `/collections/{collection_id}/items/{item_id}/tilejson.json` endpoint, but here are the requirements:\n", + "\n", + "- HAVE TO pass `assets` or `expression` parameter\n", + "- CAN pass `min/max zooms` (which will avoid under/over-zooming)\n", + "- CAN pass `rescale` parameter if datatype is not compatible with PNG/JPEG output format\n", + "- CAN pass `asset_bidx` parameter to select band combination" + ] + }, + { + "cell_type": "code", + "execution_count": 21, + "id": "b71ad07f", + "metadata": { + "scrolled": false + }, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "{'tilejson': '2.2.0', 'version': '1.0.0', 'scheme': 'xyz', 'tiles': ['https://raster.eoapi.dev/collections/MAXAR_Maui_Hawaii_fires_Aug_23/items/4_122000331020_105001003590C300/tiles/WebMercatorQuad/{z}/{x}/{y}@1x?assets=visual'], 'minzoom': 12, 'maxzoom': 19, 'bounds': [-156.31126031485115, 20.82185619107944, -156.267548, 20.846008751160078], 'center': [-156.28940415742557, 20.83393247111976, 12]}\n" + ] + }, + { + "data": { + "text/html": [ + "
Make this Notebook Trusted to load map: File -> Trust Notebook
" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 21, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "# `visual` Asset\n", + "\n", + "tilejson = httpx.get(\n", + " f\"https://raster.eoapi.dev/collections/{collection_id}/items/{item_id}/tilejson.json\",\n", + " params = (\n", + " (\"assets\", \"visual\"), # THIS PARAMETER IS MANDATORY\n", + " (\"minzoom\", 12), # By default the tiler will use 0\n", + " (\"maxzoom\", 19), # By default the tiler will use 24\n", + " )\n", + ").json()\n", + "print(tilejson)\n", + "\n", + "bounds = tilejson[\"bounds\"]\n", + "m = Map(\n", + " location=((bounds[1] + bounds[3]) / 2,(bounds[0] + bounds[2]) / 2),\n", + " zoom_start=12\n", + ")\n", + "\n", + "tiles = TileLayer(\n", + " tiles=tilejson[\"tiles\"][0],\n", + " min_zoom=tilejson[\"minzoom\"],\n", + " max_zoom=tilejson[\"maxzoom\"],\n", + " opacity=1,\n", + " attr=\"Maxar\"\n", + ")\n", + "tiles.add_to(m)\n", + "\n", + "geo_json = GeoJson(data=item)\n", + "geo_json.add_to(m)\n", + "m" + ] + }, + { + "cell_type": "code", + "execution_count": 22, + "id": "97a2ac88", + "metadata": { + "scrolled": false + }, + "outputs": [ + { + "data": { + "text/html": [ + "
Make this Notebook Trusted to load map: File -> Trust Notebook
" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 22, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "# `visual` Asset with different band combination\n", + "\n", + "tilejson = httpx.get(\n", + " f\"https://raster.eoapi.dev/collections/{collection_id}/items/{item_id}/tilejson.json\",\n", + " params = (\n", + " (\"assets\", \"visual\"),\n", + " (\"asset_bidx\", \"visual|3,2,1\"), # We use the `asset_bidx` parameter to change the band combination\n", + " (\"minzoom\", 12),\n", + " (\"maxzoom\", 19),\n", + " )\n", + ").json()\n", + "\n", + "bounds = tilejson[\"bounds\"]\n", + "m = Map(\n", + " location=((bounds[1] + bounds[3]) / 2,(bounds[0] + bounds[2]) / 2),\n", + " zoom_start=14\n", + ")\n", + "\n", + "tiles = TileLayer(\n", + " tiles=tilejson[\"tiles\"][0],\n", + " min_zoom=tilejson[\"minzoom\"],\n", + " max_zoom=tilejson[\"maxzoom\"],\n", + " opacity=1,\n", + " attr=\"Maxar\"\n", + ")\n", + "tiles.add_to(m)\n", + "\n", + "geo_json = GeoJson(data=item)\n", + "geo_json.add_to(m)\n", + "m" + ] + }, + { + "cell_type": "markdown", + "id": "b6ad993a", + "metadata": {}, + "source": [ + "the `visual` asset is pretty easy to work with because it has only 3 bands and if of `uint8` datatype, meaning that we can translate the data directly to PNG or JPEG without needed to do any rescaling nor band selection. \n", + "\n", + "This is not always the case, let's use the `ms_analytic` asset now. \n", + "\n", + "This asset has more than 3 bands and is also of `Uint16` data type, so to be able to visualize it, we will need to:\n", + "- select 1 or 3 bands\n", + "- apply some linear rescaling between min/max values" + ] + }, + { + "cell_type": "code", + "execution_count": 23, + "id": "82cf41fe", + "metadata": { + "scrolled": false + }, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "{\n", + " \"bounds\": [\n", + " -156.31126031485115,\n", + " 20.821737319524217,\n", + " -156.259392685322,\n", + " 20.870494972421625\n", + " ],\n", + " \"minzoom\": 12,\n", + " \"maxzoom\": 16,\n", + " \"band_metadata\": [\n", + " [\n", + " \"b1\",\n", + " {}\n", + " ],\n", + " [\n", + " \"b2\",\n", + " {}\n", + " ],\n", + " [\n", + " \"b3\",\n", + " {}\n", + " ],\n", + " [\n", + " \"b4\",\n", + " {}\n", + " ]\n", + " ],\n", + " \"band_descriptions\": [\n", + " [\n", + " \"b1\",\n", + " \"\"\n", + " ],\n", + " [\n", + " \"b2\",\n", + " \"\"\n", + " ],\n", + " [\n", + " \"b3\",\n", + " \"\"\n", + " ],\n", + " [\n", + " \"b4\",\n", + " \"\"\n", + " ]\n", + " ],\n", + " \"dtype\": \"uint16\",\n", + " \"nodata_type\": \"Mask\",\n", + " \"colorinterp\": [\n", + " \"gray\",\n", + " \"undefined\",\n", + " \"undefined\",\n", + " \"undefined\"\n", + " ],\n", + " \"driver\": \"GTiff\",\n", + " \"count\": 4,\n", + " \"width\": 2777,\n", + " \"height\": 2777,\n", + " \"overviews\": [\n", + " 2,\n", + " 4,\n", + " 8\n", + " ]\n", + "}\n" + ] + } + ], + "source": [ + "print(json.dumps(info[\"ms_analytic\"], indent=4))" + ] + }, + { + "cell_type": "markdown", + "id": "8d0c2596", + "metadata": {}, + "source": [ + "To choose the `min/max` rescaling values wizely we can first use the `/statistics` endpoint to get an approximation of the dataset data range" + ] + }, + { + "cell_type": "code", + "execution_count": 24, + "id": "93af96d2", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "{\n", + " \"ms_analytic_b1\": {\n", + " \"min\": 15.0,\n", + " \"max\": 9390.0,\n", + " \"mean\": 218.3455215862242,\n", + " \"count\": 422538.0,\n", + " \"sum\": 92259280.0,\n", + " \"std\": 221.38558325187785,\n", + " \"median\": 150.0,\n", + " \"majority\": 74.0,\n", + " \"minority\": 15.0,\n", + " \"unique\": 2537.0,\n", + " \"histogram\": [\n", + " [\n", + " 418845.0,\n", + " 2728.0,\n", + " 676.0,\n", + " 168.0,\n", + " 70.0,\n", + " 19.0,\n", + " 9.0,\n", + " 7.0,\n", + " 9.0,\n", + " 7.0\n", + " ],\n", + " [\n", + " 15.0,\n", + " 952.5,\n", + " 1890.0,\n", + " 2827.5,\n", + " 3765.0,\n", + " 4702.5,\n", + " 5640.0,\n", + " 6577.5,\n", + " 7515.0,\n", + " 8452.5,\n", + " 9390.0\n", + " ]\n", + " ],\n", + " \"valid_percent\": 40.3,\n", + " \"masked_pixels\": 626038.0,\n", + " \"valid_pixels\": 422538.0,\n", + " \"percentile_2\": 34.0,\n", + " \"percentile_98\": 609.0\n", + " },\n", + " \"ms_analytic_b2\": {\n", + " \"min\": 11.0,\n", + " \"max\": 9396.0,\n", + " \"mean\": 380.7165651373368,\n", + " \"count\": 422538.0,\n", + " \"sum\": 160867216.0,\n", + " \"std\": 288.0040874044608,\n", + " \"median\": 298.0,\n", + " \"majority\": 188.0,\n", + " \"minority\": 11.0,\n", + " \"unique\": 2801.0,\n", + " \"histogram\": [\n", + " [\n", + " 415831.0,\n", + " 5301.0,\n", + " 980.0,\n", + " 268.0,\n", + " 88.0,\n", + " 33.0,\n", + " 13.0,\n", + " 6.0,\n", + " 12.0,\n", + " 6.0\n", + " ],\n", + " [\n", + " 11.0,\n", + " 949.5,\n", + " 1888.0,\n", + " 2826.5,\n", + " 3765.0,\n", + " 4703.5,\n", + " 5642.0,\n", + " 6580.5,\n", + " 7519.0,\n", + " 8457.5,\n", + " 9396.0\n", + " ]\n", + " ],\n", + " \"valid_percent\": 40.3,\n", + " \"masked_pixels\": 626038.0,\n", + " \"valid_pixels\": 422538.0,\n", + " \"percentile_2\": 47.0,\n", + " \"percentile_98\": 916.0\n", + " },\n", + " \"ms_analytic_b3\": {\n", + " \"min\": 9.0,\n", + " \"max\": 9442.0,\n", + " \"mean\": 383.4325409785629,\n", + " \"count\": 422538.0,\n", + " \"sum\": 162014819.0,\n", + " \"std\": 383.590594751645,\n", + " \"median\": 212.0,\n", + " \"majority\": 61.0,\n", + " \"minority\": 1446.0,\n", + " \"unique\": 3036.0,\n", + " \"histogram\": [\n", + " [\n", + " 392015.0,\n", + " 28684.0,\n", + " 1262.0,\n", + " 367.0,\n", + " 125.0,\n", + " 40.0,\n", + " 15.0,\n", + " 11.0,\n", + " 11.0,\n", + " 8.0\n", + " ],\n", + " [\n", + " 9.0,\n", + " 952.3,\n", + " 1895.6,\n", + " 2838.8999999999996,\n", + " 3782.2,\n", + " 4725.5,\n", + " 5668.799999999999,\n", + " 6612.099999999999,\n", + " 7555.4,\n", + " 8498.699999999999,\n", + " 9442.0\n", + " ]\n", + " ],\n", + " \"valid_percent\": 40.3,\n", + " \"masked_pixels\": 626038.0,\n", + " \"valid_pixels\": 422538.0,\n", + " \"percentile_2\": 24.0,\n", + " \"percentile_98\": 1155.0\n", + " },\n", + " \"ms_analytic_b4\": {\n", + " \"min\": 48.0,\n", + " \"max\": 7906.0,\n", + " \"mean\": 2578.6057325021657,\n", + " \"count\": 422538.0,\n", + " \"sum\": 1089558909.0,\n", + " \"std\": 851.555485242252,\n", + " \"median\": 2615.0,\n", + " \"majority\": 2714.0,\n", + " \"minority\": 48.0,\n", + " \"unique\": 5588.0,\n", + " \"histogram\": [\n", + " [\n", + " 10084.0,\n", + " 47631.0,\n", + " 112975.0,\n", + " 152665.0,\n", + " 80676.0,\n", + " 15713.0,\n", + " 2515.0,\n", + " 226.0,\n", + " 34.0,\n", + " 19.0\n", + " ],\n", + " [\n", + " 48.0,\n", + " 833.8,\n", + " 1619.6,\n", + " 2405.3999999999996,\n", + " 3191.2,\n", + " 3977.0,\n", + " 4762.799999999999,\n", + " 5548.599999999999,\n", + " 6334.4,\n", + " 7120.2,\n", + " 7906.0\n", + " ]\n", + " ],\n", + " \"valid_percent\": 40.3,\n", + " \"masked_pixels\": 626038.0,\n", + " \"valid_pixels\": 422538.0,\n", + " \"percentile_2\": 778.0,\n", + " \"percentile_98\": 4326.0\n", + " }\n", + "}\n" + ] + } + ], + "source": [ + "stats = httpx.get(\n", + " f\"https://raster.eoapi.dev/collections/{collection_id}/items/{item_id}/statistics\",\n", + " params={\"assets\": \"ms_analytic\"}\n", + ").json()\n", + "print(json.dumps(stats, indent=4))" + ] + }, + { + "cell_type": "markdown", + "id": "2337a2e2", + "metadata": {}, + "source": [ + "Min/Max values for each band of the `ms_analytic` asset" + ] + }, + { + "cell_type": "code", + "execution_count": 25, + "id": "1f7c1de3", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "ms_analytic_b1 Min/Max: 15.0 - 9390.0\n", + "ms_analytic_b2 Min/Max: 11.0 - 9396.0\n", + "ms_analytic_b3 Min/Max: 9.0 - 9442.0\n", + "ms_analytic_b4 Min/Max: 48.0 - 7906.0\n" + ] + } + ], + "source": [ + "for k, v in stats.items():\n", + " print(k, \"Min/Max:\", v['min'], \"-\", v['max'], )" + ] + }, + { + "cell_type": "code", + "execution_count": 26, + "id": "286f873b", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
Make this Notebook Trusted to load map: File -> Trust Notebook
" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 26, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "# `ms_analytic` \n", + "tilejson = httpx.get(\n", + " f\"https://raster.eoapi.dev/collections/{collection_id}/items/{item_id}/tilejson.json\",\n", + " params = (\n", + " (\"assets\", \"ms_analytic\"),\n", + " (\"asset_bidx\", \"ms_analytic|4,1,2\"),\n", + " (\"rescale\", \"0,8000\"), # Here we use min/max found in the statistics response\n", + " (\"minzoom\", 12),\n", + " (\"maxzoom\", 16), \n", + " )\n", + ").json()\n", + "\n", + "bounds = tilejson[\"bounds\"]\n", + "m = Map(\n", + " location=((bounds[1] + bounds[3]) / 2,(bounds[0] + bounds[2]) / 2),\n", + " zoom_start=14\n", + ")\n", + "\n", + "tiles = TileLayer(\n", + " tiles=tilejson[\"tiles\"][0],\n", + " min_zoom=tilejson[\"minzoom\"],\n", + " max_zoom=tilejson[\"maxzoom\"],\n", + " opacity=1,\n", + " attr=\"Maxar\"\n", + ")\n", + "tiles.add_to(m)\n", + "\n", + "geo_json = GeoJson(data=item)\n", + "geo_json.add_to(m)\n", + "m" + ] + }, + { + "cell_type": "markdown", + "id": "b6d722f7", + "metadata": {}, + "source": [ + "See full list of options at https://stac-utils.github.io/titiler-pgstac/item_endpoints/#tiles" + ] + }, + { + "cell_type": "markdown", + "id": "3a02b6ae", + "metadata": {}, + "source": [ + "## Mosaics\n", + "\n", + "As mentioned and shown with `titiler-pgstac`, we can visualize an item's asset, but the real power of the raster API is to be able to create a virtual mosaic dynamically and merge multiple items on the fly.\n", + "\n", + "Learn more: http://github.com/stac-utils/titiler-pgstac.\n", + "\n", + "Let's create `mosaics` for a specific DateTime we found in the previous step.\n", + "\n", + "> ['2023-08-09T21:10', '2023-08-09T21:20', '2023-08-12T21:11', '2023-08-12T21:12', '2023-08-12T21:18']" + ] + }, + { + "cell_type": "code", + "execution_count": 27, + "id": "57c276ec", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "{\n", + " \"id\": \"c13976bc1e5dc7f3c2b4a64239871fc0\",\n", + " \"links\": [\n", + " {\n", + " \"rel\": \"metadata\",\n", + " \"title\": \"Mosaic metadata\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://raster.eoapi.dev/searches/c13976bc1e5dc7f3c2b4a64239871fc0/info\"\n", + " },\n", + " {\n", + " \"rel\": \"tilejson\",\n", + " \"title\": \"Link for TileJSON\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://raster.eoapi.dev/searches/c13976bc1e5dc7f3c2b4a64239871fc0/tilejson.json\"\n", + " },\n", + " {\n", + " \"rel\": \"map\",\n", + " \"title\": \"Link for Map viewer\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://raster.eoapi.dev/searches/c13976bc1e5dc7f3c2b4a64239871fc0/map\"\n", + " },\n", + " {\n", + " \"rel\": \"wmts\",\n", + " \"title\": \"Link for WMTS\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://raster.eoapi.dev/searches/c13976bc1e5dc7f3c2b4a64239871fc0/WMTSCapabilities.xml\"\n", + " }\n", + " ]\n", + "}\n" + ] + } + ], + "source": [ + "# Create a Mosaic for the first date `2023-08-09`\n", + "startdate = \"2023-08-09T00:00:01Z\"\n", + "enddate = \"2023-08-10T23:59:59Z\"\n", + "\n", + "mosaic = httpx.post(\n", + " \"https://raster.eoapi.dev/searches/register\",\n", + " data=json.dumps(\n", + " {\n", + " \"filter-lang\": 'cql2-json',\n", + " \"filter\": {\n", + " \"op\": 'and', \n", + " \"args\": [\n", + " {\n", + " \"op\": \"in\", \n", + " \"args\": [{\"property\": \"collection\"}, [collection_id]]\n", + " },\n", + " {\n", + " \"op\": \"t_intersects\", \n", + " \"args\": [\n", + " {\"property\": \"datetime\"}, [startdate, enddate]\n", + " ]\n", + " }\n", + " ],\n", + " },\n", + " \"metadata\":{\n", + " \"bounds\": collection_info[\"extent\"][\"spatial\"][\"bbox\"][0],\n", + " }\n", + " \n", + " }\n", + " )\n", + ").json()\n", + "print(json.dumps(mosaic, indent=4))" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "id": "6dd5f539", + "metadata": {}, + "source": [ + "Explanation:\n", + "\n", + "The `mosaic` correspond of a STAC Search query. Because we use `PgSTAC` backend we can make use of the `filter` extension to construct complex query: https://github.com/stac-api-extensions/filter\n", + "\n", + "\n", + "```json\n", + "{\n", + " // PgSTAC accepts multiple languages for filtering; here we will use cql2-json\n", + " \"filter-lang\": 'cql2-json',\n", + " // We tell PgSTAC to `register` a `search` request with the following filter:\n", + " \"filter\": {\n", + " \"op\": 'and', \n", + " \"args\": [\n", + " // Item's collection HAS TO be in `[collection_id]`\n", + " {\n", + " \"op\": \"in\", \n", + " \"args\": [{\"property\": \"collection\"}, [collection_id]]\n", + " },\n", + " {\n", + " // Item's datetime property HAS to intersect with the start/end date\n", + " \"op\": \"t_intersects\", \n", + " \"args\": [\n", + " {\"property\": \"datetime\"}, [startdate, enddate]\n", + " ]\n", + " },\n", + " // titiler-pgstac accept some additional metadata\n", + " // https://stac-utils.github.io/titiler-pgstac/advanced/metadata/\n", + " // One is useful: `bounds`. When creating a mosaic, the tiler will have no idea \n", + " // where the items will be before trying to create each tile. To avoid trying to request \n", + " // tiles where we know we don't have any items, we can add the collection's extent to the \n", + " // mosaic metadata. \n", + " // The tiler service will then return the bounds in the tilejson document for the \n", + " // client application.\n", + " \"metadata\":{\n", + " \"bounds\": collection_info[\"extent\"][\"spatial\"][\"bbox\"][0],\n", + " } \n", + " ],\n", + " },\n", + "\n", + "}\n", + "```\n", + "\n", + "API Response:\n", + "\n", + "The raster service will return a `searchid` hash (also called `mosaic id`), which we can use to construct a tile URL.\n", + "\n", + "To create a valid tile URL we will again need to pass an `assets` parameter to tell the tiler which assets we want to visualize. We can also set the min/max zooms limits to avoid underzooming (openning to many files) and overzooming.\n", + "\n", + "See full list of options: https://stac-utils.github.io/titiler-pgstac/mosaic_endpoints/#tiles" + ] + }, + { + "cell_type": "code", + "execution_count": 32, + "id": "1638c679", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "{'tilejson': '2.2.0', 'name': 'db5a7f4dc6d5763bf955e80903e6a78d', 'version': '1.0.0', 'scheme': 'xyz', 'tiles': ['https://raster.eoapi.dev/searches/db5a7f4dc6d5763bf955e80903e6a78d/tiles/WebMercatorQuad/{z}/{x}/{y}?assets=visual'], 'minzoom': 12, 'maxzoom': 19, 'bounds': [-180.0, -85.05112877980655, 179.99999999999955, 85.0511287798066], 'center': [-2.2737367544323206e-13, 2.842170943040401e-14, 12]}\n" + ] + }, + { + "data": { + "text/html": [ + "
Make this Notebook Trusted to load map: File -> Trust Notebook
" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 32, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "mosaic_id = mosaic[\"id\"]\n", + "\n", + "tilejson = httpx.get(\n", + " f\"https://raster.eoapi.dev/searches/{mosaic_id}/tilejson.json\",\n", + " params = (\n", + " (\"assets\", \"visual\"), # THIS IS MANDATORY\n", + " (\"minzoom\", 12),\n", + " (\"maxzoom\", 19), \n", + " )\n", + ").json()\n", + "print(tilejson)\n", + "\n", + "bounds = tilejson[\"bounds\"]\n", + "m = Map(\n", + " location=((bounds[1] + bounds[3]) / 2,(bounds[0] + bounds[2]) / 2),\n", + " zoom_start=12\n", + ")\n", + "\n", + "tiles = TileLayer(\n", + " tiles=tilejson[\"tiles\"][0],\n", + " min_zoom=tilejson[\"minzoom\"],\n", + " max_zoom=tilejson[\"maxzoom\"],\n", + " opacity=1,\n", + " attr=\"Maxar\"\n", + ")\n", + "tiles.add_to(m)\n", + "m" + ] + }, + { + "cell_type": "markdown", + "id": "b98b5062", + "metadata": {}, + "source": [ + "### More with Mosaic\n", + "\n", + "Let's get crazy and create a `multiple-collection` mosaic with all items which have the `GE01` plateform.\n", + "\n", + "First check how many items have the platform=\"GE01\" usin the stac `/search` endpoint" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "17edc413", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Found 2246 Items matching the query\n" + ] + } + ], + "source": [ + "items = httpx.post(\n", + " \"https://stac.eoapi.dev/search\",\n", + " data=json.dumps(\n", + " {\n", + " \"filter-lang\": 'cql2-json',\n", + " \"filter\": {\n", + " \"op\": 'and', \n", + " \"args\": [\n", + " {\n", + " \"op\": \"eq\", \n", + " \"args\": [\n", + " {\"property\": \"platform\"}, \"GE01\"\n", + " ]\n", + " }\n", + " ],\n", + " },\n", + " \"limit\": 1,\n", + " }\n", + " )\n", + ").json()\n", + "\n", + "print(f\"Found {items['context']['matched']} Items matching the query\")" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "id": "52ba019b", + "metadata": {}, + "source": [ + "Woot, more than 2000 items.\n", + "\n", + "Let's now register the mosaic query.\n", + "\n", + "Note, for this we will assume:\n", + "\n", + "- that `GE01` is a cross-collection platform\n", + "- that all `GE01` items have a `visual` asset\n", + "- that all `visual` assets are 3 bands and Uint8 raster\n", + "- that all `visual` assets cover the same zoom range" + ] + }, + { + "cell_type": "code", + "execution_count": 30, + "id": "d5e6f126", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "{'tilejson': '2.2.0', 'name': 'db5a7f4dc6d5763bf955e80903e6a78d', 'version': '1.0.0', 'scheme': 'xyz', 'tiles': ['https://raster.eoapi.dev/searches/db5a7f4dc6d5763bf955e80903e6a78d/tiles/WebMercatorQuad/{z}/{x}/{y}?assets=visual'], 'minzoom': 12, 'maxzoom': 19, 'bounds': [-180.0, -85.05112877980655, 179.99999999999955, 85.0511287798066], 'center': [-2.2737367544323206e-13, 2.842170943040401e-14, 12]}\n" + ] + }, + { + "data": { + "text/html": [ + "
Make this Notebook Trusted to load map: File -> Trust Notebook
" + ], + "text/plain": [ + "" + ] + }, + "execution_count": 30, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "mosaic = httpx.post(\n", + " \"https://raster.eoapi.dev/searches/register\",\n", + " data=json.dumps(\n", + " {\n", + " \"filter-lang\": 'cql2-json',\n", + " \"filter\": {\n", + " \"op\": 'and', \n", + " \"args\": [\n", + " {\n", + " \"op\": \"eq\", \n", + " \"args\": [\n", + " {\"property\": \"platform\"}, \"GE01\"\n", + " ]\n", + " }\n", + " ],\n", + " },\n", + " \"metadata\":{}\n", + " \n", + " }\n", + " )\n", + ").json()\n", + "\n", + "mosaic_id = mosaic[\"id\"]\n", + "\n", + "tilejson = httpx.get(\n", + " f\"https://raster.eoapi.dev/searches/{mosaic_id}/tilejson.json\",\n", + " params = (\n", + " (\"assets\", \"visual\"), # THIS IS MANDATORY\n", + " (\"minzoom\", 12),\n", + " (\"maxzoom\", 19), \n", + " )\n", + ").json()\n", + "print(tilejson)\n", + "\n", + "bounds = tilejson[\"bounds\"]\n", + "m = Map(\n", + " location=(0, 0),\n", + " zoom_start=8\n", + ")\n", + "\n", + "# let's add the collection's geojson on top of the map\n", + "geo_json = GeoJson(data=collections_geojson)\n", + "geo_json.add_to(m)\n", + "\n", + "tiles = TileLayer(\n", + " tiles=tilejson[\"tiles\"][0],\n", + " min_zoom=tilejson[\"minzoom\"],\n", + " max_zoom=tilejson[\"maxzoom\"],\n", + " opacity=1,\n", + " attr=\"Maxar\"\n", + ")\n", + "tiles.add_to(m)\n", + "m\n", + "\n" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "id": "16c8665f", + "metadata": {}, + "source": [ + "Not all collection have GE01 items; pan/zoom to some collections to see the tiles." + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "id": "0652bbf8", + "metadata": {}, + "source": [ + "Note: While we showed that it is technically possible to construct Mosaics using the `open` filter, there might be better ideas in terms of performance.\n", + "\n", + "- Only some properties are indexed in PgSTAC, meaning the `platform` properties lookup will be slow.\n", + "- We cannot spatially limit the mosaic, meaning the frontend will request tiles for the entire world.\n", + "- Assuming that all `GE01` platforms have `visual` assets is a HUGE assumption.\n", + "- Assuming that all `visual` assets are the same is also bold." + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "id": "57923484", + "metadata": {}, + "source": [ + "## What's Next?\n", + "\n", + "### Spin Up Your Own eoAPI Instance\n", + "\n", + "You've seen what eoAPI can do with Maxar data in the context of the Hawaii wildfires. Interested in setting up your own eoAPI service? It's straightforward! Follow the 'Getting Started' section of the [eoAPI GitHub repository](https://github.com/developmentseed/eoAPI) to get your instance up and running. This will give you greater control and customization options.\n", + "\n", + "### Contribute Your Data\n", + "\n", + "Consider contributing if you've used Maxar data for similar analyses or have other datasets that could benefit the community. Uploading your data to your eoAPI instance can provide more diverse examples and help in various applications.\n", + "\n", + "### Community-Driven Examples\n", + "\n", + "The examples you see here, including this notebook, are often community-driven. We encourage you to contribute your analyses, workflows, or visualizations. Your insights could be invaluable for helping others.\n", + "\n", + "### Have Questions? Join the Discussion!\n", + "\n", + "If you have questions, feedback, or want to engage with the eoAPI community, please join the [GitHub discussions](https://github.com/developmentseed/eoAPI/discussions). It's a great place to ask questions, share your experiences, and connect with others interested in eoAPI and its components. \n", + "\n", + "---\n", + "\n", + "Thank you for taking the time to go through this notebook." + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.10.5" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} diff --git a/notebooks/eoAPI_Maxar_Kahramanmaras_demo.ipynb b/notebooks/eoAPI_Maxar_Kahramanmaras_demo.ipynb new file mode 100644 index 0000000..858cb33 --- /dev/null +++ b/notebooks/eoAPI_Maxar_Kahramanmaras_demo.ipynb @@ -0,0 +1,1644 @@ +{ + "cells": [ + { + "attachments": {}, + "cell_type": "markdown", + "id": "a0eb29a0", + "metadata": {}, + "source": [ + "## eoAPI Demo: Kahramanmaras earthquakes\n", + "\n", + "\n", + "### Background\n", + "\n", + "This notebook will review the different [eoAPI](https://github.com/developmentseed/eoAPI) services using the latest Open data from Maxar acquired for the M7.8 and M7.5 Kahramanmaras earthquakes in Turkey on February 6, 2023.\n", + "\n", + "More on the event: https://www.usgs.gov/news/featured-story/m78-and-m75-kahramanmaras-earthquake-sequence-near-nurdagi-turkey-turkiye\n", + "\n", + "### Objective\n", + "\n", + "This notebook aims to demonstrate how [eoAPI](https://github.com/developmentseed/eoAPI) can be used to analyze Maxar's high-resolution satellite data to assess the Kahramanmaras earthquakes' impact.\n", + "\n", + "### Maxar Open Data\n", + "\n", + "Pre and post-event high-resolution satellite imagery in support of emergency planning, risk assessment, monitoring of staging areas and emergency response, damage assessment, and recovery. These images are generated using the Maxar ARD pipeline, tiled on an organized grid in analysis-ready cloud-optimized formats.\n", + "\n", + "### STAC and COGs\n", + "\n", + "Maxar releases open data for select sudden-onset major crisis events. In addition to making the data (as nice COGs) freely available on AWS, they also add STAC (static) metadata alongside the images. Having the STAC items already created makes ingestion into the PgSTAC database easy (we don't have to produce the items ourselves and thus have to read the images).\n", + "\n", + "To learn more about ingesting the Maxar OpenData STAC catalog into PgSTAC see https://github.com/vincentsarago/MAXAR_opendata_to_pgstac.\n", + "\n", + "---\n", + "\n", + "> 📣 **Note: Important Information**\n", + "> - **Demo Endpoints**: This notebook uses the demo endpoints [stac.eoapi.dev](https://stac.eoapi.dev) and [raster.eoapi.dev](https://raster.eoapi.dev). These are not intended for production use.\n", + "> - **Authentication**: While the demo endpoints are currently open to the public, we may introduce authentication features in the future.\n", + "> - **Set Up Your Own Services**: If you're interested in setting up your own eoAPI services, you can easily do so. For a step-by-step guide, please check out the 'Getting Started' section of the [eoAPI GitHub repository](https://github.com/developmentseed/eoAPI).\n", + "> - **Breaking changes**: DevelopmentSeed does not guarantee that these eoAPI endpoints will stay `open`, and breaking changes might be introduced anytime.\n", + "\n", + "---" + ] + }, + { + "cell_type": "markdown", + "id": "d36cc240", + "metadata": {}, + "source": [ + "# STAC Metadata\n", + "\n", + "Endpoint: https://stac.eoapi.dev" + ] + }, + { + "cell_type": "code", + "execution_count": 20, + "id": "9a912d28", + "metadata": {}, + "outputs": [], + "source": [ + "# Requirements\n", + "\n", + "# !python -m pip install httpx ipyleaflet" + ] + }, + { + "cell_type": "code", + "execution_count": 55, + "id": "0ed3efb6", + "metadata": {}, + "outputs": [], + "source": [ + "from datetime import datetime\n", + "\n", + "import json\n", + "import httpx\n", + "\n", + "import ipyleaflet" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "id": "146cfd71", + "metadata": {}, + "source": [ + "### Collection\n", + "\n", + "If you look in `https://stac.eoapi.dev/collections` response, you'll find one collection for the Kahramanmaras earthquake named `MAXAR_Kahramanmaras_turkey_earthquake_23`." + ] + }, + { + "cell_type": "code", + "execution_count": 56, + "id": "44105f25", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "['MAXAR_Kahramanmaras_turkey_earthquake_23']\n" + ] + } + ], + "source": [ + "# list the collections and find the collection_id associated to the `kahramanmaras` event\n", + "collections = httpx.get(\"https://stac.eoapi.dev/collections\").json()\n", + "print([c[\"id\"] for c in collections[\"collections\"] if \"kahramanmaras\" in c[\"description\"].lower()])" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "id": "507f0afd", + "metadata": {}, + "source": [ + "Let's check the collection's metadata:" + ] + }, + { + "cell_type": "code", + "execution_count": 57, + "id": "02f9b550", + "metadata": {}, + "outputs": [ + { + "data": { + "application/vnd.jupyter.widget-view+json": { + "model_id": "71f6bfb05f2844f4a51e754e34cc7afc", + "version_major": 2, + "version_minor": 0 + }, + "text/plain": [ + "Map(center=[36.983902384345036, 36.89273358165191], controls=(ZoomControl(options=['position', 'zoom_in_text',…" + ] + }, + "execution_count": 57, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "collection_id = \"MAXAR_Kahramanmaras_turkey_earthquake_23\"\n", + "\n", + "collection_info = httpx.get(f\"https://stac.eoapi.dev/collections/{collection_id}\").json()\n", + "\n", + "geojson = {\n", + " \"type\": \"FeatureCollection\",\n", + " \"features\": [\n", + " {\n", + " 'type': 'Feature',\n", + " 'geometry': {\n", + " 'type': 'Polygon',\n", + " 'coordinates': [[\n", + " [bbox[0], bbox[1]],\n", + " [bbox[2], bbox[1]],\n", + " [bbox[2], bbox[3]],\n", + " [bbox[0], bbox[3]],\n", + " [bbox[0], bbox[1]],\n", + " ]]\n", + " },\n", + " 'properties': {}\n", + " }\n", + " for bbox in collection_info[\"extent\"][\"spatial\"][\"bbox\"]\n", + " ]\n", + "}\n", + "\n", + "mainbbox = collection_info[\"extent\"][\"spatial\"][\"bbox\"][0]\n", + "\n", + "m = ipyleaflet.leaflet.Map(\n", + " center=((mainbbox[1] + mainbbox[3]) / 2,(mainbbox[0] + mainbbox[2]) / 2),\n", + " zoom=7\n", + ")\n", + "\n", + "geo_json = ipyleaflet.leaflet.GeoJSON(data=geojson)\n", + "m.add_layer(geo_json)\n", + "m" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "id": "5fd7a387", + "metadata": {}, + "source": [ + "Each collection can have spatial and temporal extents. As for the spatial extent, a collection can have multiple temporal extents, but its first one represents the combined min/max of all the intervals." + ] + }, + { + "cell_type": "code", + "execution_count": 58, + "id": "f425070c", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "{'interval': [['2021-02-28T08:10:22Z', '2023-03-11T08:29:15Z']]}\n" + ] + } + ], + "source": [ + "print(collection_info[\"extent\"][\"temporal\"])" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "id": "0fa1db99", + "metadata": {}, + "source": [ + "## Items\n", + "\n", + "In this section, we will:\n", + "\n", + "- List all items for a specific collection using the `/collections/{collection_id}/items` endpoint\n", + "- Talk about the `limit` parameter\n", + "- Visualize all items on a map\n", + "- Talk about the item metadata\n", + "- List the Assets available for one Item" + ] + }, + { + "cell_type": "code", + "execution_count": 59, + "id": "0870f7df", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Nb Items in Db: 2115\n", + "Returned 10 Items\n" + ] + } + ], + "source": [ + "items = httpx.get(f\"https://stac.eoapi.dev/collections/{collection_id}/items\").json()\n", + " \n", + "print(f\"Nb Items in Db: {items['context']['matched']}\")\n", + "print(f\"Returned {len(items['features'])} Items\")" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "id": "ad0efb74", + "metadata": {}, + "source": [ + "As you can see below, the `/items` endpoints returned only 10 items. To return more data, we need to either use the `paging` mechanism." + ] + }, + { + "cell_type": "code", + "execution_count": 60, + "id": "992501d7", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Nb Items: 2115\n" + ] + } + ], + "source": [ + "kahramanmaras_items = []\n", + "\n", + "url = f\"https://stac.eoapi.dev/collections/{collection_id}/items\"\n", + "while True:\n", + " items = httpx.get(url, params={\"limit\": 200}).json()\n", + " \n", + " kahramanmaras_items.extend(items[\"features\"])\n", + " next_link = list(filter(lambda link: link[\"rel\"] == \"next\", items[\"links\"]))\n", + " if next_link:\n", + " url = next_link[0][\"href\"]\n", + " else:\n", + " break\n", + "\n", + "print(f\"Nb Items: {len(kahramanmaras_items)}\")" + ] + }, + { + "cell_type": "code", + "execution_count": 61, + "id": "7f77306d", + "metadata": {}, + "outputs": [ + { + "data": { + "application/vnd.jupyter.widget-view+json": { + "model_id": "1b3051a9025749f88686803e2b803ccf", + "version_major": 2, + "version_minor": 0 + }, + "text/plain": [ + "Map(center=[36.983902384345036, 36.89273358165191], controls=(ZoomControl(options=['position', 'zoom_in_text',…" + ] + }, + "execution_count": 61, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "m = ipyleaflet.leaflet.Map(\n", + " center=((mainbbox[1] + mainbbox[3]) / 2,(mainbbox[0] + mainbbox[2]) / 2),\n", + " zoom=7\n", + ")\n", + "\n", + "event_date = datetime(2023, 2, 6, hour=0, minute=0)\n", + "\n", + "# Use a styling function to show where we have before/after items\n", + "def style_function(feature):\n", + " d = datetime.strptime(feature[\"properties\"][\"datetime\"], \"%Y-%m-%dT%H:%M:%SZ\")\n", + " return {\n", + " \"fillOpacity\": 0.1,\n", + " \"weight\": 0.1,\n", + " # Blue for pre-event / red for post-event\n", + " \"fillColor\": \"#0000ff\" if d < event_date else \"#ff0000\"\n", + " }\n", + "\n", + "geo_json = ipyleaflet.leaflet.GeoJSON(data={\"type\": \"FeatureCollection\", \"features\": kahramanmaras_items}, style_callback=style_function)\n", + "m.add_layer(geo_json)\n", + "m" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "id": "ec55f253", + "metadata": {}, + "source": [ + "##### Item metadata \n", + "\n", + "Each item should have an `id`, a `geometry`, some links to `Assets`, and a set of properties.\n", + "\n", + "Item specification: https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md" + ] + }, + { + "cell_type": "code", + "execution_count": 62, + "id": "56ba6e0c", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Item example:\n", + "{\n", + " \"id\": \"37_031133210001_10300100E49E8000\",\n", + " \"bbox\": [\n", + " 36.387245559111236,\n", + " 36.092041667396806,\n", + " 36.42079643694594,\n", + " 36.11834923545021\n", + " ],\n", + " \"type\": \"Feature\",\n", + " \"links\": [\n", + " {\n", + " \"rel\": \"collection\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://stac.eoapi.dev/collections/MAXAR_Kahramanmaras_turkey_earthquake_23\"\n", + " },\n", + " {\n", + " \"rel\": \"parent\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://stac.eoapi.dev/collections/MAXAR_Kahramanmaras_turkey_earthquake_23\"\n", + " },\n", + " {\n", + " \"rel\": \"root\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://stac.eoapi.dev/\"\n", + " },\n", + " {\n", + " \"rel\": \"self\",\n", + " \"type\": \"application/geo+json\",\n", + " \"href\": \"https://stac.eoapi.dev/collections/MAXAR_Kahramanmaras_turkey_earthquake_23/items/37_031133210001_10300100E49E8000\"\n", + " }\n", + " ],\n", + " \"assets\": {\n", + " \"visual\": {\n", + " \"href\": \"s3://maxar-opendata/events/Kahramanmaras-turkey-earthquake-23/ard/37/031133210001/2023-03-11/10300100E49E8000-visual.tif\",\n", + " \"type\": \"image/tiff; application=geotiff; profile=cloud-optimized\",\n", + " \"roles\": [\n", + " \"visual\"\n", + " ],\n", + " \"title\": \"Visual Image\",\n", + " \"eo:bands\": [\n", + " {\n", + " \"name\": \"BAND_R\",\n", + " \"common_name\": \"red\",\n", + " \"description\": \"Red\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_G\",\n", + " \"common_name\": \"green\",\n", + " \"description\": \"Green\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_B\",\n", + " \"common_name\": \"blue\",\n", + " \"description\": \"Blue\"\n", + " }\n", + " ],\n", + " \"alternate\": {\n", + " \"public\": {\n", + " \"href\": \"https://maxar-opendata.s3.amazonaws.com/events/Kahramanmaras-turkey-earthquake-23/ard/37/031133210001/2023-03-11/10300100E49E8000-visual.tif\",\n", + " \"title\": \"Public Access\"\n", + " }\n", + " },\n", + " \"proj:bbox\": [\n", + " 264843.75,\n", + " 3994843.75,\n", + " 270156.25,\n", + " 4000156.25\n", + " ],\n", + " \"proj:shape\": [\n", + " 17408,\n", + " 17408\n", + " ],\n", + " \"proj:transform\": [\n", + " 0.30517578125,\n", + " 0.0,\n", + " 264843.75,\n", + " 0.0,\n", + " -0.30517578125,\n", + " 4000156.25,\n", + " 0.0,\n", + " 0.0,\n", + " 1.0\n", + " ]\n", + " },\n", + " \"data-mask\": {\n", + " \"href\": \"s3://maxar-opendata/events/Kahramanmaras-turkey-earthquake-23/ard/37/031133210001/2023-03-11/10300100E49E8000-data-mask.gpkg\",\n", + " \"type\": \"application/geopackage+sqlite3\",\n", + " \"roles\": [\n", + " \"data-mask\"\n", + " ],\n", + " \"title\": \"Data Mask\",\n", + " \"alternate\": {\n", + " \"public\": {\n", + " \"href\": \"https://maxar-opendata.s3.amazonaws.com/events/Kahramanmaras-turkey-earthquake-23/ard/37/031133210001/2023-03-11/10300100E49E8000-data-mask.gpkg\",\n", + " \"title\": \"Public Access\"\n", + " }\n", + " }\n", + " },\n", + " \"ms_analytic\": {\n", + " \"href\": \"s3://maxar-opendata/events/Kahramanmaras-turkey-earthquake-23/ard/37/031133210001/2023-03-11/10300100E49E8000-ms.tif\",\n", + " \"type\": \"image/tiff; application=geotiff; profile=cloud-optimized\",\n", + " \"roles\": [\n", + " \"data\"\n", + " ],\n", + " \"title\": \"Multispectral Image\",\n", + " \"eo:bands\": [\n", + " {\n", + " \"name\": \"BAND_C\",\n", + " \"common_name\": \"coastal\",\n", + " \"description\": \"Coastal Blue\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_B\",\n", + " \"common_name\": \"blue\",\n", + " \"description\": \"Blue\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_G\",\n", + " \"common_name\": \"green\",\n", + " \"description\": \"Green\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_Y\",\n", + " \"common_name\": \"yellow\",\n", + " \"description\": \"Yellow\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_R\",\n", + " \"common_name\": \"red\",\n", + " \"description\": \"Red\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_RE\",\n", + " \"common_name\": \"rededge\",\n", + " \"description\": \"Red Edge 1\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_N\",\n", + " \"common_name\": \"nir08\",\n", + " \"description\": \"Near Infrared 1\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_N2\",\n", + " \"common_name\": \"nir09\",\n", + " \"description\": \"Near Infrared 2\"\n", + " }\n", + " ],\n", + " \"alternate\": {\n", + " \"public\": {\n", + " \"href\": \"https://maxar-opendata.s3.amazonaws.com/events/Kahramanmaras-turkey-earthquake-23/ard/37/031133210001/2023-03-11/10300100E49E8000-ms.tif\",\n", + " \"title\": \"Public Access\"\n", + " }\n", + " },\n", + " \"proj:bbox\": [\n", + " 264843.75,\n", + " 3994843.75,\n", + " 270156.25,\n", + " 4000156.25\n", + " ],\n", + " \"proj:shape\": [\n", + " 2779,\n", + " 2779\n", + " ],\n", + " \"proj:transform\": [\n", + " 1.9116588700971573,\n", + " 0.0,\n", + " 264843.75,\n", + " 0.0,\n", + " -1.9116588700971573,\n", + " 4000156.25,\n", + " 0.0,\n", + " 0.0,\n", + " 1.0\n", + " ]\n", + " },\n", + " \"pan_analytic\": {\n", + " \"href\": \"s3://maxar-opendata/events/Kahramanmaras-turkey-earthquake-23/ard/37/031133210001/2023-03-11/10300100E49E8000-pan.tif\",\n", + " \"type\": \"image/tiff; application=geotiff; profile=cloud-optimized\",\n", + " \"roles\": [\n", + " \"data\"\n", + " ],\n", + " \"title\": \"Panchromatic Image\",\n", + " \"eo:bands\": [\n", + " {\n", + " \"name\": \"BAND_P\",\n", + " \"description\": \"Pan\"\n", + " }\n", + " ],\n", + " \"alternate\": {\n", + " \"public\": {\n", + " \"href\": \"https://maxar-opendata.s3.amazonaws.com/events/Kahramanmaras-turkey-earthquake-23/ard/37/031133210001/2023-03-11/10300100E49E8000-pan.tif\",\n", + " \"title\": \"Public Access\"\n", + " }\n", + " },\n", + " \"proj:bbox\": [\n", + " 264843.75,\n", + " 3994843.75,\n", + " 270156.25,\n", + " 4000156.25\n", + " ],\n", + " \"proj:shape\": [\n", + " 11116,\n", + " 11116\n", + " ],\n", + " \"proj:transform\": [\n", + " 0.4779147175242893,\n", + " 0.0,\n", + " 264843.75,\n", + " 0.0,\n", + " -0.4779147175242893,\n", + " 4000156.25,\n", + " 0.0,\n", + " 0.0,\n", + " 1.0\n", + " ]\n", + " }\n", + " },\n", + " \"geometry\": {\n", + " \"type\": \"Polygon\",\n", + " \"coordinates\": [\n", + " [\n", + " [\n", + " 36.387245559111236,\n", + " 36.11762172115687\n", + " ],\n", + " [\n", + " 36.38807914445892,\n", + " 36.09246165938945\n", + " ],\n", + " [\n", + " 36.40855030738972,\n", + " 36.09229578729594\n", + " ],\n", + " [\n", + " 36.420731654920246,\n", + " 36.092041667396806\n", + " ],\n", + " [\n", + " 36.42079643694594,\n", + " 36.11834923545021\n", + " ],\n", + " [\n", + " 36.387245559111236,\n", + " 36.11762172115687\n", + " ]\n", + " ]\n", + " ]\n", + " },\n", + " \"collection\": \"MAXAR_Kahramanmaras_turkey_earthquake_23\",\n", + " \"properties\": {\n", + " \"gsd\": 0.48,\n", + " \"quadkey\": \"031133210001\",\n", + " \"datetime\": \"2023-03-11T08:29:15Z\",\n", + " \"platform\": \"WV02\",\n", + " \"utm_zone\": 37,\n", + " \"grid:code\": \"MXRA-Z37-031133210001\",\n", + " \"proj:bbox\": [\n", + " 264843.75,\n", + " 3997237.548828125,\n", + " 267866.2109375,\n", + " 4000156.25\n", + " ],\n", + " \"proj:epsg\": 32637,\n", + " \"catalog_id\": \"10300100E49E8000\",\n", + " \"view:azimuth\": 175.5,\n", + " \"proj:geometry\": {\n", + " \"type\": \"Polygon\",\n", + " \"coordinates\": [\n", + " [\n", + " [\n", + " 264843.75,\n", + " 4000156.25\n", + " ],\n", + " [\n", + " 264843.75,\n", + " 3997362.6708984375\n", + " ],\n", + " [\n", + " 266686.70654296875,\n", + " 3997294.921875\n", + " ],\n", + " [\n", + " 267782.89794921875,\n", + " 3997237.548828125\n", + " ],\n", + " [\n", + " 267866.2109375,\n", + " 4000156.25\n", + " ],\n", + " [\n", + " 264843.75,\n", + " 4000156.25\n", + " ]\n", + " ]\n", + " ]\n", + " },\n", + " \"tile:data_area\": 8.5,\n", + " \"view:off_nadir\": 12.4,\n", + " \"tile:clouds_area\": 0.0,\n", + " \"view:sun_azimuth\": 152.0,\n", + " \"view:sun_elevation\": 46.5,\n", + " \"tile:clouds_percent\": 0,\n", + " \"ard_metadata_version\": \"0.0.1\",\n", + " \"view:incidence_angle\": 76.1\n", + " },\n", + " \"stac_version\": \"1.0.0\",\n", + " \"stac_extensions\": [\n", + " \"https://stac-extensions.github.io/view/v1.0.0/schema.json\",\n", + " \"https://stac-extensions.github.io/projection/v1.0.0/schema.json\",\n", + " \"https://stac-extensions.github.io/eo/v1.0.0/schema.json\",\n", + " \"https://stac-extensions.github.io/raster/v1.1.0/schema.json\",\n", + " \"https://stac-extensions.github.io/grid/v1.0.0/schema.json\",\n", + " \"https://stac-extensions.github.io/alternate-assets/v1.1.0/schema.json\"\n", + " ]\n", + "}\n" + ] + } + ], + "source": [ + "item = kahramanmaras_items[0]\n", + "print(\"Item example:\")\n", + "print(json.dumps(item, indent=4))" + ] + }, + { + "cell_type": "code", + "execution_count": 63, + "id": "7f632955", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Item Id 37_031133210001_10300100E49E8000\n", + "Item Assets: ['visual', 'data-mask', 'ms_analytic', 'pan_analytic']\n", + "Item Properties:\n", + "{\n", + " \"gsd\": 0.48,\n", + " \"quadkey\": \"031133210001\",\n", + " \"datetime\": \"2023-03-11T08:29:15Z\",\n", + " \"platform\": \"WV02\",\n", + " \"utm_zone\": 37,\n", + " \"grid:code\": \"MXRA-Z37-031133210001\",\n", + " \"proj:bbox\": [\n", + " 264843.75,\n", + " 3997237.548828125,\n", + " 267866.2109375,\n", + " 4000156.25\n", + " ],\n", + " \"proj:epsg\": 32637,\n", + " \"catalog_id\": \"10300100E49E8000\",\n", + " \"view:azimuth\": 175.5,\n", + " \"proj:geometry\": {\n", + " \"type\": \"Polygon\",\n", + " \"coordinates\": [\n", + " [\n", + " [\n", + " 264843.75,\n", + " 4000156.25\n", + " ],\n", + " [\n", + " 264843.75,\n", + " 3997362.6708984375\n", + " ],\n", + " [\n", + " 266686.70654296875,\n", + " 3997294.921875\n", + " ],\n", + " [\n", + " 267782.89794921875,\n", + " 3997237.548828125\n", + " ],\n", + " [\n", + " 267866.2109375,\n", + " 4000156.25\n", + " ],\n", + " [\n", + " 264843.75,\n", + " 4000156.25\n", + " ]\n", + " ]\n", + " ]\n", + " },\n", + " \"tile:data_area\": 8.5,\n", + " \"view:off_nadir\": 12.4,\n", + " \"tile:clouds_area\": 0.0,\n", + " \"view:sun_azimuth\": 152.0,\n", + " \"view:sun_elevation\": 46.5,\n", + " \"tile:clouds_percent\": 0,\n", + " \"ard_metadata_version\": \"0.0.1\",\n", + " \"view:incidence_angle\": 76.1\n", + "}\n" + ] + } + ], + "source": [ + "print(\"Item Id\", item[\"id\"])\n", + "print(\"Item Assets:\", list(item[\"assets\"].keys()))\n", + "print(\"Item Properties:\")\n", + "print(json.dumps(item[\"properties\"], indent=4))" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "id": "844f4575", + "metadata": {}, + "source": [ + "#### Find acquisition times\n", + "\n", + "Every item should have either a `datetime` or a `start/end_datetime` property. For the Maxar dataset, we are assuming that `datetime` is acquisition times." + ] + }, + { + "cell_type": "code", + "execution_count": 64, + "id": "0d9013bb", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Dates: ['2021-02-28T08:10:22Z', '2021-02-28T08:10:23Z', '2021-08-17T11:16:54Z', '2021-08-18T08:13:11Z', '2021-08-18T08:13:12Z', '2021-09-09T08:36:18Z', '2021-09-09T08:36:19Z', '2021-09-09T08:36:20Z', '2021-09-27T08:40:11Z', '2021-09-27T08:40:12Z', '2021-09-27T08:40:58Z', '2021-09-27T08:41:51Z', '2021-09-27T08:41:52Z', '2021-09-27T08:41:53Z', '2021-09-27T08:41:54Z', '2022-06-18T08:14:17Z', '2022-06-18T08:14:18Z', '2022-07-20T08:39:24Z', '2022-07-20T08:39:25Z', '2022-07-20T08:39:37Z', '2022-07-20T08:39:38Z', '2022-07-26T08:19:46Z', '2022-08-05T08:51:08Z', '2022-08-05T08:51:09Z', '2022-10-10T08:19:25Z', '2022-10-10T08:19:26Z', '2022-10-17T08:44:40Z', '2022-10-17T08:44:59Z', '2022-10-31T08:44:00Z', '2022-10-31T08:44:01Z', '2022-12-16T08:45:41Z', '2022-12-16T08:45:42Z', '2022-12-22T08:24:28Z', '2022-12-22T08:24:29Z', '2022-12-27T08:40:06Z', '2022-12-27T08:40:07Z', '2022-12-27T08:40:17Z', '2023-01-02T08:18:54Z', '2023-01-02T08:18:55Z', '2023-01-02T08:19:11Z', '2023-01-07T08:39:58Z', '2023-01-07T08:39:59Z', '2023-01-18T08:29:06Z', '2023-01-18T08:29:07Z', '2023-01-26T08:37:58Z', '2023-01-26T08:37:59Z', '2023-01-26T08:38:19Z', '2023-01-26T08:38:20Z', '2023-02-07T08:27:01Z', '2023-02-07T08:27:02Z', '2023-02-07T08:27:03Z', '2023-02-07T08:27:04Z', '2023-02-07T08:27:05Z', '2023-02-07T08:27:06Z', '2023-02-07T08:27:07Z', '2023-02-07T08:27:08Z', '2023-02-07T08:27:09Z', '2023-02-07T08:27:10Z', '2023-02-07T08:27:26Z', '2023-02-07T08:27:27Z', '2023-02-07T08:38:41Z', '2023-02-07T08:38:42Z', '2023-02-07T08:38:58Z', '2023-02-07T08:38:59Z', '2023-02-07T08:39:00Z', '2023-02-07T08:39:01Z', '2023-02-07T08:39:02Z', '2023-02-07T08:39:03Z', '2023-02-08T09:01:08Z', '2023-02-08T09:01:09Z', '2023-02-08T09:01:51Z', '2023-02-08T09:01:52Z', '2023-02-08T09:01:53Z', '2023-02-08T09:02:04Z', '2023-02-08T09:02:05Z', '2023-02-08T09:02:06Z', '2023-02-08T09:02:25Z', '2023-02-08T09:02:26Z', '2023-02-08T09:02:33Z', '2023-02-08T09:02:34Z', '2023-02-08T09:02:35Z', '2023-02-09T08:25:13Z', '2023-02-09T08:25:14Z', '2023-02-09T08:25:15Z', '2023-02-09T08:26:11Z', '2023-02-09T08:26:12Z', '2023-02-10T07:49:05Z', '2023-02-10T07:49:06Z', '2023-02-10T07:49:07Z', '2023-02-11T08:51:46Z', '2023-02-11T08:51:47Z', '2023-02-11T08:51:48Z', '2023-02-11T08:52:15Z', '2023-02-11T08:52:16Z', '2023-02-11T08:52:17Z', '2023-02-11T08:52:18Z', '2023-02-11T08:52:19Z', '2023-02-11T08:52:20Z', '2023-02-11T08:52:21Z', '2023-02-11T08:52:22Z', '2023-02-11T08:52:23Z', '2023-02-11T08:52:30Z', '2023-02-11T08:52:31Z', '2023-02-11T08:52:32Z', '2023-02-11T08:52:33Z', '2023-02-11T08:52:34Z', '2023-02-11T08:52:35Z', '2023-02-11T08:52:36Z', '2023-02-11T08:52:37Z', '2023-02-11T08:52:38Z', '2023-02-11T08:52:48Z', '2023-02-11T08:52:49Z', '2023-02-11T08:53:08Z', '2023-02-11T08:53:09Z', '2023-02-12T08:15:28Z', '2023-02-12T08:15:29Z', '2023-02-12T08:16:31Z', '2023-02-12T08:16:32Z', '2023-02-12T08:16:33Z', '2023-02-12T08:16:34Z', '2023-02-12T08:16:45Z', '2023-02-12T08:16:46Z', '2023-02-12T08:16:47Z', '2023-02-12T08:16:48Z', '2023-02-12T08:16:49Z', '2023-02-12T08:16:50Z', '2023-02-12T08:17:15Z', '2023-02-12T08:17:16Z', '2023-02-12T08:17:17Z', '2023-02-12T08:17:18Z', '2023-02-13T08:19:20Z', '2023-02-13T08:19:21Z', '2023-02-13T08:19:22Z', '2023-02-13T08:20:02Z', '2023-02-13T08:20:03Z', '2023-02-13T08:20:11Z', '2023-02-13T08:20:12Z', '2023-02-13T08:20:13Z', '2023-02-13T08:20:34Z', '2023-02-13T08:20:35Z', '2023-02-14T08:35:22Z', '2023-02-14T08:35:23Z', '2023-02-14T08:35:36Z', '2023-02-14T08:35:37Z', '2023-02-21T08:45:01Z', '2023-02-21T08:45:02Z', '2023-02-21T08:45:03Z', '2023-02-22T08:50:16Z', '2023-02-22T08:50:17Z', '2023-02-22T08:50:34Z', '2023-02-22T08:50:35Z', '2023-02-23T08:13:02Z', '2023-02-23T08:13:03Z', '2023-02-23T08:14:23Z', '2023-02-23T08:14:24Z', '2023-02-23T08:14:25Z', '2023-02-26T08:03:20Z', '2023-02-26T08:03:21Z', '2023-02-28T08:29:01Z', '2023-02-28T08:29:02Z', '2023-02-28T08:29:03Z', '2023-02-28T08:29:12Z', '2023-02-28T08:29:28Z', '2023-02-28T08:29:29Z', '2023-02-28T08:29:30Z', '2023-02-28T08:29:31Z', '2023-02-28T08:29:32Z', '2023-02-28T08:29:33Z', '2023-02-28T08:29:34Z', '2023-02-28T08:29:35Z', '2023-02-28T08:29:42Z', '2023-02-28T08:29:43Z', '2023-02-28T08:29:44Z', '2023-02-28T08:29:45Z', '2023-02-28T08:29:46Z', '2023-02-28T08:29:47Z', '2023-02-28T08:29:48Z', '2023-02-28T08:29:49Z', '2023-02-28T08:30:09Z', '2023-02-28T08:30:10Z', '2023-02-28T08:30:25Z', '2023-02-28T08:30:26Z', '2023-02-28T08:30:27Z', '2023-02-28T08:30:34Z', '2023-02-28T08:30:35Z', '2023-02-28T08:52:14Z', '2023-02-28T08:52:15Z', '2023-02-28T08:52:16Z', '2023-02-28T08:52:17Z', '2023-02-28T08:52:43Z', '2023-02-28T08:52:44Z', '2023-02-28T08:52:45Z', '2023-02-28T08:52:46Z', '2023-02-28T08:52:54Z', '2023-02-28T08:52:55Z', '2023-02-28T08:52:56Z', '2023-02-28T08:52:57Z', '2023-02-28T08:52:58Z', '2023-02-28T08:53:12Z', '2023-02-28T08:53:13Z', '2023-03-02T08:56:55Z', '2023-03-02T08:56:56Z', '2023-03-02T08:56:57Z', '2023-03-05T08:32:58Z', '2023-03-05T08:32:59Z', '2023-03-05T08:47:39Z', '2023-03-05T08:47:40Z', '2023-03-05T08:47:54Z', '2023-03-05T08:47:55Z', '2023-03-11T08:28:27Z', '2023-03-11T08:28:28Z', '2023-03-11T08:29:14Z', '2023-03-11T08:29:15Z']\n" + ] + } + ], + "source": [ + "datetimes = {item[\"properties\"][\"datetime\"] for item in kahramanmaras_items}\n", + "print(\"Dates:\", sorted(list(datetimes)))" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "id": "a53e73ff", + "metadata": {}, + "source": [ + "Let's sort the items in two categories: `before` and `after` the event." + ] + }, + { + "cell_type": "code", + "execution_count": 65, + "id": "021248b8", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "PRE event items: 229\n", + "POST event items: 1886\n" + ] + } + ], + "source": [ + "event_date = datetime(2023, 2, 6, hour=0, minute=0)\n", + "\n", + "pre_items = list(\n", + " filter(\n", + " lambda item: datetime.strptime(item[\"properties\"][\"datetime\"], \"%Y-%m-%dT%H:%M:%SZ\") < event_date, \n", + " kahramanmaras_items\n", + " )\n", + ")\n", + "\n", + "post_items = list(\n", + " filter(\n", + " lambda item: datetime.strptime(item[\"properties\"][\"datetime\"], \"%Y-%m-%dT%H:%M:%SZ\") >= event_date, \n", + " kahramanmaras_items\n", + " )\n", + ")\n", + "print(\"PRE event items:\", len(pre_items))\n", + "print(\"POST event items:\", len(post_items))" + ] + }, + { + "cell_type": "markdown", + "id": "02869b48", + "metadata": {}, + "source": [ + "##### Other metadata" + ] + }, + { + "cell_type": "code", + "execution_count": 66, + "id": "29652a32", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Maxar Catalog Id: ['10200100B5C3A800', '10300100D6740900', '10300100D6789800', '10300100D76F1300', '10300100D797E100', '10300100DB913300', '10300100DC08C900', '10300100DD62DB00', '10300100DF069700', '10300100DF1DB000', '10300100DF6BFE00', '10300100DFA9DD00', '10300100E0287700', '10300100E131D000', '10300100E1700300', '10300100E18A1000', '10300100E18CB600', '10300100E19A4400', '10300100E1B9D900', '10300100E201BA00', '10300100E20A6300', '10300100E21A3000', '10300100E2226200', '10300100E2514200', '10300100E26DC400', '10300100E2780300', '10300100E287FA00', '10300100E2901100', '10300100E291D100', '10300100E29F9100', '10300100E2A73B00', '10300100E2B30500', '10300100E2BF8000', '10300100E2C66F00', '10300100E2D3B600', '10300100E304B400', '10300100E3154100', '10300100E32E3D00', '10300100E32F7A00', '10300100E383D900', '10300100E3CF1000', '10300100E3D52E00', '10300100E49E8000', '10300500BFF94800', '10300500BFF94C00', '10300500BFF95000', '10300500D8F90C00', '10300500D9F8CC00', '10300500D9F8D100', '10300500D9F8D200', '10300500D9F8D400', '10300500D9F8D500', '10300500D9F8E600', '1040010067C49900', '104001006D138700', '1040010077137900', '104001007DAE2D00', '104001007E564300', '1040010080453800', '104001008058CD00', '1040010080895500', '104001008209EE00', '1040010082388600', '1040010082530900', '1040010082651500', '1040010082661F00', '1040010082698700', '1040010082990000', '1040010082B2FB00', '1040010082B6D600', '1040010082B85E00', '104001008314FC00', '1040010083278E00', '1050050044DE7E00', '1050050044DE7F00', '10500500F0DD9700']\n", + "Maxar Platform: ['GE01', 'WV01', 'WV02', 'WV03']\n" + ] + } + ], + "source": [ + "catalog_id = {item[\"properties\"][\"catalog_id\"] for item in kahramanmaras_items}\n", + "print(\"Maxar Catalog Id:\", sorted(list(catalog_id)))\n", + "\n", + "platform = {item[\"properties\"][\"platform\"] for item in kahramanmaras_items}\n", + "print(\"Maxar Platform: \", sorted(list(platform)))" + ] + }, + { + "cell_type": "markdown", + "id": "2693e87a", + "metadata": {}, + "source": [ + "Note: The `catalog_id` represents a unique acquisition ID. In our case, this means that all items are derived from 5 different acquisitions. \n", + "\n", + "> The unique identifier for the item, as assigned by the provider, Maxar. This is also referred to as the \"acquisition ID\".\n", + "\n", + "ref: https://ard.maxar.com/docs/select-and-order/select-stac-collection-file/#properties-object" + ] + }, + { + "cell_type": "markdown", + "id": "4ca2e374", + "metadata": {}, + "source": [ + "## Asset visualization\n", + "\n", + "So we have **2115** items for the `MAXAR_Kahramanmaras_turkey_earthquake_23` collection, and each item has **4** assets (this is also found at the collection level in the `item_assets extension`)." + ] + }, + { + "cell_type": "code", + "execution_count": 67, + "id": "aca07238", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "['visual', 'data-mask', 'ms_analytic', 'pan_analytic']\n", + "{\n", + " \"href\": \"s3://maxar-opendata/events/Kahramanmaras-turkey-earthquake-23/ard/37/031133210001/2023-03-11/10300100E49E8000-visual.tif\",\n", + " \"type\": \"image/tiff; application=geotiff; profile=cloud-optimized\",\n", + " \"roles\": [\n", + " \"visual\"\n", + " ],\n", + " \"title\": \"Visual Image\",\n", + " \"eo:bands\": [\n", + " {\n", + " \"name\": \"BAND_R\",\n", + " \"common_name\": \"red\",\n", + " \"description\": \"Red\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_G\",\n", + " \"common_name\": \"green\",\n", + " \"description\": \"Green\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_B\",\n", + " \"common_name\": \"blue\",\n", + " \"description\": \"Blue\"\n", + " }\n", + " ],\n", + " \"alternate\": {\n", + " \"public\": {\n", + " \"href\": \"https://maxar-opendata.s3.amazonaws.com/events/Kahramanmaras-turkey-earthquake-23/ard/37/031133210001/2023-03-11/10300100E49E8000-visual.tif\",\n", + " \"title\": \"Public Access\"\n", + " }\n", + " },\n", + " \"proj:bbox\": [\n", + " 264843.75,\n", + " 3994843.75,\n", + " 270156.25,\n", + " 4000156.25\n", + " ],\n", + " \"proj:shape\": [\n", + " 17408,\n", + " 17408\n", + " ],\n", + " \"proj:transform\": [\n", + " 0.30517578125,\n", + " 0.0,\n", + " 264843.75,\n", + " 0.0,\n", + " -0.30517578125,\n", + " 4000156.25,\n", + " 0.0,\n", + " 0.0,\n", + " 1.0\n", + " ]\n", + "}\n", + "visual : image/tiff; application=geotiff; profile=cloud-optimized\n", + "data-mask : application/geopackage+sqlite3\n", + "ms_analytic : image/tiff; application=geotiff; profile=cloud-optimized\n", + "pan_analytic : image/tiff; application=geotiff; profile=cloud-optimized\n" + ] + } + ], + "source": [ + "print(list(item[\"assets\"].keys()))\n", + "print(json.dumps(item[\"assets\"][\"visual\"], indent=4))\n", + "\n", + "for name, asset in item[\"assets\"].items():\n", + " print(name, \": \", asset[\"type\"])" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "id": "7bc1a304", + "metadata": {}, + "source": [ + "In eoAPI, we have a raster API connected to the PgSTAC database. The service is built using [titiler-pgstac](http://github.com/stac-utils/titiler-pgstac) and can be used to visualize `Item` or `Mosaics` (multiple items).\n", + "\n", + "Endpoint: [https://raster.eoapi.dev](https://raster.eoapi.dev/)\n", + "\n", + "We know we have 4 assets for each item, and 3 are of `Cloud-Optimized` type. Let's use the raster API to visualize them.\n", + "\n", + "First, let's get the Raster metadata for each `raster` asset. The raster API will use the asset's `type` metadata to filter non-raster dataset (e.g. `application/geopackage+sqlite3`)." + ] + }, + { + "cell_type": "code", + "execution_count": 68, + "id": "e2a45bf1", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Fetching Raster info for Item 37_031133210001_10300100E49E8000\n", + "Returned metadata for Assets: ['visual', 'ms_analytic', 'pan_analytic']\n", + "{\n", + " \"bounds\": [\n", + " 36.387245559111236,\n", + " 36.069775171369855,\n", + " 36.447766515172646,\n", + " 36.11889420532333\n", + " ],\n", + " \"minzoom\": 12,\n", + " \"maxzoom\": 19,\n", + " \"band_metadata\": [\n", + " [\n", + " \"b1\",\n", + " {}\n", + " ],\n", + " [\n", + " \"b2\",\n", + " {}\n", + " ],\n", + " [\n", + " \"b3\",\n", + " {}\n", + " ]\n", + " ],\n", + " \"band_descriptions\": [\n", + " [\n", + " \"b1\",\n", + " \"\"\n", + " ],\n", + " [\n", + " \"b2\",\n", + " \"\"\n", + " ],\n", + " [\n", + " \"b3\",\n", + " \"\"\n", + " ]\n", + " ],\n", + " \"dtype\": \"uint8\",\n", + " \"nodata_type\": \"Mask\",\n", + " \"colorinterp\": [\n", + " \"red\",\n", + " \"green\",\n", + " \"blue\"\n", + " ],\n", + " \"driver\": \"GTiff\",\n", + " \"count\": 3,\n", + " \"width\": 17408,\n", + " \"height\": 17408,\n", + " \"overviews\": [\n", + " 2,\n", + " 4,\n", + " 8,\n", + " 16,\n", + " 32,\n", + " 64\n", + " ]\n", + "}\n", + "visual 12 19\n", + "ms_analytic 12 16\n", + "pan_analytic 12 18\n" + ] + } + ], + "source": [ + "# fetching Raster information for all the `raster` assets\n", + "item_id = item[\"id\"]\n", + "\n", + "print(f\"Fetching Raster info for Item {item_id}\")\n", + "info = httpx.get(f\"https://raster.eoapi.dev/collections/{collection_id}/items/{item_id}/info\").json()\n", + "\n", + "print(\"Returned metadata for Assets:\", list(info.keys()))\n", + "\n", + "print(json.dumps(info[\"visual\"], indent=4))\n", + "for name, asset in info.items():\n", + " print(name, asset[\"minzoom\"], asset[\"maxzoom\"])" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "id": "3a87b045", + "metadata": {}, + "source": [ + "The `/collections/{collectionId}/items/{itemId}/info` endpoint returned metadata for 3 assets (the raster ones). We now know more about each asset (datatype, zoom levels, number of bands), which can help us create tiles urls.\n", + "\n", + "### Asset on Map\n", + "\n", + "To visualize an asset on a Map, we need to construct a `Tile URL`. To ease the task we can use the raster's service `/collections/{collection_id}/items/{item_id}/tilejson.json` endpoint, but here are the requirements:\n", + "\n", + "- HAVE TO pass `assets` or `expression` parameter\n", + "- CAN pass `min/max zooms` (which will avoid under/over-zooming)\n", + "- CAN pass `rescale` parameter if datatype is not compatible with PNG/JPEG output format\n", + "- CAN pass `asset_bidx` parameter to select band combination" + ] + }, + { + "cell_type": "code", + "execution_count": 69, + "id": "b71ad07f", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "{'tilejson': '2.2.0', 'version': '1.0.0', 'scheme': 'xyz', 'tiles': ['https://raster.eoapi.dev/collections/MAXAR_Kahramanmaras_turkey_earthquake_23/items/37_031133210001_10300100E49E8000/tiles/WebMercatorQuad/{z}/{x}/{y}@1x?assets=visual'], 'minzoom': 12, 'maxzoom': 19, 'bounds': [36.387245559111236, 36.092041667396806, 36.42079643694594, 36.11834923545021], 'center': [36.404020998028585, 36.10519545142351, 12]}\n" + ] + }, + { + "data": { + "application/vnd.jupyter.widget-view+json": { + "model_id": "75dfcb710d454c4e8f432e747a27621c", + "version_major": 2, + "version_minor": 0 + }, + "text/plain": [ + "Map(center=[36.10519545142351, 36.404020998028585], controls=(ZoomControl(options=['position', 'zoom_in_text',…" + ] + }, + "execution_count": 69, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "# `visual` Asset\n", + "tilejson = httpx.get(\n", + " f\"https://raster.eoapi.dev/collections/{collection_id}/items/{item_id}/tilejson.json\",\n", + " params = (\n", + " (\"assets\", \"visual\"), # THIS PARAMETER IS MANDATORY\n", + " (\"minzoom\", 12), # By default the tiler will use 0\n", + " (\"maxzoom\", 19), # By default the tiler will use 24\n", + " )\n", + ").json()\n", + "print(tilejson)\n", + "\n", + "bounds = tilejson[\"bounds\"]\n", + "m = ipyleaflet.leaflet.Map(\n", + " center=((bounds[1] + bounds[3]) / 2,(bounds[0] + bounds[2]) / 2),\n", + " zoom=12\n", + ")\n", + "\n", + "geo_json = ipyleaflet.leaflet.GeoJSON(\n", + " data=item,\n", + " style={\n", + " 'opacity': 1, 'dashArray': '9', 'fillOpacity': 0., 'weight': 4\n", + " }\n", + ")\n", + "m.add_layer(geo_json)\n", + "\n", + "tiles = ipyleaflet.leaflet.TileLayer(\n", + " url=tilejson[\"tiles\"][0],\n", + " min_zoom=tilejson[\"minzoom\"],\n", + " max_zoom=tilejson[\"maxzoom\"],\n", + " bounds=[\n", + " [bounds[1], bounds[0]],\n", + " [bounds[3], bounds[2]],\n", + "\n", + " ],\n", + ")\n", + "\n", + "m.add_layer(tiles)\n", + "\n", + "m" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "id": "3a02b6ae", + "metadata": {}, + "source": [ + "## Mosaics\n", + "\n", + "As mentioned and shown with `titiler-pgstac`, we can visualize an item's asset. Still, the raster API's real power is to create a virtual mosaic dynamically and merge multiple items on the fly.\n", + "\n", + "Learn more: http://github.com/stac-utils/titiler-pgstac.\n", + "\n", + "Let's create `mosaics` for `pre` and `post` events." + ] + }, + { + "cell_type": "code", + "execution_count": 70, + "id": "57c276ec", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Pre event Mosaic\n", + "{\n", + " \"id\": \"9c2101bb56005850dcc6e95303586432\",\n", + " \"links\": [\n", + " {\n", + " \"rel\": \"metadata\",\n", + " \"title\": \"Mosaic metadata\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://raster.eoapi.dev/searches/9c2101bb56005850dcc6e95303586432/info\"\n", + " },\n", + " {\n", + " \"rel\": \"tilejson\",\n", + " \"title\": \"Link for TileJSON\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://raster.eoapi.dev/searches/9c2101bb56005850dcc6e95303586432/tilejson.json\"\n", + " },\n", + " {\n", + " \"rel\": \"map\",\n", + " \"title\": \"Link for Map viewer\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://raster.eoapi.dev/searches/9c2101bb56005850dcc6e95303586432/map\"\n", + " },\n", + " {\n", + " \"rel\": \"wmts\",\n", + " \"title\": \"Link for WMTS\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://raster.eoapi.dev/searches/9c2101bb56005850dcc6e95303586432/WMTSCapabilities.xml\"\n", + " }\n", + " ]\n", + "}\n", + "\n", + "Post event Mosaic\n", + "{\n", + " \"id\": \"8aebe8860a92d2f7bc0cdad4d7d81acf\",\n", + " \"links\": [\n", + " {\n", + " \"rel\": \"metadata\",\n", + " \"title\": \"Mosaic metadata\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://raster.eoapi.dev/searches/8aebe8860a92d2f7bc0cdad4d7d81acf/info\"\n", + " },\n", + " {\n", + " \"rel\": \"tilejson\",\n", + " \"title\": \"Link for TileJSON\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://raster.eoapi.dev/searches/8aebe8860a92d2f7bc0cdad4d7d81acf/tilejson.json\"\n", + " },\n", + " {\n", + " \"rel\": \"map\",\n", + " \"title\": \"Link for Map viewer\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://raster.eoapi.dev/searches/8aebe8860a92d2f7bc0cdad4d7d81acf/map\"\n", + " },\n", + " {\n", + " \"rel\": \"wmts\",\n", + " \"title\": \"Link for WMTS\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://raster.eoapi.dev/searches/8aebe8860a92d2f7bc0cdad4d7d81acf/WMTSCapabilities.xml\"\n", + " }\n", + " ]\n", + "}\n" + ] + } + ], + "source": [ + "event_date = \"2023-02-06T00:00:00Z\"\n", + "\n", + "# Let's focus on Kahramanmaraş city \n", + "bounds = [36.83064386785452, 37.53123515817725, 37.03859654890988, 37.63167525356958]\n", + "\n", + "pre_mosaic = httpx.post(\n", + " \"https://raster.eoapi.dev/searches/register\",\n", + " data=json.dumps(\n", + " {\n", + " \"filter-lang\": 'cql2-json',\n", + " \"filter\": {\n", + " \"op\": 'and', \n", + " \"args\": [\n", + " {\n", + " \"op\": \"in\", \n", + " \"args\": [{\"property\": \"collection\"}, [collection_id]]\n", + " },\n", + " {\n", + " \"op\": \"lt\", \n", + " \"args\": [\n", + " {\"property\": \"datetime\"}, event_date\n", + " ]\n", + " }\n", + " ],\n", + " },\n", + " \"sortby\": [\n", + " {\n", + " \"field\": \"tile:clouds_percent\",\n", + " \"direction\": \"asc\"\n", + " },\n", + " ],\n", + " \"metadata\":{\n", + " \"name\": \"Maxar Kahramanmaras - Pre event\",\n", + " \"bounds\": bounds,\n", + " }\n", + " \n", + " }\n", + " )\n", + ").json()\n", + "\n", + "post_mosaic = httpx.post(\n", + " \"https://raster.eoapi.dev/searches/register\",\n", + " data=json.dumps(\n", + " {\n", + " \"filter-lang\": 'cql2-json',\n", + " \"filter\": {\n", + " \"op\": 'and', \n", + " \"args\": [\n", + " {\n", + " \"op\": \"in\", \n", + " \"args\": [{\"property\": \"collection\"}, [collection_id]]\n", + " },\n", + " {\n", + " \"op\": \"ge\", \n", + " \"args\": [\n", + " {\"property\": \"datetime\"}, event_date\n", + " ]\n", + " }\n", + " ],\n", + " },\n", + " \"sortby\": [\n", + " {\n", + " \"field\": \"tile:clouds_percent\",\n", + " \"direction\": \"asc\"\n", + " },\n", + " ],\n", + " \"metadata\":{\n", + " \"name\": \"Maxar Kahramanmaras - Port event\",\n", + " \"bounds\": bounds,\n", + " }\n", + " \n", + " }\n", + " )\n", + ").json()\n", + "\n", + "print(\"Pre event Mosaic\")\n", + "print(json.dumps(pre_mosaic, indent=4))\n", + "print()\n", + "print(\"Post event Mosaic\")\n", + "print(json.dumps(post_mosaic, indent=4))" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "id": "6dd5f539", + "metadata": {}, + "source": [ + "Explanation:\n", + "\n", + "The `mosaic` corresponds to an STAC Search query. Because we use `PgSTAC` backend, we can make use of the `filter` extension to construct complex queries: https://github.com/stac-api-extensions/filter\n", + "\n", + "```json\n", + "{\n", + " // PgSTAC accepts multiple languages for filtering; here we will use cql2-json\n", + " \"filter-lang\": 'cql2-json',\n", + " // We tell PgSTAC to `register` a `search` request with the following filter:\n", + " \"filter\": {\n", + " \"op\": 'and',\n", + " \"args\": [\n", + " // Item's collection HAS TO be in `[collection_id]`\n", + " {\n", + " \"op\": \"in\",\n", + " \"args\": [{\"property\": \"collection\"}, [collection_id]]\n", + " },\n", + " // Filter Items that have datetime `lt` than the event date\n", + " {\n", + " \"op\": \"lt\",\n", + " \"args\": [\n", + " {\"property\": \"datetime\"}, event_date\n", + " ]\n", + " },\n", + " // Sort the items using clouds_percent property to make sure cloudless images are on the top\n", + " \"sortby\": [\n", + " {\n", + " \"field\": \"tile:clouds_percent\",\n", + " \"direction\": \"asc\"\n", + " },\n", + " ],\n", + " // titiler-pgstac accept some additional metadata\n", + " // \n", + " // One is useful: `bounds`. When creating a mosaic, the tiler will have no idea\n", + " // where the items will be before trying to create each tile. To avoid trying to request\n", + " // tiles where we know we don't have any items, we can add the collection's extent to the\n", + " // mosaic metadata.\n", + " // The tiler service will then return the bounds in the tilejson document for the\n", + " // client application.\n", + " \"metadata\":{\n", + " \"name\": \"Maxar Kahramanmaras - Pre event\",\n", + " \"bounds\": bounds,\n", + " }\n", + " ],\n", + " },\n", + "\n", + "}\n", + "\n", + "```\n", + "\n", + "API Response:\n", + "\n", + "The raster service will return a `id` hash (`mosaic id`), which we can use to construct a tile URL.\n", + "\n", + "To create a valid tile URL, we will again need to pass an `assets` parameter to tell the tiler which assets we want to visualize. We can also set the min/max zoom limits to avoid underzooming (opening too many files) and overzooming.\n", + "\n", + "See the complete list of options: https://stac-utils.github.io/titiler-pgstac/mosaic_endpoints/#tiles" + ] + }, + { + "cell_type": "code", + "execution_count": 71, + "id": "1638c679", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "{'tilejson': '2.2.0', 'name': 'Maxar Kahramanmaras - Pre event', 'version': '1.0.0', 'scheme': 'xyz', 'tiles': ['https://raster.eoapi.dev/searches/9c2101bb56005850dcc6e95303586432/tiles/WebMercatorQuad/{z}/{x}/{y}?assets=visual'], 'minzoom': 12, 'maxzoom': 19, 'bounds': [36.83064386785452, 37.53123515817725, 37.03859654890988, 37.63167525356958], 'center': [36.9346202083822, 37.58145520587342, 12]}\n" + ] + }, + { + "data": { + "application/vnd.jupyter.widget-view+json": { + "model_id": "346f211c9fac4b649d02b0b326adcc7c", + "version_major": 2, + "version_minor": 0 + }, + "text/plain": [ + "Map(center=[37.58145520587342, 36.9346202083822], controls=(ZoomControl(options=['position', 'zoom_in_text', '…" + ] + }, + "execution_count": 71, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "mosaic_id = pre_mosaic[\"id\"]\n", + "\n", + "tilejson_pre = httpx.get(\n", + " f\"https://raster.eoapi.dev/searches/{mosaic_id}/tilejson.json\",\n", + " params = (\n", + " (\"assets\", \"visual\"), # THIS IS MANDATORY\n", + " (\"minzoom\", 12),\n", + " (\"maxzoom\", 19), \n", + " )\n", + ").json()\n", + "print(tilejson_pre)\n", + "\n", + "bounds = tilejson_pre[\"bounds\"]\n", + "m = ipyleaflet.leaflet.Map(\n", + " center=((bounds[1] + bounds[3]) / 2,(bounds[0] + bounds[2]) / 2),\n", + " zoom=12\n", + ")\n", + "\n", + "geo_json = ipyleaflet.leaflet.GeoJSON(\n", + " data={\"type\": \"FeatureCollection\", \"features\": pre_items}, \n", + " style={\n", + " \"fillOpacity\": 0,\n", + " \"weight\": 1,\n", + " },\n", + ")\n", + "m.add_layer(geo_json)\n", + "\n", + "tiles = ipyleaflet.leaflet.TileLayer(\n", + " url=tilejson_pre[\"tiles\"][0],\n", + " min_zoom=tilejson_pre[\"minzoom\"],\n", + " max_zoom=tilejson_pre[\"maxzoom\"],\n", + " bounds=[\n", + " [bounds[1], bounds[0]],\n", + " [bounds[3], bounds[2]],\n", + "\n", + " ],\n", + ")\n", + "\n", + "m.add_layer(tiles)\n", + "m" + ] + }, + { + "cell_type": "code", + "execution_count": 72, + "id": "c74df2f5", + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "{'tilejson': '2.2.0', 'name': 'Maxar Kahramanmaras - Port event', 'version': '1.0.0', 'scheme': 'xyz', 'tiles': ['https://raster.eoapi.dev/searches/8aebe8860a92d2f7bc0cdad4d7d81acf/tiles/WebMercatorQuad/{z}/{x}/{y}?assets=visual'], 'minzoom': 12, 'maxzoom': 19, 'bounds': [36.83064386785452, 37.53123515817725, 37.03859654890988, 37.63167525356958], 'center': [36.9346202083822, 37.58145520587342, 12]}\n" + ] + }, + { + "data": { + "application/vnd.jupyter.widget-view+json": { + "model_id": "70ffff2868c946eda75493ad50c16dc8", + "version_major": 2, + "version_minor": 0 + }, + "text/plain": [ + "Map(center=[37.58145520587342, 36.9346202083822], controls=(ZoomControl(options=['position', 'zoom_in_text', '…" + ] + }, + "execution_count": 72, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "mosaic_id = post_mosaic[\"id\"]\n", + "\n", + "tilejson_post = httpx.get(\n", + " f\"https://raster.eoapi.dev/searches/{mosaic_id}/tilejson.json\",\n", + " params = (\n", + " (\"assets\", \"visual\"), # THIS IS MANDATORY\n", + " (\"minzoom\", 12),\n", + " (\"maxzoom\", 19), \n", + " )\n", + ").json()\n", + "print(tilejson_post)\n", + "\n", + "bounds = tilejson_post[\"bounds\"]\n", + "m = ipyleaflet.leaflet.Map(\n", + " center=((bounds[1] + bounds[3]) / 2,(bounds[0] + bounds[2]) / 2),\n", + " zoom=10\n", + ")\n", + "\n", + "geo_json = ipyleaflet.leaflet.GeoJSON(\n", + " data={\"type\": \"FeatureCollection\", \"features\": post_items}, \n", + " style={\n", + " \"fillOpacity\": 0,\n", + " \"weight\": 0.5,\n", + " },\n", + ")\n", + "m.add_layer(geo_json)\n", + "\n", + "tiles = ipyleaflet.leaflet.TileLayer(\n", + " url=tilejson_post[\"tiles\"][0],\n", + " min_zoom=tilejson_post[\"minzoom\"],\n", + " max_zoom=tilejson_post[\"maxzoom\"],\n", + " bounds=[\n", + " [bounds[1], bounds[0]],\n", + " [bounds[3], bounds[2]],\n", + "\n", + " ],\n", + ")\n", + "\n", + "m.add_layer(tiles)\n", + "m" + ] + }, + { + "cell_type": "code", + "execution_count": 73, + "id": "b8d900b4", + "metadata": {}, + "outputs": [ + { + "data": { + "application/vnd.jupyter.widget-view+json": { + "model_id": "3717d40b082a4258b9d1c3a42292d138", + "version_major": 2, + "version_minor": 0 + }, + "text/plain": [ + "Map(center=[37.571788, 36.9191], controls=(ZoomControl(options=['position', 'zoom_in_text', 'zoom_in_title', '…" + ] + }, + "execution_count": 73, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "m = ipyleaflet.leaflet.Map(\n", + " center=(37.571788, 36.919100),\n", + " zoom=12,\n", + ")\n", + "\n", + "bounds = tilejson_pre[\"bounds\"]\n", + "before_layer = ipyleaflet.leaflet.TileLayer(\n", + " url=tilejson_pre[\"tiles\"][0],\n", + " min_zoom=tilejson_pre[\"minzoom\"],\n", + " max_zoom=tilejson_pre[\"maxzoom\"],\n", + " bounds=[\n", + " [bounds[1], bounds[0]],\n", + " [bounds[3], bounds[2]],\n", + " ],\n", + ")\n", + "\n", + "bounds = tilejson_post[\"bounds\"]\n", + "after_layer = ipyleaflet.leaflet.TileLayer(\n", + " url=tilejson_post[\"tiles\"][0],\n", + " min_zoom=tilejson_post[\"minzoom\"],\n", + " max_zoom=tilejson_post[\"maxzoom\"],\n", + " bounds=[\n", + " [bounds[1], bounds[0]],\n", + " [bounds[3], bounds[2]],\n", + " ],\n", + ")\n", + "\n", + "control = ipyleaflet.leaflet.SplitMapControl(left_layer=before_layer, right_layer=after_layer)\n", + "m.add_control(control)\n", + "\n", + "m" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "id": "8b9bc02d", + "metadata": {}, + "source": [ + "## What's Next?\n", + "\n", + "### Spin Up Your Own eoAPI Instance\n", + "\n", + "You've seen what eoAPI can do with Maxar data in the context of the Turkey Earthquakes. Interested in setting up your own eoAPI service? It's straightforward! Follow the 'Getting Started' section of the [eoAPI GitHub repository](https://github.com/developmentseed/eoAPI) to get your instance up and running. This will give you greater control and customization options.\n", + "\n", + "### Contribute Your Data\n", + "\n", + "Consider contributing if you've used Maxar data for similar analyses or have other datasets that could benefit the community. Uploading your data to your eoAPI instance can provide more diverse examples and help in various applications.\n", + "\n", + "### Community-Driven Examples\n", + "\n", + "The examples you see here, including this notebook, are often community-driven. We encourage you to contribute your analyses, workflows, or visualizations. Your insights could be invaluable for helping others.\n", + "\n", + "### Have Questions? Join the Discussion!\n", + "\n", + "If you have questions, feedback, or want to engage with the eoAPI community, please join the [GitHub discussions](https://github.com/developmentseed/eoAPI/discussions). It's a great place to ask questions, share your experiences, and connect with others interested in eoAPI and its components. \n", + "\n", + "---\n", + "\n", + "Thank you for taking the time to go through this notebook." + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.10.5" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} diff --git a/notebooks/getting-started.ipynb b/notebooks/getting-started.ipynb new file mode 100644 index 0000000..1d608a5 --- /dev/null +++ b/notebooks/getting-started.ipynb @@ -0,0 +1,1678 @@ +{ + "cells": [ + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Getting Started with STAC and eoAPI\n", + "\n", + "## A Foundational Guide for Geospatial Data Analysis\n", + "\n", + "### Overview\n", + "\n", + "Welcome to this guide designed to introduce you to the world of SpatioTemporal Asset Catalog (STAC), Cloud Optimized Geotiffs (COGs), and eoAPI. This Jupyter Notebook aims to provide you with the foundational knowledge and practical skills necessary to effectively utilize these powerful tools in geospatial data management and analysis.\n", + "\n", + "### Context\n", + "\n", + "The notebook delves into the essentials of using eoAPI, offering insights into STAC and COGs. We will explore how eoAPI facilitates querying metadata and visualizing the underlying referenced data. All notebooks of the repository run within a specially configured cluster, integrating a deployed instance of eoAPI and JupyterHub to provide a seamless, hands-on experience.\n", + "\n", + "### STAC, COG, and eoAPI\n", + "\n", + "- **STAC**: We begin with an introduction to STAC, explaining its structure and critical role in damage assessment and risk management.\n", + "- **COG**: Next, we explore COGs and why they are pivotal in modern geospatial data handling.\n", + "- **eoAPI**: Finally, we discuss eoAPI, detailing its functionalities and importance in this ecosystem.\n", + "\n", + "In this notebook, we leverage Maxar's high-resolution satellite imagery, acquired explicitly for the M7.8 and M7.5 Kahramanmaras earthquakes in Turkey on February 6, 2023. This data, pivotal for emergency response and risk assessment, has been ingested into our instance of eoAPI deployed on the cluster. The imagery, available as Cloud Optimized Geotiffs (COGs) with accompanying STAC metadata, enables streamlined analysis and visualization of the earthquake's impact. Maxar's data, being analysis-ready and cloud-optimized, provides a rich resource for demonstrating the capabilities of eoAPI in handling large-scale geospatial datasets in a crisis context.\n", + "\n", + "This notebook is the foundational guide for eoAPI and associated resources. It is structured to guide you through these concepts, culminating in a hands-on demonstration of using eoAPI to query and visualize earth observation data." + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## An Introduction to STAC\n", + "\n", + "### What is STAC (SpatioTemporal Asset Catalog)?\n", + "\n", + "The SpatioTemporal Asset Catalog (STAC) is a specification designed to standardize how geospatial data is organized and accessed. It's a community-driven standard developed collaboratively by experts and stakeholders in the geospatial data field. STAC provides a common language and structure for describing geospatial information, making it easier to index, discover, and manage spatial data across various platforms and systems. One of the critical features of STAC is its format: simple JSON objects, which are both human-readable and machine-processable, ensuring ease of use and broad accessibility.\n", + "\n", + "A fundamental aspect of STAC's design is its hierarchical organization, comprising Catalogs, Collections, and Items. At the highest level, **Catalogs** serve as containers that organize and provide access to Collections and Items. **Collections** represent a group of Items that share common properties, metadata, and structure, typically representing a dataset or a series of datasets. Within Collections, **Items** are individual pieces of data, each containing specific geospatial information, such as location and time. Crucially, each Item includes links to its Assets, which are the files associated with the data, such as imagery, thumbnails, or other related resources. These **Assets** are integral to the utility of each Item, providing the data required for analysis and visualization. This structured approach ensures a consistent and intuitive way to access and manage vast amounts of geospatial data, making STAC an efficient tool for data providers and users.\n", + "\n", + "### Why is STAC Important?\n", + "\n", + "STAC is critical in the modern earth observation stack, particularly for large-scale environmental monitoring, disaster response, and risk assessment scenarios. Its standardized, community-backed approach facilitates:\n", + "\n", + "- **Efficient Data Discovery**: Simplifying the finding of relevant geospatial data across vast datasets.\n", + "- **Interoperability**: Enabling different systems and tools to access and use geospatial data seamlessly.\n", + "- **Scalability**: Supporting the management of increasingly large and complex datasets is a common challenge in geospatial analysis.\n", + "- **Inclusivity and Collaboration**: STAC evolves through collective insights as a community-driven standard, ensuring it remains relevant and effective for various use cases.\n", + "\n", + "STAC's capabilities are invaluable in rapidly accessing and analyzing data for humanitarian aid, disaster relief, and risk management purposes.\n", + "\n", + "### How Can I Learn More?\n", + "\n", + "To deepen your understanding of STAC and its applications:\n", + "\n", + "- **STAC Specification**: Dive into the official [STAC Specification](https://stacspec.org/) for detailed documentation and standards.\n", + "- **STAC Index**: Explore the [STAC Index](https://stacindex.org/), a comprehensive resource listing STAC implementations, tools, and data catalogs, to get a better grasp of the ecosystem and its applications.\n", + "- **Developer Best Practices**: For a more technical perspective, review the [STAC Best Practices](https://github.com/radiantearth/stac-spec/blob/master/best-practices.md) on GitHub, offering in-depth guidance for developers working with STAC.\n", + "\n", + "As we progress through this notebook, we'll explore applying STAC principles using eoAPI in practical scenarios." + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## An Introduction to COGs\n", + "\n", + "### What is a COG (Cloud Optimized Geotiff)?\n", + "\n", + "A Cloud Optimized GeoTIFF (COG) is a variant of the TIFF image format tailored explicitly for optimized access over a network. A raster format specifies a particular layout of internal data within the GeoTIFF specification, allowing for efficient, subsetted, or aggregated access. This format is designed to enable efficient workflows on the cloud by leveraging HTTP GET range requests for just the parts of the file needed. COGs are regular GeoTIFF files, making them backward compatible with other geospatial software but with an internal organization that enables more efficient data access and processing.\n", + "\n", + "### Why is COG Important?\n", + "\n", + "COGs represent a significant advancement in geospatial data handling, primarily due to:\n", + "\n", + "- **Efficient Imagery Data Access**: COG-aware software can stream just the portion of data it needs, significantly improving processing times and enabling real-time workflows that were previously not possible.\n", + "- **Internal Compression and Optimized Read Performance**: COGs are internally compressed, meaning the inner blocks in a GeoTIFF are already compressed. This internal compression allows COG readers to decompress only the specific portion of the file requested rather than the entire file.\n", + "- **Reduced Duplication of Data**: COGs enable diverse software to access a single file online, reducing the need to copy and cache data.\n", + "- **Legacy Compatibility**: Traditional GIS software can treat cloud-optimized geoTIFFs just like normal geoTIFFs, simplifying data management.\n", + "\n", + "### How Can I Learn More?\n", + "\n", + "For a deeper dive into COGs and to understand their implementation and usage:\n", + "\n", + "- **Official Documentation**: Visit the [COG website](https://www.cogeo.org/) for a comprehensive understanding of COGs and their implementation details.\n", + "- **Cloud Native Geospatial Formats Guide**: The [Cloud Native Geospatial Formats Guide](https://guide.cloudnativegeo.org/) offers detailed insights into COGs, including advanced details and working examples to help you grasp the practical applications of this format.\n", + "\n", + "In the following sections, we'll explore the practical application of COGs in conjunction with eoAPI, focusing on how they can be utilized for efficient geospatial data management and visualization." + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## An Introduction to eoAPI\n", + "\n", + "### What is eoAPI?\n", + "\n", + "eoAPI is an open-source framework for accessing and utilizing Earth Observation (EO) data. It simplifies constructing a cloud-native EO infrastructure by providing sensible defaults for most EO and geospatial infrastructure needs. eoAPI is modular, allowing for easy customization to specific requirements. Its key features include:\n", + "\n", + "- **STAC Powered**: Utilizes a suite of STAC-focused technologies.\n", + "- **Sensible Defaults**: Facilitates seamless deployment, configuration, and customization.\n", + "- **Cloud Agnostic**: Capable of quick deployment and scaling of EO services anywhere.\n", + "\n", + "### Why is eoAPI Important?\n", + "\n", + "eoAPI addresses the challenge of making EO data easily discoverable, interoperable, ingestible, and optimized for integration into modern applications and decision-making tools. Simply put, it lowers the barrier of entry to earth observation data to a broader range of developers, scientists, and the general public. This is crucial for understanding our changing planet and maximizing the societal impact of EO data. eoAPI's framework supports end-to-end EO infrastructure, including data cataloging, searching, visualization, and access, making it a powerful tool for organizations leveraging geospatial data.\n", + "\n", + "### How Can I Learn More?\n", + "\n", + "To explore eoAPI further:\n", + "\n", + "- **Official Documentation and Guides**: Visit [eoAPI's website](https://eoapi.dev/) for comprehensive documentation and guides on deploying and using the framework.\n", + "- **GitHub Repository**: Check out the [eoAPI GitHub repository](https://github.com/developmentseed/eoapi) for source code, updates, and community contributions.\n", + "\n", + "We'll delve into effectively utilizing eoAPI with STAC and COGs as we proceed." + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## eoAPI in Action - Kahramanmaras Earthquakes\n", + "\n", + "### Background\n", + "\n", + "This section will review the different [eoAPI](https://github.com/developmentseed/eoAPI) services using the latest Open data from Maxar acquired for the M7.8 and M7.5 Kahramanmaras earthquakes in Turkey on February 6, 2023. For more information on the event, visit [USGS' article](https://www.usgs.gov/news/featured-story/m78-and-m75-kahramanmaras-earthquake-sequence-near-nurdagi-turkey-turkiye)\n", + "\n", + "Maxar provides pre and post-event high-resolution satellite imagery in support of emergency planning, risk assessment, monitoring of staging areas and emergency response, damage assessment, and recovery. These images are generated using the Maxar ARD pipeline, tiled on an organized grid in analysis-ready cloud-optimized formats.\n", + "\n", + "Maxar releases open data for select sudden-onset major crisis events. In addition to making the formatted COG data freely available on AWS, they also add static STAC metadata alongside the images. Having the STAC items already created makes ingestion into the PgSTAC database easy because we don't have to produce the items ourselves and read the images.\n", + "\n", + "To learn more about ingesting the Maxar OpenData STAC catalog into PgSTAC, see https://github.com/vincentsarago/MAXAR_opendata_to_pgstac.\n", + "\n", + "### Structure of eoAPI in Action\n", + "\n", + "0. Setting Up\n", + "1. How to query STAC\n", + " - How to query Collections\n", + " - How to query Items\n", + "3. Visualizing an Asset\n", + "5. Comparing pre and post events\n", + " - Finding pre and post event Items\n", + " - Visualizing pre and post event Mosaics" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "### Setting Up\n", + "\n", + "Before we start querying the STAC endpoint, there are a few setup steps to ensure that our environment has all the necessary tools and libraries. This section will guide you through installing the required packages and importing essential modules.\n", + "\n", + "We must install two packages: **`httpx`** for making HTTP requests and **`ipyleaflet`** for interactive mapping in Jupyter notebooks.\n", + "\n", + "Run the following command in your Jupyter Notebook to install these packages:" + ] + }, + { + "cell_type": "code", + "execution_count": 34, + "metadata": {}, + "outputs": [], + "source": [ + "import IPython\n", + "!python -m pip install httpx ipyleaflet\n", + "IPython.display.clear_output(wait=False)\n" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "This command uses pip, Python's package installer, to download and install the **`httpx`** and **`ipyleaflet`** packages from the Python Package Index (PyPI).\n", + "\n", + "### Importing Modules\n", + "\n", + "After installing the necessary packages, we need to import some standard and installed modules that will be used throughout our queries. The following Python code imports these modules:" + ] + }, + { + "cell_type": "code", + "execution_count": 35, + "metadata": {}, + "outputs": [], + "source": [ + "from datetime import datetime\n", + "import json\n", + "\n", + "import httpx\n", + "import ipyleaflet" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "- **`datetime`**: This module from Python's standard library works with dates and times. It's especially useful when dealing with time-based geospatial data.\n", + "- **`json`**: This module is used for JSON data handling. Since responses from STAC endpoints are typically in JSON format, this module is crucial for parsing and processing these responses.\n", + "- **`httpx`**: A powerful and user-friendly HTTP client for Python. We will use it to send requests to the STAC endpoint.\n", + "- **`ipyleaflet`**: A library for creating interactive maps in Jupyter notebooks. It's beneficial for visualizing geospatial data on a map.\n", + "\n", + "Ensure that all imports run successfully. Double-check that the required packages are installed correctly if there are any issues." + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "### How to Query STAC\n", + "\n", + "The SpatioTemporal Asset Catalog (STAC) provides a standardized way to expose geospatial data and metadata. This section will explore how to query the STAC endpoint.\n", + "\n", + "The demo eoAPI STAC endpoint available at:" + ] + }, + { + "cell_type": "code", + "execution_count": 36, + "metadata": {}, + "outputs": [], + "source": [ + "stac_endpoint = \"https://stac.eoapi.dev\"" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "#### How to Query STAC Collections\n", + "\n", + "Collections in STAC represent higher-level groupings under which items (geospatial datasets) are associated. These collections are folders containing related items. To start querying, we'll focus on these collections to understand the types of data available.\n", + "\n", + "To query collections, we can use `httpx` to use a HTTP GET request to the **`/collections`** endpoint. To give you an overview of the STAC specification, here's what the first Collection of the requests looks like in its JSON format:" + ] + }, + { + "cell_type": "code", + "execution_count": 37, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "{'id': 'MAXAR_BayofBengal_Cyclone_Mocha_May_23',\n", + " 'type': 'Collection',\n", + " 'links': [{'rel': 'items',\n", + " 'type': 'application/geo+json',\n", + " 'href': 'https://stac.eoapi.dev/collections/MAXAR_BayofBengal_Cyclone_Mocha_May_23/items'},\n", + " {'rel': 'parent',\n", + " 'type': 'application/json',\n", + " 'href': 'https://stac.eoapi.dev/'},\n", + " {'rel': 'root',\n", + " 'type': 'application/json',\n", + " 'href': 'https://stac.eoapi.dev/'},\n", + " {'rel': 'self',\n", + " 'type': 'application/json',\n", + " 'href': 'https://stac.eoapi.dev/collections/MAXAR_BayofBengal_Cyclone_Mocha_May_23'}],\n", + " 'extent': {'spatial': {'bbox': [[91.831615,\n", + " 19.984656587012033,\n", + " 92.97426268500965,\n", + " 21.666101],\n", + " [92.75855246040959,\n", + " 19.982078842323997,\n", + " 92.89682495377032,\n", + " 20.514473160464657],\n", + " [91.831615, 21.518411, 91.957078, 21.666101]]},\n", + " 'temporal': {'interval': [['2023-01-03T04:30:17Z',\n", + " '2023-03-14T04:30:25Z']]}},\n", + " 'license': 'proprietary',\n", + " 'description': 'Maxar OpenData | BayofBengal Cyclone Mocha May 23',\n", + " 'item_assets': {'visual': {'type': 'image/tiff; application=geotiff; profile=cloud-optimized',\n", + " 'roles': ['visual'],\n", + " 'title': 'Visual Image'},\n", + " 'data-mask': {'type': 'application/geopackage+sqlite3',\n", + " 'roles': ['data-mask'],\n", + " 'title': 'Data Mask'},\n", + " 'ms_analytic': {'type': 'image/tiff; application=geotiff; profile=cloud-optimized',\n", + " 'roles': ['data'],\n", + " 'title': 'Multispectral Image'},\n", + " 'pan_analytic': {'type': 'image/tiff; application=geotiff; profile=cloud-optimized',\n", + " 'roles': ['data'],\n", + " 'title': 'Panchromatic Image'}},\n", + " 'stac_version': '1.0.0',\n", + " 'stac_extensions': ['https://stac-extensions.github.io/item-assets/v1.0.0/schema.json']}" + ] + }, + "execution_count": 37, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "collections = httpx.get(f\"{stac_endpoint}/collections\").json()\n", + "collections[\"collections\"][0]" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "However, there are many more collections available through the STAC endpoint. We can list the available collections by their `id`:" + ] + }, + { + "cell_type": "code", + "execution_count": 38, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "['MAXAR_BayofBengal_Cyclone_Mocha_May_23',\n", + " 'MAXAR_Emilia_Romagna_Italy_flooding_may23',\n", + " 'MAXAR_Gambia_flooding_8_11_2022',\n", + " 'MAXAR_Marshall_Fire_21_Update',\n", + " 'MAXAR_Hurricane_Fiona_9_19_2022',\n", + " 'MAXAR_Hurricane_Ian_9_26_2022',\n", + " 'MAXAR_Indonesia_Earthquake22',\n", + " 'MAXAR_Kahramanmaras_turkey_earthquake_23',\n", + " 'MAXAR_Kalehe_DRC_Flooding_5_8_23',\n", + " 'MAXAR_volcano_indonesia21',\n", + " 'MAXAR_New_Zealand_Flooding22',\n", + " 'MAXAR_New_Zealand_Flooding23',\n", + " 'MAXAR_Sudan_flooding_8_22_2022',\n", + " 'MAXAR_afghanistan_earthquake22',\n", + " 'MAXAR_cyclone_emnati22',\n", + " 'MAXAR_ghana_explosion22',\n", + " 'MAXAR_kentucky_flooding_7_29_2022',\n", + " 'MAXAR_pakistan_flooding22',\n", + " 'MAXAR_southafrica_flooding22',\n", + " 'MAXAR_tonga_volcano21',\n", + " 'MAXAR_yellowstone_flooding22',\n", + " 'MAXAR_Maui_Hawaii_fires_Aug_23',\n", + " 'MAXAR_NWT_Canada_Aug_23',\n", + " 'MAXAR_shovi_georgia_landslide_8Aug23',\n", + " 'MAXAR_Hurricane_Idalia_Florida_Aug23',\n", + " 'MAXAR_Libya_Floods_Sept_2023',\n", + " 'MAXAR_McDougallCreekWildfire_BC_Canada_Aug_23',\n", + " 'MAXAR_Morocco_Earthquake_Sept_2023',\n", + " 'UMBRA_2023']" + ] + }, + "execution_count": 38, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "[c['id'] for c in collections[\"collections\"]]" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "For the following steps, we will be using the Kahramanmaras Earthquake collection. \n", + "\n", + "A key feature of STAC is spatial and temporal extents. It is slightly intricate, but a collection can have multiple spatial and temporal extents. By convention, the first extent is supposed to encapsulate all sub-extents. For the temporal extents, the first data interval must cover the entire date interval of the sub-extents. For spatial extents, the first bounding box must cover all other bounding boxes for spatial extents.\n", + "\n", + "However, the Maxar Collections do not follow this convention for spatial extents. Let's illustrate the structure for spatial extents and display them on a map:" + ] + }, + { + "cell_type": "code", + "execution_count": 39, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Number of spatial extents: 72\n", + "First spatial extent bounding box: \n", + " [35.32861203895262, 36.06630343440598, 38.45685512435119, 37.90150133428409]\n" + ] + } + ], + "source": [ + "collection_id = \"MAXAR_Kahramanmaras_turkey_earthquake_23\"\n", + "\n", + "collection_info = httpx.get(f\"{stac_endpoint}/collections/{collection_id}\").json()\n", + "bboxes = collection_info[\"extent\"][\"spatial\"][\"bbox\"]\n", + "print(f\"Number of spatial extents: {len(bboxes)}\")\n", + "print(f\"First spatial extent bounding box: \\n {bboxes[0]}\")" + ] + }, + { + "cell_type": "code", + "execution_count": 40, + "metadata": {}, + "outputs": [ + { + "data": { + "application/vnd.jupyter.widget-view+json": { + "model_id": "aa5137dff01f4ba4ab2037cda29314ca", + "version_major": 2, + "version_minor": 0 + }, + "text/plain": [ + "Map(center=[36.983902384345036, 36.89273358165191], controls=(ZoomControl(options=['position', 'zoom_in_text',…" + ] + }, + "execution_count": 40, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "geojson = {\n", + " \"type\": \"FeatureCollection\",\n", + " \"features\": [\n", + " {\n", + " 'type': 'Feature',\n", + " 'geometry': {\n", + " 'type': 'Polygon',\n", + " 'coordinates': [[\n", + " [bbox[0], bbox[1]],\n", + " [bbox[2], bbox[1]],\n", + " [bbox[2], bbox[3]],\n", + " [bbox[0], bbox[3]],\n", + " [bbox[0], bbox[1]],\n", + " ]]\n", + " },\n", + " 'properties': {}\n", + " }\n", + " for bbox in bboxes\n", + " ]\n", + "}\n", + "\n", + "mainbbox = collection_info[\"extent\"][\"spatial\"][\"bbox\"][0]\n", + "\n", + "m = ipyleaflet.leaflet.Map(\n", + " center=((mainbbox[1] + mainbbox[3]) / 2,(mainbbox[0] + mainbbox[2]) / 2),\n", + " zoom=7\n", + ")\n", + "\n", + "geo_json = ipyleaflet.leaflet.GeoJSON(data=geojson)\n", + "m.add_layer(geo_json)\n", + "m" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Now, let's take a look into the temporal extent of the collection. In the case of Maxar's collections, there is a single temporal extent:" + ] + }, + { + "cell_type": "code", + "execution_count": 41, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Number of temporal extents: 1\n", + "Temporal extent: \n", + " ['2021-02-28T08:10:22Z', '2023-03-11T08:29:15Z']\n" + ] + } + ], + "source": [ + "temporal_extents = collection_info[\"extent\"][\"temporal\"]['interval']\n", + "print(f\"Number of temporal extents: {len(temporal_extents)}\")\n", + "print(f\"Temporal extent: \\n {temporal_extents[0]}\")" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "#### How to Query STAC Items\n", + "\n", + "Querying items in STAC (SpatioTemporal Asset Catalog) involves accessing individual datasets within a collection. Each item in a STAC collection represents a distinct spatiotemporal asset, such as a satellite image or geographical survey data. These items are the fundamental units of STAC, containing metadata and links to the actual data.\n", + "\n", + "To begin querying items, we must use the `id` of the collection under which the items are defined. To query the Kahramanmaras collection's items, we will use the following URL:" + ] + }, + { + "cell_type": "code", + "execution_count": 42, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "'https://stac.eoapi.dev/collections/MAXAR_Kahramanmaras_turkey_earthquake_23/items'" + ] + }, + "execution_count": 42, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "collection_id = \"MAXAR_Kahramanmaras_turkey_earthquake_23\"\n", + "turkey_items_url = f\"{stac_endpoint}/collections/{collection_id}/items\"\n", + "turkey_items_url" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + " To provide a practical insight into the STAC specification and how it structures item data, let's examine the first item returned from a typical request:" + ] + }, + { + "cell_type": "code", + "execution_count": 43, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Item attributes: \n", + " id, bbox, type, links, assets, geometry, collection, properties, stac_version, stac_extensions\n", + "{\n", + " \"id\": \"37_031133210001_10300100E49E8000\",\n", + " \"bbox\": [\n", + " 36.387245559111236,\n", + " 36.092041667396806,\n", + " 36.42079643694594,\n", + " 36.11834923545021\n", + " ],\n", + " \"type\": \"Feature\",\n", + " \"links\": [\n", + " {\n", + " \"rel\": \"collection\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://stac.eoapi.dev/collections/MAXAR_Kahramanmaras_turkey_earthquake_23\"\n", + " },\n", + " {\n", + " \"rel\": \"parent\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://stac.eoapi.dev/collections/MAXAR_Kahramanmaras_turkey_earthquake_23\"\n", + " },\n", + " {\n", + " \"rel\": \"root\",\n", + " \"type\": \"application/json\",\n", + " \"href\": \"https://stac.eoapi.dev/\"\n", + " },\n", + " {\n", + " \"rel\": \"self\",\n", + " \"type\": \"application/geo+json\",\n", + " \"href\": \"https://stac.eoapi.dev/collections/MAXAR_Kahramanmaras_turkey_earthquake_23/items/37_031133210001_10300100E49E8000\"\n", + " }\n", + " ],\n", + " \"assets\": {\n", + " \"visual\": {\n", + " \"href\": \"s3://maxar-opendata/events/Kahramanmaras-turkey-earthquake-23/ard/37/031133210001/2023-03-11/10300100E49E8000-visual.tif\",\n", + " \"type\": \"image/tiff; application=geotiff; profile=cloud-optimized\",\n", + " \"roles\": [\n", + " \"visual\"\n", + " ],\n", + " \"title\": \"Visual Image\",\n", + " \"eo:bands\": [\n", + " {\n", + " \"name\": \"BAND_R\",\n", + " \"common_name\": \"red\",\n", + " \"description\": \"Red\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_G\",\n", + " \"common_name\": \"green\",\n", + " \"description\": \"Green\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_B\",\n", + " \"common_name\": \"blue\",\n", + " \"description\": \"Blue\"\n", + " }\n", + " ],\n", + " \"alternate\": {\n", + " \"public\": {\n", + " \"href\": \"https://maxar-opendata.s3.amazonaws.com/events/Kahramanmaras-turkey-earthquake-23/ard/37/031133210001/2023-03-11/10300100E49E8000-visual.tif\",\n", + " \"title\": \"Public Access\"\n", + " }\n", + " },\n", + " \"proj:bbox\": [\n", + " 264843.75,\n", + " 3994843.75,\n", + " 270156.25,\n", + " 4000156.25\n", + " ],\n", + " \"proj:shape\": [\n", + " 17408,\n", + " 17408\n", + " ],\n", + " \"proj:transform\": [\n", + " 0.30517578125,\n", + " 0.0,\n", + " 264843.75,\n", + " 0.0,\n", + " -0.30517578125,\n", + " 4000156.25,\n", + " 0.0,\n", + " 0.0,\n", + " 1.0\n", + " ]\n", + " },\n", + " \"data-mask\": {\n", + " \"href\": \"s3://maxar-opendata/events/Kahramanmaras-turkey-earthquake-23/ard/37/031133210001/2023-03-11/10300100E49E8000-data-mask.gpkg\",\n", + " \"type\": \"application/geopackage+sqlite3\",\n", + " \"roles\": [\n", + " \"data-mask\"\n", + " ],\n", + " \"title\": \"Data Mask\",\n", + " \"alternate\": {\n", + " \"public\": {\n", + " \"href\": \"https://maxar-opendata.s3.amazonaws.com/events/Kahramanmaras-turkey-earthquake-23/ard/37/031133210001/2023-03-11/10300100E49E8000-data-mask.gpkg\",\n", + " \"title\": \"Public Access\"\n", + " }\n", + " }\n", + " },\n", + " \"ms_analytic\": {\n", + " \"href\": \"s3://maxar-opendata/events/Kahramanmaras-turkey-earthquake-23/ard/37/031133210001/2023-03-11/10300100E49E8000-ms.tif\",\n", + " \"type\": \"image/tiff; application=geotiff; profile=cloud-optimized\",\n", + " \"roles\": [\n", + " \"data\"\n", + " ],\n", + " \"title\": \"Multispectral Image\",\n", + " \"eo:bands\": [\n", + " {\n", + " \"name\": \"BAND_C\",\n", + " \"common_name\": \"coastal\",\n", + " \"description\": \"Coastal Blue\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_B\",\n", + " \"common_name\": \"blue\",\n", + " \"description\": \"Blue\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_G\",\n", + " \"common_name\": \"green\",\n", + " \"description\": \"Green\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_Y\",\n", + " \"common_name\": \"yellow\",\n", + " \"description\": \"Yellow\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_R\",\n", + " \"common_name\": \"red\",\n", + " \"description\": \"Red\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_RE\",\n", + " \"common_name\": \"rededge\",\n", + " \"description\": \"Red Edge 1\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_N\",\n", + " \"common_name\": \"nir08\",\n", + " \"description\": \"Near Infrared 1\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_N2\",\n", + " \"common_name\": \"nir09\",\n", + " \"description\": \"Near Infrared 2\"\n", + " }\n", + " ],\n", + " \"alternate\": {\n", + " \"public\": {\n", + " \"href\": \"https://maxar-opendata.s3.amazonaws.com/events/Kahramanmaras-turkey-earthquake-23/ard/37/031133210001/2023-03-11/10300100E49E8000-ms.tif\",\n", + " \"title\": \"Public Access\"\n", + " }\n", + " },\n", + " \"proj:bbox\": [\n", + " 264843.75,\n", + " 3994843.75,\n", + " 270156.25,\n", + " 4000156.25\n", + " ],\n", + " \"proj:shape\": [\n", + " 2779,\n", + " 2779\n", + " ],\n", + " \"proj:transform\": [\n", + " 1.9116588700971573,\n", + " 0.0,\n", + " 264843.75,\n", + " 0.0,\n", + " -1.9116588700971573,\n", + " 4000156.25,\n", + " 0.0,\n", + " 0.0,\n", + " 1.0\n", + " ]\n", + " },\n", + " \"pan_analytic\": {\n", + " \"href\": \"s3://maxar-opendata/events/Kahramanmaras-turkey-earthquake-23/ard/37/031133210001/2023-03-11/10300100E49E8000-pan.tif\",\n", + " \"type\": \"image/tiff; application=geotiff; profile=cloud-optimized\",\n", + " \"roles\": [\n", + " \"data\"\n", + " ],\n", + " \"title\": \"Panchromatic Image\",\n", + " \"eo:bands\": [\n", + " {\n", + " \"name\": \"BAND_P\",\n", + " \"description\": \"Pan\"\n", + " }\n", + " ],\n", + " \"alternate\": {\n", + " \"public\": {\n", + " \"href\": \"https://maxar-opendata.s3.amazonaws.com/events/Kahramanmaras-turkey-earthquake-23/ard/37/031133210001/2023-03-11/10300100E49E8000-pan.tif\",\n", + " \"title\": \"Public Access\"\n", + " }\n", + " },\n", + " \"proj:bbox\": [\n", + " 264843.75,\n", + " 3994843.75,\n", + " 270156.25,\n", + " 4000156.25\n", + " ],\n", + " \"proj:shape\": [\n", + " 11116,\n", + " 11116\n", + " ],\n", + " \"proj:transform\": [\n", + " 0.4779147175242893,\n", + " 0.0,\n", + " 264843.75,\n", + " 0.0,\n", + " -0.4779147175242893,\n", + " 4000156.25,\n", + " 0.0,\n", + " 0.0,\n", + " 1.0\n", + " ]\n", + " }\n", + " },\n", + " \"geometry\": {\n", + " \"type\": \"Polygon\",\n", + " \"coordinates\": [\n", + " [\n", + " [\n", + " 36.387245559111236,\n", + " 36.11762172115687\n", + " ],\n", + " [\n", + " 36.38807914445892,\n", + " 36.09246165938945\n", + " ],\n", + " [\n", + " 36.40855030738972,\n", + " 36.09229578729594\n", + " ],\n", + " [\n", + " 36.420731654920246,\n", + " 36.092041667396806\n", + " ],\n", + " [\n", + " 36.42079643694594,\n", + " 36.11834923545021\n", + " ],\n", + " [\n", + " 36.387245559111236,\n", + " 36.11762172115687\n", + " ]\n", + " ]\n", + " ]\n", + " },\n", + " \"collection\": \"MAXAR_Kahramanmaras_turkey_earthquake_23\",\n", + " \"properties\": {\n", + " \"gsd\": 0.48,\n", + " \"quadkey\": \"031133210001\",\n", + " \"datetime\": \"2023-03-11T08:29:15Z\",\n", + " \"platform\": \"WV02\",\n", + " \"utm_zone\": 37,\n", + " \"grid:code\": \"MXRA-Z37-031133210001\",\n", + " \"proj:bbox\": [\n", + " 264843.75,\n", + " 3997237.548828125,\n", + " 267866.2109375,\n", + " 4000156.25\n", + " ],\n", + " \"proj:epsg\": 32637,\n", + " \"catalog_id\": \"10300100E49E8000\",\n", + " \"view:azimuth\": 175.5,\n", + " \"proj:geometry\": {\n", + " \"type\": \"Polygon\",\n", + " \"coordinates\": [\n", + " [\n", + " [\n", + " 264843.75,\n", + " 4000156.25\n", + " ],\n", + " [\n", + " 264843.75,\n", + " 3997362.6708984375\n", + " ],\n", + " [\n", + " 266686.70654296875,\n", + " 3997294.921875\n", + " ],\n", + " [\n", + " 267782.89794921875,\n", + " 3997237.548828125\n", + " ],\n", + " [\n", + " 267866.2109375,\n", + " 4000156.25\n", + " ],\n", + " [\n", + " 264843.75,\n", + " 4000156.25\n", + " ]\n", + " ]\n", + " ]\n", + " },\n", + " \"tile:data_area\": 8.5,\n", + " \"view:off_nadir\": 12.4,\n", + " \"tile:clouds_area\": 0.0,\n", + " \"view:sun_azimuth\": 152.0,\n", + " \"view:sun_elevation\": 46.5,\n", + " \"tile:clouds_percent\": 0,\n", + " \"ard_metadata_version\": \"0.0.1\",\n", + " \"view:incidence_angle\": 76.1\n", + " },\n", + " \"stac_version\": \"1.0.0\",\n", + " \"stac_extensions\": [\n", + " \"https://stac-extensions.github.io/view/v1.0.0/schema.json\",\n", + " \"https://stac-extensions.github.io/projection/v1.0.0/schema.json\",\n", + " \"https://stac-extensions.github.io/eo/v1.0.0/schema.json\",\n", + " \"https://stac-extensions.github.io/raster/v1.1.0/schema.json\",\n", + " \"https://stac-extensions.github.io/grid/v1.0.0/schema.json\",\n", + " \"https://stac-extensions.github.io/alternate-assets/v1.1.0/schema.json\"\n", + " ]\n", + "}\n" + ] + } + ], + "source": [ + "items = httpx.get(turkey_items_url).json() \n", + "print(f\"Item attributes: \\n {', '.join(items['features'][0].keys())}\")\n", + "print(json.dumps(items['features'][0], indent=4))" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "For our purposes, we are focusing on the essential components of a STAC item. Here's a concise description of the key elements that are most relevant:\n", + "\n", + "- ID (`id`): This is the unique identifier of the STAC item, crucial for referencing and retrieving the specific asset within its collection.\n", + "- Bounding Box (`bbox`): This field defines the geographical bounds of the item, typically as an array representing the minimum and maximum coordinates (longitude and latitude) that encompass the asset.\n", + "- Properties (`properties`): This segment contains important metadata about the item, such as the acquisition date, sensor type, and other descriptive information specific to the asset.\n", + "- Links (`links`): Links are an array of objects that provide hyperlinks related to the item. These links can direct to the item itself, its parent collection, related items, and other URLs for data access or further details.\n", + "- Assets (`assets`): Assets are pointers to the actual data files associated with the item, such as images or data files. They contain URLs and metadata for each file, enabling access to the spatial data.\n", + "\n", + "While these are the key components for our analysis, it's important to note that there are additional elements in the STAC item output, such as the STAC version (`stac_version`) and STAC extensions (`stac_extensions`). These provide information about the version of the STAC specification used and any extensions enabled for the item, respectively. " + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Before diving into more advanced item queries, let's get a sens of the number of items within the collection. `STAC-FastAPI` will only return the first 10 items of collection by default:" + ] + }, + { + "cell_type": "code", + "execution_count": 44, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Returned Items in JSON: 10\n" + ] + }, + { + "data": { + "text/plain": [ + "{'limit': 10, 'matched': 2115, 'returned': 10}" + ] + }, + "execution_count": 44, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "items = httpx.get(turkey_items_url).json()\n", + "print(f\"Returned Items in JSON: {len(items['features'])}\")\n", + "items['context']" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "To retrieve the JSON of every item, we must incorporate the paging mechanism of `STAC-FastAPI` with the `limit` parameter. The mechanics are slightly intricate regarding retrieving the next link.\n", + "\n", + "\n", + "> *Note: if summary statistics like the number of items are important, you may enable the `context` variable within `PgSTAC.` With the option enabled, the `items['context']` will contain the number of `matched` Items.*" + ] + }, + { + "cell_type": "code", + "execution_count": 45, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Actual Number of Items: 2115\n" + ] + } + ], + "source": [ + "turkey_items = []\n", + "\n", + "url = turkey_items_url\n", + "while True:\n", + " items = httpx.get(url, params={\"limit\": 200}).json()\n", + " \n", + " turkey_items.extend(items[\"features\"])\n", + " next_link = list(filter(lambda link: link[\"rel\"] == \"next\", items[\"links\"]))\n", + " if next_link:\n", + " url = next_link[0][\"href\"]\n", + " else:\n", + " break\n", + "\n", + "print(f\"Actual Number of Items: {len(turkey_items)}\")\n" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "With all the items, we can start visualizing some important details that will help with our pre and post event analysis. The code block below generates a heatmap of the STAC items where we fill the color of pre-event Items with Blue and post-event Items with Red. " + ] + }, + { + "cell_type": "code", + "execution_count": 46, + "metadata": {}, + "outputs": [ + { + "data": { + "application/vnd.jupyter.widget-view+json": { + "model_id": "bd72e4f9defa439d8f58120c75efcbf4", + "version_major": 2, + "version_minor": 0 + }, + "text/plain": [ + "Map(center=[36.983902384345036, 36.89273358165191], controls=(ZoomControl(options=['position', 'zoom_in_text',…" + ] + }, + "execution_count": 46, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "m = ipyleaflet.leaflet.Map(\n", + " center=((mainbbox[1] + mainbbox[3]) / 2,(mainbbox[0] + mainbbox[2]) / 2),\n", + " zoom=7\n", + ")\n", + "\n", + "event_date = datetime(2023, 2, 6, hour=0, minute=0)\n", + "\n", + "# Use a styling function to show where we have before/after items\n", + "def style_function(feature):\n", + " d = datetime.strptime(feature[\"properties\"][\"datetime\"], \"%Y-%m-%dT%H:%M:%SZ\")\n", + " return {\n", + " \"fillOpacity\": 0.1,\n", + " \"weight\": 0.1,\n", + " # Blue for pre-event / red for post-event\n", + " \"fillColor\": \"#0000ff\" if d < event_date else \"#ff0000\"\n", + " }\n", + "\n", + "geojson = ipyleaflet.leaflet.GeoJSON(data={\"type\": \"FeatureCollection\", \"features\": turkey_items}, style_callback=style_function)\n", + "m.add_layer(geojson)\n", + "m" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Visualizing an Asset\n", + "\n", + "So far, all we've been utilizing is the `stac-fastapi` endpoint to query Collections and Items. We will now dive into how to visualize some of the underlying data associated with Items.\n", + "\n", + "Here's where the magic with eoAPI happens. Within eoAPI capabilities, is a raster API that is directly connected to the `pgSTAC` database that contains our STAC metadata via `titiler-pgstac`. The raster service leverages `TiTiler` to help us visualize the associated assets of a single, or as we will see, multiple STAC items. The demo raster endpoint is accessible via:" + ] + }, + { + "cell_type": "code", + "execution_count": 47, + "metadata": {}, + "outputs": [], + "source": [ + "raster_endpoint = \"https://raster.eoapi.dev\"" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "As previously mentionned, Items have an `asset` attribute which links to the underlying datasets and resources of the item. Let's revisit the assets of an item in our Turkey examples:" + ] + }, + { + "cell_type": "code", + "execution_count": 48, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "['visual', 'data-mask', 'ms_analytic', 'pan_analytic']\n", + "{\n", + " \"href\": \"s3://maxar-opendata/events/Kahramanmaras-turkey-earthquake-23/ard/37/031133032132/2022-10-10/10300100DB913300-visual.tif\",\n", + " \"type\": \"image/tiff; application=geotiff; profile=cloud-optimized\",\n", + " \"roles\": [\n", + " \"visual\"\n", + " ],\n", + " \"title\": \"Visual Image\",\n", + " \"eo:bands\": [\n", + " {\n", + " \"name\": \"BAND_R\",\n", + " \"common_name\": \"red\",\n", + " \"description\": \"Red\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_G\",\n", + " \"common_name\": \"green\",\n", + " \"description\": \"Green\"\n", + " },\n", + " {\n", + " \"name\": \"BAND_B\",\n", + " \"common_name\": \"blue\",\n", + " \"description\": \"Blue\"\n", + " }\n", + " ],\n", + " \"alternate\": {\n", + " \"public\": {\n", + " \"href\": \"https://maxar-opendata.s3.amazonaws.com/events/Kahramanmaras-turkey-earthquake-23/ard/37/031133032132/2022-10-10/10300100DB913300-visual.tif\",\n", + " \"title\": \"Public Access\"\n", + " }\n", + " },\n", + " \"proj:bbox\": [\n", + " 289843.75,\n", + " 4019843.75,\n", + " 295156.25,\n", + " 4025156.25\n", + " ],\n", + " \"proj:shape\": [\n", + " 17408,\n", + " 17408\n", + " ],\n", + " \"proj:transform\": [\n", + " 0.30517578125,\n", + " 0.0,\n", + " 289843.75,\n", + " 0.0,\n", + " -0.30517578125,\n", + " 4025156.25,\n", + " 0.0,\n", + " 0.0,\n", + " 1.0\n", + " ]\n", + "}\n", + "visual : image/tiff; application=geotiff; profile=cloud-optimized\n", + "data-mask : application/geopackage+sqlite3\n", + "ms_analytic : image/tiff; application=geotiff; profile=cloud-optimized\n", + "pan_analytic : image/tiff; application=geotiff; profile=cloud-optimized\n" + ] + } + ], + "source": [ + "item = items[\"features\"][0]\n", + "\n", + "print(list(item[\"assets\"].keys()))\n", + "print(json.dumps(item[\"assets\"][\"visual\"], indent=4))\n", + "\n", + "for name, asset in item[\"assets\"].items():\n", + " print(name, \": \", asset[\"type\"])" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Each Item of Maxar's collection has four assets, and three are cloud-optimized! Here's how we can use the raster API to visualize them.\n", + "\n", + "First, we must retrieve the Raster metadata for each Raster asset. The raster API will default filter non-raster datasets using the asset's `type` metadata. In the example below, we are fetching the metadata for the `visual`, `ms_analytic`, and `pan_analytic` because these assets have a cloud-optimized type:" + ] + }, + { + "cell_type": "code", + "execution_count": 49, + "metadata": {}, + "outputs": [ + { + "ename": "ReadTimeout", + "evalue": "The read operation timed out", + "output_type": "error", + "traceback": [ + "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m", + "\u001b[0;31mTimeoutError\u001b[0m Traceback (most recent call last)", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpcore/_exceptions.py:10\u001b[0m, in \u001b[0;36mmap_exceptions\u001b[0;34m(map)\u001b[0m\n\u001b[1;32m 9\u001b[0m \u001b[39mtry\u001b[39;00m:\n\u001b[0;32m---> 10\u001b[0m \u001b[39myield\u001b[39;00m\n\u001b[1;32m 11\u001b[0m \u001b[39mexcept\u001b[39;00m \u001b[39mException\u001b[39;00m \u001b[39mas\u001b[39;00m exc: \u001b[39m# noqa: PIE786\u001b[39;00m\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpcore/_backends/sync.py:28\u001b[0m, in \u001b[0;36mSyncStream.read\u001b[0;34m(self, max_bytes, timeout)\u001b[0m\n\u001b[1;32m 27\u001b[0m \u001b[39mself\u001b[39m\u001b[39m.\u001b[39m_sock\u001b[39m.\u001b[39msettimeout(timeout)\n\u001b[0;32m---> 28\u001b[0m \u001b[39mreturn\u001b[39;00m \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49m_sock\u001b[39m.\u001b[39;49mrecv(max_bytes)\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/ssl.py:1259\u001b[0m, in \u001b[0;36mSSLSocket.recv\u001b[0;34m(self, buflen, flags)\u001b[0m\n\u001b[1;32m 1256\u001b[0m \u001b[39mraise\u001b[39;00m \u001b[39mValueError\u001b[39;00m(\n\u001b[1;32m 1257\u001b[0m \u001b[39m\"\u001b[39m\u001b[39mnon-zero flags not allowed in calls to recv() on \u001b[39m\u001b[39m%s\u001b[39;00m\u001b[39m\"\u001b[39m \u001b[39m%\u001b[39m\n\u001b[1;32m 1258\u001b[0m \u001b[39mself\u001b[39m\u001b[39m.\u001b[39m\u001b[39m__class__\u001b[39m)\n\u001b[0;32m-> 1259\u001b[0m \u001b[39mreturn\u001b[39;00m \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49mread(buflen)\n\u001b[1;32m 1260\u001b[0m \u001b[39melse\u001b[39;00m:\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/ssl.py:1132\u001b[0m, in \u001b[0;36mSSLSocket.read\u001b[0;34m(self, len, buffer)\u001b[0m\n\u001b[1;32m 1131\u001b[0m \u001b[39melse\u001b[39;00m:\n\u001b[0;32m-> 1132\u001b[0m \u001b[39mreturn\u001b[39;00m \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49m_sslobj\u001b[39m.\u001b[39;49mread(\u001b[39mlen\u001b[39;49m)\n\u001b[1;32m 1133\u001b[0m \u001b[39mexcept\u001b[39;00m SSLError \u001b[39mas\u001b[39;00m x:\n", + "\u001b[0;31mTimeoutError\u001b[0m: The read operation timed out", + "\nThe above exception was the direct cause of the following exception:\n", + "\u001b[0;31mReadTimeout\u001b[0m Traceback (most recent call last)", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpx/_transports/default.py:60\u001b[0m, in \u001b[0;36mmap_httpcore_exceptions\u001b[0;34m()\u001b[0m\n\u001b[1;32m 59\u001b[0m \u001b[39mtry\u001b[39;00m:\n\u001b[0;32m---> 60\u001b[0m \u001b[39myield\u001b[39;00m\n\u001b[1;32m 61\u001b[0m \u001b[39mexcept\u001b[39;00m \u001b[39mException\u001b[39;00m \u001b[39mas\u001b[39;00m exc: \u001b[39m# noqa: PIE-786\u001b[39;00m\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpx/_transports/default.py:218\u001b[0m, in \u001b[0;36mHTTPTransport.handle_request\u001b[0;34m(self, request)\u001b[0m\n\u001b[1;32m 217\u001b[0m \u001b[39mwith\u001b[39;00m map_httpcore_exceptions():\n\u001b[0;32m--> 218\u001b[0m resp \u001b[39m=\u001b[39m \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49m_pool\u001b[39m.\u001b[39;49mhandle_request(req)\n\u001b[1;32m 220\u001b[0m \u001b[39massert\u001b[39;00m \u001b[39misinstance\u001b[39m(resp\u001b[39m.\u001b[39mstream, typing\u001b[39m.\u001b[39mIterable)\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpcore/_sync/connection_pool.py:262\u001b[0m, in \u001b[0;36mConnectionPool.handle_request\u001b[0;34m(self, request)\u001b[0m\n\u001b[1;32m 261\u001b[0m \u001b[39mself\u001b[39m\u001b[39m.\u001b[39mresponse_closed(status)\n\u001b[0;32m--> 262\u001b[0m \u001b[39mraise\u001b[39;00m exc\n\u001b[1;32m 263\u001b[0m \u001b[39melse\u001b[39;00m:\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpcore/_sync/connection_pool.py:245\u001b[0m, in \u001b[0;36mConnectionPool.handle_request\u001b[0;34m(self, request)\u001b[0m\n\u001b[1;32m 244\u001b[0m \u001b[39mtry\u001b[39;00m:\n\u001b[0;32m--> 245\u001b[0m response \u001b[39m=\u001b[39m connection\u001b[39m.\u001b[39;49mhandle_request(request)\n\u001b[1;32m 246\u001b[0m \u001b[39mexcept\u001b[39;00m ConnectionNotAvailable:\n\u001b[1;32m 247\u001b[0m \u001b[39m# The ConnectionNotAvailable exception is a special case, that\u001b[39;00m\n\u001b[1;32m 248\u001b[0m \u001b[39m# indicates we need to retry the request on a new connection.\u001b[39;00m\n\u001b[0;32m (...)\u001b[0m\n\u001b[1;32m 252\u001b[0m \u001b[39m# might end up as an HTTP/2 connection, but which actually ends\u001b[39;00m\n\u001b[1;32m 253\u001b[0m \u001b[39m# up as HTTP/1.1.\u001b[39;00m\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpcore/_sync/connection.py:96\u001b[0m, in \u001b[0;36mHTTPConnection.handle_request\u001b[0;34m(self, request)\u001b[0m\n\u001b[1;32m 94\u001b[0m \u001b[39mraise\u001b[39;00m ConnectionNotAvailable()\n\u001b[0;32m---> 96\u001b[0m \u001b[39mreturn\u001b[39;00m \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49m_connection\u001b[39m.\u001b[39;49mhandle_request(request)\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpcore/_sync/http11.py:121\u001b[0m, in \u001b[0;36mHTTP11Connection.handle_request\u001b[0;34m(self, request)\u001b[0m\n\u001b[1;32m 120\u001b[0m \u001b[39mself\u001b[39m\u001b[39m.\u001b[39m_response_closed()\n\u001b[0;32m--> 121\u001b[0m \u001b[39mraise\u001b[39;00m exc\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpcore/_sync/http11.py:99\u001b[0m, in \u001b[0;36mHTTP11Connection.handle_request\u001b[0;34m(self, request)\u001b[0m\n\u001b[1;32m 91\u001b[0m \u001b[39mwith\u001b[39;00m Trace(\n\u001b[1;32m 92\u001b[0m \u001b[39m\"\u001b[39m\u001b[39mreceive_response_headers\u001b[39m\u001b[39m\"\u001b[39m, logger, request, kwargs\n\u001b[1;32m 93\u001b[0m ) \u001b[39mas\u001b[39;00m trace:\n\u001b[1;32m 94\u001b[0m (\n\u001b[1;32m 95\u001b[0m http_version,\n\u001b[1;32m 96\u001b[0m status,\n\u001b[1;32m 97\u001b[0m reason_phrase,\n\u001b[1;32m 98\u001b[0m headers,\n\u001b[0;32m---> 99\u001b[0m ) \u001b[39m=\u001b[39m \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49m_receive_response_headers(\u001b[39m*\u001b[39;49m\u001b[39m*\u001b[39;49mkwargs)\n\u001b[1;32m 100\u001b[0m trace\u001b[39m.\u001b[39mreturn_value \u001b[39m=\u001b[39m (\n\u001b[1;32m 101\u001b[0m http_version,\n\u001b[1;32m 102\u001b[0m status,\n\u001b[1;32m 103\u001b[0m reason_phrase,\n\u001b[1;32m 104\u001b[0m headers,\n\u001b[1;32m 105\u001b[0m )\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpcore/_sync/http11.py:164\u001b[0m, in \u001b[0;36mHTTP11Connection._receive_response_headers\u001b[0;34m(self, request)\u001b[0m\n\u001b[1;32m 163\u001b[0m \u001b[39mwhile\u001b[39;00m \u001b[39mTrue\u001b[39;00m:\n\u001b[0;32m--> 164\u001b[0m event \u001b[39m=\u001b[39m \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49m_receive_event(timeout\u001b[39m=\u001b[39;49mtimeout)\n\u001b[1;32m 165\u001b[0m \u001b[39mif\u001b[39;00m \u001b[39misinstance\u001b[39m(event, h11\u001b[39m.\u001b[39mResponse):\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpcore/_sync/http11.py:200\u001b[0m, in \u001b[0;36mHTTP11Connection._receive_event\u001b[0;34m(self, timeout)\u001b[0m\n\u001b[1;32m 199\u001b[0m \u001b[39mif\u001b[39;00m event \u001b[39mis\u001b[39;00m h11\u001b[39m.\u001b[39mNEED_DATA:\n\u001b[0;32m--> 200\u001b[0m data \u001b[39m=\u001b[39m \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49m_network_stream\u001b[39m.\u001b[39;49mread(\n\u001b[1;32m 201\u001b[0m \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49mREAD_NUM_BYTES, timeout\u001b[39m=\u001b[39;49mtimeout\n\u001b[1;32m 202\u001b[0m )\n\u001b[1;32m 204\u001b[0m \u001b[39m# If we feed this case through h11 we'll raise an exception like:\u001b[39;00m\n\u001b[1;32m 205\u001b[0m \u001b[39m#\u001b[39;00m\n\u001b[1;32m 206\u001b[0m \u001b[39m# httpcore.RemoteProtocolError: can't handle event type\u001b[39;00m\n\u001b[0;32m (...)\u001b[0m\n\u001b[1;32m 210\u001b[0m \u001b[39m# perspective. Instead we handle this case distinctly and treat\u001b[39;00m\n\u001b[1;32m 211\u001b[0m \u001b[39m# it as a ConnectError.\u001b[39;00m\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpcore/_backends/sync.py:26\u001b[0m, in \u001b[0;36mSyncStream.read\u001b[0;34m(self, max_bytes, timeout)\u001b[0m\n\u001b[1;32m 25\u001b[0m exc_map: ExceptionMapping \u001b[39m=\u001b[39m {socket\u001b[39m.\u001b[39mtimeout: ReadTimeout, \u001b[39mOSError\u001b[39;00m: ReadError}\n\u001b[0;32m---> 26\u001b[0m \u001b[39mwith\u001b[39;00m map_exceptions(exc_map):\n\u001b[1;32m 27\u001b[0m \u001b[39mself\u001b[39m\u001b[39m.\u001b[39m_sock\u001b[39m.\u001b[39msettimeout(timeout)\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/contextlib.py:153\u001b[0m, in \u001b[0;36m_GeneratorContextManager.__exit__\u001b[0;34m(self, typ, value, traceback)\u001b[0m\n\u001b[1;32m 152\u001b[0m \u001b[39mtry\u001b[39;00m:\n\u001b[0;32m--> 153\u001b[0m \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49mgen\u001b[39m.\u001b[39;49mthrow(typ, value, traceback)\n\u001b[1;32m 154\u001b[0m \u001b[39mexcept\u001b[39;00m \u001b[39mStopIteration\u001b[39;00m \u001b[39mas\u001b[39;00m exc:\n\u001b[1;32m 155\u001b[0m \u001b[39m# Suppress StopIteration *unless* it's the same exception that\u001b[39;00m\n\u001b[1;32m 156\u001b[0m \u001b[39m# was passed to throw(). This prevents a StopIteration\u001b[39;00m\n\u001b[1;32m 157\u001b[0m \u001b[39m# raised inside the \"with\" statement from being suppressed.\u001b[39;00m\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpcore/_exceptions.py:14\u001b[0m, in \u001b[0;36mmap_exceptions\u001b[0;34m(map)\u001b[0m\n\u001b[1;32m 13\u001b[0m \u001b[39mif\u001b[39;00m \u001b[39misinstance\u001b[39m(exc, from_exc):\n\u001b[0;32m---> 14\u001b[0m \u001b[39mraise\u001b[39;00m to_exc(exc) \u001b[39mfrom\u001b[39;00m \u001b[39mexc\u001b[39;00m\n\u001b[1;32m 15\u001b[0m \u001b[39mraise\u001b[39;00m\n", + "\u001b[0;31mReadTimeout\u001b[0m: The read operation timed out", + "\nThe above exception was the direct cause of the following exception:\n", + "\u001b[0;31mReadTimeout\u001b[0m Traceback (most recent call last)", + "Cell \u001b[0;32mIn[49], line 3\u001b[0m\n\u001b[1;32m 1\u001b[0m item_id \u001b[39m=\u001b[39m item[\u001b[39m\"\u001b[39m\u001b[39mid\u001b[39m\u001b[39m\"\u001b[39m]\n\u001b[0;32m----> 3\u001b[0m info \u001b[39m=\u001b[39m httpx\u001b[39m.\u001b[39;49mget(\u001b[39mf\u001b[39;49m\u001b[39m\"\u001b[39;49m\u001b[39m{\u001b[39;49;00mraster_endpoint\u001b[39m}\u001b[39;49;00m\u001b[39m/collections/\u001b[39;49m\u001b[39m{\u001b[39;49;00mcollection_id\u001b[39m}\u001b[39;49;00m\u001b[39m/items/\u001b[39;49m\u001b[39m{\u001b[39;49;00mitem_id\u001b[39m}\u001b[39;49;00m\u001b[39m/info\u001b[39;49m\u001b[39m\"\u001b[39;49m)\u001b[39m.\u001b[39mjson()\n\u001b[1;32m 5\u001b[0m \u001b[39mprint\u001b[39m(json\u001b[39m.\u001b[39mdumps(info[\u001b[39m\"\u001b[39m\u001b[39mvisual\u001b[39m\u001b[39m\"\u001b[39m], indent\u001b[39m=\u001b[39m\u001b[39m4\u001b[39m))\n\u001b[1;32m 7\u001b[0m \u001b[39mfor\u001b[39;00m name, asset \u001b[39min\u001b[39;00m info\u001b[39m.\u001b[39mitems():\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpx/_api.py:189\u001b[0m, in \u001b[0;36mget\u001b[0;34m(url, params, headers, cookies, auth, proxies, follow_redirects, cert, verify, timeout, trust_env)\u001b[0m\n\u001b[1;32m 167\u001b[0m \u001b[39mdef\u001b[39;00m \u001b[39mget\u001b[39m(\n\u001b[1;32m 168\u001b[0m url: URLTypes,\n\u001b[1;32m 169\u001b[0m \u001b[39m*\u001b[39m,\n\u001b[0;32m (...)\u001b[0m\n\u001b[1;32m 179\u001b[0m trust_env: \u001b[39mbool\u001b[39m \u001b[39m=\u001b[39m \u001b[39mTrue\u001b[39;00m,\n\u001b[1;32m 180\u001b[0m ) \u001b[39m-\u001b[39m\u001b[39m>\u001b[39m Response:\n\u001b[1;32m 181\u001b[0m \u001b[39m \u001b[39m\u001b[39m\"\"\"\u001b[39;00m\n\u001b[1;32m 182\u001b[0m \u001b[39m Sends a `GET` request.\u001b[39;00m\n\u001b[1;32m 183\u001b[0m \n\u001b[0;32m (...)\u001b[0m\n\u001b[1;32m 187\u001b[0m \u001b[39m on this function, as `GET` requests should not include a request body.\u001b[39;00m\n\u001b[1;32m 188\u001b[0m \u001b[39m \"\"\"\u001b[39;00m\n\u001b[0;32m--> 189\u001b[0m \u001b[39mreturn\u001b[39;00m request(\n\u001b[1;32m 190\u001b[0m \u001b[39m\"\u001b[39;49m\u001b[39mGET\u001b[39;49m\u001b[39m\"\u001b[39;49m,\n\u001b[1;32m 191\u001b[0m url,\n\u001b[1;32m 192\u001b[0m params\u001b[39m=\u001b[39;49mparams,\n\u001b[1;32m 193\u001b[0m headers\u001b[39m=\u001b[39;49mheaders,\n\u001b[1;32m 194\u001b[0m cookies\u001b[39m=\u001b[39;49mcookies,\n\u001b[1;32m 195\u001b[0m auth\u001b[39m=\u001b[39;49mauth,\n\u001b[1;32m 196\u001b[0m proxies\u001b[39m=\u001b[39;49mproxies,\n\u001b[1;32m 197\u001b[0m follow_redirects\u001b[39m=\u001b[39;49mfollow_redirects,\n\u001b[1;32m 198\u001b[0m cert\u001b[39m=\u001b[39;49mcert,\n\u001b[1;32m 199\u001b[0m verify\u001b[39m=\u001b[39;49mverify,\n\u001b[1;32m 200\u001b[0m timeout\u001b[39m=\u001b[39;49mtimeout,\n\u001b[1;32m 201\u001b[0m trust_env\u001b[39m=\u001b[39;49mtrust_env,\n\u001b[1;32m 202\u001b[0m )\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpx/_api.py:100\u001b[0m, in \u001b[0;36mrequest\u001b[0;34m(method, url, params, content, data, files, json, headers, cookies, auth, proxies, timeout, follow_redirects, verify, cert, trust_env)\u001b[0m\n\u001b[1;32m 42\u001b[0m \u001b[39m\u001b[39m\u001b[39m\"\"\"\u001b[39;00m\n\u001b[1;32m 43\u001b[0m \u001b[39mSends an HTTP request.\u001b[39;00m\n\u001b[1;32m 44\u001b[0m \n\u001b[0;32m (...)\u001b[0m\n\u001b[1;32m 90\u001b[0m \u001b[39m```\u001b[39;00m\n\u001b[1;32m 91\u001b[0m \u001b[39m\"\"\"\u001b[39;00m\n\u001b[1;32m 92\u001b[0m \u001b[39mwith\u001b[39;00m Client(\n\u001b[1;32m 93\u001b[0m cookies\u001b[39m=\u001b[39mcookies,\n\u001b[1;32m 94\u001b[0m proxies\u001b[39m=\u001b[39mproxies,\n\u001b[0;32m (...)\u001b[0m\n\u001b[1;32m 98\u001b[0m trust_env\u001b[39m=\u001b[39mtrust_env,\n\u001b[1;32m 99\u001b[0m ) \u001b[39mas\u001b[39;00m client:\n\u001b[0;32m--> 100\u001b[0m \u001b[39mreturn\u001b[39;00m client\u001b[39m.\u001b[39;49mrequest(\n\u001b[1;32m 101\u001b[0m method\u001b[39m=\u001b[39;49mmethod,\n\u001b[1;32m 102\u001b[0m url\u001b[39m=\u001b[39;49murl,\n\u001b[1;32m 103\u001b[0m content\u001b[39m=\u001b[39;49mcontent,\n\u001b[1;32m 104\u001b[0m data\u001b[39m=\u001b[39;49mdata,\n\u001b[1;32m 105\u001b[0m files\u001b[39m=\u001b[39;49mfiles,\n\u001b[1;32m 106\u001b[0m json\u001b[39m=\u001b[39;49mjson,\n\u001b[1;32m 107\u001b[0m params\u001b[39m=\u001b[39;49mparams,\n\u001b[1;32m 108\u001b[0m headers\u001b[39m=\u001b[39;49mheaders,\n\u001b[1;32m 109\u001b[0m auth\u001b[39m=\u001b[39;49mauth,\n\u001b[1;32m 110\u001b[0m follow_redirects\u001b[39m=\u001b[39;49mfollow_redirects,\n\u001b[1;32m 111\u001b[0m )\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpx/_client.py:814\u001b[0m, in \u001b[0;36mClient.request\u001b[0;34m(self, method, url, content, data, files, json, params, headers, cookies, auth, follow_redirects, timeout, extensions)\u001b[0m\n\u001b[1;32m 799\u001b[0m warnings\u001b[39m.\u001b[39mwarn(message, \u001b[39mDeprecationWarning\u001b[39;00m)\n\u001b[1;32m 801\u001b[0m request \u001b[39m=\u001b[39m \u001b[39mself\u001b[39m\u001b[39m.\u001b[39mbuild_request(\n\u001b[1;32m 802\u001b[0m method\u001b[39m=\u001b[39mmethod,\n\u001b[1;32m 803\u001b[0m url\u001b[39m=\u001b[39murl,\n\u001b[0;32m (...)\u001b[0m\n\u001b[1;32m 812\u001b[0m extensions\u001b[39m=\u001b[39mextensions,\n\u001b[1;32m 813\u001b[0m )\n\u001b[0;32m--> 814\u001b[0m \u001b[39mreturn\u001b[39;00m \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49msend(request, auth\u001b[39m=\u001b[39;49mauth, follow_redirects\u001b[39m=\u001b[39;49mfollow_redirects)\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpx/_client.py:901\u001b[0m, in \u001b[0;36mClient.send\u001b[0;34m(self, request, stream, auth, follow_redirects)\u001b[0m\n\u001b[1;32m 893\u001b[0m follow_redirects \u001b[39m=\u001b[39m (\n\u001b[1;32m 894\u001b[0m \u001b[39mself\u001b[39m\u001b[39m.\u001b[39mfollow_redirects\n\u001b[1;32m 895\u001b[0m \u001b[39mif\u001b[39;00m \u001b[39misinstance\u001b[39m(follow_redirects, UseClientDefault)\n\u001b[1;32m 896\u001b[0m \u001b[39melse\u001b[39;00m follow_redirects\n\u001b[1;32m 897\u001b[0m )\n\u001b[1;32m 899\u001b[0m auth \u001b[39m=\u001b[39m \u001b[39mself\u001b[39m\u001b[39m.\u001b[39m_build_request_auth(request, auth)\n\u001b[0;32m--> 901\u001b[0m response \u001b[39m=\u001b[39m \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49m_send_handling_auth(\n\u001b[1;32m 902\u001b[0m request,\n\u001b[1;32m 903\u001b[0m auth\u001b[39m=\u001b[39;49mauth,\n\u001b[1;32m 904\u001b[0m follow_redirects\u001b[39m=\u001b[39;49mfollow_redirects,\n\u001b[1;32m 905\u001b[0m history\u001b[39m=\u001b[39;49m[],\n\u001b[1;32m 906\u001b[0m )\n\u001b[1;32m 907\u001b[0m \u001b[39mtry\u001b[39;00m:\n\u001b[1;32m 908\u001b[0m \u001b[39mif\u001b[39;00m \u001b[39mnot\u001b[39;00m stream:\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpx/_client.py:929\u001b[0m, in \u001b[0;36mClient._send_handling_auth\u001b[0;34m(self, request, auth, follow_redirects, history)\u001b[0m\n\u001b[1;32m 926\u001b[0m request \u001b[39m=\u001b[39m \u001b[39mnext\u001b[39m(auth_flow)\n\u001b[1;32m 928\u001b[0m \u001b[39mwhile\u001b[39;00m \u001b[39mTrue\u001b[39;00m:\n\u001b[0;32m--> 929\u001b[0m response \u001b[39m=\u001b[39m \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49m_send_handling_redirects(\n\u001b[1;32m 930\u001b[0m request,\n\u001b[1;32m 931\u001b[0m follow_redirects\u001b[39m=\u001b[39;49mfollow_redirects,\n\u001b[1;32m 932\u001b[0m history\u001b[39m=\u001b[39;49mhistory,\n\u001b[1;32m 933\u001b[0m )\n\u001b[1;32m 934\u001b[0m \u001b[39mtry\u001b[39;00m:\n\u001b[1;32m 935\u001b[0m \u001b[39mtry\u001b[39;00m:\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpx/_client.py:966\u001b[0m, in \u001b[0;36mClient._send_handling_redirects\u001b[0;34m(self, request, follow_redirects, history)\u001b[0m\n\u001b[1;32m 963\u001b[0m \u001b[39mfor\u001b[39;00m hook \u001b[39min\u001b[39;00m \u001b[39mself\u001b[39m\u001b[39m.\u001b[39m_event_hooks[\u001b[39m\"\u001b[39m\u001b[39mrequest\u001b[39m\u001b[39m\"\u001b[39m]:\n\u001b[1;32m 964\u001b[0m hook(request)\n\u001b[0;32m--> 966\u001b[0m response \u001b[39m=\u001b[39m \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49m_send_single_request(request)\n\u001b[1;32m 967\u001b[0m \u001b[39mtry\u001b[39;00m:\n\u001b[1;32m 968\u001b[0m \u001b[39mfor\u001b[39;00m hook \u001b[39min\u001b[39;00m \u001b[39mself\u001b[39m\u001b[39m.\u001b[39m_event_hooks[\u001b[39m\"\u001b[39m\u001b[39mresponse\u001b[39m\u001b[39m\"\u001b[39m]:\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpx/_client.py:1002\u001b[0m, in \u001b[0;36mClient._send_single_request\u001b[0;34m(self, request)\u001b[0m\n\u001b[1;32m 997\u001b[0m \u001b[39mraise\u001b[39;00m \u001b[39mRuntimeError\u001b[39;00m(\n\u001b[1;32m 998\u001b[0m \u001b[39m\"\u001b[39m\u001b[39mAttempted to send an async request with a sync Client instance.\u001b[39m\u001b[39m\"\u001b[39m\n\u001b[1;32m 999\u001b[0m )\n\u001b[1;32m 1001\u001b[0m \u001b[39mwith\u001b[39;00m request_context(request\u001b[39m=\u001b[39mrequest):\n\u001b[0;32m-> 1002\u001b[0m response \u001b[39m=\u001b[39m transport\u001b[39m.\u001b[39;49mhandle_request(request)\n\u001b[1;32m 1004\u001b[0m \u001b[39massert\u001b[39;00m \u001b[39misinstance\u001b[39m(response\u001b[39m.\u001b[39mstream, SyncByteStream)\n\u001b[1;32m 1006\u001b[0m response\u001b[39m.\u001b[39mrequest \u001b[39m=\u001b[39m request\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpx/_transports/default.py:217\u001b[0m, in \u001b[0;36mHTTPTransport.handle_request\u001b[0;34m(self, request)\u001b[0m\n\u001b[1;32m 203\u001b[0m \u001b[39massert\u001b[39;00m \u001b[39misinstance\u001b[39m(request\u001b[39m.\u001b[39mstream, SyncByteStream)\n\u001b[1;32m 205\u001b[0m req \u001b[39m=\u001b[39m httpcore\u001b[39m.\u001b[39mRequest(\n\u001b[1;32m 206\u001b[0m method\u001b[39m=\u001b[39mrequest\u001b[39m.\u001b[39mmethod,\n\u001b[1;32m 207\u001b[0m url\u001b[39m=\u001b[39mhttpcore\u001b[39m.\u001b[39mURL(\n\u001b[0;32m (...)\u001b[0m\n\u001b[1;32m 215\u001b[0m extensions\u001b[39m=\u001b[39mrequest\u001b[39m.\u001b[39mextensions,\n\u001b[1;32m 216\u001b[0m )\n\u001b[0;32m--> 217\u001b[0m \u001b[39mwith\u001b[39;00m map_httpcore_exceptions():\n\u001b[1;32m 218\u001b[0m resp \u001b[39m=\u001b[39m \u001b[39mself\u001b[39m\u001b[39m.\u001b[39m_pool\u001b[39m.\u001b[39mhandle_request(req)\n\u001b[1;32m 220\u001b[0m \u001b[39massert\u001b[39;00m \u001b[39misinstance\u001b[39m(resp\u001b[39m.\u001b[39mstream, typing\u001b[39m.\u001b[39mIterable)\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/contextlib.py:153\u001b[0m, in \u001b[0;36m_GeneratorContextManager.__exit__\u001b[0;34m(self, typ, value, traceback)\u001b[0m\n\u001b[1;32m 151\u001b[0m value \u001b[39m=\u001b[39m typ()\n\u001b[1;32m 152\u001b[0m \u001b[39mtry\u001b[39;00m:\n\u001b[0;32m--> 153\u001b[0m \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49mgen\u001b[39m.\u001b[39;49mthrow(typ, value, traceback)\n\u001b[1;32m 154\u001b[0m \u001b[39mexcept\u001b[39;00m \u001b[39mStopIteration\u001b[39;00m \u001b[39mas\u001b[39;00m exc:\n\u001b[1;32m 155\u001b[0m \u001b[39m# Suppress StopIteration *unless* it's the same exception that\u001b[39;00m\n\u001b[1;32m 156\u001b[0m \u001b[39m# was passed to throw(). This prevents a StopIteration\u001b[39;00m\n\u001b[1;32m 157\u001b[0m \u001b[39m# raised inside the \"with\" statement from being suppressed.\u001b[39;00m\n\u001b[1;32m 158\u001b[0m \u001b[39mreturn\u001b[39;00m exc \u001b[39mis\u001b[39;00m \u001b[39mnot\u001b[39;00m value\n", + "File \u001b[0;32m~/.pyenv/versions/3.10.5/lib/python3.10/site-packages/httpx/_transports/default.py:77\u001b[0m, in \u001b[0;36mmap_httpcore_exceptions\u001b[0;34m()\u001b[0m\n\u001b[1;32m 74\u001b[0m \u001b[39mraise\u001b[39;00m\n\u001b[1;32m 76\u001b[0m message \u001b[39m=\u001b[39m \u001b[39mstr\u001b[39m(exc)\n\u001b[0;32m---> 77\u001b[0m \u001b[39mraise\u001b[39;00m mapped_exc(message) \u001b[39mfrom\u001b[39;00m \u001b[39mexc\u001b[39;00m\n", + "\u001b[0;31mReadTimeout\u001b[0m: The read operation timed out" + ] + } + ], + "source": [ + "item_id = item[\"id\"]\n", + "\n", + "info = httpx.get(f\"{raster_endpoint}/collections/{collection_id}/items/{item_id}/info\").json()\n", + "\n", + "print(json.dumps(info[\"visual\"], indent=4))\n", + "\n", + "for name, asset in info.items():\n", + " print(name, asset[\"minzoom\"], asset[\"maxzoom\"])" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Of importance, the `/collections/{collectionId}/items/{itemId}/info` endpoint returns the information we need to create the necessary URLs for `TiTiler` which are:\n", + "- the datatype, \n", + "- the zoom levels,\n", + "- and the number of bands\n", + "\n", + "Here's how we can build and retrieve the tilejson with the raster endpoint:" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "{'tilejson': '2.2.0',\n", + " 'version': '1.0.0',\n", + " 'scheme': 'xyz',\n", + " 'tiles': ['https://raster.eoapi.dev/collections/MAXAR_Kahramanmaras_turkey_earthquake_23/items/37_031133032132_10300100DB913300/tiles/WebMercatorQuad/{z}/{x}/{y}@1x?assets=visual'],\n", + " 'minzoom': 12,\n", + " 'maxzoom': 19,\n", + " 'bounds': [36.65808288486373,\n", + " 36.345093,\n", + " 36.717375426995574,\n", + " 36.34970381857705],\n", + " 'center': [36.68772915592965, 36.34739840928852, 12]}" + ] + }, + "execution_count": 25, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "tilejson = httpx.get(\n", + " f\"{raster_endpoint}/collections/{collection_id}/items/{item_id}/tilejson.json\",\n", + " params = (\n", + " (\"assets\", \"visual\"), # THIS PARAMETER IS MANDATORY\n", + " (\"minzoom\", 12), # By default the tiler will use 0\n", + " (\"maxzoom\", 19), # By default the tiler will use 24\n", + " )\n", + ").json()\n", + "tilejson" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Finally, let's visualize the asset on a map:" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [ + { + "data": { + "application/vnd.jupyter.widget-view+json": { + "model_id": "8931b25e68d74ec490aab06ba7e2a91d", + "version_major": 2, + "version_minor": 0 + }, + "text/plain": [ + "Map(center=[36.34739840928852, 36.68772915592965], controls=(ZoomControl(options=['position', 'zoom_in_text', …" + ] + }, + "execution_count": 26, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "bounds = tilejson[\"bounds\"]\n", + "m = ipyleaflet.leaflet.Map(\n", + " center=((bounds[1] + bounds[3]) / 2,(bounds[0] + bounds[2]) / 2),\n", + " zoom=12\n", + ")\n", + "\n", + "geo_json = ipyleaflet.leaflet.GeoJSON(\n", + " data=item,\n", + " style={\n", + " 'opacity': 1, 'dashArray': '9', 'fillOpacity': 0., 'weight': 4\n", + " }\n", + ")\n", + "m.add_layer(geo_json)\n", + "\n", + "tiles = ipyleaflet.leaflet.TileLayer(\n", + " url=tilejson[\"tiles\"][0],\n", + " min_zoom=tilejson[\"minzoom\"],\n", + " max_zoom=tilejson[\"maxzoom\"],\n", + " bounds=[\n", + " [bounds[1], bounds[0]],\n", + " [bounds[3], bounds[2]],\n", + "\n", + " ],\n", + ")\n", + "\n", + "m.add_layer(tiles)\n", + "\n", + "m" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Comparing imagery of pre and post events\n", + "\n", + "We've been building up to the grand finale of the notebook - comparing imagery before and after the Turkey earthquakes.\n", + "\n", + "We will use the STAC endpoint to query the images pre and post-event. Then, we will demonstrate how to visualize multiple assets together with Mosaics. Finally, we will create a map to visualize post and pre-events side-by-side. \n", + "\n", + "Here's an example of how we could create objects to store the pre and post-event STAC items:" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Pre-event items: 229\n", + "Post-event items: 1886\n" + ] + } + ], + "source": [ + "event_date = datetime(2023, 2, 6, hour=0, minute=0)\n", + "\n", + "pre_items = list(\n", + " filter(\n", + " lambda item: datetime.strptime(item[\"properties\"][\"datetime\"], \"%Y-%m-%dT%H:%M:%SZ\") < event_date, \n", + " turkey_items\n", + " )\n", + ")\n", + "\n", + "post_items = list(\n", + " filter(\n", + " lambda item: datetime.strptime(item[\"properties\"][\"datetime\"], \"%Y-%m-%dT%H:%M:%SZ\") >= event_date, \n", + " turkey_items\n", + " )\n", + ")\n", + "print(\"Pre-event items:\", len(pre_items))\n", + "print(\"Post-event items:\", len(post_items))" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Contrary to that single sliver of imagery we visualized with a single asset; we can create a *Mosaic* which combines Assets from multiple Items. The Raster API's true power is to make these virtual mosaics dynamically - merging various items on the fly! In fact, with the `pgSTAC` backend utilized by the Raster endpoint, we can use the filter extension to construct complex queries. \n", + "\n", + "For more information on filtering, you can visit the stac-fastapi documentation section on it [here](https://github.com/stac-api-extensions/filter).\n", + "\n", + "Under the hood, the process happens in two separate steps:\n", + "1. Registering the Raster Mosaic,\n", + "2. Creating a Valid tile URL\n", + "\n", + "Here's an example of Kahramanmaras, where we filter by the event date, the collection ID, and the city's bounds. First, we register the Mosaic with our specific filters:" + ] + }, + { + "cell_type": "code", + "execution_count": 54, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "{'id': '9c2101bb56005850dcc6e95303586432',\n", + " 'links': [{'rel': 'metadata',\n", + " 'title': 'Mosaic metadata',\n", + " 'type': 'application/json',\n", + " 'href': 'https://raster.eoapi.dev/searches/9c2101bb56005850dcc6e95303586432/info'},\n", + " {'rel': 'tilejson',\n", + " 'title': 'Link for TileJSON',\n", + " 'type': 'application/json',\n", + " 'href': 'https://raster.eoapi.dev/searches/9c2101bb56005850dcc6e95303586432/tilejson.json'},\n", + " {'rel': 'map',\n", + " 'title': 'Link for Map viewer',\n", + " 'type': 'application/json',\n", + " 'href': 'https://raster.eoapi.dev/searches/9c2101bb56005850dcc6e95303586432/map'},\n", + " {'rel': 'wmts',\n", + " 'title': 'Link for WMTS',\n", + " 'type': 'application/json',\n", + " 'href': 'https://raster.eoapi.dev/searches/9c2101bb56005850dcc6e95303586432/WMTSCapabilities.xml'}]}" + ] + }, + "execution_count": 54, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "event_date = \"2023-02-06T00:00:00Z\"\n", + "\n", + "# Let's focus on Kahramanmaraş city \n", + "bounds = [36.83064386785452, 37.53123515817725, 37.03859654890988, 37.63167525356958]\n", + "\n", + "pre_mosaic = httpx.post(\n", + " f\"{raster_endpoint}/searches/register\",\n", + " data=json.dumps(\n", + " {\n", + " \"filter-lang\": 'cql2-json',\n", + " \"filter\": {\n", + " \"op\": 'and', \n", + " \"args\": [\n", + " {\n", + " \"op\": \"in\", \n", + " \"args\": [{\"property\": \"collection\"}, [collection_id]]\n", + " },\n", + " {\n", + " \"op\": \"lt\", \n", + " \"args\": [\n", + " {\"property\": \"datetime\"}, event_date\n", + " ]\n", + " }\n", + " ],\n", + " },\n", + " \"sortby\": [\n", + " {\n", + " \"field\": \"tile:clouds_percent\",\n", + " \"direction\": \"asc\"\n", + " },\n", + " ],\n", + " \"metadata\":{\n", + " \"name\": \"Maxar Kahramanmaras - Pre event\",\n", + " \"bounds\": bounds,\n", + " }\n", + " \n", + " }\n", + " )\n", + ").json()\n", + "pre_mosaic" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Then, we can create a valid Tile URL using the `searchid` hash returned by the mosaic registration. Again, we will pass the assets parameter when creating the tile as well as our zoom levels to avoid over and under-zooming:" + ] + }, + { + "cell_type": "code", + "execution_count": 56, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "'9c2101bb56005850dcc6e95303586432'" + ] + }, + "execution_count": 56, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "mosaic_id = pre_mosaic[\"id\"]\n", + "mosaic_id\n", + "# tilejson_pre = httpx.get(\n", + "# f\"{raster_endpoint}/mosaic/{mosaic_id}/tilejson.json\",\n", + "# params = (\n", + "# (\"assets\", \"visual\"), # required parameter\n", + "# (\"minzoom\", 12),\n", + "# (\"maxzoom\", 19), \n", + "# )\n", + "# ).json()\n", + "# tilejson_pre" + ] + }, + { + "cell_type": "code", + "execution_count": 59, + "metadata": {}, + "outputs": [ + { + "data": { + "application/vnd.jupyter.widget-view+json": { + "model_id": "0d8b49841bee48489cd5cf2e59fe6f3d", + "version_major": 2, + "version_minor": 0 + }, + "text/plain": [ + "Map(center=[37.58145520587342, 36.9346202083822], controls=(ZoomControl(options=['position', 'zoom_in_text', '…" + ] + }, + "execution_count": 59, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "mosaic_id = pre_mosaic[\"id\"]\n", + "\n", + "tilejson_pre = httpx.get(\n", + " f\"{raster_endpoint}/searches/{mosaic_id}/tilejson.json\",\n", + " params = (\n", + " (\"assets\", \"visual\"), # required parameter\n", + " (\"minzoom\", 12),\n", + " (\"maxzoom\", 19), \n", + " )\n", + ").json()\n", + "\n", + "bounds = tilejson_pre[\"bounds\"]\n", + "m = ipyleaflet.leaflet.Map(\n", + " center=((bounds[1] + bounds[3]) / 2,(bounds[0] + bounds[2]) / 2),\n", + " zoom=12\n", + ")\n", + "\n", + "geo_json = ipyleaflet.leaflet.GeoJSON(\n", + " data={\"type\": \"FeatureCollection\", \"features\": pre_items}, \n", + " style={\n", + " \"fillOpacity\": 0,\n", + " \"weight\": 1,\n", + " },\n", + ")\n", + "m.add_layer(geo_json)\n", + "\n", + "tiles = ipyleaflet.leaflet.TileLayer(\n", + " url=tilejson_pre[\"tiles\"][0],\n", + " min_zoom=tilejson_pre[\"minzoom\"],\n", + " max_zoom=tilejson_pre[\"maxzoom\"],\n", + " bounds=[\n", + " [bounds[1], bounds[0]],\n", + " [bounds[3], bounds[2]],\n", + "\n", + " ],\n", + ")\n", + "\n", + "m.add_layer(tiles)\n", + "m" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "A complete list of options for the mosaic endpoint is available in the documentation [here](https://stac-utils.github.io/titiler-pgstac/mosaic_endpoints/#tiles).\n", + "\n", + "Finally, we can visualize the pre and post-events simultaneously with leaflet's slider capability and creating another mosaic for post-events:" + ] + }, + { + "cell_type": "code", + "execution_count": 61, + "metadata": {}, + "outputs": [ + { + "ename": "KeyError", + "evalue": "'searchid'", + "output_type": "error", + "traceback": [ + "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m", + "\u001b[0;31mKeyError\u001b[0m Traceback (most recent call last)", + "Cell \u001b[0;32mIn[61], line 36\u001b[0m\n\u001b[1;32m 1\u001b[0m post_mosaic \u001b[39m=\u001b[39m httpx\u001b[39m.\u001b[39mpost(\n\u001b[1;32m 2\u001b[0m \u001b[39mf\u001b[39m\u001b[39m\"\u001b[39m\u001b[39m{\u001b[39;00mraster_endpoint\u001b[39m}\u001b[39;00m\u001b[39m/searches/register\u001b[39m\u001b[39m\"\u001b[39m,\n\u001b[1;32m 3\u001b[0m data\u001b[39m=\u001b[39mjson\u001b[39m.\u001b[39mdumps(\n\u001b[0;32m (...)\u001b[0m\n\u001b[1;32m 33\u001b[0m )\n\u001b[1;32m 34\u001b[0m )\u001b[39m.\u001b[39mjson()\n\u001b[0;32m---> 36\u001b[0m mosaic_id \u001b[39m=\u001b[39m post_mosaic[\u001b[39m\"\u001b[39;49m\u001b[39msearchid\u001b[39;49m\u001b[39m\"\u001b[39;49m]\n\u001b[1;32m 38\u001b[0m tilejson_post \u001b[39m=\u001b[39m httpx\u001b[39m.\u001b[39mget(\n\u001b[1;32m 39\u001b[0m \u001b[39mf\u001b[39m\u001b[39m\"\u001b[39m\u001b[39m{\u001b[39;00mraster_endpoint\u001b[39m}\u001b[39;00m\u001b[39m/searches/\u001b[39m\u001b[39m{\u001b[39;00mmosaic_id\u001b[39m}\u001b[39;00m\u001b[39m/tilejson.json\u001b[39m\u001b[39m\"\u001b[39m,\n\u001b[1;32m 40\u001b[0m params \u001b[39m=\u001b[39m (\n\u001b[0;32m (...)\u001b[0m\n\u001b[1;32m 44\u001b[0m )\n\u001b[1;32m 45\u001b[0m )\u001b[39m.\u001b[39mjson()\n\u001b[1;32m 47\u001b[0m bounds \u001b[39m=\u001b[39m tilejson_pre[\u001b[39m\"\u001b[39m\u001b[39mbounds\u001b[39m\u001b[39m\"\u001b[39m]\n", + "\u001b[0;31mKeyError\u001b[0m: 'searchid'" + ] + } + ], + "source": [ + "post_mosaic = httpx.post(\n", + " f\"{raster_endpoint}/searches/register\",\n", + " data=json.dumps(\n", + " {\n", + " \"filter-lang\": 'cql2-json',\n", + " \"filter\": {\n", + " \"op\": 'and', \n", + " \"args\": [\n", + " {\n", + " \"op\": \"in\", \n", + " \"args\": [{\"property\": \"collection\"}, [collection_id]]\n", + " },\n", + " {\n", + " \"op\": \"ge\", \n", + " \"args\": [\n", + " {\"property\": \"datetime\"}, event_date\n", + " ]\n", + " }\n", + " ],\n", + " },\n", + " \"sortby\": [\n", + " {\n", + " \"field\": \"tile:clouds_percent\",\n", + " \"direction\": \"asc\"\n", + " },\n", + " ],\n", + " \"metadata\":{\n", + " \"name\": \"Maxar Kahramanmaras - Port event\",\n", + " \"bounds\": bounds,\n", + " }\n", + " \n", + " }\n", + " )\n", + ").json()\n", + "\n", + "mosaic_id = post_mosaic[\"id\"]\n", + "\n", + "tilejson_post = httpx.get(\n", + " f\"{raster_endpoint}/searches/{mosaic_id}/tilejson.json\",\n", + " params = (\n", + " (\"assets\", \"visual\"), # THIS IS MANDATORY\n", + " (\"minzoom\", 12),\n", + " (\"maxzoom\", 19), \n", + " )\n", + ").json()\n", + "\n", + "bounds = tilejson_pre[\"bounds\"]\n", + "before_layer = ipyleaflet.leaflet.TileLayer(\n", + " url=tilejson_pre[\"tiles\"][0],\n", + " min_zoom=tilejson_pre[\"minzoom\"],\n", + " max_zoom=tilejson_pre[\"maxzoom\"],\n", + " bounds=[\n", + " [bounds[1], bounds[0]],\n", + " [bounds[3], bounds[2]],\n", + " ],\n", + ")\n", + "\n", + "bounds = tilejson_post[\"bounds\"]\n", + "after_layer = ipyleaflet.leaflet.TileLayer(\n", + " url=tilejson_post[\"tiles\"][0],\n", + " min_zoom=tilejson_post[\"minzoom\"],\n", + " max_zoom=tilejson_post[\"maxzoom\"],\n", + " bounds=[\n", + " [bounds[1], bounds[0]],\n", + " [bounds[3], bounds[2]],\n", + " ],\n", + ")\n", + "\n", + "control = ipyleaflet.leaflet.SplitMapControl(left_layer=before_layer, right_layer=after_layer)\n", + "m.add_control(control)\n", + "\n", + "m" + ] + }, + { + "attachments": {}, + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Conclusion\n", + "\n", + "In this notebook, we've explored the essentials of STAC, COGs, and eoAPI, providing practical insights into their use in data analysis. Please further experiment with the techniques demonstrated here and explore the other notebooks in our [eoAPI](https://github.com/developmentseed/eoAPI) repository for more applications.\n", + "\n", + "I want to thank Vincent Sarago for his foundational work that inspired this notebook. Your feedback and contributions are highly valued; feel free to open an issue or submit a Pull Request on our GitHub repository.\n", + "\n", + "Thank you for your time, and I hope this notebook has sparked your interest in further exploring geospatial data analysis!" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.10.5" + }, + "orig_nbformat": 4 + }, + "nbformat": 4, + "nbformat_minor": 2 +} diff --git a/overrides/assets/stylesheets/home.css b/overrides/assets/stylesheets/home.css new file mode 100644 index 0000000..6575198 --- /dev/null +++ b/overrides/assets/stylesheets/home.css @@ -0,0 +1,389 @@ +.md-main { + display: none; +} +.md-header { + background-color: black; +} +.md-tabs, +.md-header:not(.md-header--shadow) { + background: transparent; + box-shadow: none; + transition: background-color 125ms, + transform 125ms cubic-bezier(0.1, 0.7, 0.1, 1); +} + +.tx-container { + background: linear-gradient(to bottom, transparent, rgba(0, 0, 0, 0.5)), + url(../../../img/NASA_SunEarth.jpg) no-repeat center top scroll; + background-color: #000; + background-size: cover; + transition: all ease 0.1s; + position: relative; + top: -5rem; + padding: 6rem 0 4rem; +} + +.tx-container:before { + display: block; + position: absolute; + content: ''; + height: clamp(6rem, 14vw, 12rem); + width: clamp(12rem, 40vw, 40rem); + background: var(--md-primary-fg-color); + mix-blend-mode: multiply; + border-radius: 0.5rem 0 0 0.5rem; + pointer-events: none; + z-index: 3; + right: 0; + bottom: -3rem; +} + +.tx-hero { + display: flex; + color: var(--md-primary-bg-color); + justify-content: center; + padding: 0 1rem; +} + +.media-attribution { + position: absolute; + top: 4rem; + right: 1rem; + z-index: 40; + max-width: calc(100% - 2rem); + display: inline-flex; + color: rgb(255, 255, 255); + border-radius: 320rem; + padding: 0rem 0.25rem; + font-size: 0.75rem; + line-height: 1.25rem; + background: rgba(68, 63, 63, 0.32); + overflow: hidden; +} +.media-attribution .twemoji { + font-size: 0.75rem; + height: initial; +} +.media-attribution strong { + display: block; + width: 100%; + max-width: 0px; + overflow: hidden; + font-size: 0.75rem; + font-weight: normal; + white-space: nowrap; + padding: 0rem; + opacity: 0; + transition: all 0.24s ease-in-out 0s; +} +.media-attribution a { + display: flex; + flex-flow: row; + align-items: center; + color: rgb(255, 255, 255); +} +.media-attribution a:hover strong { + white-space: nowrap; + overflow: hidden; + text-overflow: ellipsis; + max-width: 64vw; + padding: 0rem 0.5rem 0rem 0.25rem; + opacity: 1; + color: rgb(255, 255, 255); +} +.tx-hero h1 { + color: currentColor; + font-weight: 700; + font-size: clamp(1.25rem, 7vw, 3rem); + margin: 0; + line-height: 1.125; + text-shadow: 0 0 0.25rem rgba(0, 0, 0, 0.25); +} + +.tx-hero__content { + display: flex; + flex-flow: column nowrap; + margin: 0 auto; + align-items: stretch; +} + +.tx-hero__content .supheading { + color: currentColor; + text-transform: none; +} + +.tx-hero__content .button-wrapper { + display: flex; + gap: 1rem; + flex-flow: column nowrap; + align-items: stretch; +} + +.tx-hero .md-button { + display: inline-flex; + gap: 0.25rem; + align-items: center; + justify-content: center; + background-color: var(--md-default-bg-color); + color: var(--md-default-fg-color); + border-color: transparent; + text-transform: uppercase; + text-align: center; +} +.tx-hero .md-button img { + height: 1rem; + vertical-align: middle; +} + +.tx-hero .md-button--primary { + background-color: var(--md-primary-fg-color); + color: var(--md-default-bg-color); +} + +.tx-hero .md-button:focus, +.tx-hero .md-button:hover { + background-color: var(--md-accent-fg-color); + color: var(--md-default-bg-color); + border-color: var(--md-accent-fg-color); +} + +.feature-item { + display: flex; + flex-direction: column; + align-items: flex-start; + flex: 1 0 0; + align-self: stretch; + border-radius: 0.375rem; + background: #fff; + box-shadow: var(--boxShadowD); +} + +.feature-grid .feature-item { + height: 100%; +} + +.feature-item svg, +.feature-item img { + max-height: 8rem; + object-fit: contain; + padding: 0.5rem; + align-self: stretch; + text-align: center; + border-radius: 0.375rem 0.375rem 0rem 0rem; + border: 6px solid var(--md-primary-fg-color); +} + +.feature-item__description { + padding: 1rem; +} + +.top-hr { + margin-top: 42px; +} + +section + section { + padding: 2rem 0; +} + +.secondary-section { + background: rgb(245, 245, 245) none repeat scroll 0% 0%; + border-top: 1px solid rgb(222, 222, 222); + border-bottom: 1px solid rgb(222, 222, 222); +} + +.dark-section { + background: #2e2b2b; + color: var(--md-default-bg-color); +} + +.dark-section .md-typeset, +.dark-section .md-typeset h2, +.dark-section .md-typeset h3, +.dark-section .supheading { + color: var(--md-default-bg-color); +} +.gradient-section { + background: radial-gradient( + 100% 100% at 47.12% 100%, + rgba(207, 63, 2, 0.12) 0%, + rgba(255, 255, 255, 0) 100% + ), + linear-gradient( + 0deg, + rgba(255, 255, 255, 0.96) 0%, + rgba(255, 255, 255, 0.96) 100% + ), + #443f3f; +} +.gradient-section .supheading { + color: var(--md-default-fg-color); +} +.md-typeset mark { + background: initial; + box-shadow: var(--md-primary-fg-color) 0px -8px 0px 0px inset; +} +.feature-tout { + flex: 1; + width: 100%; +} +.feature-tout .twemoji { + font-size: 4rem; + height: auto; + position: relative; + margin-bottom: 1rem; + color: var(--md-primary-fg-color); +} +.feature-tout .twemoji:after { + position: absolute; + background: rgba(207, 63, 2, 0.12); + border-radius: 100%; + padding: 2.5rem; + content: ''; + top: 50%; + left: 50%; + transform: translate(-50%, -50%); +} + +.feature-grid { + display: grid; + align-items: stretch; + justify-items: center; + list-style: none; + margin: 0; + padding: 0; + grid-template-columns: 1fr; + gap: 1rem; +} + +.figure-collection { + display: flex; + flex-flow: column nowrap; + gap: 1rem; +} + +.figure-collection figure { + display: flex; + flex-flow: column nowrap; + margin: 1rem 0; + gap: 1rem; + position: relative; +} +.figure-collection figure img { + max-width: 100%; +} + +.text-centered { + text-align: center; +} + +.centered { + margin: 0 auto; + padding: 0 0.75rem; +} +.logo-grid { + align-items: center; +} +.logo-grid figure { + mix-blend-mode: luminosity; +} +a > img { + max-width: 100%; +} + +@media screen and (min-width: 40em) { + .tx-hero { + justify-content: stretch; + align-items: flex-start; + } + + .tx-hero__content { + justify-content: flex-start; + align-items: flex-start; + margin: 0; + } + + .tx-hero__content .button-wrapper { + flex-flow: row nowrap; + align-items: flex-start; + } + + .tx-hero__content .lead { + max-width: 60ch; + font-size: 1rem; + } + .feature-grid { + grid-template-columns: repeat(var(--cols), minmax(10px, 1fr)); + } + .figure-collection figure img { + max-width: 75%; + align-self: center; + } + #eoapi-benefits.figure-collection figure:last-of-type:after { + display: block; + position: absolute; + content: ''; + height: clamp(6rem, 14vw, 12rem); + width: 50vw; + background: var(--md-primary-fg-color); + mix-blend-mode: multiply; + border-radius: 0 0.5rem 0.5rem 0; + pointer-events: none; + z-index: -1; + bottom: 12rem; + left: -20vw; + } + + .width-160 { + max-width: 160ch; + } +} + +@media screen and (min-width: 60em) { + .tx-hero { + padding: 4rem 1rem 6rem; + } + .centered { + padding: 0; + } + .figure-collection figure { + flex-flow: row nowrap; + justify-content: flex-start; + gap: 2rem; + align-items: center; + } + + .figure-collection figure > * { + flex: 1; + flex-shrink: 0; + } + + .figure-collection figure img { + max-width: 50%; + } + #eoapi-benefits.figure-collection figure:nth-of-type(even) img { + margin-right: -5rem; + max-width: 100%; + } + #eoapi-benefits.figure-collection figure:nth-of-type(odd) img { + margin-left: -5rem; + max-width: 100%; + } + #eoapi-benefits.figure-collection figure:last-of-type:after { + bottom: 2rem; + left: -30vw; + } + .figure-collection figure:nth-of-type(even) img { + order: 1; + } + + .figure-collection figure > :first-child { + order: var(--figureOrder); + } + .md-typeset h2 { + font-size: 2rem; + line-height: 2.5rem; + } + section + section { + padding: 4rem 0; + } +} diff --git a/overrides/home.html b/overrides/home.html new file mode 100644 index 0000000..d356595 --- /dev/null +++ b/overrides/home.html @@ -0,0 +1,312 @@ + + +{% extends "main.html" %} +{% block tabs %} +{{ super() }} + + + + + +{% endblock %} +{% block content %}{% endblock %} +{% block footer %}{% endblock %} \ No newline at end of file diff --git a/overrides/main.html b/overrides/main.html new file mode 100644 index 0000000..8f500e3 --- /dev/null +++ b/overrides/main.html @@ -0,0 +1,8 @@ +{% extends "base.html" %} + + +{% block extrahead %} + + + +{% endblock %} \ No newline at end of file diff --git a/overrides/stylesheets/extra.css b/overrides/stylesheets/extra.css new file mode 100644 index 0000000..d6a8c82 --- /dev/null +++ b/overrides/stylesheets/extra.css @@ -0,0 +1,41 @@ +:root, +[data-md-color-scheme='default'] { + --md-heading-font: 'Oswald'; + --md-primary-fg-color: #cf3f02; + --md-default-fg-color: #443f3f; + --boxShadowD: 0px 12px 24px 0px rgba(68, 63, 63, 0.08), + 0px 0px 4px 0px rgba(68, 63, 63, 0.08); +} +body { + margin: 0; + padding: 0; + /* font-size: 16px; */ +} +h1, +h2, +h3, +h4, +h5, +h6 { + font-family: var(--md-heading-font); + font-weight: bold; +} +.md-typeset h1, +.md-typeset h2, +.md-typeset h3, +.md-typeset h4 { + font-weight: bold; + color: var(--md-default-fg-color); + margin: 0; +} +.md-button, +.md-typeset .md-button { + font-family: var(--md-heading-font); +} +.md-content .supheading { + font-family: var(--md-heading-font); + text-transform: uppercase; + color: var(--md-primary-fg-color); + font-size: 0.75rem; + font-weight: bold; +} diff --git a/search/search_index.json b/search/search_index.json new file mode 100644 index 0000000..99e5b92 --- /dev/null +++ b/search/search_index.json @@ -0,0 +1 @@ +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"contributing/","title":"Contributing","text":"

Issues and pull requests are more than welcome: github.com/developmentseed/eoAPI/issues

You can also start Discussions in github.com/developmentseed/eoAPI/discussions

dev install

# Download the code\ngit clone https://github.com/developmentseed/eoAPI.git\ncd eoAPI\n\n# Create a virtual environment\npython -m pip install --upgrade virtualenv\nvirtualenv .venv\nsource .venv/bin/activate\n\n# Install the eoapi module\npython -m pip install \"psycopg[binary,pool]\"\npython -m pip install -e runtime/eoapi/raster[\"test\"] # or -e runtime/eoapi/stac[\"test\"]  | -e runtime/eoapi/vector[\"test\"]\n

Danger

Python applications might have incompatible dependencies, which you can resolve by using a virtual environment per application

pre-commit

This repo is set to use pre-commit to run isort, ruff, pydocstring, black (\"uncompromising Python code formatter\") and mypy when committing new code.

$ pre-commit install\n
"},{"location":"contributing/#open-source","title":"Open Source","text":"

You can also contribute indirectly to eoAPI by helping on the sub-modules:

  • PgSTAC database stac-utils/pgstac
  • stac-fastapi: stac-utils/stac-fastapi
  • titiler-pgstac: stac-utils/titiler-pgstac
  • TiTiler: developmentseed/titiler
  • TiPg: developmentseed/tipg
"},{"location":"customization/","title":"Customization","text":"

The eoAPI repository (developmentseed/eoAPI) hosts customized versions of each base service. The documentation below demonstrates how each service can be customized. The eoAPI services can work in parallel or in combination with each other.

"},{"location":"customization/#eoapistac","title":"eoapi.stac","text":"

Built on stac-fastapi.pgstac application, adding a TiTilerExtension and a simple Search Viewer.

The service includes:

  • Full stac-fastapi implementation - see docs if using the docker-compose configuration.
  • Simple STAC Search viewer - see viewer if using the docker-compose configuration.
  • Proxy to the tiler endpoint for STAC Items.

When the TITILER_ENDPOINT environment variable is set (pointing to the raster application), additional endpoints will be added to the stac-fastapi application (see: stac/extension.py):

  • /collections/{collectionId}/items/{itemId}/tilejson.json: Return the raster tilejson for an item
  • /collections/{collectionId}/items/{itemId}/viewer: Redirect to the raster viewer

Code: /runtime/eoapi/stac

"},{"location":"customization/#eoapiraster","title":"eoapi.raster","text":"

The dynamic tiler deployed within eoAPI is built on top of titiler-pgstac and pgstac. It enables large-scale mosaic based on the results of STAC search queries.

The service includes all the default endpoints from titiler-pgstac application and:

  • /: a custom landing page with links to the different endpoints

  • /mosaic/builder: a virtual mosaic builder UI, which helps create and register STAC Search queries

  • /collections: a secret (not in OpenAPI documentation) endpoint used in the mosaic-builder page

  • /collections/{collection_id}/items/{item_id}/viewer: a simple STAC Item viewer

Code: /runtime/eoapi/raster

"},{"location":"customization/#eoapivector","title":"eoapi.vector","text":"

OGC Features and Tiles API built on top of tipg.

By default, the API will look for tables in the public schema of the database. We've also added three functions that connect to the pgSTAC schema:

  • pg_temp.pgstac_collections_view: Simple function which returns PgSTAC Collections
  • pg_temp.pgstac_hash: Return features for a specific searchId (hash)
  • pg_temp.pgstac_hash_count: Return the number of items per geometry for a specific searchId (hash)

Code: /runtime/eoapi/vector

--

"},{"location":"customization/#stac-browser","title":"STAC browser","text":"

The custom browser configuration can be modified using the config located in /dockerfiles/browser_config.js. For more information about available configurations, see the Radiant Earth repository.

"},{"location":"deployment/","title":"Deployment","text":""},{"location":"deployment/#via-eoapi-cdk","title":"Via eoapi-cdk","text":"

eoapi-cdk is a set of AWS CDK constructs that can be used to easily deploy eoAPI services on AWS with the CDK.

eoapi-template is an AWS CDK app that shows how to configure the eoapi-cdk constructs.

An example of Cloud Stack is available for AWS (RDS for the database and Lambda for the APIs).

The stack is deployed by the AWS CDK utility. Under the hood, CDK will create the deployment packages required for AWS Lambda, upload them to AWS, and handle the creation of the Lambda and API Gateway resources.

The example commands here will deploy a CloudFormation stack called eoAPI-staging.

  1. Clone the eoapi repo and install dependencies 

    # Download eoapi repo\ngit clone https://github.com/developmentseed/eoapi.git\n\n# Create a virtual environment\npython -m pip install --upgrade virtualenv\nvirtualenv infrastructure/aws/.venv\nsource infrastructure/aws/.venv/bin/activate\n\n# install cdk dependencies\npython -m pip install -r infrastructure/aws/requirements-cdk.txt\n

  2. Install node dependency - requires node version 14+ 

    npm --prefix infrastructure/aws install\n

  3. Update settings

    Set environment variable or complex code in the infrastructure/aws/.env file (e.g., CDK_EOAPI_DB_PGSTAC_VERSION=0.7.1).

    To modify the size of the burstable database instance, modify CDK_EOAPI_DB_INSTANCE_SIZE to one of the values of aws_cdk.aws_ec2.InstanceSize. The default size is SMALL.

    Important:

    • CDK_EOAPI_DB_PGSTAC_VERSION is a required env (see github.com/stac-utils/pgstac/tags for the latest version)

    • You can choose which functions to deploy by setting CDK_EOAPI_FUNCTIONS env (e.g., CDK_EOAPI_FUNCTIONS='[\"stac\",\"raster\",\"vector\"]')

  4. Install CDK and connect to your AWS account. This step is only necessary once per AWS account. The environment variable CDK_EOAPI_STAGE determines the name of the stack (e.g., eoAPI-staging or eoAPI-production) 

    # Deploy the CDK toolkit stack into an AWS environment.\nCDK_EOAPI_STAGE=staging \\\nCDK_EOAPI_DB_PGSTAC_VERSION=0.7.1 \\\nnpm --prefix infrastructure/aws run cdk -- bootstrap\n\n# or to a specific region\nAWS_DEFAULT_REGION=us-west-2 \\\nAWS_REGION=us-west-2 \\\nCDK_EOAPI_STAGE=staging \\\nCDK_EOAPI_DB_PGSTAC_VERSION=0.7.1 \\\nnpm --prefix infrastructure/aws run cdk -- bootstrap\n

  5. Pre-Generate CFN template

    CDK_EOAPI_STAGE=staging \\\nCDK_EOAPI_DB_PGSTAC_VERSION=0.7.1 \\\nnpm --prefix infrastructure/aws run cdk -- synth  # Synthesizes and prints the CloudFormation template for this stack\n

  6. Deploy

    CDK_EOAPI_STAGE=staging \\\nCDK_EOAPI_DB_PGSTAC_VERSION=0.7.1 \\\nnpm --prefix infrastructure/aws run cdk -- deploy eoAPI-staging\n\n# Deploy in a specific region\nAWS_DEFAULT_REGION=eu-central-1 \\\nAWS_REGION=eu-central-1 \\\nCDK_EOAPI_STAGE=staging \\\nCDK_EOAPI_DB_PGSTAC_VERSION=0.7.1 \\\nnpm --prefix infrastructure/aws run cdk -- deploy eoapi-staging --profile {my-aws-profile}\n

If you get an error saying that the max VPCs have been reached, you have hit the limit for the number of VPCs per unique AWS account and region combination. You can change the AWS region to a region with fewer VPCs and deploy again to fix this.

"},{"location":"deployment/#via-eoapi-k8s","title":"Via eoapi-k8s","text":"

eoapi-k8s has the IaC and Helm charts for deploying eoAPI services on AWS and GCP.

Getting started

If you still need to set up a k8s cluster on AWS or GCP, then follow an IaC guide below that is relevant to you.

\u24d8 The helm chart in this repo assumes your cluster has a few third-party add-ons and controllers installed. So It's in your best interest to read through the IaC guides to understand what those defaults are

  • AWS EKS Cluster Setup

  • TBD: GCP GKE Cluster Setup

Helm Installation

Once you have a k8s cluster set up, you can helm install eoAPI as follows

  1. helm install from this repo's helm-chart/ folder:

      ######################################################\n  # create os environment variables for required secrets\n  ######################################################\n  $ export GITSHA=$(git rev-parse HEAD | cut -c1-10)\n  $ export PGUSER=s00pers3cr3t\n  $ export POSTGRES_USER=s00pers3cr3t\n  $ export POSTGRES_PASSWORD=superuserfoobar\n  $ export PGPASSWORD=foobar\n\n  $ cd ./helm-chart\n\n  $ helm install \\\n      --namespace eoapi \\\n      --create-namespace \\\n      --set gitSha=$GITSHA \\\n      --set db.settings.secrets.PGUSER=$PGUSER \\\n      --set db.settings.secrets.POSTGRES_USER=$POSTGRES_USER \\\n      --set db.settings.secrets.PGPASSWORD=$PGPASSWORD \\\n      --set db.settings.secrets.POSTGRES_PASSWORD=$POSTGRES_PASSWORD \\\n      eoapi \\\n      ./eoapi\n

  2. or helm install from devseed.com/eoapi-k8s/:

      # add the eoapi helm repo locally\n  $ helm repo add eoapi https://devseed.com/eoapi-k8s/\n\n  # List out the eoapi chart versions\n  $ helm search repo eoapi\n  NAME            CHART VERSION   APP VERSION     DESCRIPTION\n  eoapi/eoapi     0.1.1           0.1.0           Create a full Earth Observation API with Metada...\n  eoapi/eoapi     0.1.2           0.1.0           Create a full Earth Observation API with Metada...\n\n  # add the required secret overrides to an arbitrarily named `.yaml` file (`config.yaml` below)\n  $ cat config.yaml\n  db:\n    settings:\n      secrets:\n        PGUSER: \"username\"\n        POSTGRES_USER: \"username\"\n        PGPASSWORD: \"password\"\n        POSTGRES_PASSWORD: \"password\"\n\n  # then run `helm install` with those overrides\n  helm install eoapi eoapi/eoapi --version 0.1.1 -f config.yaml\n
"},{"location":"intro/","title":"Intro","text":"

Create a full Earth Observation API with Metadata, Raster, and Vector services.

"},{"location":"intro/#earth-observation-api","title":"Earth Observation API","text":"

eoAPI combines several state-of-the-art projects to create a full Earth Observation API. Each service can be used and deployed independently, but eoAPI creates the interconnections between each service:

  • pgSTAC database stac-utils/pgstac

  • STAC API built on top of stac-utils/stac-fastapi

  • STAC browser a UI that exposes, in a user friendly interface, the metadata served by the STAC API. Built on top of radiantearth/stac-browser

  • STAC Items And Mosaic Raster Tiles API built on top of stac-utils/titiler-pgstac

  • OGC Features and Vector Tiles API built on top of developmentseed/tipg

"},{"location":"intro/#eoapi-an-open-source-community-project","title":"\ud83c\udf0d eoAPI: An Open-Source Community Project","text":"

eoAPI is proudly open-source and driven by a dedicated community of contributors. We believe in the power of open collaboration and welcome anyone to contribute, discuss, and grow this tool. Join the conversations on GitHub Discussions and make a difference in the Earth Observation realm.

"},{"location":"intro/#why-should-you-use-eoapi","title":"Why should you use eoAPI","text":"

  • Focus on your use case: eoAPI\u00a0is used for large-scale data processing, building geographic information systems (GIS), creating real-time data applications, climate research and environmental monitoring, machine learning model training, and more.

  • Unified Repository: eoAPI\u00a0provides a single, unified repository for several state-of-the-art Earth Observation (EO) data services, including Metadata search (STAC), Raster, and Vector services. This can simplify the process of accessing and working with these services.

  • Interoperability: eoAPI\u00a0is designed to enable interoperability among its included services. This can make building complex applications that leverage different types of EO data easier.

  • Open Source and Community Support:\u00a0As an open-source project,\u00a0eoAPI\u00a0allows developers to inspect its code, contribute to its development, and use it as a base for custom solutions. It also benefits from the support and innovation of a community of developers and EO data users.

  • Scalability and Flexibility:\u00a0Each service in\u00a0eoAPI\u00a0can be used or deployed independently, which provides a lot of flexibility. If a developer's application only requires one or two of eoAPI's services, they don't need to deploy the entire suite.

  • Facilitate Earth Observation Tasks: eoAPI\u00a0includes specialized tools for working with EO data, such as dynamic tiling, metadata searching, and features/vector tiles API. These can significantly facilitate EO data processing, analysis, and visualization.

  • Ease of Deployment: eoAPI\u00a0supports containerized deployment using Docker, making it easier to set up, scale, and maintain applications built on it. Spin up the demo locally and start experimenting in minutes.

"},{"location":"intro/#services-overview","title":"Services Overview","text":"

  • STAC Metadata: Built with stac-fastapi.pgstac to enable data discovery. See the specifications core, search and features for API details.

  • STAC browser : Built with the Radiant Earth STAC browser to provide a simple user-friendly interface for searching the STAC metadata.

  • Raster Tiles: Built with titiler-pgstac and pgstac to enable large scale mosaic based on results of STAC searches queries. See docs for API details.

  • OGC Features & Vector Tiles: Built with tipg to create a lightweight OGC Features and Tiles API with a PostGIS database. See docs for API details.

See service details for more information.

"},{"location":"intro/#getting-started","title":"Getting started","text":"

The easiest way to start exploring the different eoAPI services is with Docker. Clone this repository and start the multi-container Docker applications using Compose:

git clone https://github.com/developmentseed/eoAPI.git\ncd eoAPI\ndocker compose up\n

Once the applications are up, you'll need to add STAC Collections and Items to the PgSTAC database. If you don't have, you can use the follow the MAXAR open data demo (or get inspired by the other demos).

Then you can start exploring your dataset with:

  • the STAC Metadata service http://localhost:8081
  • the Raster service http://localhost:8082

Info

If you've added vector datasets to the public schema in the Postgres database, they will be available through the Vector service at http://localhost:8083.

Alternatively, you may install and launch applications locally:

python -m pip install --upgrade virtualenv\nvirtualenv .venv\nsource .venv/bin/activate\n\nexport DATABASE_URL=postgresql://username:password@0.0.0.0:5439/postgis  # Connect to the database of your choice\n\npython -m pip install uvicorn\n\n###############################################################################\n# Install and launch the application\n# Select one of the following\n\n###############################################################################\n# STAC\npython -m pip install \"psycopg[binary,pool]\" stac-fastapi-pgstac\n.venv/bin/uvicorn stac_fastapi.pgstac.app:app --port 8081 --reload\n\n###############################################################################\n# RASTER\npython -m pip install \"psycopg[binary,pool]\" titiler-pgstac\n.venv/bin/uvicorn titiler.pgstac.main:app --port 8082 --reload\n\n###############################################################################\n# VECTOR\npython -m pip install tipg\n.venv/bin/uvicorn tipg.main:app --port 8083 --reload\n

Danger

Python applications might have incompatible dependencies, which you can resolve by using a virtual environment per application

"},{"location":"services/","title":"Services","text":"

eoAPI combines several state-of-the-art projects to create an entire Earth Observation API. Each service can be used and deployed independently, but eoAPI creates the interconnections between each service:

  • pgSTAC database stac-utils/pgstac
  • STAC API built on top of stac-utils/stac-fastapi
  • STAC Items And Mosaic Raster Tiles API built on top of stac-utils/titiler-pgstac
  • OGC Features and Vector Tiles API built on top of developmentseed/tipg
"},{"location":"services/#database","title":"Database","text":"

The STAC database is at the heart of eoAPI and is the only mandatory service. We use PgSTAC Postgres schema and functions, which provides functionality for STAC Filters, CQL2 search, and utilities to help manage the indexing and partitioning of STAC Collections and Items.

PgSTAC is used in production to scale to hundreds of millions of STAC items. PgSTAC implements core data models and functions to provide a STAC API from a PostgreSQL database. PgSTAC is entirely within the database and does not provide an HTTP-facing API. The Stac FastAPI PgSTAC backend and Franklin can be used to expose a PgSTAC catalog. Integrating PgSTAC with any other language with PostgreSQL drivers is also possible.

PgSTAC Documentation: stac-utils.github.io/pgstac/pgstac

pyPgSTAC Documentation: stac-utils.github.io/pgstac/pypgstac

"},{"location":"services/#metadata","title":"Metadata","text":"

The Metadata service deployed in eoAPI is built on stac-fastapi.pgstac application.

By default, the STAC metadata service will have a set of endpoints to search and list STAC collections and items.

Example

  • stac.eoapi.dev landing page

  • stac.eoapi.dev/collections list available Collection

  • stac.eoapi.dev/collections/MAXAR_southafrica_flooding22/items list available Items for the MAXAR_southafrica_flooding22 collection

  • stac.eoapi.dev/collections/MAXAR_southafrica_flooding22/items/36_213131033000_1040010076566100 get 36_213131033000_1040010076566100 Item in the MAXAR_southafrica_flooding22 collection

  • stac.eoapi.dev/search list of Items in the catalog

  • stac.eoapi.dev/search?collections=MAXAR_Kahramanmaras_turkey_earthquake_23&limit=5&datetime=2023-02-06T00:00:00Z/2023-02-10T00:00:00Z list of Items in the catalog for the MAXAR_Kahramanmaras_turkey_earthquake_23 collection between February 6th and 10th

"},{"location":"services/#raster","title":"Raster","text":"

The Raster service deployed in eoAPI is built on top of titiler-pgstac.

It enables Raster visualization for a single STAC Item and large-scale (multi collections/items) mosaic based on STAC search queries.

Example

  • raster.eoapi.dev landing page

Items endpoints

  • raster.eoapi.dev/collections/MAXAR_southafrica_flooding22/items/36_213131033000_1040010076566100/info get Raster metadata information about Assets found in 36_213131033000_1040010076566100 Item in the MAXAR_southafrica_flooding22 collection

  • raster.eoapi.dev/collections/MAXAR_southafrica_flooding22/items/36_213131033000_1040010076566100/info?assets=visual get Raster metadata information only for the visual Asset

  • raster.eoapi.dev/collections/MAXAR_southafrica_flooding22/items/36_213131033000_1040010076566100/map?assets=visual&minzoom=12&maxzoom=19 show the visual Asset on a Map client

  • raster.eoapi.dev/collections/MAXAR_southafrica_flooding22/items/36_213131033000_1040010076566100/tilejson.json?assets=ms_analytic&minzoom=13&maxzoom=17&asset_bidx=ms_analytic|8,2,1&rescale=0,4000 get a TileJSON document for the ms_analytic Asset with band combination 8,2,1 with values rescaling from 0,4000 to 0,255

Mosaic endpoints

  • raster.eoapi.dev/searches/list list pre-registered Virtual Mosaics

  • raster.eoapi.dev/searches/2f3073257a5b6530aedbb0e4b4f726fa/info get information about the 2f3073257a5b6530aedbb0e4b4f726fa mosaic

  • raster.eoapi.dev/searches/2f3073257a5b6530aedbb0e4b4f726fa/map?assets=visual&minzoom=12&maxzoom=19 show the 2f3073257a5b6530aedbb0e4b4f726fa mosaic and using the visual Asset on a Map client

  • raster.eoapi.dev/searches/2f3073257a5b6530aedbb0e4b4f726fa/tilejson.json?assets=visual&minzoom=12&maxzoom=19 get a TileJSON document for the 2f3073257a5b6530aedbb0e4b4f726fa mosaic and using the visual Asset

"},{"location":"services/#vector","title":"Vector","text":"

The OGC Features and (Mapbox Vector) Tiles API service deployed in eoAPI is built on top of tipg).

It enables vector Features/Features Collection exploration and visualization for Tables stored in the Postgres database (in the public schema).

Example

  • vector.eoapi.dev landing page

OGC Features

  • vector.eoapi.dev/collections list available Tables or Function Layers

  • vector.eoapi.dev/collections/public.countries get information about the countries Table

  • vector.eoapi.dev/collections/public.countries/items list items for the countries Table

OGC Tiles

  • vector.eoapi.dev/collections/public.countries/tiles list all TileSet available for the countries Table

  • vector.eoapi.dev/collections/public.countries/tiles/WebMercatorQuad get WebMercatorQuad TileSet information for the countries Table

  • vector.eoapi.dev/collections/public.countries/viewer shows the countries Table on a Map client using vector tiles

  • vector.eoapi.dev/tileMatrixSets/WebMercatorQuad WebMercatorQuad TileMatrixSet information

"},{"location":"services/#browsing-ui","title":"Browsing UI","text":"

The browsing UI deployed in eoAPI is built on the radiant earth STAC browser, and provides a configurable, user-friendly interface to search across and within collections and quickly visualize single items assets.

Example

  • eoapi-dev-stac-browser.s3-website-us-east-1.amazonaws.com landing page
"}]} \ No newline at end of file diff --git a/services/index.html b/services/index.html new file mode 100644 index 0000000..8ba1ccd --- /dev/null +++ b/services/index.html @@ -0,0 +1,989 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Services - The Earth Observation API + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + + + + + + +
+ +
+ + + + +
+
+ + + +
+
+
+ + + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Services

+ +

eoAPI combines several state-of-the-art projects to create an entire Earth Observation API. Each service can be used and deployed independently, but eoAPI creates the interconnections between each service:

+ +

Database

+

The STAC database is at the heart of eoAPI and is the only mandatory service. We use PgSTAC Postgres schema and functions, which provides functionality for STAC Filters, CQL2 search, and utilities to help manage the indexing and partitioning of STAC Collections and Items.

+
+

PgSTAC is used in production to scale to hundreds of millions of STAC items. PgSTAC implements core data models and functions to provide a STAC API from a PostgreSQL database. PgSTAC is entirely within the database and does not provide an HTTP-facing API. The Stac FastAPI PgSTAC backend and Franklin can be used to expose a PgSTAC catalog. Integrating PgSTAC with any other language with PostgreSQL drivers is also possible.

+

PgSTAC Documentation: stac-utils.github.io/pgstac/pgstac

+

pyPgSTAC Documentation: stac-utils.github.io/pgstac/pypgstac

+
+

Metadata

+

The Metadata service deployed in eoAPI is built on stac-fastapi.pgstac application.

+

By default, the STAC metadata service will have a set of endpoints to search and list STAC collections and items.

+

+stac-fastapi +

+ +
+

Example

+ +
+
+

Raster

+

The Raster service deployed in eoAPI is built on top of titiler-pgstac.

+

It enables Raster visualization for a single STAC Item and large-scale (multi collections/items) mosaic based on STAC search queries.

+

+titiler-pgstac +

+ +
+

Example

+ +

Items endpoints

+ +

Mosaic endpoints

+ +
+
+

Vector

+

The OGC Features and (Mapbox Vector) Tiles API service deployed in eoAPI is built on top of tipg).

+

It enables vector Features/Features Collection exploration and visualization for Tables stored in the Postgres database (in the public schema).

+

+tipg +

+ +
+

Example

+ +

OGC Features

+ +

OGC Tiles

+ +
+

Browsing UI

+

The browsing UI deployed in eoAPI is built on the radiant earth STAC browser, and provides a configurable, user-friendly interface to search across and within collections and quickly visualize single items assets.

+

+stac-fastapi +

+ +
+

Example

+ +
+ + + + + + + + + + + + + +
+
+ + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml new file mode 100644 index 0000000..0f8724e --- /dev/null +++ b/sitemap.xml @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz new file mode 100644 index 0000000000000000000000000000000000000000..c6c4131a9783496ebfb32645ecc6cf011f909f97 GIT binary patch literal 127 zcmV-_0D%7=iwFpSteIv4|8r?{Wo=<_E_iKh04<9_3V)_WXo8&M?ytk3HC}0~zlG)Vu
+ +
+
+
+
+

eoAPI

+

Earth Observation Data at Scale

+

Deployed in minutes

+

eoAPI makes massive earth observation (EO) data archives discoverable and + interoperable—the fastest and easiest way to configure, customize, and deploy a full Earth + Observation stack.

+
+ + Get Started + + {% include ".icons/material/arrow-right.svg" %} + + + + View on GitHub + + {% include ".icons/simple/github.svg" %} + + + +
+

+ {% include ".icons/material/information-outline.svg" %} + Photo + ©NASA +

+ +
+
+
+
+ + +
+
+
+
+
What is eoAPI?
+

State-of-the-art services to enable data discovery, search, + visualization, and access. + +

+
+

eoAPI presents an open-source and reusable framework for harnessing earth + observation data. eoAPI takes the work out of constructing a cloud-native EO infrastructure through + a set of sensible defaults that fit most EO and geospatial infrastructure needs. Built with + modularity as a core principle, eoAPI can easily be customized to your needs.

+
+
+
    +
  • +
    + + {% include ".icons/material/database-marker-outline.svg" %} + +

    STAC Powered

    +

    A suite of STAC-focused technologies that consistently perform well as a backend

    +
    +
    • +
  • +
    + + {% include ".icons/material/folder-home.svg" %} + +

    Sensible Defaults

    +

    Seamless deployment, configuration, and customization while preserving flexibility. +

    +
    +
    • +
  • +
    + + {% include ".icons/material/cloud-braces.svg" %} + +

    Cloud agnostic

    +

    Quickly deploy, configure, and scale EO services, anywhere.

    +
    +
    • +
+
+
+
+ + +
+
+
+
+
End-To-End Earth Observation Infrastructure
+
+
    +
  • +
    + pgstac logo +
    +

    + Catalog Your Data +

    +
    + pgSTAC - Postgres STAC Extension +
    +

    pg-STAC is an optimized Postgres schema to index and search large-scale STAC + collections. +

    + stac-utils/pgstac +

    +
    +
    • +
    + stac-fastapi logo +
    +

    + Make it Searchable +

    +
    + stac-fastapi - REST API Service +
    +

    stac-fastapi is an Open Geospatial Consortium (OGC) Features API compliant FastAPI + application for STAC metadata search. +

    + stac-utils/stac-fastapi + +

    +
    +
    + titiler-pgstac logo +
    +

    + Visualize Raster Data +

    +
    + titiler-pgstac - Raster Tiling Service +
    +

    titiler-pgSTAC is a TiTiler extension that connects to pgSTAC to support large-scale + dynamic mosaic tiling for visualizing STAC collections and items. +

    + stac-utils/titiler-pgstac + +
    +
    +
    + tipg logo +
    +

    + Visualize Vector Data +

    +
    + tipg - Vector Tiling Service +
    +

    tipg is an Open Geospatial Consortium (OGC) Features and Tiles API for vector datasets. +

    + developmentseed/tipg +
    +
    +
+
+
+
+ + +
+
+
+
+
harness eoapi benefits
+
+
+
+ Download eoAPI and deploy anywhere +
+

Download and Deploy

+

Get started by downloading all the eoAPI resources you need. With our easy-to-follow + guides and documentation, you'll have eoAPI up and running in minutes.

+
+
+
+ Ingest your data +
+

Ingest Data & Metadata

+

Whether working with raster or vector data, eoAPI's flexible design allows you to + ingest STAC Collections quickly. +

+
+
+
+ Share imagery +
+

Share, Visualize, and Analyze

+

Now that your data is ingested, eoAPI provides the tools to share, + visualize, and analyze it. From simple sharing options to advanced analytics + capabilities, eoAPI is designed to help you make the most out of your geospatial data. +

+ +
+
+ +
+
+
+
+ + +
+
+
+
+
Why eoAPI
+

We believe that the community of people who would benefit from STAC is + larger than the current + core + community and early adopters of STAC.

+
+

The potential of Earth Observation data is immense in helping us understand our + ever-changing planet. To fulfill this potential, we must provide EO data that can be easily + integrated into modern applications and decision-making tools. It's crucial that it's easy to + discover, interoperable, ingestible, and optimized for applications. This is a significant challenge + for many organizations, and our mission at Development Seed is to address this challenge.

+
+
+
+ +
+
+
+
+
eoAPI in action
+
+
+
+
+

NASA IMPACT's VEDA Project

+

NASA IMPACT is leading the way for how NASA (and space agencies worldwide) can increase + the + societal impact of their data through cloud-optimized data distribution. They've + invested + significant resources in advancing modern public EO data standards, tools, and + platforms. + You + can see eoAPI services in action throughout the VEDA platform.

+
+ NASA VEDA platform screenshot +
+
+
+
+
+ +
+
+
+
+
+
Bespoke Solutions
+

Want to discuss a customized solution for your needs? +

+ Contact us +
+
+
Driven by Community
+

eoAPI is a community-driven initiative built on collaboration. We welcome your contributions, + feedback, and suggestions. Join the discussion or open a pull request in the + eoAPI + repository +

+
+
+ Development Seed Logo +
+
+
+