diff --git a/CHANGES.rst b/CHANGES.rst index e3d9ba6..8cef7e4 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,2 +1,59 @@ +0.5.3 +^^^^^ +- v0.5.3: 0.5.1 with: +-- tests that pass +-- Sage removed +-- Test fixes where just relating to rounding errors. + +- dggs.py: +-- RG, 2020-09-08: Issue #6 Added optional region="none" arg to rhealpix projection calls, and + forced region to cell.region() in cell.vertex() and cell.boundary() +-- RG, 2020-07-31: Issue #5 Moved plot_cells to GRS2013 to remove sage dependence +-- Robert Gibb (RG), 2020-07-13: Issue #1 Multiple tests fail due to rounding errors + +- ellipsoids.py: +-- Robert Gibb (RG), 2020-07-13: Issue #1 Multiple tests fail due to rounding errors + +- pj_healpix.py: +-- RG, 2020-09-08: Issue #6 In in_healpix_image added +-eps to the extreme corner vertices + added calling function abbrev to error statements +-- RG, 2020-07-31: Issue #5 Moved healpix_diagram to GRS2013 to remove sage dependence +-- Robert Gibb (RG), 2020-07-13: Issue #1 Multiple tests fail due to rounding errors + +- pj_rhealpix.py: +-- RG, 2020-09-08: Issue #6 Added optional region="none" arg to all projection calls, and + used it to enforce region behaviour in calls to combine_triangles + added calling function abbrev to error statements +-- RG, 2020-07-31: Issue #5 Moved rhealpix_diagram to GRS2013 to remove sage dependence +-- Robert Gibb (RG), 2020-07-13: Issue #1 Multiple tests fail due to rounding errors + +- projection_wrapper.py: +-- RG, 2020-09-08: Issue #6 Added optional region="none" arg to all projection calls +-- Robert Gibb (RG), 2020-07-13: Issue #1 Multiple tests fail due to rounding errors + +- utils.py: +-- Robert Gibb (RG), 2020-07-13: Issue #1 Multiple tests fail due to rounding errors + +0.5.1 +^^^^^ +- v0.5.1, 2013-07-29: Port to Python 3.7 +- Rounded floats in doctests. + +0.5 +^^^ - v0.5, 2013-07-26: Port to Python 3.3. -- v0.5.1, 2013-07-29: Rounded floats in doctests. + +- dggs.py: +-- AR, 2013-03-14: Fixed bug in nw_vertex(). +-- AR, 2013-01-16: Changed the string keyword 'surface' to a boolean keyword 'plane'. +-- AR, 2013-01-14: Added intersects_meridian(), cell_latitudes(), cells_from_meridian(), cells_from_parallel(), cells_from_region(). +-- AR, 2013-01-01: Added ellipsoidal functionality to neighbor() and neighbors(). +-- AR, 2012-12-19: Tested all the methods and added examples. +-- AR, 2012-12-10: Corrected centroid() and moved some methods from graphics.py to here. + +- pj_healpix.py: +-- AR, 2013-03-05: In in_healpix_image() increased eps to 1e-10 to decrease out-of-bounds errors i was getting when drawing figures. + +Older releases +^^^^^^^^^^^^^^ +For releases 0.3, 0.4 & 0.5, see the ``_old`` folder within the `0.5.1 release `_ on GitHub diff --git a/README.rst b/README.rst index ec93b37..59452ca 100644 --- a/README.rst +++ b/README.rst @@ -10,20 +10,11 @@ Release Notes ------------- This package was originally authored in 2013 and has had only minor code updates since then. -0.5.3 - current +0.5.4 - current ^^^^^^^^^^^^^^^ -0.5.1 with: -* tests that pass -* Sage removed -* Test fixes where just relating to rounding errors. - -0.5.1 -^^^^^ -Code unchanged from 2013 other than updating to Python 3.7. - -Pre-0.5.1 -^^^^^^^^^ -For releases 0.3, 0.4 & 0.5, see the ``_old`` folder within the `0.5.1 release `_ on GitHub +Code unchanged from 0.5.3 other than updating to Python 3.11 + +Refer to file CHANGES.rst for a more detailed history of changes. Requirements ------------- diff --git a/docs/build/Makefile b/docs/build/Makefile deleted file mode 100644 index 76e7c3e..0000000 --- a/docs/build/Makefile +++ /dev/null @@ -1,66 +0,0 @@ -# Makefile for Sphinx LaTeX output - -ALLDOCS = $(basename $(wildcard *.tex)) -ALLPDF = $(addsuffix .pdf,$(ALLDOCS)) -ALLDVI = $(addsuffix .dvi,$(ALLDOCS)) - -# Prefix for archive names -ARCHIVEPRREFIX = -# Additional LaTeX options -LATEXOPTS = - -all: $(ALLPDF) -all-pdf: $(ALLPDF) -all-dvi: $(ALLDVI) -all-ps: all-dvi - for f in *.dvi; do dvips $$f; done - -all-pdf-ja: - for f in *.pdf *.png *.gif *.jpg *.jpeg; do ebb $$f; done - for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done - for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done - for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done - for f in *.idx; do mendex -U -f -d "`basename $$f .idx`.dic" -s python.ist $$f; done - for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done - for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done - for f in *.dvi; do dvipdfmx $$f; done - -zip: all-$(FMT) - mkdir $(ARCHIVEPREFIX)docs-$(FMT) - cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT) - zip -q -r -9 $(ARCHIVEPREFIX)docs-$(FMT).zip $(ARCHIVEPREFIX)docs-$(FMT) - rm -r $(ARCHIVEPREFIX)docs-$(FMT) - -tar: all-$(FMT) - mkdir $(ARCHIVEPREFIX)docs-$(FMT) - cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT) - tar cf $(ARCHIVEPREFIX)docs-$(FMT).tar $(ARCHIVEPREFIX)docs-$(FMT) - rm -r $(ARCHIVEPREFIX)docs-$(FMT) - -bz2: tar - bzip2 -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar - -# The number of LaTeX runs is quite conservative, but I don't expect it -# to get run often, so the little extra time won't hurt. -%.dvi: %.tex - latex $(LATEXOPTS) '$<' - latex $(LATEXOPTS) '$<' - latex $(LATEXOPTS) '$<' - -makeindex -s python.ist '$(basename $<).idx' - latex $(LATEXOPTS) '$<' - latex $(LATEXOPTS) '$<' - -%.pdf: %.tex - pdflatex $(LATEXOPTS) '$<' - pdflatex $(LATEXOPTS) '$<' - pdflatex $(LATEXOPTS) '$<' - -makeindex -s python.ist '$(basename $<).idx' - pdflatex $(LATEXOPTS) '$<' - pdflatex $(LATEXOPTS) '$<' - -clean: - rm -f *.dvi *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla - -.PHONY: all all-pdf all-dvi all-ps clean -.PHONY: all-pdf-ja - diff --git a/docs/build/doctrees/dggs.doctree b/docs/build/doctrees/dggs.doctree index e79cc66..eb12509 100644 Binary files a/docs/build/doctrees/dggs.doctree and b/docs/build/doctrees/dggs.doctree differ diff --git a/docs/build/doctrees/distortion.doctree b/docs/build/doctrees/distortion.doctree deleted file mode 100644 index 8e9a487..0000000 Binary files a/docs/build/doctrees/distortion.doctree and /dev/null differ diff --git a/docs/build/doctrees/ellipsoids.doctree b/docs/build/doctrees/ellipsoids.doctree index 0c18d83..3b9a2b3 100644 Binary files a/docs/build/doctrees/ellipsoids.doctree and b/docs/build/doctrees/ellipsoids.doctree differ diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index 32378f2..1f921a0 100644 Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree index e5d2255..13fa1d2 100644 Binary files a/docs/build/doctrees/index.doctree and b/docs/build/doctrees/index.doctree differ diff --git a/docs/build/doctrees/index2.doctree b/docs/build/doctrees/index2.doctree deleted file mode 100644 index fd7aaaf..0000000 Binary files a/docs/build/doctrees/index2.doctree and /dev/null differ diff --git a/docs/build/doctrees/introduction.doctree b/docs/build/doctrees/introduction.doctree index 6ef792b..8343a7d 100644 Binary files a/docs/build/doctrees/introduction.doctree and b/docs/build/doctrees/introduction.doctree differ diff --git a/docs/build/doctrees/pj_healpix.doctree b/docs/build/doctrees/pj_healpix.doctree index 7ba87e9..02e16f7 100644 Binary files a/docs/build/doctrees/pj_healpix.doctree and b/docs/build/doctrees/pj_healpix.doctree differ diff --git a/docs/build/doctrees/pj_rhealpix.doctree b/docs/build/doctrees/pj_rhealpix.doctree index b1e88de..701c5c5 100644 Binary files a/docs/build/doctrees/pj_rhealpix.doctree and b/docs/build/doctrees/pj_rhealpix.doctree differ diff --git a/docs/build/doctrees/projection_tools.doctree b/docs/build/doctrees/projection_tools.doctree deleted file mode 100644 index 4fb64a8..0000000 Binary files a/docs/build/doctrees/projection_tools.doctree and /dev/null differ diff --git a/docs/build/doctrees/projection_wrapper.doctree b/docs/build/doctrees/projection_wrapper.doctree index ba159ca..c05d2dc 100644 Binary files a/docs/build/doctrees/projection_wrapper.doctree and b/docs/build/doctrees/projection_wrapper.doctree differ diff --git a/docs/build/doctrees/rhealpix_dggs.doctree b/docs/build/doctrees/rhealpix_dggs.doctree deleted file mode 100644 index 0e4fbb1..0000000 Binary files a/docs/build/doctrees/rhealpix_dggs.doctree and /dev/null differ diff --git a/docs/build/doctrees/utils.doctree b/docs/build/doctrees/utils.doctree index 12bc18e..d6844f7 100644 Binary files a/docs/build/doctrees/utils.doctree and b/docs/build/doctrees/utils.doctree differ diff --git a/docs/build/fncychap.sty b/docs/build/fncychap.sty deleted file mode 100644 index 9a56c04..0000000 --- a/docs/build/fncychap.sty +++ /dev/null @@ -1,683 +0,0 @@ -%%% Copyright Ulf A. Lindgren -%%% -%%% Note Premission is granted to modify this file under -%%% the condition that it is saved using another -%%% file and package name. -%%% -%%% Revision 1.1 (1997) -%%% -%%% Jan. 8th Modified package name base date option -%%% Jan. 22th Modified FmN and FmTi for error in book.cls -%%% \MakeUppercase{#}->{\MakeUppercase#} -%%% Apr. 6th Modified Lenny option to prevent undesired -%%% skip of line. -%%% Nov. 8th Fixed \@chapapp for AMS -%%% -%%% Revision 1.2 (1998) -%%% -%%% Feb. 11th Fixed appendix problem related to Bjarne -%%% Aug. 11th Fixed problem related to 11pt and 12pt -%%% suggested by Tomas Lundberg. THANKS! -%%% -%%% Revision 1.3 (2004) -%%% Sep. 20th problem with frontmatter, mainmatter and -%%% backmatter, pointed out by Lapo Mori -%%% -%%% Revision 1.31 (2004) -%%% Sep. 21th problem with the Rejne definition streched text -%%% caused ugly gaps in the vrule aligned with the title -%%% text. Kindly pointed out to me by Hendri Adriaens -%%% -%%% Revision 1.32 (2005) -%%% Jun. 23th compatibility problem with the KOMA class 'scrbook.cls' -%%% a remedy is a redefinition of '\@schapter' in -%%% line with that used in KOMA. The problem was pointed -%%% out to me by Mikkel Holm Olsen -%%% -%%% Revision 1.33 (2005) -%%% Aug. 9th misspelled ``TWELV'' corrected, the error was pointed -%%% out to me by George Pearson -%%% -%%% Revision 1.34 (2007) -%%% Added an alternative to Lenny provided by Peter -%%% Osborne (2005-11-28) -%%% Corrected front, main and back matter, based on input -%%% from Bas van Gils (2006-04-24) -%%% Jul. 30th Added Bjornstrup option provided by Jean-Marc -%%% Francois (2007-01-05). -%%% Reverted to \MakeUppercase{#} see rev 1.1, solved -%%% problem with MakeUppercase and MakeLowercase pointed -%%% out by Marco Feuerstein (2007-06-06) - - -%%% Last modified Jul. 2007 - -\NeedsTeXFormat{LaTeX2e}[1995/12/01] -\ProvidesPackage{fncychap} - [2007/07/30 v1.34 - LaTeX package (Revised chapters)] - -%%%% For conditional inclusion of color -\newif\ifusecolor -\usecolorfalse - - - -%%%% DEFINITION OF Chapapp variables -\newcommand{\CNV}{\huge\bfseries} -\newcommand{\ChNameVar}[1]{\renewcommand{\CNV}{#1}} - - -%%%% DEFINITION OF TheChapter variables -\newcommand{\CNoV}{\huge\bfseries} -\newcommand{\ChNumVar}[1]{\renewcommand{\CNoV}{#1}} - -\newif\ifUCN -\UCNfalse -\newif\ifLCN -\LCNfalse -\def\ChNameLowerCase{\LCNtrue\UCNfalse} -\def\ChNameUpperCase{\UCNtrue\LCNfalse} -\def\ChNameAsIs{\UCNfalse\LCNfalse} - -%%%%% Fix for AMSBook 971008 - -\@ifundefined{@chapapp}{\let\@chapapp\chaptername}{} - - -%%%%% Fix for Bjarne and appendix 980211 - -\newif\ifinapp -\inappfalse -\renewcommand\appendix{\par - \setcounter{chapter}{0}% - \setcounter{section}{0}% - \inapptrue% - \renewcommand\@chapapp{\appendixname}% - \renewcommand\thechapter{\@Alph\c@chapter}} - -%%%%% Fix for frontmatter, mainmatter, and backmatter 040920 - -\@ifundefined{@mainmatter}{\newif\if@mainmatter \@mainmattertrue}{} - -%%%%% - - - -\newcommand{\FmN}[1]{% -\ifUCN - {\MakeUppercase{#1}}\LCNfalse -\else - \ifLCN - {\MakeLowercase{#1}}\UCNfalse - \else #1 - \fi -\fi} - - -%%%% DEFINITION OF Title variables -\newcommand{\CTV}{\Huge\bfseries} -\newcommand{\ChTitleVar}[1]{\renewcommand{\CTV}{#1}} - -%%%% DEFINITION OF the basic rule width -\newlength{\RW} -\setlength{\RW}{1pt} -\newcommand{\ChRuleWidth}[1]{\setlength{\RW}{#1}} - -\newif\ifUCT -\UCTfalse -\newif\ifLCT -\LCTfalse -\def\ChTitleLowerCase{\LCTtrue\UCTfalse} -\def\ChTitleUpperCase{\UCTtrue\LCTfalse} -\def\ChTitleAsIs{\UCTfalse\LCTfalse} -\newcommand{\FmTi}[1]{% -\ifUCT - {\MakeUppercase{#1}}\LCTfalse -\else - \ifLCT - {\MakeLowercase{#1}}\UCTfalse - \else {#1} - \fi -\fi} - - - -\newlength{\mylen} -\newlength{\myhi} -\newlength{\px} -\newlength{\py} -\newlength{\pyy} -\newlength{\pxx} - - -\def\mghrulefill#1{\leavevmode\leaders\hrule\@height #1\hfill\kern\z@} - -\newcommand{\DOCH}{% - \CNV\FmN{\@chapapp}\space \CNoV\thechapter - \par\nobreak - \vskip 20\p@ - } -\newcommand{\DOTI}[1]{% - \CTV\FmTi{#1}\par\nobreak - \vskip 40\p@ - } -\newcommand{\DOTIS}[1]{% - \CTV\FmTi{#1}\par\nobreak - \vskip 40\p@ - } - -%%%%%% SONNY DEF - -\DeclareOption{Sonny}{% - \ChNameVar{\Large\sf} - \ChNumVar{\Huge} - \ChTitleVar{\Large\sf} - \ChRuleWidth{0.5pt} - \ChNameUpperCase - \renewcommand{\DOCH}{% - \raggedleft - \CNV\FmN{\@chapapp}\space \CNoV\thechapter - \par\nobreak - \vskip 40\p@} - \renewcommand{\DOTI}[1]{% - \CTV\raggedleft\mghrulefill{\RW}\par\nobreak - \vskip 5\p@ - \CTV\FmTi{#1}\par\nobreak - \mghrulefill{\RW}\par\nobreak - \vskip 40\p@} - \renewcommand{\DOTIS}[1]{% - \CTV\raggedleft\mghrulefill{\RW}\par\nobreak - \vskip 5\p@ - \CTV\FmTi{#1}\par\nobreak - \mghrulefill{\RW}\par\nobreak - \vskip 40\p@} -} - -%%%%%% LENNY DEF - -\DeclareOption{Lenny}{% - - \ChNameVar{\fontsize{14}{16}\usefont{OT1}{phv}{m}{n}\selectfont} - \ChNumVar{\fontsize{60}{62}\usefont{OT1}{ptm}{m}{n}\selectfont} - \ChTitleVar{\Huge\bfseries\rm} - \ChRuleWidth{1pt} - \renewcommand{\DOCH}{% - \settowidth{\px}{\CNV\FmN{\@chapapp}} - \addtolength{\px}{2pt} - \settoheight{\py}{\CNV\FmN{\@chapapp}} - \addtolength{\py}{1pt} - - \settowidth{\mylen}{\CNV\FmN{\@chapapp}\space\CNoV\thechapter} - \addtolength{\mylen}{1pt} - \settowidth{\pxx}{\CNoV\thechapter} - \addtolength{\pxx}{-1pt} - - \settoheight{\pyy}{\CNoV\thechapter} - \addtolength{\pyy}{-2pt} - \setlength{\myhi}{\pyy} - \addtolength{\myhi}{-1\py} - \par - \parbox[b]{\textwidth}{% - \rule[\py]{\RW}{\myhi}% - \hskip -\RW% - \rule[\pyy]{\px}{\RW}% - \hskip -\px% - \raggedright% - \CNV\FmN{\@chapapp}\space\CNoV\thechapter% - \hskip1pt% - \mghrulefill{\RW}% - \rule{\RW}{\pyy}\par\nobreak% - \vskip -\baselineskip% - \vskip -\pyy% - \hskip \mylen% - \mghrulefill{\RW}\par\nobreak% - \vskip \pyy}% - \vskip 20\p@} - - - \renewcommand{\DOTI}[1]{% - \raggedright - \CTV\FmTi{#1}\par\nobreak - \vskip 40\p@} - - \renewcommand{\DOTIS}[1]{% - \raggedright - \CTV\FmTi{#1}\par\nobreak - \vskip 40\p@} - } - -%%%%%% Peter Osbornes' version of LENNY DEF - -\DeclareOption{PetersLenny}{% - -% five new lengths -\newlength{\bl} % bottom left : orig \space -\setlength{\bl}{6pt} -\newcommand{\BL}[1]{\setlength{\bl}{#1}} -\newlength{\br} % bottom right : orig 1pt -\setlength{\br}{1pt} -\newcommand{\BR}[1]{\setlength{\br}{#1}} -\newlength{\tl} % top left : orig 2pt -\setlength{\tl}{2pt} -\newcommand{\TL}[1]{\setlength{\tl}{#1}} -\newlength{\trr} % top right :orig 1pt -\setlength{\trr}{1pt} -\newcommand{\TR}[1]{\setlength{\trr}{#1}} -\newlength{\blrule} % top right :orig 1pt -\setlength{\trr}{0pt} -\newcommand{\BLrule}[1]{\setlength{\blrule}{#1}} - - - \ChNameVar{\fontsize{14}{16}\usefont{OT1}{phv}{m}{n}\selectfont} - \ChNumVar{\fontsize{60}{62}\usefont{OT1}{ptm}{m}{n}\selectfont} - \ChTitleVar{\Huge\bfseries\rm} - \ChRuleWidth{1pt} -\renewcommand{\DOCH}{% - - -%%%%%%% tweaks for 1--9 and A--Z -\ifcase\c@chapter\relax% -\or\BL{-3pt}\TL{-4pt}\BR{0pt}\TR{-6pt}%1 -\or\BL{0pt}\TL{-4pt}\BR{2pt}\TR{-4pt}%2 -\or\BL{0pt}\TL{-4pt}\BR{2pt}\TR{-4pt}%3 -\or\BL{0pt}\TL{5pt}\BR{2pt}\TR{-4pt}%4 -\or\BL{0pt}\TL{3pt}\BR{2pt}\TR{-4pt}%5 -\or\BL{-1pt}\TL{0pt}\BR{2pt}\TR{-2pt}%6 -\or\BL{0pt}\TL{-3pt}\BR{2pt}\TR{-2pt}%7 -\or\BL{0pt}\TL{-3pt}\BR{2pt}\TR{-2pt}%8 -\or\BL{0pt}\TL{-3pt}\BR{-4pt}\TR{-2pt}%9 -\or\BL{-3pt}\TL{-3pt}\BR{2pt}\TR{-7pt}%10 -\or\BL{-6pt}\TL{-6pt}\BR{0pt}\TR{-9pt}%11 -\or\BL{-6pt}\TL{-6pt}\BR{2pt}\TR{-7pt}%12 -\or\BL{-5pt}\TL{-5pt}\BR{0pt}\TR{-9pt}%13 -\or\BL{-6pt}\TL{-6pt}\BR{0pt}\TR{-9pt}%14 -\or\BL{-3pt}\TL{-3pt}\BR{3pt}\TR{-6pt}%15 -\or\BL{-3pt}\TL{-3pt}\BR{3pt}\TR{-6pt}%16 -\or\BL{-5pt}\TL{-3pt}\BR{-8pt}\TR{-6pt}%17 -\or\BL{-5pt}\TL{-5pt}\BR{0pt}\TR{-9pt}%18 -\or\BL{-3pt}\TL{-3pt}\BR{-6pt}\TR{-9pt}%19 -\or\BL{0pt}\TL{0pt}\BR{0pt}\TR{-5pt}%20 -\fi - -\ifinapp\ifcase\c@chapter\relax% -\or\BL{0pt}\TL{14pt}\BR{5pt}\TR{-19pt}%A -\or\BL{0pt}\TL{-5pt}\BR{-3pt}\TR{-8pt}%B -\or\BL{-3pt}\TL{-2pt}\BR{1pt}\TR{-6pt}\BLrule{0pt}%C -\or\BL{0pt}\TL{-5pt}\BR{-3pt}\TR{-8pt}\BLrule{0pt}%D -\or\BL{0pt}\TL{-5pt}\BR{2pt}\TR{-3pt}%E -\or\BL{0pt}\TL{-5pt}\BR{-10pt}\TR{-1pt}%F -\or\BL{-3pt}\TL{0pt}\BR{0pt}\TR{-7pt}%G -\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}%H -\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}%I -\or\BL{2pt}\TL{0pt}\BR{-3pt}\TR{1pt}%J -\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}%K -\or\BL{0pt}\TL{-5pt}\BR{2pt}\TR{-19pt}%L -\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}%M -\or\BL{0pt}\TL{-5pt}\BR{-2pt}\TR{-1pt}%N -\or\BL{-3pt}\TL{-2pt}\BR{-3pt}\TR{-11pt}%O -\or\BL{0pt}\TL{-5pt}\BR{-9pt}\TR{-3pt}%P -\or\BL{-3pt}\TL{-2pt}\BR{-3pt}\TR{-11pt}%Q -\or\BL{0pt}\TL{-5pt}\BR{4pt}\TR{-8pt}%R -\or\BL{-2pt}\TL{-2pt}\BR{-2pt}\TR{-7pt}%S -\or\BL{-3pt}\TL{0pt}\BR{-5pt}\TR{4pt}\BLrule{8pt}%T -\or\BL{-7pt}\TL{-11pt}\BR{-5pt}\TR{-7pt}\BLrule{0pt}%U -\or\BL{-14pt}\TL{-5pt}\BR{-14pt}\TR{-1pt}\BLrule{14pt}%V -\or\BL{-10pt}\TL{-9pt}\BR{-13pt}\TR{-3pt}\BLrule{7pt}%W -\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}\BLrule{0pt}%X -\or\BL{-6pt}\TL{-4pt}\BR{-7pt}\TR{1pt}\BLrule{7pt}%Y -\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}\BLrule{0pt}%Z -\fi\fi -%%%%%%% - \settowidth{\px}{\CNV\FmN{\@chapapp}} - \addtolength{\px}{\tl} %MOD change 2pt to \tl - \settoheight{\py}{\CNV\FmN{\@chapapp}} - \addtolength{\py}{1pt} - - \settowidth{\mylen}{\CNV\FmN{\@chapapp}\space\CNoV\thechapter} - \addtolength{\mylen}{\trr}% MOD change 1pt to \tr - \settowidth{\pxx}{\CNoV\thechapter} - \addtolength{\pxx}{-1pt} - - \settoheight{\pyy}{\CNoV\thechapter} - \addtolength{\pyy}{-2pt} - \setlength{\myhi}{\pyy} - \addtolength{\myhi}{-1\py} - \par - \parbox[b]{\textwidth}{% - \rule[\py]{\RW}{\myhi}% - \hskip -\RW% - \rule[\pyy]{\px}{\RW}% - \hskip -\px% - \raggedright% - \CNV\FmN{\@chapapp}\rule{\blrule}{\RW}\hskip\bl\CNoV\thechapter%MOD -% \CNV\FmN{\@chapapp}\space\CNoV\thechapter %ORIGINAL - \hskip\br% %MOD 1pt to \br - \mghrulefill{\RW}% - \rule{\RW}{\pyy}\par\nobreak% - \vskip -\baselineskip% - \vskip -\pyy% - \hskip \mylen% - \mghrulefill{\RW}\par\nobreak% - \vskip \pyy}% - \vskip 20\p@} - - - \renewcommand{\DOTI}[1]{% - \raggedright - \CTV\FmTi{#1}\par\nobreak - \vskip 40\p@} - - \renewcommand{\DOTIS}[1]{% - \raggedright - \CTV\FmTi{#1}\par\nobreak - \vskip 40\p@} - } - - -% - - -%%%%%% BJORNSTRUP DEF - -\DeclareOption{Bjornstrup}{% - \usecolortrue - % pzc (Zapf Chancelery) is nice. ppl (Palatino) is cool too. - \ChNumVar{\fontsize{76}{80}\usefont{OT1}{pzc}{m}{n}\selectfont} - \ChTitleVar{\raggedleft\Large\sffamily\bfseries} - - \setlength{\myhi}{10pt} % Space between grey box border and text - \setlength{\mylen}{\textwidth} - \addtolength{\mylen}{-2\myhi} - \renewcommand{\DOCH}{% - \settowidth{\py}{\CNoV\thechapter} - \addtolength{\py}{-10pt} % Amount of space by which the -% % number is shifted right - \fboxsep=0pt% - \colorbox[gray]{.85}{\rule{0pt}{40pt}\parbox[b]{\textwidth}{\hfill}}% - \kern-\py\raise20pt% - \hbox{\color[gray]{.5}\CNoV\thechapter}\\% - } - - \renewcommand{\DOTI}[1]{% - \nointerlineskip\raggedright% - \fboxsep=\myhi% - \vskip-1ex% - \colorbox[gray]{.85}{\parbox[t]{\mylen}{\CTV\FmTi{#1}}}\par\nobreak% - \vskip 40\p@% - } - - \renewcommand{\DOTIS}[1]{% - \fboxsep=0pt - \colorbox[gray]{.85}{\rule{0pt}{40pt}\parbox[b]{\textwidth}{\hfill}}\\% - \nointerlineskip\raggedright% - \fboxsep=\myhi% - \colorbox[gray]{.85}{\parbox[t]{\mylen}{\CTV\FmTi{#1}}}\par\nobreak% - \vskip 40\p@% - } -} - - -%%%%%%% GLENN DEF - - -\DeclareOption{Glenn}{% - \ChNameVar{\bfseries\Large\sf} - \ChNumVar{\Huge} - \ChTitleVar{\bfseries\Large\rm} - \ChRuleWidth{1pt} - \ChNameUpperCase - \ChTitleUpperCase - \renewcommand{\DOCH}{% - \settoheight{\myhi}{\CTV\FmTi{Test}} - \setlength{\py}{\baselineskip} - \addtolength{\py}{\RW} - \addtolength{\py}{\myhi} - \setlength{\pyy}{\py} - \addtolength{\pyy}{-1\RW} - - \raggedright - \CNV\FmN{\@chapapp}\space\CNoV\thechapter - \hskip 3pt\mghrulefill{\RW}\rule[-1\pyy]{2\RW}{\py}\par\nobreak} - - \renewcommand{\DOTI}[1]{% - \addtolength{\pyy}{-4pt} - \settoheight{\myhi}{\CTV\FmTi{#1}} - \addtolength{\myhi}{\py} - \addtolength{\myhi}{-1\RW} - \vskip -1\pyy - \rule{2\RW}{\myhi}\mghrulefill{\RW}\hskip 2pt - \raggedleft\CTV\FmTi{#1}\par\nobreak - \vskip 80\p@} - -\newlength{\backskip} - \renewcommand{\DOTIS}[1]{% -% \setlength{\py}{10pt} -% \setlength{\pyy}{\py} -% \addtolength{\pyy}{\RW} -% \setlength{\myhi}{\baselineskip} -% \addtolength{\myhi}{\pyy} -% \mghrulefill{\RW}\rule[-1\py]{2\RW}{\pyy}\par\nobreak -% \addtolength{}{} -%\vskip -1\baselineskip -% \rule{2\RW}{\myhi}\mghrulefill{\RW}\hskip 2pt -% \raggedleft\CTV\FmTi{#1}\par\nobreak -% \vskip 60\p@} -%% Fix suggested by Tomas Lundberg - \setlength{\py}{25pt} % eller vad man vill - \setlength{\pyy}{\py} - \setlength{\backskip}{\py} - \addtolength{\backskip}{2pt} - \addtolength{\pyy}{\RW} - \setlength{\myhi}{\baselineskip} - \addtolength{\myhi}{\pyy} - \mghrulefill{\RW}\rule[-1\py]{2\RW}{\pyy}\par\nobreak - \vskip -1\backskip - \rule{2\RW}{\myhi}\mghrulefill{\RW}\hskip 3pt % - \raggedleft\CTV\FmTi{#1}\par\nobreak - \vskip 40\p@} - } - -%%%%%%% CONNY DEF - -\DeclareOption{Conny}{% - \ChNameUpperCase - \ChTitleUpperCase - \ChNameVar{\centering\Huge\rm\bfseries} - \ChNumVar{\Huge} - \ChTitleVar{\centering\Huge\rm} - \ChRuleWidth{2pt} - - \renewcommand{\DOCH}{% - \mghrulefill{3\RW}\par\nobreak - \vskip -0.5\baselineskip - \mghrulefill{\RW}\par\nobreak - \CNV\FmN{\@chapapp}\space \CNoV\thechapter - \par\nobreak - \vskip -0.5\baselineskip - } - \renewcommand{\DOTI}[1]{% - \mghrulefill{\RW}\par\nobreak - \CTV\FmTi{#1}\par\nobreak - \vskip 60\p@ - } - \renewcommand{\DOTIS}[1]{% - \mghrulefill{\RW}\par\nobreak - \CTV\FmTi{#1}\par\nobreak - \vskip 60\p@ - } - } - -%%%%%%% REJNE DEF - -\DeclareOption{Rejne}{% - - \ChNameUpperCase - \ChTitleUpperCase - \ChNameVar{\centering\Large\rm} - \ChNumVar{\Huge} - \ChTitleVar{\centering\Huge\rm} - \ChRuleWidth{1pt} - \renewcommand{\DOCH}{% - \settoheight{\py}{\CNoV\thechapter} - \parskip=0pt plus 1pt % Set parskip to default, just in case v1.31 - \addtolength{\py}{-1pt} - \CNV\FmN{\@chapapp}\par\nobreak - \vskip 20\p@ - \setlength{\myhi}{2\baselineskip} - \setlength{\px}{\myhi} - \addtolength{\px}{-1\RW} - \rule[-1\px]{\RW}{\myhi}\mghrulefill{\RW}\hskip - 10pt\raisebox{-0.5\py}{\CNoV\thechapter}\hskip 10pt\mghrulefill{\RW}\rule[-1\px]{\RW}{\myhi}\par\nobreak - \vskip -3\p@% Added -2pt vskip to correct for streched text v1.31 - } - \renewcommand{\DOTI}[1]{% - \setlength{\mylen}{\textwidth} - \parskip=0pt plus 1pt % Set parskip to default, just in case v1.31 - \addtolength{\mylen}{-2\RW} - {\vrule width\RW}\parbox{\mylen}{\CTV\FmTi{#1}}{\vrule width\RW}\par\nobreak% - \vskip -3pt\rule{\RW}{2\baselineskip}\mghrulefill{\RW}\rule{\RW}{2\baselineskip}% - \vskip 60\p@% Added -2pt in vskip to correct for streched text v1.31 - } - \renewcommand{\DOTIS}[1]{% - \setlength{\py}{\fboxrule} - \setlength{\fboxrule}{\RW} - \setlength{\mylen}{\textwidth} - \addtolength{\mylen}{-2\RW} - \fbox{\parbox{\mylen}{\vskip 2\baselineskip\CTV\FmTi{#1}\par\nobreak\vskip \baselineskip}} - \setlength{\fboxrule}{\py} - \vskip 60\p@ - } - } - - -%%%%%%% BJARNE DEF - -\DeclareOption{Bjarne}{% - \ChNameUpperCase - \ChTitleUpperCase - \ChNameVar{\raggedleft\normalsize\rm} - \ChNumVar{\raggedleft \bfseries\Large} - \ChTitleVar{\raggedleft \Large\rm} - \ChRuleWidth{1pt} - - -%% Note thechapter -> c@chapter fix appendix bug -%% Fixed misspelled 12 - - \newcounter{AlphaCnt} - \newcounter{AlphaDecCnt} - \newcommand{\AlphaNo}{% - \ifcase\number\theAlphaCnt - \ifnum\c@chapter=0 - ZERO\else{}\fi - \or ONE\or TWO\or THREE\or FOUR\or FIVE - \or SIX\or SEVEN\or EIGHT\or NINE\or TEN - \or ELEVEN\or TWELVE\or THIRTEEN\or FOURTEEN\or FIFTEEN - \or SIXTEEN\or SEVENTEEN\or EIGHTEEN\or NINETEEN\fi -} - - \newcommand{\AlphaDecNo}{% - \setcounter{AlphaDecCnt}{0} - \@whilenum\number\theAlphaCnt>0\do - {\addtocounter{AlphaCnt}{-10} - \addtocounter{AlphaDecCnt}{1}} - \ifnum\number\theAlphaCnt=0 - \else - \addtocounter{AlphaDecCnt}{-1} - \addtocounter{AlphaCnt}{10} - \fi - - - \ifcase\number\theAlphaDecCnt\or TEN\or TWENTY\or THIRTY\or - FORTY\or FIFTY\or SIXTY\or SEVENTY\or EIGHTY\or NINETY\fi - } - \newcommand{\TheAlphaChapter}{% - - \ifinapp - \thechapter - \else - \setcounter{AlphaCnt}{\c@chapter} - \ifnum\c@chapter<20 - \AlphaNo - \else - \AlphaDecNo\AlphaNo - \fi - \fi - } - \renewcommand{\DOCH}{% - \mghrulefill{\RW}\par\nobreak - \CNV\FmN{\@chapapp}\par\nobreak - \CNoV\TheAlphaChapter\par\nobreak - \vskip -1\baselineskip\vskip 5pt\mghrulefill{\RW}\par\nobreak - \vskip 20\p@ - } - \renewcommand{\DOTI}[1]{% - \CTV\FmTi{#1}\par\nobreak - \vskip 40\p@ - } - \renewcommand{\DOTIS}[1]{% - \CTV\FmTi{#1}\par\nobreak - \vskip 40\p@ - } -} - -\DeclareOption*{% - \PackageWarning{fancychapter}{unknown style option} - } - -\ProcessOptions* \relax - -\ifusecolor - \RequirePackage{color} -\fi -\def\@makechapterhead#1{% - \vspace*{50\p@}% - {\parindent \z@ \raggedright \normalfont - \ifnum \c@secnumdepth >\m@ne - \if@mainmatter%%%%% Fix for frontmatter, mainmatter, and backmatter 040920 - \DOCH - \fi - \fi - \interlinepenalty\@M - \if@mainmatter%%%%% Fix for frontmatter, mainmatter, and backmatter 060424 - \DOTI{#1}% - \else% - \DOTIS{#1}% - \fi - }} - - -%%% Begin: To avoid problem with scrbook.cls (fncychap version 1.32) - -%%OUT: -%\def\@schapter#1{\if@twocolumn -% \@topnewpage[\@makeschapterhead{#1}]% -% \else -% \@makeschapterhead{#1}% -% \@afterheading -% \fi} - -%%IN: -\def\@schapter#1{% -\if@twocolumn% - \@makeschapterhead{#1}% -\else% - \@makeschapterhead{#1}% - \@afterheading% -\fi} - -%%% End: To avoid problem with scrbook.cls (fncychap version 1.32) - -\def\@makeschapterhead#1{% - \vspace*{50\p@}% - {\parindent \z@ \raggedright - \normalfont - \interlinepenalty\@M - \DOTIS{#1} - \vskip 40\p@ - }} - -\endinput - - diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo index a2f2116..c6abe7a 100644 --- a/docs/build/html/.buildinfo +++ b/docs/build/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 3b01511e2b1ff9156cce8d25f6d31c89 -tags: fbb0d17656682115ca4d033fb2f83ba1 +config: d39ec6c7b042573807eea819bdc144c3 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/_sources/dggs.txt b/docs/build/html/_sources/dggs.txt deleted file mode 100644 index bb70aa5..0000000 --- a/docs/build/html/_sources/dggs.txt +++ /dev/null @@ -1,7 +0,0 @@ -The dggs Module -=========================== - -.. automodule:: rhealpix_dggs.dggs - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/distortion.txt b/docs/build/html/_sources/distortion.txt deleted file mode 100644 index 304b691..0000000 --- a/docs/build/html/_sources/distortion.txt +++ /dev/null @@ -1,7 +0,0 @@ -The distortion Module -=========================== - -.. automodule:: rhealpix_dggs.distortion - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/ellipsoids.txt b/docs/build/html/_sources/ellipsoids.txt deleted file mode 100644 index 8a8f3b9..0000000 --- a/docs/build/html/_sources/ellipsoids.txt +++ /dev/null @@ -1,7 +0,0 @@ -The ellipsoids Module -=========================== - -.. automodule:: rhealpix_dggs.ellipsoids - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/index.txt b/docs/build/html/_sources/index.txt deleted file mode 100644 index caa92fe..0000000 --- a/docs/build/html/_sources/index.txt +++ /dev/null @@ -1,26 +0,0 @@ -.. scenzgrid-dggs documentation master file. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome the rHEALPixDGGS documentation! -=========================================== - -.. toctree:: - :maxdepth: 2 - - introduction - utils - pj_healpix - pj_rhealpix - ellipsoids - projection_wrapper - dggs - distortion - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/docs/build/html/_sources/introduction.txt b/docs/build/html/_sources/introduction.txt deleted file mode 100644 index ddc146b..0000000 --- a/docs/build/html/_sources/introduction.txt +++ /dev/null @@ -1,339 +0,0 @@ -Introduction -============ -rHEALPixDGGS is a Python 3.3 package that implements the rHEALPix discrete global grid system (DGGS). -This documentation assumes you are familiar with the rHEALPix DGGS as described in [GRS2013]_ and familiar with basic Python 3.3 usage as described in `The Python Tutorial `_. - -.. [GRS2013] Robert Gibb, Alexander Raichev, Michael Speth, `The rHEALPix discrete global grid system `_, in preparation, 2013. - -Requirements ---------------- -- `Python >=3.3 `_ -- `NumPy >=1.7 `_ Base N-dimensional array package -- `SciPy >=0.12 `_ Fundamental library for scientific computing -- `Matplotlib >=1.2.1 `_ Comprehensive 2D Plotting -- `Pyproj >=1.9.3 `_ - Python interface to the PROJ.4 cartographic library -- `Sage >=5.10 `_ - (Optional) Comprehensive mathematics package. - Needed only for a few optional graphics methods. - To use the optional graphics methods, start a Sage notebook session and import/attach the Python module that contains the methods. - For examples, see the Sage worksheet ``rhealpix_dggs/tests/test_dggs.sws``. - -Installation --------------- -rHEALPixDGGS is available for download at Landcare Research's git repository ``_ and can be cloned via the command ``git clone git@code.scenzgrid.org:scenzgrid-py.git``. - -To install Sage, download and install the appropriate binary file from `sagemath.org `_. -Then install Pyproj within Sage by downloading the Pyproj source, changing to the Pyproj directory, starting a Sage shell via ``sage -sh``, then typing ``python setup.py build``, then ``python setup.py install``. -If that doesn't work, try again but first start in superuser mode via ``sudo su``. - -Usage ------- -To use rHEALPixDGGS after installing it, start a Python session in the directory where you downloaded the modules and import the modules. -Here are some examples. -For a list of all methods available, see the application programming interface (API) in the following chapters. - -Using the ``ellipsoids`` and ``projection_wrapper`` Modules -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The ``ellipsoids`` module implements functions and constants dealing with ellipsoids of revolution (which include spheres but not general triaxial ellipsoids). -For brevity hereafter, the word 'ellipsoid' abbreviates 'ellipsoid of revolution'. - -The module ``projection_wrapper`` implements a wrapper for the map projections of ellipsoids defined in ``pj_healpix``, ``pj_rhealpix``, and Pyproj. - -Currently ``projection_wrapper`` uses the HEALPix and rHEALPix projections -defined in ``pj_healpix`` and ``pj_rhealpix`` and *not* the buggy versions defined in Pyproj 1.9.3 as ``PJ_healpix.c``. -Alternatively, you can download a corrected version of ``PJ_healpix.c`` from -`trac.osgeo.org/proj/changeset/2378 `_, rebuild Pyproj with it, and use it in ``dggs`` by editing the ``HOMEMADE_PROJECTIONS`` line in ``projection_wrapper``. - -Import all the classes, methods, and constants from the module:: - - >>> from rhealpix_dggs.projection_wrapper import * - -Create an ellipsoid, say, one with major radius 5 and eccentricity 0.8:: - - >>> from rhealpix_dggs.ellipsoids import * - >>> ellps_1 = Ellipsoid(a=5, e=0.8) - >>> print(ellps_1) - ellipsoid: - R_A = 4.32200117119 - a = 5 - b = 3.0 - e = 0.8 - f = 0.4 - lat_0 = 0 - lon_0 = 0 - radians = False - sphere = False - -The names of the ellipsoid attributes agree with the names of the `PROJ.4 ellipsoid parameters `_. -For example, ``R_A`` is the authalic radius of the ellipsoid, the radius of the sphere that has the same area as the ellipsoid. - -By default, angles are measured in degrees. -If you prefer radians, then do:: - - >>> ellps_2 = Ellipsoid(a=5, e=0.8, radians=True) - >>> print(ellps_2) - ellipsoid: - R_A = 4.32200117119 - a = 5 - b = 3.0 - e = 0.8 - f = 0.4 - lat_0 = 0 - lon_0 = 0 - radians = True - sphere = False - -Some common ellipsoids are predefined as constants. - - >>> print(UNIT_SPHERE) - ellipsoid: - R = 1 - R_A = 1 - a = 1 - b = 1 - e = 0 - f = 0 - lat_0 = 0 - lon_0 = 0 - radians = False - sphere = True - >>> print(WGS84_ELLIPSOID) - ellipsoid: - R_A = 6374581.4671 - a = 6378137.0 - b = 6356752.314140356 - e = 0.0578063088401 - f = 0.003352810681182 - lat_0 = 0 - lon_0 = 0 - radians = False - sphere = False - >>> print(WGS84_ELLIPSOID_RADIANS) - ellipsoid: - R_A = 6374581.4671 - a = 6378137.0 - b = 6356752.314140356 - e = 0.0578063088401 - f = 0.003352810681182 - lat_0 = 0 - lon_0 = 0 - radians = True - sphere = False - -Ellipsoid instances are parametrized by geographic longitude and latitude with the central meridian at ``lon_0`` and the parallel of origin at ``lat_0``. - -Project some points of the ellipsoid using the HEALPix and rHEALPix projections:: - - >>> h = Proj(ellps_1, 'healpix') - >>> rh = Proj(ellps_1, 'rhealpix', north_square=1, south_square=2) - >>> print(h(0, 60)) - (0.0, 3.351278550178026) - >>> print(rh(0, 60)) - (0.0, 3.351278550178026) - >>> print(h(0, 70)) - (0.864006732389895, 4.2584985144432679) - >>> print(rh(0, 70)) - (-0.86400673238989445, 4.2584985144432679) - - - -Using the ``dggs`` Module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The module ``dggs`` implements the rHEALPix DGGS and various operations thereupon. - -Import all the classes, methods, and constants from the module :: - - >>> from rhealpix_dggs.dggs import * - -Create the (0, 0)-rHEALPix DGGS with N_side=3 that is based upon the WGS84 ellipsoid:: - - >>> from rhealpix_dggs.ellipsoids import WGS84_ELLIPSOID - >>> E = WGS84_ELLIPSOID - >>> rdggs = RHEALPixDGGS(ellipsoid=E, north_square=0, south_square=0, N_side=3) - >>> print(rdggs) - rHEALPix DGGS: - N_side = 3 - north_square = 0 - south_square = 0 - max_areal_resolution = 1 - max_resolution = 15 - ellipsoid: - R_A = 6374581.4671 - a = 6378137.0 - b = 6356752.314140356 - e = 0.0578063088401 - f = 0.003352810681182319 - lat_0 = 0 - lon_0 = 0 - radians = False - sphere = False - -Some common rHEALPix DGGSs are predefined as constants:: - - >>> print(UNIT_003) - rHEALPix DGGS: - N_side = 3 - north_square = 0 - south_square = 0 - max_areal_resolution = 1 - max_resolution = 1 - ellipsoid: - R = 1 - R_A = 1 - a = 1 - b = 1 - e = 0 - f = 0 - lat_0 = 0 - lon_0 = 0 - radians = False - sphere = True - >>> print(WGS84_003) - rHEALPix DGGS: - N_side = 3 - north_square = 0 - south_square = 0 - max_areal_resolution = 1 - max_resolution = 15 - ellipsoid: - R_A = 6374581.4671 - a = 6378137.0 - b = 6356752.314140356 - e = 0.0578063088401 - f = 0.003352810681182319 - lat_0 = 0 - lon_0 = 0 - radians = False - sphere = False - >>> print(UNIT_003_RADIANS) - rHEALPix DGGS: - N_side = 3 - north_square = 0 - south_square = 0 - max_areal_resolution = 1 - max_resolution = 1 - ellipsoid: - R = 1 - R_A = 1 - a = 1 - b = 1 - e = 0 - f = 0 - lat_0 = 0 - lon_0 = 0 - radians = True - sphere = True - -Pick a (longitude-latitude) point on the ellipsoid and find the level 1 cell that contains it :: - - >>> p = (0, 15) - >>> c = rdggs.cell_from_point(1, p, plane=False); print(c) - Q0 - -Find the ellipsoidal (edge) neighbors of this cell :: - - >>> for (direction, cell) in sorted(c.neighbors(plane=False).items()): - ... print(direction, cell) - east Q1 - north N2 - south Q3 - west P2 - -Find the planar (edge) neighbors of this cell :: - - >>> for (direction, cell) in sorted(c.neighbors('plane').items()): - ... print(direction, cell) - down Q3 - left P2 - right Q1 - up N2 - -Find all the level 1 cells intersecting the longitude-latitude aligned ellipsoidal quadrangle with given northwest and southeast corners :: - - >>> nw = (0, 45) - >>> se = (90, 0) - >>> cells = rdggs.cells_from_region(1, nw, se, plane=False) - >>> for row in cells: - ... print([str(cell) for cell in row]) - ['N2', 'N1', 'N0'] - ['Q0', 'Q1', 'Q2', 'R0'] - ['Q3', 'Q4', 'Q5', 'R3'] - -Compute the ellipsoidal shape and ellipsoidal nuclei of these cells :: - - >>> for row in cells: - ... for cell in row: - ... print(cell, cell.ellipsoidal_shape(), cell.nucleus(plane=False)) - N2 dart (5.0888874903416268e-14, 58.470677829627355) - N1 skew_quad (45.000000000000036, 58.470677829627355) - N0 dart (89.999999999999957, 58.470677829627363) - Q0 quad (14.999999999999998, 26.438744923100096) - Q1 quad (45.0, 26.438744923100096) - Q2 quad (74.999999999999986, 26.438744923100096) - R0 quad (105.00000000000001, 26.438744923100096) - Q3 quad (14.999999999999998, 3.560649871414923e-15) - Q4 quad (45.0, 3.560649871414923e-15) - Q5 quad (74.999999999999986, 3.560649871414923e-15) - R3 quad (105.00000000000001, 3.560649871414923e-15) - -Create the (0, 0)-rHEALPix DGGS with N_side = 3 that is based on the WGS84 ellipsoid. -Orient the DGGS so that the planar origin (0, 0) is on Auckland, New Zealand:: - - >>> p = (174, -37) # Approximate Auckland lon-lat coordinates - >>> from rhealpix_dggs.projection_wrapper import * - >>> E = Ellipsoid(a=WGS84_A, f=WGS84_F, radians=False, lon_0=p[0], lat_0=p[1]) - >>> rdggs = RHEALPixDGGS(E, N_side=3, north_square=0, south_square=0) - >>> print(rdggs) - rHEALPix DGGS: - N_side = 3 - north_square = 0 - south_square = 0 - max_areal_resolution = 1 - max_resolution = 15 - ellipsoid: - R_A = 6374581.4671 - a = 6378137.0 - b = 6356752.314140356 - e = 0.0578063088401 - f = 0.003352810681182319 - lat_0 = -37 - lon_0 = 174 - radians = False - sphere = False - >>> print(rdggs.cell_from_point(1, p, plane=False)) - Q3 - -Using the ``distortion`` Module -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The module ``distortion`` computes distortions of map projections created via ``projection_wrapper`` and was used to produce the tables in [GRS2013]_. -The module is not necessary for manipulating the rHEALPix DGGS. - -Import all the classes, methods, and constants from the module:: - - >>> from rhealpix_dggs.distortion import * - -Import the WGS84 ellipsoid, define the rHEALPix projection on the ellipsoid, and compute linear distortion and areal distortion for the projection at a given point:: - - >>> from rhealpix_dggs.ellipsoids import WGS84_ELLIPSOID - >>> E = WGS84_ELLIPSOID - >>> from rhealpix_dggs.projection_wrapper import Proj - >>> f = Proj(ellipsoid=E, proj='rhealpix', north_square=0, south_square=0) - >>> p = (0, 30) - >>> print(distortion(f, *p) # First entry of output is f(*p)) # doctest: +SKIP - ((0.0, 3748655.115049511), 6.976075406932126, 1.1295629192757011, 1.1780969079183845) - -Sample 100 random points from the WGS84 ellipsoid and compute the sample minimum, sample maximum, sample median, sample mean, and sample standard deviation of the linear and area distortion functions of the rHEALPix projection of those points:: - - >>> sample = [E.random_point() for i in range(100)] - >>> print(distortion_stats(f, sample)[1]) # doctest: +SKIP - [[14.918, 13.82, 0.124, 48.086, 8.623], [1.345, 0.371, 1.002, 2.375, 1.163], [1.178, 0.0, 1.178, 1.178, 1.178]] - -Do the same for 100 points chosen at random from an rHEALPix DGGS dart cell:: - - >>> from rhealpix_dggs.dggs import * - >>> rdggs = WGS84_003 - >>> cell = rdggs.cell(['N', 6]) - >>> sample = [cell.random_point(plane=False) for i in range(100)] - >>> print(distortion_stats(f, sample)[1]) # doctest: +SKIP - [[38.907, 6.044, 28.189, 48.963, 38.701], [2.013, 0.226, 1.644, 2.415, 1.991], [1.178, 0.0, 1.178, 1.178, 1.178]] \ No newline at end of file diff --git a/docs/build/html/_sources/pj_healpix.txt b/docs/build/html/_sources/pj_healpix.txt deleted file mode 100644 index 2d9cab0..0000000 --- a/docs/build/html/_sources/pj_healpix.txt +++ /dev/null @@ -1,7 +0,0 @@ -The pj_healpix Module -=============================== - -.. automodule:: rhealpix_dggs.pj_healpix - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/pj_rhealpix.txt b/docs/build/html/_sources/pj_rhealpix.txt deleted file mode 100644 index efa967e..0000000 --- a/docs/build/html/_sources/pj_rhealpix.txt +++ /dev/null @@ -1,7 +0,0 @@ -The pj_rhealpix Module -=============================== - -.. automodule:: rhealpix_dggs.pj_rhealpix - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/projection_tools.txt b/docs/build/html/_sources/projection_tools.txt deleted file mode 100644 index 4a4b63e..0000000 --- a/docs/build/html/_sources/projection_tools.txt +++ /dev/null @@ -1,7 +0,0 @@ -The projection_tools Module -=============================== - -.. automodule:: projection_tools - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/projection_wrapper.txt b/docs/build/html/_sources/projection_wrapper.txt deleted file mode 100644 index ce4946c..0000000 --- a/docs/build/html/_sources/projection_wrapper.txt +++ /dev/null @@ -1,7 +0,0 @@ -The projection_wrapper Module -=============================== - -.. automodule:: rhealpix_dggs.projection_wrapper - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/rhealpix_dggs.txt b/docs/build/html/_sources/rhealpix_dggs.txt deleted file mode 100644 index bb70aa5..0000000 --- a/docs/build/html/_sources/rhealpix_dggs.txt +++ /dev/null @@ -1,7 +0,0 @@ -The dggs Module -=========================== - -.. automodule:: rhealpix_dggs.dggs - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/utils.txt b/docs/build/html/_sources/utils.txt deleted file mode 100644 index e9661f0..0000000 --- a/docs/build/html/_sources/utils.txt +++ /dev/null @@ -1,7 +0,0 @@ -The utils Module -=========================== - -.. automodule:: rhealpix_dggs.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_static/basic.css b/docs/build/html/_static/basic.css index 43e8baf..4e9a9f1 100644 --- a/docs/build/html/_static/basic.css +++ b/docs/build/html/_static/basic.css @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- basic theme. * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -15,6 +15,12 @@ div.clearer { clear: both; } +div.section::after { + display: block; + content: ''; + clear: left; +} + /* -- relbar ---------------------------------------------------------------- */ div.related { @@ -52,6 +58,8 @@ div.sphinxsidebar { width: 230px; margin-left: -100%; font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; } div.sphinxsidebar ul { @@ -79,16 +87,29 @@ div.sphinxsidebar input { font-size: 1em; } +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + div.sphinxsidebar #searchbox input[type="text"] { - width: 170px; + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; } div.sphinxsidebar #searchbox input[type="submit"] { - width: 30px; + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; } + img { border: 0; + max-width: 100%; } /* -- search page ----------------------------------------------------------- */ @@ -109,7 +130,7 @@ ul.search li a { font-weight: bold; } -ul.search li div.context { +ul.search li p.context { color: #888; margin: 2px 0 0 30px; text-align: left; @@ -123,6 +144,8 @@ ul.keywordmatches li.goodmatch a { table.contentstable { width: 90%; + margin-left: auto; + margin-right: auto; } table.contentstable p.biglink { @@ -150,9 +173,14 @@ table.indextable td { vertical-align: top; } -table.indextable dl, table.indextable dd { +table.indextable ul { margin-top: 0; margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; } table.indextable tr.pcap { @@ -184,8 +212,27 @@ div.genindex-jumpbox { padding: 0.4em; } +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + /* -- general body styles --------------------------------------------------- */ +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + a.headerlink { visibility: hidden; } @@ -196,7 +243,10 @@ h3:hover > a.headerlink, h4:hover > a.headerlink, h5:hover > a.headerlink, h6:hover > a.headerlink, -dt:hover > a.headerlink { +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { visibility: visible; } @@ -208,10 +258,6 @@ div.body td { text-align: left; } -.field-list ul { - padding-left: 1em; -} - .first { margin-top: 0 !important; } @@ -221,19 +267,25 @@ p.rubric { font-weight: bold; } -img.align-left, .figure.align-left, object.align-left { +img.align-left, figure.align-left, .figure.align-left, object.align-left { clear: left; float: left; margin-right: 1em; } -img.align-right, .figure.align-right, object.align-right { +img.align-right, figure.align-right, .figure.align-right, object.align-right { clear: right; float: right; margin-left: 1em; } -img.align-center, .figure.align-center, object.align-center { +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { display: block; margin-left: auto; margin-right: auto; @@ -247,30 +299,43 @@ img.align-center, .figure.align-center, object.align-center { text-align: center; } +.align-default { + text-align: center; +} + .align-right { text-align: right; } /* -- sidebars -------------------------------------------------------------- */ -div.sidebar { +div.sidebar, +aside.sidebar { margin: 0 0 0.5em 1em; border: 1px solid #ddb; - padding: 7px 7px 0 7px; + padding: 7px; background-color: #ffe; width: 40%; float: right; + clear: right; + overflow-x: auto; } p.sidebar-title { font-weight: bold; } +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} /* -- topics ---------------------------------------------------------------- */ - +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; - padding: 7px 7px 0 7px; + padding: 7px; margin: 10px 0 10px 0; } @@ -292,10 +357,6 @@ div.admonition dt { font-weight: bold; } -div.admonition dl { - margin-bottom: 0; -} - p.admonition-title { margin: 0px 10px 5px 0px; font-weight: bold; @@ -306,13 +367,55 @@ div.body p.centered { margin-top: 25px; } +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + /* -- tables ---------------------------------------------------------------- */ table.docutils { + margin-top: 10px; + margin-bottom: 10px; border: 0; border-collapse: collapse; } +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + table.docutils td, table.docutils th { padding: 1px 8px 1px 5px; border-top: 0; @@ -321,14 +424,6 @@ table.docutils td, table.docutils th { border-bottom: 1px solid #aaa; } -table.field-list td, table.field-list th { - border: 0 !important; -} - -table.footnote td, table.footnote th { - border: 0 !important; -} - th { text-align: left; padding-right: 5px; @@ -343,6 +438,126 @@ table.citation td { border-bottom: none; } +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + /* -- other body styles ----------------------------------------------------- */ ol.arabic { @@ -365,11 +580,80 @@ ol.upperroman { list-style: upper-roman; } +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + dl { margin-bottom: 15px; } -dd p { +dd > :first-child { margin-top: 0px; } @@ -383,30 +667,22 @@ dd { margin-left: 30px; } -dt:target, .highlighted { - background-color: #fbe54e; -} - -dl.glossary dt { - font-weight: bold; - font-size: 1.1em; -} - -.field-list ul { - margin: 0; - padding-left: 1em; +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; } -.field-list p { - margin: 0; +dt:target, span.highlighted { + background-color: #fbe54e; } -.refcount { - color: #060; +rect.highlighted { + fill: #fbe54e; } -.optional { - font-size: 1.3em; +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; } .versionmodified { @@ -447,6 +723,13 @@ dl.glossary dt { font-style: oblique; } +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + abbr, acronym { border-bottom: dotted 1px; cursor: help; @@ -459,37 +742,105 @@ pre { overflow-y: hidden; /* fixes display issues on Chrome browsers */ } +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + td.linenos pre { - padding: 5px 0px; border: 0; background-color: transparent; color: #aaa; } table.highlighttable { - margin-left: 0.5em; + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; } table.highlighttable td { - padding: 0 0.5em 0 0.5em; + margin: 0; + padding: 0; } -tt.descname { - background-color: transparent; - font-weight: bold; - font-size: 1.2em; +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; } -tt.descclassname { +div.code-block-caption code { background-color: transparent; } -tt.xref, a tt { +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { background-color: transparent; font-weight: bold; } -h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { background-color: transparent; } @@ -521,6 +872,15 @@ span.eqno { float: right; } +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + /* -- printout stylesheet --------------------------------------------------- */ @media print { diff --git a/docs/build/html/_static/default.css b/docs/build/html/_static/default.css index 21f3f50..81b9363 100644 --- a/docs/build/html/_static/default.css +++ b/docs/build/html/_static/default.css @@ -1,256 +1 @@ -/* - * default.css_t - * ~~~~~~~~~~~~~ - * - * Sphinx stylesheet -- default theme. - * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -@import url("basic.css"); - -/* -- page layout ----------------------------------------------------------- */ - -body { - font-family: sans-serif; - font-size: 100%; - background-color: #11303d; - color: #000; - margin: 0; - padding: 0; -} - -div.document { - background-color: #1c4e63; -} - -div.documentwrapper { - float: left; - width: 100%; -} - -div.bodywrapper { - margin: 0 0 0 230px; -} - -div.body { - background-color: #ffffff; - color: #000000; - padding: 0 20px 30px 20px; -} - -div.footer { - color: #ffffff; - width: 100%; - padding: 9px 0 9px 0; - text-align: center; - font-size: 75%; -} - -div.footer a { - color: #ffffff; - text-decoration: underline; -} - -div.related { - background-color: #133f52; - line-height: 30px; - color: #ffffff; -} - -div.related a { - color: #ffffff; -} - -div.sphinxsidebar { -} - -div.sphinxsidebar h3 { - font-family: 'Trebuchet MS', sans-serif; - color: #ffffff; - font-size: 1.4em; - font-weight: normal; - margin: 0; - padding: 0; -} - -div.sphinxsidebar h3 a { - color: #ffffff; -} - -div.sphinxsidebar h4 { - font-family: 'Trebuchet MS', sans-serif; - color: #ffffff; - font-size: 1.3em; - font-weight: normal; - margin: 5px 0 0 0; - padding: 0; -} - -div.sphinxsidebar p { - color: #ffffff; -} - -div.sphinxsidebar p.topless { - margin: 5px 10px 10px 10px; -} - -div.sphinxsidebar ul { - margin: 10px; - padding: 0; - color: #ffffff; -} - -div.sphinxsidebar a { - color: #98dbcc; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - - - -/* -- hyperlink styles ------------------------------------------------------ */ - -a { - color: #355f7c; - text-decoration: none; -} - -a:visited { - color: #355f7c; - text-decoration: none; -} - -a:hover { - text-decoration: underline; -} - - - -/* -- body styles ----------------------------------------------------------- */ - -div.body h1, -div.body h2, -div.body h3, -div.body h4, -div.body h5, -div.body h6 { - font-family: 'Trebuchet MS', sans-serif; - background-color: #f2f2f2; - font-weight: normal; - color: #20435c; - border-bottom: 1px solid #ccc; - margin: 20px -20px 10px -20px; - padding: 3px 0 3px 10px; -} - -div.body h1 { margin-top: 0; font-size: 200%; } -div.body h2 { font-size: 160%; } -div.body h3 { font-size: 140%; } -div.body h4 { font-size: 120%; } -div.body h5 { font-size: 110%; } -div.body h6 { font-size: 100%; } - -a.headerlink { - color: #c60f0f; - font-size: 0.8em; - padding: 0 4px 0 4px; - text-decoration: none; -} - -a.headerlink:hover { - background-color: #c60f0f; - color: white; -} - -div.body p, div.body dd, div.body li { - text-align: justify; - line-height: 130%; -} - -div.admonition p.admonition-title + p { - display: inline; -} - -div.admonition p { - margin-bottom: 5px; -} - -div.admonition pre { - margin-bottom: 5px; -} - -div.admonition ul, div.admonition ol { - margin-bottom: 5px; -} - -div.note { - background-color: #eee; - border: 1px solid #ccc; -} - -div.seealso { - background-color: #ffc; - border: 1px solid #ff6; -} - -div.topic { - background-color: #eee; -} - -div.warning { - background-color: #ffe4e4; - border: 1px solid #f66; -} - -p.admonition-title { - display: inline; -} - -p.admonition-title:after { - content: ":"; -} - -pre { - padding: 5px; - background-color: #eeffcc; - color: #333333; - line-height: 120%; - border: 1px solid #ac9; - border-left: none; - border-right: none; -} - -tt { - background-color: #ecf0f3; - padding: 0 1px 0 1px; - font-size: 0.95em; -} - -th { - background-color: #ede; -} - -.warning tt { - background: #efc2c2; -} - -.note tt { - background: #d6d6d6; -} - -.viewcode-back { - font-family: sans-serif; -} - -div.viewcode-block:target { - background-color: #f4debf; - border-top: 1px solid #ac9; - border-bottom: 1px solid #ac9; -} \ No newline at end of file +@import url("classic.css"); diff --git a/docs/build/html/_static/doctools.js b/docs/build/html/_static/doctools.js index d4619fd..527b876 100644 --- a/docs/build/html/_static/doctools.js +++ b/docs/build/html/_static/doctools.js @@ -2,246 +2,155 @@ * doctools.js * ~~~~~~~~~~~ * - * Sphinx JavaScript utilities for all documentation. + * Base JavaScript utilities for all Sphinx HTML documentation. * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ - -/** - * select a different prefix for underscore - */ -$u = _.noConflict(); - -/** - * make the code below compatible with browsers without - * an installed firebug like debugger -if (!window.console || !console.firebug) { - var names = ["log", "debug", "info", "warn", "error", "assert", "dir", - "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", - "profile", "profileEnd"]; - window.console = {}; - for (var i = 0; i < names.length; ++i) - window.console[names[i]] = function() {}; -} - */ - -/** - * small helper function to urldecode strings - */ -jQuery.urldecode = function(x) { - return decodeURIComponent(x).replace(/\+/g, ' '); -} - -/** - * small helper function to urlencode strings - */ -jQuery.urlencode = encodeURIComponent; - -/** - * This function returns the parsed url parameters of the - * current request. Multiple values per key are supported, - * it will always return arrays of strings for the value parts. - */ -jQuery.getQueryParameters = function(s) { - if (typeof s == 'undefined') - s = document.location.search; - var parts = s.substr(s.indexOf('?') + 1).split('&'); - var result = {}; - for (var i = 0; i < parts.length; i++) { - var tmp = parts[i].split('=', 2); - var key = jQuery.urldecode(tmp[0]); - var value = jQuery.urldecode(tmp[1]); - if (key in result) - result[key].push(value); - else - result[key] = [value]; - } - return result; -}; - -/** - * small function to check if an array contains - * a given item. - */ -jQuery.contains = function(arr, item) { - for (var i = 0; i < arr.length; i++) { - if (arr[i] == item) - return true; - } - return false; -}; - -/** - * highlight a given string on a jquery object by wrapping it in - * span elements with the given class name. - */ -jQuery.fn.highlightText = function(text, className) { - function highlight(node) { - if (node.nodeType == 3) { - var val = node.nodeValue; - var pos = val.toLowerCase().indexOf(text); - if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) { - var span = document.createElement("span"); - span.className = className; - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - node.parentNode.insertBefore(span, node.parentNode.insertBefore( - document.createTextNode(val.substr(pos + text.length)), - node.nextSibling)); - node.nodeValue = val.substr(0, pos); - } - } - else if (!jQuery(node).is("button, select, textarea")) { - jQuery.each(node.childNodes, function() { - highlight(this); - }); - } +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); } - return this.each(function() { - highlight(this); - }); }; /** * Small JavaScript module for the documentation. */ -var Documentation = { - - init : function() { - this.fixFirefoxAnchorBug(); - this.highlightSearchWords(); - this.initIndexTable(); +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); }, /** * i18n support */ - TRANSLATIONS : {}, - PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; }, - LOCALE : 'unknown', + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", // gettext and ngettext don't access this so that the functions // can safely bound to a different name (_ = Documentation.gettext) - gettext : function(string) { - var translated = Documentation.TRANSLATIONS[string]; - if (typeof translated == 'undefined') - return string; - return (typeof translated == 'string') ? translated : translated[0]; - }, - - ngettext : function(singular, plural, n) { - var translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated == 'undefined') - return (n == 1) ? singular : plural; - return translated[Documentation.PLURALEXPR(n)]; - }, - - addTranslations : function(catalog) { - for (var key in catalog.messages) - this.TRANSLATIONS[key] = catalog.messages[key]; - this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); - this.LOCALE = catalog.locale; - }, - - /** - * add context elements like header anchor links - */ - addContextElements : function() { - $('div[id] > :header:first').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this headline')). - appendTo(this); - }); - $('dt[id]').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this definition')). - appendTo(this); - }); + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } }, - /** - * workaround a firefox stupidity - */ - fixFirefoxAnchorBug : function() { - if (document.location.hash && $.browser.mozilla) - window.setTimeout(function() { - document.location.href += ''; - }, 10); + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; }, - /** - * highlight the search words provided in the url in the text - */ - highlightSearchWords : function() { - var params = $.getQueryParameters(); - var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; - if (terms.length) { - var body = $('div.body'); - window.setTimeout(function() { - $.each(terms, function() { - body.highlightText(this.toLowerCase(), 'highlighted'); - }); - }, 10); - $('

' + _('Hide Search Matches') + '

') - .appendTo($('#searchbox')); - } + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; }, /** - * init the domain index toggle buttons + * helper function to focus on search bar */ - initIndexTable : function() { - var togglers = $('img.toggler').click(function() { - var src = $(this).attr('src'); - var idnum = $(this).attr('id').substr(7); - $('tr.cg-' + idnum).toggle(); - if (src.substr(-9) == 'minus.png') - $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); - else - $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); - }).css('display', ''); - if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { - togglers.click(); - } + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); }, /** - * helper function to hide the search marks again + * Initialise the domain index toggle buttons */ - hideSearchWords : function() { - $('#searchbox .highlight-link').fadeOut(300); - $('span.highlighted').removeClass('highlighted'); + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); }, - /** - * make the url absolute - */ - makeURL : function(relativeURL) { - return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; - }, + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } - /** - * get the current relative url - */ - getCurrentURL : function() { - var path = document.location.pathname; - var parts = path.split(/\//); - $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { - if (this == '..') - parts.pop(); + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } }); - var url = parts.join('/'); - return path.substring(url.lastIndexOf('/') + 1, path.length - 1); - } + }, }; // quick alias for translations -_ = Documentation.gettext; +const _ = Documentation.gettext; -$(document).ready(function() { - Documentation.init(); -}); +_ready(Documentation.init); diff --git a/docs/build/html/_static/file.png b/docs/build/html/_static/file.png index d18082e..a858a41 100644 Binary files a/docs/build/html/_static/file.png and b/docs/build/html/_static/file.png differ diff --git a/docs/build/html/_static/jquery.js b/docs/build/html/_static/jquery.js index 7c24308..c4c6022 100644 --- a/docs/build/html/_static/jquery.js +++ b/docs/build/html/_static/jquery.js @@ -1,154 +1,2 @@ -/*! - * jQuery JavaScript Library v1.4.2 - * http://jquery.com/ - * - * Copyright 2010, John Resig - * Dual licensed under the MIT or GPL Version 2 licenses. - * http://jquery.org/license - * - * Includes Sizzle.js - * http://sizzlejs.com/ - * Copyright 2010, The Dojo Foundation - * Released under the MIT, BSD, and GPL Licenses. - * - * Date: Sat Feb 13 22:33:48 2010 -0500 - */ -(function(A,w){function ma(){if(!c.isReady){try{s.documentElement.doScroll("left")}catch(a){setTimeout(ma,1);return}c.ready()}}function Qa(a,b){b.src?c.ajax({url:b.src,async:false,dataType:"script"}):c.globalEval(b.text||b.textContent||b.innerHTML||"");b.parentNode&&b.parentNode.removeChild(b)}function X(a,b,d,f,e,j){var i=a.length;if(typeof b==="object"){for(var o in b)X(a,o,b[o],f,e,d);return a}if(d!==w){f=!j&&f&&c.isFunction(d);for(o=0;o)[^>]*$|^#([\w-]+)$/,Ua=/^.[^:#\[\.,]*$/,Va=/\S/, -Wa=/^(\s|\u00A0)+|(\s|\u00A0)+$/g,Xa=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,P=navigator.userAgent,xa=false,Q=[],L,$=Object.prototype.toString,aa=Object.prototype.hasOwnProperty,ba=Array.prototype.push,R=Array.prototype.slice,ya=Array.prototype.indexOf;c.fn=c.prototype={init:function(a,b){var d,f;if(!a)return this;if(a.nodeType){this.context=this[0]=a;this.length=1;return this}if(a==="body"&&!b){this.context=s;this[0]=s.body;this.selector="body";this.length=1;return this}if(typeof a==="string")if((d=Ta.exec(a))&& -(d[1]||!b))if(d[1]){f=b?b.ownerDocument||b:s;if(a=Xa.exec(a))if(c.isPlainObject(b)){a=[s.createElement(a[1])];c.fn.attr.call(a,b,true)}else a=[f.createElement(a[1])];else{a=sa([d[1]],[f]);a=(a.cacheable?a.fragment.cloneNode(true):a.fragment).childNodes}return c.merge(this,a)}else{if(b=s.getElementById(d[2])){if(b.id!==d[2])return T.find(a);this.length=1;this[0]=b}this.context=s;this.selector=a;return this}else if(!b&&/^\w+$/.test(a)){this.selector=a;this.context=s;a=s.getElementsByTagName(a);return c.merge(this, -a)}else return!b||b.jquery?(b||T).find(a):c(b).find(a);else if(c.isFunction(a))return T.ready(a);if(a.selector!==w){this.selector=a.selector;this.context=a.context}return c.makeArray(a,this)},selector:"",jquery:"1.4.2",length:0,size:function(){return this.length},toArray:function(){return R.call(this,0)},get:function(a){return a==null?this.toArray():a<0?this.slice(a)[0]:this[a]},pushStack:function(a,b,d){var f=c();c.isArray(a)?ba.apply(f,a):c.merge(f,a);f.prevObject=this;f.context=this.context;if(b=== -"find")f.selector=this.selector+(this.selector?" ":"")+d;else if(b)f.selector=this.selector+"."+b+"("+d+")";return f},each:function(a,b){return c.each(this,a,b)},ready:function(a){c.bindReady();if(c.isReady)a.call(s,c);else Q&&Q.push(a);return this},eq:function(a){return a===-1?this.slice(a):this.slice(a,+a+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(R.apply(this,arguments),"slice",R.call(arguments).join(","))},map:function(a){return this.pushStack(c.map(this, -function(b,d){return a.call(b,d,b)}))},end:function(){return this.prevObject||c(null)},push:ba,sort:[].sort,splice:[].splice};c.fn.init.prototype=c.fn;c.extend=c.fn.extend=function(){var a=arguments[0]||{},b=1,d=arguments.length,f=false,e,j,i,o;if(typeof a==="boolean"){f=a;a=arguments[1]||{};b=2}if(typeof a!=="object"&&!c.isFunction(a))a={};if(d===b){a=this;--b}for(;b
a"; -var e=d.getElementsByTagName("*"),j=d.getElementsByTagName("a")[0];if(!(!e||!e.length||!j)){c.support={leadingWhitespace:d.firstChild.nodeType===3,tbody:!d.getElementsByTagName("tbody").length,htmlSerialize:!!d.getElementsByTagName("link").length,style:/red/.test(j.getAttribute("style")),hrefNormalized:j.getAttribute("href")==="/a",opacity:/^0.55$/.test(j.style.opacity),cssFloat:!!j.style.cssFloat,checkOn:d.getElementsByTagName("input")[0].value==="on",optSelected:s.createElement("select").appendChild(s.createElement("option")).selected, -parentNode:d.removeChild(d.appendChild(s.createElement("div"))).parentNode===null,deleteExpando:true,checkClone:false,scriptEval:false,noCloneEvent:true,boxModel:null};b.type="text/javascript";try{b.appendChild(s.createTextNode("window."+f+"=1;"))}catch(i){}a.insertBefore(b,a.firstChild);if(A[f]){c.support.scriptEval=true;delete A[f]}try{delete b.test}catch(o){c.support.deleteExpando=false}a.removeChild(b);if(d.attachEvent&&d.fireEvent){d.attachEvent("onclick",function k(){c.support.noCloneEvent= -false;d.detachEvent("onclick",k)});d.cloneNode(true).fireEvent("onclick")}d=s.createElement("div");d.innerHTML="";a=s.createDocumentFragment();a.appendChild(d.firstChild);c.support.checkClone=a.cloneNode(true).cloneNode(true).lastChild.checked;c(function(){var k=s.createElement("div");k.style.width=k.style.paddingLeft="1px";s.body.appendChild(k);c.boxModel=c.support.boxModel=k.offsetWidth===2;s.body.removeChild(k).style.display="none"});a=function(k){var n= -s.createElement("div");k="on"+k;var r=k in n;if(!r){n.setAttribute(k,"return;");r=typeof n[k]==="function"}return r};c.support.submitBubbles=a("submit");c.support.changeBubbles=a("change");a=b=d=e=j=null}})();c.props={"for":"htmlFor","class":"className",readonly:"readOnly",maxlength:"maxLength",cellspacing:"cellSpacing",rowspan:"rowSpan",colspan:"colSpan",tabindex:"tabIndex",usemap:"useMap",frameborder:"frameBorder"};var G="jQuery"+J(),Ya=0,za={};c.extend({cache:{},expando:G,noData:{embed:true,object:true, -applet:true},data:function(a,b,d){if(!(a.nodeName&&c.noData[a.nodeName.toLowerCase()])){a=a==A?za:a;var f=a[G],e=c.cache;if(!f&&typeof b==="string"&&d===w)return null;f||(f=++Ya);if(typeof b==="object"){a[G]=f;e[f]=c.extend(true,{},b)}else if(!e[f]){a[G]=f;e[f]={}}a=e[f];if(d!==w)a[b]=d;return typeof b==="string"?a[b]:a}},removeData:function(a,b){if(!(a.nodeName&&c.noData[a.nodeName.toLowerCase()])){a=a==A?za:a;var d=a[G],f=c.cache,e=f[d];if(b){if(e){delete e[b];c.isEmptyObject(e)&&c.removeData(a)}}else{if(c.support.deleteExpando)delete a[c.expando]; -else a.removeAttribute&&a.removeAttribute(c.expando);delete f[d]}}}});c.fn.extend({data:function(a,b){if(typeof a==="undefined"&&this.length)return c.data(this[0]);else if(typeof a==="object")return this.each(function(){c.data(this,a)});var d=a.split(".");d[1]=d[1]?"."+d[1]:"";if(b===w){var f=this.triggerHandler("getData"+d[1]+"!",[d[0]]);if(f===w&&this.length)f=c.data(this[0],a);return f===w&&d[1]?this.data(d[0]):f}else return this.trigger("setData"+d[1]+"!",[d[0],b]).each(function(){c.data(this, -a,b)})},removeData:function(a){return this.each(function(){c.removeData(this,a)})}});c.extend({queue:function(a,b,d){if(a){b=(b||"fx")+"queue";var f=c.data(a,b);if(!d)return f||[];if(!f||c.isArray(d))f=c.data(a,b,c.makeArray(d));else f.push(d);return f}},dequeue:function(a,b){b=b||"fx";var d=c.queue(a,b),f=d.shift();if(f==="inprogress")f=d.shift();if(f){b==="fx"&&d.unshift("inprogress");f.call(a,function(){c.dequeue(a,b)})}}});c.fn.extend({queue:function(a,b){if(typeof a!=="string"){b=a;a="fx"}if(b=== -w)return c.queue(this[0],a);return this.each(function(){var d=c.queue(this,a,b);a==="fx"&&d[0]!=="inprogress"&&c.dequeue(this,a)})},dequeue:function(a){return this.each(function(){c.dequeue(this,a)})},delay:function(a,b){a=c.fx?c.fx.speeds[a]||a:a;b=b||"fx";return this.queue(b,function(){var d=this;setTimeout(function(){c.dequeue(d,b)},a)})},clearQueue:function(a){return this.queue(a||"fx",[])}});var Aa=/[\n\t]/g,ca=/\s+/,Za=/\r/g,$a=/href|src|style/,ab=/(button|input)/i,bb=/(button|input|object|select|textarea)/i, -cb=/^(a|area)$/i,Ba=/radio|checkbox/;c.fn.extend({attr:function(a,b){return X(this,a,b,true,c.attr)},removeAttr:function(a){return this.each(function(){c.attr(this,a,"");this.nodeType===1&&this.removeAttribute(a)})},addClass:function(a){if(c.isFunction(a))return this.each(function(n){var r=c(this);r.addClass(a.call(this,n,r.attr("class")))});if(a&&typeof a==="string")for(var b=(a||"").split(ca),d=0,f=this.length;d-1)return true;return false},val:function(a){if(a===w){var b=this[0];if(b){if(c.nodeName(b,"option"))return(b.attributes.value||{}).specified?b.value:b.text;if(c.nodeName(b,"select")){var d=b.selectedIndex,f=[],e=b.options;b=b.type==="select-one";if(d<0)return null;var j=b?d:0;for(d=b?d+1:e.length;j=0;else if(c.nodeName(this,"select")){var u=c.makeArray(r);c("option",this).each(function(){this.selected= -c.inArray(c(this).val(),u)>=0});if(!u.length)this.selectedIndex=-1}else this.value=r}})}});c.extend({attrFn:{val:true,css:true,html:true,text:true,data:true,width:true,height:true,offset:true},attr:function(a,b,d,f){if(!a||a.nodeType===3||a.nodeType===8)return w;if(f&&b in c.attrFn)return c(a)[b](d);f=a.nodeType!==1||!c.isXMLDoc(a);var e=d!==w;b=f&&c.props[b]||b;if(a.nodeType===1){var j=$a.test(b);if(b in a&&f&&!j){if(e){b==="type"&&ab.test(a.nodeName)&&a.parentNode&&c.error("type property can't be changed"); -a[b]=d}if(c.nodeName(a,"form")&&a.getAttributeNode(b))return a.getAttributeNode(b).nodeValue;if(b==="tabIndex")return(b=a.getAttributeNode("tabIndex"))&&b.specified?b.value:bb.test(a.nodeName)||cb.test(a.nodeName)&&a.href?0:w;return a[b]}if(!c.support.style&&f&&b==="style"){if(e)a.style.cssText=""+d;return a.style.cssText}e&&a.setAttribute(b,""+d);a=!c.support.hrefNormalized&&f&&j?a.getAttribute(b,2):a.getAttribute(b);return a===null?w:a}return c.style(a,b,d)}});var O=/\.(.*)$/,db=function(a){return a.replace(/[^\w\s\.\|`]/g, -function(b){return"\\"+b})};c.event={add:function(a,b,d,f){if(!(a.nodeType===3||a.nodeType===8)){if(a.setInterval&&a!==A&&!a.frameElement)a=A;var e,j;if(d.handler){e=d;d=e.handler}if(!d.guid)d.guid=c.guid++;if(j=c.data(a)){var i=j.events=j.events||{},o=j.handle;if(!o)j.handle=o=function(){return typeof c!=="undefined"&&!c.event.triggered?c.event.handle.apply(o.elem,arguments):w};o.elem=a;b=b.split(" ");for(var k,n=0,r;k=b[n++];){j=e?c.extend({},e):{handler:d,data:f};if(k.indexOf(".")>-1){r=k.split("."); -k=r.shift();j.namespace=r.slice(0).sort().join(".")}else{r=[];j.namespace=""}j.type=k;j.guid=d.guid;var u=i[k],z=c.event.special[k]||{};if(!u){u=i[k]=[];if(!z.setup||z.setup.call(a,f,r,o)===false)if(a.addEventListener)a.addEventListener(k,o,false);else a.attachEvent&&a.attachEvent("on"+k,o)}if(z.add){z.add.call(a,j);if(!j.handler.guid)j.handler.guid=d.guid}u.push(j);c.event.global[k]=true}a=null}}},global:{},remove:function(a,b,d,f){if(!(a.nodeType===3||a.nodeType===8)){var e,j=0,i,o,k,n,r,u,z=c.data(a), -C=z&&z.events;if(z&&C){if(b&&b.type){d=b.handler;b=b.type}if(!b||typeof b==="string"&&b.charAt(0)==="."){b=b||"";for(e in C)c.event.remove(a,e+b)}else{for(b=b.split(" ");e=b[j++];){n=e;i=e.indexOf(".")<0;o=[];if(!i){o=e.split(".");e=o.shift();k=new RegExp("(^|\\.)"+c.map(o.slice(0).sort(),db).join("\\.(?:.*\\.)?")+"(\\.|$)")}if(r=C[e])if(d){n=c.event.special[e]||{};for(B=f||0;B=0){a.type= -e=e.slice(0,-1);a.exclusive=true}if(!d){a.stopPropagation();c.event.global[e]&&c.each(c.cache,function(){this.events&&this.events[e]&&c.event.trigger(a,b,this.handle.elem)})}if(!d||d.nodeType===3||d.nodeType===8)return w;a.result=w;a.target=d;b=c.makeArray(b);b.unshift(a)}a.currentTarget=d;(f=c.data(d,"handle"))&&f.apply(d,b);f=d.parentNode||d.ownerDocument;try{if(!(d&&d.nodeName&&c.noData[d.nodeName.toLowerCase()]))if(d["on"+e]&&d["on"+e].apply(d,b)===false)a.result=false}catch(j){}if(!a.isPropagationStopped()&& -f)c.event.trigger(a,b,f,true);else if(!a.isDefaultPrevented()){f=a.target;var i,o=c.nodeName(f,"a")&&e==="click",k=c.event.special[e]||{};if((!k._default||k._default.call(d,a)===false)&&!o&&!(f&&f.nodeName&&c.noData[f.nodeName.toLowerCase()])){try{if(f[e]){if(i=f["on"+e])f["on"+e]=null;c.event.triggered=true;f[e]()}}catch(n){}if(i)f["on"+e]=i;c.event.triggered=false}}},handle:function(a){var b,d,f,e;a=arguments[0]=c.event.fix(a||A.event);a.currentTarget=this;b=a.type.indexOf(".")<0&&!a.exclusive; -if(!b){d=a.type.split(".");a.type=d.shift();f=new RegExp("(^|\\.)"+d.slice(0).sort().join("\\.(?:.*\\.)?")+"(\\.|$)")}e=c.data(this,"events");d=e[a.type];if(e&&d){d=d.slice(0);e=0;for(var j=d.length;e-1?c.map(a.options,function(f){return f.selected}).join("-"):"";else if(a.nodeName.toLowerCase()==="select")d=a.selectedIndex;return d},fa=function(a,b){var d=a.target,f,e;if(!(!da.test(d.nodeName)||d.readOnly)){f=c.data(d,"_change_data");e=Fa(d);if(a.type!=="focusout"||d.type!=="radio")c.data(d,"_change_data", -e);if(!(f===w||e===f))if(f!=null||e){a.type="change";return c.event.trigger(a,b,d)}}};c.event.special.change={filters:{focusout:fa,click:function(a){var b=a.target,d=b.type;if(d==="radio"||d==="checkbox"||b.nodeName.toLowerCase()==="select")return fa.call(this,a)},keydown:function(a){var b=a.target,d=b.type;if(a.keyCode===13&&b.nodeName.toLowerCase()!=="textarea"||a.keyCode===32&&(d==="checkbox"||d==="radio")||d==="select-multiple")return fa.call(this,a)},beforeactivate:function(a){a=a.target;c.data(a, -"_change_data",Fa(a))}},setup:function(){if(this.type==="file")return false;for(var a in ea)c.event.add(this,a+".specialChange",ea[a]);return da.test(this.nodeName)},teardown:function(){c.event.remove(this,".specialChange");return da.test(this.nodeName)}};ea=c.event.special.change.filters}s.addEventListener&&c.each({focus:"focusin",blur:"focusout"},function(a,b){function d(f){f=c.event.fix(f);f.type=b;return c.event.handle.call(this,f)}c.event.special[b]={setup:function(){this.addEventListener(a, -d,true)},teardown:function(){this.removeEventListener(a,d,true)}}});c.each(["bind","one"],function(a,b){c.fn[b]=function(d,f,e){if(typeof d==="object"){for(var j in d)this[b](j,f,d[j],e);return this}if(c.isFunction(f)){e=f;f=w}var i=b==="one"?c.proxy(e,function(k){c(this).unbind(k,i);return e.apply(this,arguments)}):e;if(d==="unload"&&b!=="one")this.one(d,f,e);else{j=0;for(var o=this.length;j0){y=t;break}}t=t[g]}m[q]=y}}}var f=/((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^[\]]*\]|['"][^'"]*['"]|[^[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g, -e=0,j=Object.prototype.toString,i=false,o=true;[0,0].sort(function(){o=false;return 0});var k=function(g,h,l,m){l=l||[];var q=h=h||s;if(h.nodeType!==1&&h.nodeType!==9)return[];if(!g||typeof g!=="string")return l;for(var p=[],v,t,y,S,H=true,M=x(h),I=g;(f.exec(""),v=f.exec(I))!==null;){I=v[3];p.push(v[1]);if(v[2]){S=v[3];break}}if(p.length>1&&r.exec(g))if(p.length===2&&n.relative[p[0]])t=ga(p[0]+p[1],h);else for(t=n.relative[p[0]]?[h]:k(p.shift(),h);p.length;){g=p.shift();if(n.relative[g])g+=p.shift(); -t=ga(g,t)}else{if(!m&&p.length>1&&h.nodeType===9&&!M&&n.match.ID.test(p[0])&&!n.match.ID.test(p[p.length-1])){v=k.find(p.shift(),h,M);h=v.expr?k.filter(v.expr,v.set)[0]:v.set[0]}if(h){v=m?{expr:p.pop(),set:z(m)}:k.find(p.pop(),p.length===1&&(p[0]==="~"||p[0]==="+")&&h.parentNode?h.parentNode:h,M);t=v.expr?k.filter(v.expr,v.set):v.set;if(p.length>0)y=z(t);else H=false;for(;p.length;){var D=p.pop();v=D;if(n.relative[D])v=p.pop();else D="";if(v==null)v=h;n.relative[D](y,v,M)}}else y=[]}y||(y=t);y||k.error(D|| -g);if(j.call(y)==="[object Array]")if(H)if(h&&h.nodeType===1)for(g=0;y[g]!=null;g++){if(y[g]&&(y[g]===true||y[g].nodeType===1&&E(h,y[g])))l.push(t[g])}else for(g=0;y[g]!=null;g++)y[g]&&y[g].nodeType===1&&l.push(t[g]);else l.push.apply(l,y);else z(y,l);if(S){k(S,q,l,m);k.uniqueSort(l)}return l};k.uniqueSort=function(g){if(B){i=o;g.sort(B);if(i)for(var h=1;h":function(g,h){var l=typeof h==="string";if(l&&!/\W/.test(h)){h=h.toLowerCase();for(var m=0,q=g.length;m=0))l||m.push(v);else if(l)h[p]=false;return false},ID:function(g){return g[1].replace(/\\/g,"")},TAG:function(g){return g[1].toLowerCase()}, -CHILD:function(g){if(g[1]==="nth"){var h=/(-?)(\d*)n((?:\+|-)?\d*)/.exec(g[2]==="even"&&"2n"||g[2]==="odd"&&"2n+1"||!/\D/.test(g[2])&&"0n+"+g[2]||g[2]);g[2]=h[1]+(h[2]||1)-0;g[3]=h[3]-0}g[0]=e++;return g},ATTR:function(g,h,l,m,q,p){h=g[1].replace(/\\/g,"");if(!p&&n.attrMap[h])g[1]=n.attrMap[h];if(g[2]==="~=")g[4]=" "+g[4]+" ";return g},PSEUDO:function(g,h,l,m,q){if(g[1]==="not")if((f.exec(g[3])||"").length>1||/^\w/.test(g[3]))g[3]=k(g[3],null,null,h);else{g=k.filter(g[3],h,l,true^q);l||m.push.apply(m, -g);return false}else if(n.match.POS.test(g[0])||n.match.CHILD.test(g[0]))return true;return g},POS:function(g){g.unshift(true);return g}},filters:{enabled:function(g){return g.disabled===false&&g.type!=="hidden"},disabled:function(g){return g.disabled===true},checked:function(g){return g.checked===true},selected:function(g){return g.selected===true},parent:function(g){return!!g.firstChild},empty:function(g){return!g.firstChild},has:function(g,h,l){return!!k(l[3],g).length},header:function(g){return/h\d/i.test(g.nodeName)}, -text:function(g){return"text"===g.type},radio:function(g){return"radio"===g.type},checkbox:function(g){return"checkbox"===g.type},file:function(g){return"file"===g.type},password:function(g){return"password"===g.type},submit:function(g){return"submit"===g.type},image:function(g){return"image"===g.type},reset:function(g){return"reset"===g.type},button:function(g){return"button"===g.type||g.nodeName.toLowerCase()==="button"},input:function(g){return/input|select|textarea|button/i.test(g.nodeName)}}, -setFilters:{first:function(g,h){return h===0},last:function(g,h,l,m){return h===m.length-1},even:function(g,h){return h%2===0},odd:function(g,h){return h%2===1},lt:function(g,h,l){return hl[3]-0},nth:function(g,h,l){return l[3]-0===h},eq:function(g,h,l){return l[3]-0===h}},filter:{PSEUDO:function(g,h,l,m){var q=h[1],p=n.filters[q];if(p)return p(g,l,h,m);else if(q==="contains")return(g.textContent||g.innerText||a([g])||"").indexOf(h[3])>=0;else if(q==="not"){h= -h[3];l=0;for(m=h.length;l=0}},ID:function(g,h){return g.nodeType===1&&g.getAttribute("id")===h},TAG:function(g,h){return h==="*"&&g.nodeType===1||g.nodeName.toLowerCase()===h},CLASS:function(g,h){return(" "+(g.className||g.getAttribute("class"))+" ").indexOf(h)>-1},ATTR:function(g,h){var l=h[1];g=n.attrHandle[l]?n.attrHandle[l](g):g[l]!=null?g[l]:g.getAttribute(l);l=g+"";var m=h[2];h=h[4];return g==null?m==="!=":m=== -"="?l===h:m==="*="?l.indexOf(h)>=0:m==="~="?(" "+l+" ").indexOf(h)>=0:!h?l&&g!==false:m==="!="?l!==h:m==="^="?l.indexOf(h)===0:m==="$="?l.substr(l.length-h.length)===h:m==="|="?l===h||l.substr(0,h.length+1)===h+"-":false},POS:function(g,h,l,m){var q=n.setFilters[h[2]];if(q)return q(g,l,h,m)}}},r=n.match.POS;for(var u in n.match){n.match[u]=new RegExp(n.match[u].source+/(?![^\[]*\])(?![^\(]*\))/.source);n.leftMatch[u]=new RegExp(/(^(?:.|\r|\n)*?)/.source+n.match[u].source.replace(/\\(\d+)/g,function(g, -h){return"\\"+(h-0+1)}))}var z=function(g,h){g=Array.prototype.slice.call(g,0);if(h){h.push.apply(h,g);return h}return g};try{Array.prototype.slice.call(s.documentElement.childNodes,0)}catch(C){z=function(g,h){h=h||[];if(j.call(g)==="[object Array]")Array.prototype.push.apply(h,g);else if(typeof g.length==="number")for(var l=0,m=g.length;l";var l=s.documentElement;l.insertBefore(g,l.firstChild);if(s.getElementById(h)){n.find.ID=function(m,q,p){if(typeof q.getElementById!=="undefined"&&!p)return(q=q.getElementById(m[1]))?q.id===m[1]||typeof q.getAttributeNode!=="undefined"&& -q.getAttributeNode("id").nodeValue===m[1]?[q]:w:[]};n.filter.ID=function(m,q){var p=typeof m.getAttributeNode!=="undefined"&&m.getAttributeNode("id");return m.nodeType===1&&p&&p.nodeValue===q}}l.removeChild(g);l=g=null})();(function(){var g=s.createElement("div");g.appendChild(s.createComment(""));if(g.getElementsByTagName("*").length>0)n.find.TAG=function(h,l){l=l.getElementsByTagName(h[1]);if(h[1]==="*"){h=[];for(var m=0;l[m];m++)l[m].nodeType===1&&h.push(l[m]);l=h}return l};g.innerHTML=""; -if(g.firstChild&&typeof g.firstChild.getAttribute!=="undefined"&&g.firstChild.getAttribute("href")!=="#")n.attrHandle.href=function(h){return h.getAttribute("href",2)};g=null})();s.querySelectorAll&&function(){var g=k,h=s.createElement("div");h.innerHTML="

";if(!(h.querySelectorAll&&h.querySelectorAll(".TEST").length===0)){k=function(m,q,p,v){q=q||s;if(!v&&q.nodeType===9&&!x(q))try{return z(q.querySelectorAll(m),p)}catch(t){}return g(m,q,p,v)};for(var l in g)k[l]=g[l];h=null}}(); -(function(){var g=s.createElement("div");g.innerHTML="
";if(!(!g.getElementsByClassName||g.getElementsByClassName("e").length===0)){g.lastChild.className="e";if(g.getElementsByClassName("e").length!==1){n.order.splice(1,0,"CLASS");n.find.CLASS=function(h,l,m){if(typeof l.getElementsByClassName!=="undefined"&&!m)return l.getElementsByClassName(h[1])};g=null}}})();var E=s.compareDocumentPosition?function(g,h){return!!(g.compareDocumentPosition(h)&16)}: -function(g,h){return g!==h&&(g.contains?g.contains(h):true)},x=function(g){return(g=(g?g.ownerDocument||g:0).documentElement)?g.nodeName!=="HTML":false},ga=function(g,h){var l=[],m="",q;for(h=h.nodeType?[h]:h;q=n.match.PSEUDO.exec(g);){m+=q[0];g=g.replace(n.match.PSEUDO,"")}g=n.relative[g]?g+"*":g;q=0;for(var p=h.length;q=0===d})};c.fn.extend({find:function(a){for(var b=this.pushStack("","find",a),d=0,f=0,e=this.length;f0)for(var j=d;j0},closest:function(a,b){if(c.isArray(a)){var d=[],f=this[0],e,j= -{},i;if(f&&a.length){e=0;for(var o=a.length;e-1:c(f).is(e)){d.push({selector:i,elem:f});delete j[i]}}f=f.parentNode}}return d}var k=c.expr.match.POS.test(a)?c(a,b||this.context):null;return this.map(function(n,r){for(;r&&r.ownerDocument&&r!==b;){if(k?k.index(r)>-1:c(r).is(a))return r;r=r.parentNode}return null})},index:function(a){if(!a||typeof a=== -"string")return c.inArray(this[0],a?c(a):this.parent().children());return c.inArray(a.jquery?a[0]:a,this)},add:function(a,b){a=typeof a==="string"?c(a,b||this.context):c.makeArray(a);b=c.merge(this.get(),a);return this.pushStack(qa(a[0])||qa(b[0])?b:c.unique(b))},andSelf:function(){return this.add(this.prevObject)}});c.each({parent:function(a){return(a=a.parentNode)&&a.nodeType!==11?a:null},parents:function(a){return c.dir(a,"parentNode")},parentsUntil:function(a,b,d){return c.dir(a,"parentNode", -d)},next:function(a){return c.nth(a,2,"nextSibling")},prev:function(a){return c.nth(a,2,"previousSibling")},nextAll:function(a){return c.dir(a,"nextSibling")},prevAll:function(a){return c.dir(a,"previousSibling")},nextUntil:function(a,b,d){return c.dir(a,"nextSibling",d)},prevUntil:function(a,b,d){return c.dir(a,"previousSibling",d)},siblings:function(a){return c.sibling(a.parentNode.firstChild,a)},children:function(a){return c.sibling(a.firstChild)},contents:function(a){return c.nodeName(a,"iframe")? -a.contentDocument||a.contentWindow.document:c.makeArray(a.childNodes)}},function(a,b){c.fn[a]=function(d,f){var e=c.map(this,b,d);eb.test(a)||(f=d);if(f&&typeof f==="string")e=c.filter(f,e);e=this.length>1?c.unique(e):e;if((this.length>1||gb.test(f))&&fb.test(a))e=e.reverse();return this.pushStack(e,a,R.call(arguments).join(","))}});c.extend({filter:function(a,b,d){if(d)a=":not("+a+")";return c.find.matches(a,b)},dir:function(a,b,d){var f=[];for(a=a[b];a&&a.nodeType!==9&&(d===w||a.nodeType!==1||!c(a).is(d));){a.nodeType=== -1&&f.push(a);a=a[b]}return f},nth:function(a,b,d){b=b||1;for(var f=0;a;a=a[d])if(a.nodeType===1&&++f===b)break;return a},sibling:function(a,b){for(var d=[];a;a=a.nextSibling)a.nodeType===1&&a!==b&&d.push(a);return d}});var Ja=/ jQuery\d+="(?:\d+|null)"/g,V=/^\s+/,Ka=/(<([\w:]+)[^>]*?)\/>/g,hb=/^(?:area|br|col|embed|hr|img|input|link|meta|param)$/i,La=/<([\w:]+)/,ib=/"},F={option:[1,""],legend:[1,"
","
"],thead:[1,"","
"],tr:[2,"","
"],td:[3,"","
"],col:[2,"","
"],area:[1,"",""],_default:[0,"",""]};F.optgroup=F.option;F.tbody=F.tfoot=F.colgroup=F.caption=F.thead;F.th=F.td;if(!c.support.htmlSerialize)F._default=[1,"div
","
"];c.fn.extend({text:function(a){if(c.isFunction(a))return this.each(function(b){var d= -c(this);d.text(a.call(this,b,d.text()))});if(typeof a!=="object"&&a!==w)return this.empty().append((this[0]&&this[0].ownerDocument||s).createTextNode(a));return c.text(this)},wrapAll:function(a){if(c.isFunction(a))return this.each(function(d){c(this).wrapAll(a.call(this,d))});if(this[0]){var b=c(a,this[0].ownerDocument).eq(0).clone(true);this[0].parentNode&&b.insertBefore(this[0]);b.map(function(){for(var d=this;d.firstChild&&d.firstChild.nodeType===1;)d=d.firstChild;return d}).append(this)}return this}, -wrapInner:function(a){if(c.isFunction(a))return this.each(function(b){c(this).wrapInner(a.call(this,b))});return this.each(function(){var b=c(this),d=b.contents();d.length?d.wrapAll(a):b.append(a)})},wrap:function(a){return this.each(function(){c(this).wrapAll(a)})},unwrap:function(){return this.parent().each(function(){c.nodeName(this,"body")||c(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.appendChild(a)})}, -prepend:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.insertBefore(a,this.firstChild)})},before:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b,this)});else if(arguments.length){var a=c(arguments[0]);a.push.apply(a,this.toArray());return this.pushStack(a,"before",arguments)}},after:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b, -this.nextSibling)});else if(arguments.length){var a=this.pushStack(this,"after",arguments);a.push.apply(a,c(arguments[0]).toArray());return a}},remove:function(a,b){for(var d=0,f;(f=this[d])!=null;d++)if(!a||c.filter(a,[f]).length){if(!b&&f.nodeType===1){c.cleanData(f.getElementsByTagName("*"));c.cleanData([f])}f.parentNode&&f.parentNode.removeChild(f)}return this},empty:function(){for(var a=0,b;(b=this[a])!=null;a++)for(b.nodeType===1&&c.cleanData(b.getElementsByTagName("*"));b.firstChild;)b.removeChild(b.firstChild); -return this},clone:function(a){var b=this.map(function(){if(!c.support.noCloneEvent&&!c.isXMLDoc(this)){var d=this.outerHTML,f=this.ownerDocument;if(!d){d=f.createElement("div");d.appendChild(this.cloneNode(true));d=d.innerHTML}return c.clean([d.replace(Ja,"").replace(/=([^="'>\s]+\/)>/g,'="$1">').replace(V,"")],f)[0]}else return this.cloneNode(true)});if(a===true){ra(this,b);ra(this.find("*"),b.find("*"))}return b},html:function(a){if(a===w)return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(Ja, -""):null;else if(typeof a==="string"&&!ta.test(a)&&(c.support.leadingWhitespace||!V.test(a))&&!F[(La.exec(a)||["",""])[1].toLowerCase()]){a=a.replace(Ka,Ma);try{for(var b=0,d=this.length;b0||e.cacheable||this.length>1?k.cloneNode(true):k)}o.length&&c.each(o,Qa)}return this}});c.fragments={};c.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){c.fn[a]=function(d){var f=[];d=c(d);var e=this.length===1&&this[0].parentNode;if(e&&e.nodeType===11&&e.childNodes.length===1&&d.length===1){d[b](this[0]); -return this}else{e=0;for(var j=d.length;e0?this.clone(true):this).get();c.fn[b].apply(c(d[e]),i);f=f.concat(i)}return this.pushStack(f,a,d.selector)}}});c.extend({clean:function(a,b,d,f){b=b||s;if(typeof b.createElement==="undefined")b=b.ownerDocument||b[0]&&b[0].ownerDocument||s;for(var e=[],j=0,i;(i=a[j])!=null;j++){if(typeof i==="number")i+="";if(i){if(typeof i==="string"&&!jb.test(i))i=b.createTextNode(i);else if(typeof i==="string"){i=i.replace(Ka,Ma);var o=(La.exec(i)||["", -""])[1].toLowerCase(),k=F[o]||F._default,n=k[0],r=b.createElement("div");for(r.innerHTML=k[1]+i+k[2];n--;)r=r.lastChild;if(!c.support.tbody){n=ib.test(i);o=o==="table"&&!n?r.firstChild&&r.firstChild.childNodes:k[1]===""&&!n?r.childNodes:[];for(k=o.length-1;k>=0;--k)c.nodeName(o[k],"tbody")&&!o[k].childNodes.length&&o[k].parentNode.removeChild(o[k])}!c.support.leadingWhitespace&&V.test(i)&&r.insertBefore(b.createTextNode(V.exec(i)[0]),r.firstChild);i=r.childNodes}if(i.nodeType)e.push(i);else e= -c.merge(e,i)}}if(d)for(j=0;e[j];j++)if(f&&c.nodeName(e[j],"script")&&(!e[j].type||e[j].type.toLowerCase()==="text/javascript"))f.push(e[j].parentNode?e[j].parentNode.removeChild(e[j]):e[j]);else{e[j].nodeType===1&&e.splice.apply(e,[j+1,0].concat(c.makeArray(e[j].getElementsByTagName("script"))));d.appendChild(e[j])}return e},cleanData:function(a){for(var b,d,f=c.cache,e=c.event.special,j=c.support.deleteExpando,i=0,o;(o=a[i])!=null;i++)if(d=o[c.expando]){b=f[d];if(b.events)for(var k in b.events)e[k]? -c.event.remove(o,k):Ca(o,k,b.handle);if(j)delete o[c.expando];else o.removeAttribute&&o.removeAttribute(c.expando);delete f[d]}}});var kb=/z-?index|font-?weight|opacity|zoom|line-?height/i,Na=/alpha\([^)]*\)/,Oa=/opacity=([^)]*)/,ha=/float/i,ia=/-([a-z])/ig,lb=/([A-Z])/g,mb=/^-?\d+(?:px)?$/i,nb=/^-?\d/,ob={position:"absolute",visibility:"hidden",display:"block"},pb=["Left","Right"],qb=["Top","Bottom"],rb=s.defaultView&&s.defaultView.getComputedStyle,Pa=c.support.cssFloat?"cssFloat":"styleFloat",ja= -function(a,b){return b.toUpperCase()};c.fn.css=function(a,b){return X(this,a,b,true,function(d,f,e){if(e===w)return c.curCSS(d,f);if(typeof e==="number"&&!kb.test(f))e+="px";c.style(d,f,e)})};c.extend({style:function(a,b,d){if(!a||a.nodeType===3||a.nodeType===8)return w;if((b==="width"||b==="height")&&parseFloat(d)<0)d=w;var f=a.style||a,e=d!==w;if(!c.support.opacity&&b==="opacity"){if(e){f.zoom=1;b=parseInt(d,10)+""==="NaN"?"":"alpha(opacity="+d*100+")";a=f.filter||c.curCSS(a,"filter")||"";f.filter= -Na.test(a)?a.replace(Na,b):b}return f.filter&&f.filter.indexOf("opacity=")>=0?parseFloat(Oa.exec(f.filter)[1])/100+"":""}if(ha.test(b))b=Pa;b=b.replace(ia,ja);if(e)f[b]=d;return f[b]},css:function(a,b,d,f){if(b==="width"||b==="height"){var e,j=b==="width"?pb:qb;function i(){e=b==="width"?a.offsetWidth:a.offsetHeight;f!=="border"&&c.each(j,function(){f||(e-=parseFloat(c.curCSS(a,"padding"+this,true))||0);if(f==="margin")e+=parseFloat(c.curCSS(a,"margin"+this,true))||0;else e-=parseFloat(c.curCSS(a, -"border"+this+"Width",true))||0})}a.offsetWidth!==0?i():c.swap(a,ob,i);return Math.max(0,Math.round(e))}return c.curCSS(a,b,d)},curCSS:function(a,b,d){var f,e=a.style;if(!c.support.opacity&&b==="opacity"&&a.currentStyle){f=Oa.test(a.currentStyle.filter||"")?parseFloat(RegExp.$1)/100+"":"";return f===""?"1":f}if(ha.test(b))b=Pa;if(!d&&e&&e[b])f=e[b];else if(rb){if(ha.test(b))b="float";b=b.replace(lb,"-$1").toLowerCase();e=a.ownerDocument.defaultView;if(!e)return null;if(a=e.getComputedStyle(a,null))f= -a.getPropertyValue(b);if(b==="opacity"&&f==="")f="1"}else if(a.currentStyle){d=b.replace(ia,ja);f=a.currentStyle[b]||a.currentStyle[d];if(!mb.test(f)&&nb.test(f)){b=e.left;var j=a.runtimeStyle.left;a.runtimeStyle.left=a.currentStyle.left;e.left=d==="fontSize"?"1em":f||0;f=e.pixelLeft+"px";e.left=b;a.runtimeStyle.left=j}}return f},swap:function(a,b,d){var f={};for(var e in b){f[e]=a.style[e];a.style[e]=b[e]}d.call(a);for(e in b)a.style[e]=f[e]}});if(c.expr&&c.expr.filters){c.expr.filters.hidden=function(a){var b= -a.offsetWidth,d=a.offsetHeight,f=a.nodeName.toLowerCase()==="tr";return b===0&&d===0&&!f?true:b>0&&d>0&&!f?false:c.curCSS(a,"display")==="none"};c.expr.filters.visible=function(a){return!c.expr.filters.hidden(a)}}var sb=J(),tb=//gi,ub=/select|textarea/i,vb=/color|date|datetime|email|hidden|month|number|password|range|search|tel|text|time|url|week/i,N=/=\?(&|$)/,ka=/\?/,wb=/(\?|&)_=.*?(&|$)/,xb=/^(\w+:)?\/\/([^\/?#]+)/,yb=/%20/g,zb=c.fn.load;c.fn.extend({load:function(a,b,d){if(typeof a!== -"string")return zb.call(this,a);else if(!this.length)return this;var f=a.indexOf(" ");if(f>=0){var e=a.slice(f,a.length);a=a.slice(0,f)}f="GET";if(b)if(c.isFunction(b)){d=b;b=null}else if(typeof b==="object"){b=c.param(b,c.ajaxSettings.traditional);f="POST"}var j=this;c.ajax({url:a,type:f,dataType:"html",data:b,complete:function(i,o){if(o==="success"||o==="notmodified")j.html(e?c("
").append(i.responseText.replace(tb,"")).find(e):i.responseText);d&&j.each(d,[i.responseText,o,i])}});return this}, -serialize:function(){return c.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?c.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||ub.test(this.nodeName)||vb.test(this.type))}).map(function(a,b){a=c(this).val();return a==null?null:c.isArray(a)?c.map(a,function(d){return{name:b.name,value:d}}):{name:b.name,value:a}}).get()}});c.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "), -function(a,b){c.fn[b]=function(d){return this.bind(b,d)}});c.extend({get:function(a,b,d,f){if(c.isFunction(b)){f=f||d;d=b;b=null}return c.ajax({type:"GET",url:a,data:b,success:d,dataType:f})},getScript:function(a,b){return c.get(a,null,b,"script")},getJSON:function(a,b,d){return c.get(a,b,d,"json")},post:function(a,b,d,f){if(c.isFunction(b)){f=f||d;d=b;b={}}return c.ajax({type:"POST",url:a,data:b,success:d,dataType:f})},ajaxSetup:function(a){c.extend(c.ajaxSettings,a)},ajaxSettings:{url:location.href, -global:true,type:"GET",contentType:"application/x-www-form-urlencoded",processData:true,async:true,xhr:A.XMLHttpRequest&&(A.location.protocol!=="file:"||!A.ActiveXObject)?function(){return new A.XMLHttpRequest}:function(){try{return new A.ActiveXObject("Microsoft.XMLHTTP")}catch(a){}},accepts:{xml:"application/xml, text/xml",html:"text/html",script:"text/javascript, application/javascript",json:"application/json, text/javascript",text:"text/plain",_default:"*/*"}},lastModified:{},etag:{},ajax:function(a){function b(){e.success&& -e.success.call(k,o,i,x);e.global&&f("ajaxSuccess",[x,e])}function d(){e.complete&&e.complete.call(k,x,i);e.global&&f("ajaxComplete",[x,e]);e.global&&!--c.active&&c.event.trigger("ajaxStop")}function f(q,p){(e.context?c(e.context):c.event).trigger(q,p)}var e=c.extend(true,{},c.ajaxSettings,a),j,i,o,k=a&&a.context||e,n=e.type.toUpperCase();if(e.data&&e.processData&&typeof e.data!=="string")e.data=c.param(e.data,e.traditional);if(e.dataType==="jsonp"){if(n==="GET")N.test(e.url)||(e.url+=(ka.test(e.url)? -"&":"?")+(e.jsonp||"callback")+"=?");else if(!e.data||!N.test(e.data))e.data=(e.data?e.data+"&":"")+(e.jsonp||"callback")+"=?";e.dataType="json"}if(e.dataType==="json"&&(e.data&&N.test(e.data)||N.test(e.url))){j=e.jsonpCallback||"jsonp"+sb++;if(e.data)e.data=(e.data+"").replace(N,"="+j+"$1");e.url=e.url.replace(N,"="+j+"$1");e.dataType="script";A[j]=A[j]||function(q){o=q;b();d();A[j]=w;try{delete A[j]}catch(p){}z&&z.removeChild(C)}}if(e.dataType==="script"&&e.cache===null)e.cache=false;if(e.cache=== -false&&n==="GET"){var r=J(),u=e.url.replace(wb,"$1_="+r+"$2");e.url=u+(u===e.url?(ka.test(e.url)?"&":"?")+"_="+r:"")}if(e.data&&n==="GET")e.url+=(ka.test(e.url)?"&":"?")+e.data;e.global&&!c.active++&&c.event.trigger("ajaxStart");r=(r=xb.exec(e.url))&&(r[1]&&r[1]!==location.protocol||r[2]!==location.host);if(e.dataType==="script"&&n==="GET"&&r){var z=s.getElementsByTagName("head")[0]||s.documentElement,C=s.createElement("script");C.src=e.url;if(e.scriptCharset)C.charset=e.scriptCharset;if(!j){var B= -false;C.onload=C.onreadystatechange=function(){if(!B&&(!this.readyState||this.readyState==="loaded"||this.readyState==="complete")){B=true;b();d();C.onload=C.onreadystatechange=null;z&&C.parentNode&&z.removeChild(C)}}}z.insertBefore(C,z.firstChild);return w}var E=false,x=e.xhr();if(x){e.username?x.open(n,e.url,e.async,e.username,e.password):x.open(n,e.url,e.async);try{if(e.data||a&&a.contentType)x.setRequestHeader("Content-Type",e.contentType);if(e.ifModified){c.lastModified[e.url]&&x.setRequestHeader("If-Modified-Since", -c.lastModified[e.url]);c.etag[e.url]&&x.setRequestHeader("If-None-Match",c.etag[e.url])}r||x.setRequestHeader("X-Requested-With","XMLHttpRequest");x.setRequestHeader("Accept",e.dataType&&e.accepts[e.dataType]?e.accepts[e.dataType]+", */*":e.accepts._default)}catch(ga){}if(e.beforeSend&&e.beforeSend.call(k,x,e)===false){e.global&&!--c.active&&c.event.trigger("ajaxStop");x.abort();return false}e.global&&f("ajaxSend",[x,e]);var g=x.onreadystatechange=function(q){if(!x||x.readyState===0||q==="abort"){E|| -d();E=true;if(x)x.onreadystatechange=c.noop}else if(!E&&x&&(x.readyState===4||q==="timeout")){E=true;x.onreadystatechange=c.noop;i=q==="timeout"?"timeout":!c.httpSuccess(x)?"error":e.ifModified&&c.httpNotModified(x,e.url)?"notmodified":"success";var p;if(i==="success")try{o=c.httpData(x,e.dataType,e)}catch(v){i="parsererror";p=v}if(i==="success"||i==="notmodified")j||b();else c.handleError(e,x,i,p);d();q==="timeout"&&x.abort();if(e.async)x=null}};try{var h=x.abort;x.abort=function(){x&&h.call(x); -g("abort")}}catch(l){}e.async&&e.timeout>0&&setTimeout(function(){x&&!E&&g("timeout")},e.timeout);try{x.send(n==="POST"||n==="PUT"||n==="DELETE"?e.data:null)}catch(m){c.handleError(e,x,null,m);d()}e.async||g();return x}},handleError:function(a,b,d,f){if(a.error)a.error.call(a.context||a,b,d,f);if(a.global)(a.context?c(a.context):c.event).trigger("ajaxError",[b,a,f])},active:0,httpSuccess:function(a){try{return!a.status&&location.protocol==="file:"||a.status>=200&&a.status<300||a.status===304||a.status=== -1223||a.status===0}catch(b){}return false},httpNotModified:function(a,b){var d=a.getResponseHeader("Last-Modified"),f=a.getResponseHeader("Etag");if(d)c.lastModified[b]=d;if(f)c.etag[b]=f;return a.status===304||a.status===0},httpData:function(a,b,d){var f=a.getResponseHeader("content-type")||"",e=b==="xml"||!b&&f.indexOf("xml")>=0;a=e?a.responseXML:a.responseText;e&&a.documentElement.nodeName==="parsererror"&&c.error("parsererror");if(d&&d.dataFilter)a=d.dataFilter(a,b);if(typeof a==="string")if(b=== -"json"||!b&&f.indexOf("json")>=0)a=c.parseJSON(a);else if(b==="script"||!b&&f.indexOf("javascript")>=0)c.globalEval(a);return a},param:function(a,b){function d(i,o){if(c.isArray(o))c.each(o,function(k,n){b||/\[\]$/.test(i)?f(i,n):d(i+"["+(typeof n==="object"||c.isArray(n)?k:"")+"]",n)});else!b&&o!=null&&typeof o==="object"?c.each(o,function(k,n){d(i+"["+k+"]",n)}):f(i,o)}function f(i,o){o=c.isFunction(o)?o():o;e[e.length]=encodeURIComponent(i)+"="+encodeURIComponent(o)}var e=[];if(b===w)b=c.ajaxSettings.traditional; -if(c.isArray(a)||a.jquery)c.each(a,function(){f(this.name,this.value)});else for(var j in a)d(j,a[j]);return e.join("&").replace(yb,"+")}});var la={},Ab=/toggle|show|hide/,Bb=/^([+-]=)?([\d+-.]+)(.*)$/,W,va=[["height","marginTop","marginBottom","paddingTop","paddingBottom"],["width","marginLeft","marginRight","paddingLeft","paddingRight"],["opacity"]];c.fn.extend({show:function(a,b){if(a||a===0)return this.animate(K("show",3),a,b);else{a=0;for(b=this.length;a").appendTo("body");f=e.css("display");if(f==="none")f="block";e.remove();la[d]=f}c.data(this[a],"olddisplay",f)}}a=0;for(b=this.length;a=0;f--)if(d[f].elem===this){b&&d[f](true);d.splice(f,1)}});b||this.dequeue();return this}});c.each({slideDown:K("show",1),slideUp:K("hide",1),slideToggle:K("toggle",1),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"}},function(a,b){c.fn[a]=function(d,f){return this.animate(b,d,f)}});c.extend({speed:function(a,b,d){var f=a&&typeof a==="object"?a:{complete:d||!d&&b||c.isFunction(a)&&a,duration:a,easing:d&&b||b&&!c.isFunction(b)&&b};f.duration=c.fx.off?0:typeof f.duration=== -"number"?f.duration:c.fx.speeds[f.duration]||c.fx.speeds._default;f.old=f.complete;f.complete=function(){f.queue!==false&&c(this).dequeue();c.isFunction(f.old)&&f.old.call(this)};return f},easing:{linear:function(a,b,d,f){return d+f*a},swing:function(a,b,d,f){return(-Math.cos(a*Math.PI)/2+0.5)*f+d}},timers:[],fx:function(a,b,d){this.options=b;this.elem=a;this.prop=d;if(!b.orig)b.orig={}}});c.fx.prototype={update:function(){this.options.step&&this.options.step.call(this.elem,this.now,this);(c.fx.step[this.prop]|| -c.fx.step._default)(this);if((this.prop==="height"||this.prop==="width")&&this.elem.style)this.elem.style.display="block"},cur:function(a){if(this.elem[this.prop]!=null&&(!this.elem.style||this.elem.style[this.prop]==null))return this.elem[this.prop];return(a=parseFloat(c.css(this.elem,this.prop,a)))&&a>-10000?a:parseFloat(c.curCSS(this.elem,this.prop))||0},custom:function(a,b,d){function f(j){return e.step(j)}this.startTime=J();this.start=a;this.end=b;this.unit=d||this.unit||"px";this.now=this.start; -this.pos=this.state=0;var e=this;f.elem=this.elem;if(f()&&c.timers.push(f)&&!W)W=setInterval(c.fx.tick,13)},show:function(){this.options.orig[this.prop]=c.style(this.elem,this.prop);this.options.show=true;this.custom(this.prop==="width"||this.prop==="height"?1:0,this.cur());c(this.elem).show()},hide:function(){this.options.orig[this.prop]=c.style(this.elem,this.prop);this.options.hide=true;this.custom(this.cur(),0)},step:function(a){var b=J(),d=true;if(a||b>=this.options.duration+this.startTime){this.now= -this.end;this.pos=this.state=1;this.update();this.options.curAnim[this.prop]=true;for(var f in this.options.curAnim)if(this.options.curAnim[f]!==true)d=false;if(d){if(this.options.display!=null){this.elem.style.overflow=this.options.overflow;a=c.data(this.elem,"olddisplay");this.elem.style.display=a?a:this.options.display;if(c.css(this.elem,"display")==="none")this.elem.style.display="block"}this.options.hide&&c(this.elem).hide();if(this.options.hide||this.options.show)for(var e in this.options.curAnim)c.style(this.elem, -e,this.options.orig[e]);this.options.complete.call(this.elem)}return false}else{e=b-this.startTime;this.state=e/this.options.duration;a=this.options.easing||(c.easing.swing?"swing":"linear");this.pos=c.easing[this.options.specialEasing&&this.options.specialEasing[this.prop]||a](this.state,e,0,1,this.options.duration);this.now=this.start+(this.end-this.start)*this.pos;this.update()}return true}};c.extend(c.fx,{tick:function(){for(var a=c.timers,b=0;b
"; -a.insertBefore(b,a.firstChild);d=b.firstChild;f=d.firstChild;e=d.nextSibling.firstChild.firstChild;this.doesNotAddBorder=f.offsetTop!==5;this.doesAddBorderForTableAndCells=e.offsetTop===5;f.style.position="fixed";f.style.top="20px";this.supportsFixedPosition=f.offsetTop===20||f.offsetTop===15;f.style.position=f.style.top="";d.style.overflow="hidden";d.style.position="relative";this.subtractsBorderForOverflowNotVisible=f.offsetTop===-5;this.doesNotIncludeMarginInBodyOffset=a.offsetTop!==j;a.removeChild(b); -c.offset.initialize=c.noop},bodyOffset:function(a){var b=a.offsetTop,d=a.offsetLeft;c.offset.initialize();if(c.offset.doesNotIncludeMarginInBodyOffset){b+=parseFloat(c.curCSS(a,"marginTop",true))||0;d+=parseFloat(c.curCSS(a,"marginLeft",true))||0}return{top:b,left:d}},setOffset:function(a,b,d){if(/static/.test(c.curCSS(a,"position")))a.style.position="relative";var f=c(a),e=f.offset(),j=parseInt(c.curCSS(a,"top",true),10)||0,i=parseInt(c.curCSS(a,"left",true),10)||0;if(c.isFunction(b))b=b.call(a, -d,e);d={top:b.top-e.top+j,left:b.left-e.left+i};"using"in b?b.using.call(a,d):f.css(d)}};c.fn.extend({position:function(){if(!this[0])return null;var a=this[0],b=this.offsetParent(),d=this.offset(),f=/^body|html$/i.test(b[0].nodeName)?{top:0,left:0}:b.offset();d.top-=parseFloat(c.curCSS(a,"marginTop",true))||0;d.left-=parseFloat(c.curCSS(a,"marginLeft",true))||0;f.top+=parseFloat(c.curCSS(b[0],"borderTopWidth",true))||0;f.left+=parseFloat(c.curCSS(b[0],"borderLeftWidth",true))||0;return{top:d.top- -f.top,left:d.left-f.left}},offsetParent:function(){return this.map(function(){for(var a=this.offsetParent||s.body;a&&!/^body|html$/i.test(a.nodeName)&&c.css(a,"position")==="static";)a=a.offsetParent;return a})}});c.each(["Left","Top"],function(a,b){var d="scroll"+b;c.fn[d]=function(f){var e=this[0],j;if(!e)return null;if(f!==w)return this.each(function(){if(j=wa(this))j.scrollTo(!a?f:c(j).scrollLeft(),a?f:c(j).scrollTop());else this[d]=f});else return(j=wa(e))?"pageXOffset"in j?j[a?"pageYOffset": -"pageXOffset"]:c.support.boxModel&&j.document.documentElement[d]||j.document.body[d]:e[d]}});c.each(["Height","Width"],function(a,b){var d=b.toLowerCase();c.fn["inner"+b]=function(){return this[0]?c.css(this[0],d,false,"padding"):null};c.fn["outer"+b]=function(f){return this[0]?c.css(this[0],d,false,f?"margin":"border"):null};c.fn[d]=function(f){var e=this[0];if(!e)return f==null?null:this;if(c.isFunction(f))return this.each(function(j){var i=c(this);i[d](f.call(this,j,i[d]()))});return"scrollTo"in -e&&e.document?e.document.compatMode==="CSS1Compat"&&e.document.documentElement["client"+b]||e.document.body["client"+b]:e.nodeType===9?Math.max(e.documentElement["client"+b],e.body["scroll"+b],e.documentElement["scroll"+b],e.body["offset"+b],e.documentElement["offset"+b]):f===w?c.css(e,d):this.css(d,typeof f==="string"?f:f+"px")}});A.jQuery=A.$=c})(window); +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0 -1) - start = i; - }); - start = Math.max(start - 120, 0); - var excerpt = ((start > 0) ? '...' : '') + - $.trim(text.substr(start, 240)) + - ((start + 240 - text.length) ? '...' : ''); - var rv = $('
').text(excerpt); - $.each(hlwords, function() { - rv = rv.highlightText(this, 'highlighted'); - }); - return rv; +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; } +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; /** - * Porter Stemmer + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping */ -var Stemmer = function() { - - var step2list = { - ational: 'ate', - tional: 'tion', - enci: 'ence', - anci: 'ance', - izer: 'ize', - bli: 'ble', - alli: 'al', - entli: 'ent', - eli: 'e', - ousli: 'ous', - ization: 'ize', - ation: 'ate', - ator: 'ate', - alism: 'al', - iveness: 'ive', - fulness: 'ful', - ousness: 'ous', - aliti: 'al', - iviti: 'ive', - biliti: 'ble', - logi: 'log' - }; - - var step3list = { - icate: 'ic', - ative: '', - alize: 'al', - iciti: 'ic', - ical: 'ic', - ful: '', - ness: '' - }; - - var c = "[^aeiou]"; // consonant - var v = "[aeiouy]"; // vowel - var C = c + "[^aeiouy]*"; // consonant sequence - var V = v + "[aeiou]*"; // vowel sequence - - var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 - var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 - var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 - var s_v = "^(" + C + ")?" + v; // vowel in stem - - this.stemWord = function (w) { - var stem; - var suffix; - var firstch; - var origword = w; - - if (w.length < 3) - return w; - - var re; - var re2; - var re3; - var re4; - - firstch = w.substr(0,1); - if (firstch == "y") - w = firstch.toUpperCase() + w.substr(1); - - // Step 1a - re = /^(.+?)(ss|i)es$/; - re2 = /^(.+?)([^s])s$/; - - if (re.test(w)) - w = w.replace(re,"$1$2"); - else if (re2.test(w)) - w = w.replace(re2,"$1$2"); - - // Step 1b - re = /^(.+?)eed$/; - re2 = /^(.+?)(ed|ing)$/; - if (re.test(w)) { - var fp = re.exec(w); - re = new RegExp(mgr0); - if (re.test(fp[1])) { - re = /.$/; - w = w.replace(re,""); - } - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1]; - re2 = new RegExp(s_v); - if (re2.test(stem)) { - w = stem; - re2 = /(at|bl|iz)$/; - re3 = new RegExp("([^aeiouylsz])\\1$"); - re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re2.test(w)) - w = w + "e"; - else if (re3.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - else if (re4.test(w)) - w = w + "e"; - } - } - - // Step 1c - re = /^(.+?)y$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(s_v); - if (re.test(stem)) - w = stem + "i"; - } - - // Step 2 - re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step2list[suffix]; - } - - // Step 3 - re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step3list[suffix]; - } - - // Step 4 - re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; - re2 = /^(.+?)(s|t)(ion)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - if (re.test(stem)) - w = stem; - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1] + fp[2]; - re2 = new RegExp(mgr1); - if (re2.test(stem)) - w = stem; - } - - // Step 5 - re = /^(.+?)e$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - re2 = new RegExp(meq1); - re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) - w = stem; - } - re = /ll$/; - re2 = new RegExp(mgr1); - if (re.test(w) && re2.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - - // and turn initial Y back to y - if (firstch == "y") - w = firstch.toLowerCase() + w.substr(1); - return w; +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = docUrlRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = docUrlRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; } -} + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms) + ); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + `Search finished, found ${resultCount} page(s) matching the search query.` + ); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} /** * Search Module */ -var Search = { - - _index : null, - _queued_query : null, - _pulse_status : -1, - - init : function() { - var params = $.getQueryParameters(); - if (params.q) { - var query = params.q[0]; - $('input[name="q"]')[0].value = query; - this.performSearch(query); - } +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent !== undefined) return docContent.textContent; + console.warn( + "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + ); + return ""; }, - loadIndex : function(url) { - $.ajax({type: "GET", url: url, data: null, success: null, - dataType: "script", cache: true}); + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); }, - setIndex : function(index) { - var q; - this._index = index; - if ((q = this._queued_query) !== null) { - this._queued_query = null; - Search.query(q); + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); } }, - hasIndex : function() { - return this._index !== null; - }, + hasIndex: () => Search._index !== null, - deferQuery : function(query) { - this._queued_query = query; - }, + deferQuery: (query) => (Search._queued_query = query), - stopPulse : function() { - this._pulse_status = 0; - }, + stopPulse: () => (Search._pulse_status = -1), - startPulse : function() { - if (this._pulse_status >= 0) - return; - function pulse() { + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { Search._pulse_status = (Search._pulse_status + 1) % 4; - var dotString = ''; - for (var i = 0; i < Search._pulse_status; i++) - dotString += '.'; - Search.dots.text(dotString); - if (Search._pulse_status > -1) - window.setTimeout(pulse, 500); + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); }; pulse(); }, /** - * perform a search for something + * perform a search for something (or wait until index is loaded) */ - performSearch : function(query) { + performSearch: (query) => { // create the required interface elements - this.out = $('#search-results'); - this.title = $('

' + _('Searching') + '

').appendTo(this.out); - this.dots = $('').appendTo(this.title); - this.status = $('

').appendTo(this.out); - this.output = $('
    ').appendTo(this.out); - - $('#search-progress').text(_('Preparing search...')); - this.startPulse(); + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); // index already loaded, the browser was quick! - if (this.hasIndex()) - this.query(query); - else - this.deferQuery(query); + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); }, - query : function(query) { - var stopwords = ["a","for","no","into","but","are","to","this","or","there","the","near","on","as","such","of","if","and","in","is","with","it","not","that","they","these","by","their","was","then","at","be","will"]; - - // Stem the searchterms and add them to the correct list - var stemmer = new Stemmer(); - var searchterms = []; - var excluded = []; - var hlterms = []; - var tmp = query.split(/\s+/); - var objectterms = []; - for (var i = 0; i < tmp.length; i++) { - if (tmp[i] != "") { - objectterms.push(tmp[i].toLowerCase()); - } + /** + * execute search (requires search index to be loaded) + */ + query: (query) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; - if ($u.indexOf(stopwords, tmp[i]) != -1 || tmp[i].match(/^\d+$/) || - tmp[i] == "") { - // skip this "word" - continue; - } // stem the word - var word = stemmer.stemWord(tmp[i]).toLowerCase(); + let word = stemmer.stemWord(queryTermLower); // select the correct list - if (word[0] == '-') { - var toAppend = excluded; - word = word.substr(1); - } + if (word[0] === "-") excludedTerms.add(word.substr(1)); else { - var toAppend = searchterms; - hlterms.push(tmp[i].toLowerCase()); + searchTerms.add(word); + highlightTerms.add(queryTermLower); } - // only add if not already in the list - if (!$.contains(toAppend, word)) - toAppend.push(word); - }; - var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" ")); + }); - // console.debug('SEARCH: searching for:'); - // console.info('required: ', searchterms); - // console.info('excluded: ', excluded); + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } - // prepare search - var filenames = this._index.filenames; - var titles = this._index.titles; - var terms = this._index.terms; - var fileMap = {}; - var files = null; - // different result priorities - var importantResults = []; - var objectResults = []; - var regularResults = []; - var unimportantResults = []; - $('#search-progress').empty(); + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + // array of [docname, title, anchor, descr, score, filename] + let results = []; + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + let score = Math.round(100 * queryLower.length / title.length) + results.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } - // lookup as object - for (var i = 0; i < objectterms.length; i++) { - var others = [].concat(objectterms.slice(0,i), - objectterms.slice(i+1, objectterms.length)) - var results = this.performObjectSearch(objectterms[i], others); - // Assume first word is most likely to be the object, - // other words more likely to be in description. - // Therefore put matches for earlier words first. - // (Results are eventually used in reverse order). - objectResults = results[0].concat(objectResults); - importantResults = results[1].concat(importantResults); - unimportantResults = results[2].concat(unimportantResults); + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id] of foundEntries) { + let score = Math.round(100 * queryLower.length / entry.length) + results.push([ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } } - // perform the search on the required terms - for (var i = 0; i < searchterms.length; i++) { - var word = searchterms[i]; - // no match but word was a required one - if ((files = terms[word]) == null) - break; - if (files.length == undefined) { - files = [files]; + // lookup as object + objectTerms.forEach((term) => + results.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); + + // now sort the results by score (in opposite order of appearance, since the + // display function below uses pop() to retrieve items) and then + // alphabetically + results.sort((a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional } - // create the mapping - for (var j = 0; j < files.length; j++) { - var file = files[j]; - if (file in fileMap) - fileMap[file].push(word); - else - fileMap[file] = [word]; + return leftScore > rightScore ? 1 : -1; + }); + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); } - } + return acc; + }, []); - // now check if the files don't contain excluded terms - for (var file in fileMap) { - var valid = true; + results = results.reverse(); - // check if all requirements are matched - if (fileMap[file].length != searchterms.length) - continue; + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); - // ensure that none of the excluded terms is in the - // search result. - for (var i = 0; i < excluded.length; i++) { - if (terms[excluded[i]] == file || - $.contains(terms[excluded[i]] || [], file)) { - valid = false; - break; - } + // print the results + _displayNextItem(results, results.length, searchTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; } - // if we have still a valid result we can add it - // to the result list - if (valid) - regularResults.push([filenames[file], titles[file], '', null]); - } + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord) && !terms[word]) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord) && !titleTerms[word]) + arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); + }); + } - // delete unused variables in order to not waste - // memory until list is retrieved completely - delete filenames, titles, terms; + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); - // now sort the regular results descending by title - regularResults.sort(function(a, b) { - var left = a[1].toLowerCase(); - var right = b[1].toLowerCase(); - return (left > right) ? -1 : ((left < right) ? 1 : 0); + // create the mapping + files.forEach((file) => { + if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) + fileMap.get(file).push(word); + else fileMap.set(file, [word]); + }); }); - // combine all results - var results = unimportantResults.concat(regularResults) - .concat(objectResults).concat(importantResults); + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched - // print the results - var resultCount = results.length; - function displayNextItem() { - // results left, load the summary and display it - if (results.length) { - var item = results.pop(); - var listItem = $('
  • '); - if (DOCUMENTATION_OPTIONS.FILE_SUFFIX == '') { - // dirhtml builder - var dirname = item[0] + '/'; - if (dirname.match(/\/index\/$/)) { - dirname = dirname.substring(0, dirname.length-6); - } else if (dirname == 'index/') { - dirname = ''; - } - listItem.append($('').attr('href', - DOCUMENTATION_OPTIONS.URL_ROOT + dirname + - highlightstring + item[2]).html(item[1])); - } else { - // normal html builders - listItem.append($('').attr('href', - item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX + - highlightstring + item[2]).html(item[1])); - } - if (item[3]) { - listItem.append($(' (' + item[3] + ')')); - Search.output.append(listItem); - listItem.slideDown(5, function() { - displayNextItem(); - }); - } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) { - $.get(DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + - item[0] + '.txt', function(data) { - if (data != '') { - listItem.append($.makeSearchSummary(data, searchterms, hlterms)); - Search.output.append(listItem); - } - listItem.slideDown(5, function() { - displayNextItem(); - }); - }, "text"); - } else { - // no source available, just display title - Search.output.append(listItem); - listItem.slideDown(5, function() { - displayNextItem(); - }); - } - } - // search finished, update title and status message - else { - Search.stopPulse(); - Search.title.text(_('Search Results')); - if (!resultCount) - Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.')); - else - Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount)); - Search.status.fadeIn(500); - } + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); } - displayNextItem(); + return results; }, - performObjectSearch : function(object, otherterms) { - var filenames = this._index.filenames; - var objects = this._index.objects; - var objnames = this._index.objnames; - var titles = this._index.titles; - - var importantResults = []; - var objectResults = []; - var unimportantResults = []; - - for (var prefix in objects) { - for (var name in objects[prefix]) { - var fullname = (prefix ? prefix + '.' : '') + name; - if (fullname.toLowerCase().indexOf(object) > -1) { - var match = objects[prefix][name]; - var objname = objnames[match[1]][2]; - var title = titles[match[0]]; - // If more than one term searched for, we require other words to be - // found in the name/title/description - if (otherterms.length > 0) { - var haystack = (prefix + ' ' + name + ' ' + - objname + ' ' + title).toLowerCase(); - var allfound = true; - for (var i = 0; i < otherterms.length; i++) { - if (haystack.indexOf(otherterms[i]) == -1) { - allfound = false; - break; - } - } - if (!allfound) { - continue; - } - } - var descr = objname + _(', in ') + title; - anchor = match[3]; - if (anchor == '') - anchor = fullname; - else if (anchor == '-') - anchor = objnames[match[1]][1] + '-' + fullname; - result = [filenames[match[0]], fullname, '#'+anchor, descr]; - switch (match[2]) { - case 1: objectResults.push(result); break; - case 0: importantResults.push(result); break; - case 2: unimportantResults.push(result); break; - } - } - } - } + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords) => { + const text = Search.htmlToText(htmlText); + if (text === "") return null; - // sort results descending - objectResults.sort(function(a, b) { - return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); - }); + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); - importantResults.sort(function(a, b) { - return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); - }); + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; - unimportantResults.sort(function(a, b) { - return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); - }); + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; - return [importantResults, objectResults, unimportantResults] - } -} + return summary; + }, +}; -$(document).ready(function() { - Search.init(); -}); \ No newline at end of file +_ready(Search.init); diff --git a/docs/build/html/_static/sidebar.js b/docs/build/html/_static/sidebar.js index a45e192..ae3080b 100644 --- a/docs/build/html/_static/sidebar.js +++ b/docs/build/html/_static/sidebar.js @@ -16,136 +16,55 @@ * Once the browser is closed the cookie is deleted and the position * reset to the default (expanded). * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ -$(function() { +const initialiseSidebar = () => { + + + + // global elements used by the functions. - // the 'sidebarbutton' element is defined as global after its - // creation, in the add_sidebar_button function - var bodywrapper = $('.bodywrapper'); - var sidebar = $('.sphinxsidebar'); - var sidebarwrapper = $('.sphinxsidebarwrapper'); + const bodyWrapper = document.getElementsByClassName("bodywrapper")[0] + const sidebar = document.getElementsByClassName("sphinxsidebar")[0] + const sidebarWrapper = document.getElementsByClassName('sphinxsidebarwrapper')[0] + const sidebarButton = document.getElementById("sidebarbutton") + const sidebarArrow = sidebarButton.querySelector('span') // for some reason, the document has no sidebar; do not run into errors - if (!sidebar.length) return; - - // original margin-left of the bodywrapper and width of the sidebar - // with the sidebar expanded - var bw_margin_expanded = bodywrapper.css('margin-left'); - var ssb_width_expanded = sidebar.width(); - - // margin-left of the bodywrapper and width of the sidebar - // with the sidebar collapsed - var bw_margin_collapsed = '.8em'; - var ssb_width_collapsed = '.8em'; + if (typeof sidebar === "undefined") return; - // colors used by the current theme - var dark_color = $('.related').css('background-color'); - var light_color = $('.document').css('background-color'); + const flipArrow = element => element.innerText = (element.innerText === "»") ? "«" : "»" - function sidebar_is_collapsed() { - return sidebarwrapper.is(':not(:visible)'); + const collapse_sidebar = () => { + bodyWrapper.style.marginLeft = ".8em"; + sidebar.style.width = ".8em" + sidebarWrapper.style.display = "none" + flipArrow(sidebarArrow) + sidebarButton.title = _('Expand sidebar') + window.localStorage.setItem("sidebar", "collapsed") } - function toggle_sidebar() { - if (sidebar_is_collapsed()) - expand_sidebar(); - else - collapse_sidebar(); + const expand_sidebar = () => { + bodyWrapper.style.marginLeft = "" + sidebar.style.removeProperty("width") + sidebarWrapper.style.display = "" + flipArrow(sidebarArrow) + sidebarButton.title = _('Collapse sidebar') + window.localStorage.setItem("sidebar", "expanded") } - function collapse_sidebar() { - sidebarwrapper.hide(); - sidebar.css('width', ssb_width_collapsed); - bodywrapper.css('margin-left', bw_margin_collapsed); - sidebarbutton.css({ - 'margin-left': '0', - 'height': bodywrapper.height() - }); - sidebarbutton.find('span').text('»'); - sidebarbutton.attr('title', _('Expand sidebar')); - document.cookie = 'sidebar=collapsed'; - } - - function expand_sidebar() { - bodywrapper.css('margin-left', bw_margin_expanded); - sidebar.css('width', ssb_width_expanded); - sidebarwrapper.show(); - sidebarbutton.css({ - 'margin-left': ssb_width_expanded-12, - 'height': bodywrapper.height() - }); - sidebarbutton.find('span').text('«'); - sidebarbutton.attr('title', _('Collapse sidebar')); - document.cookie = 'sidebar=expanded'; - } + sidebarButton.addEventListener("click", () => { + (sidebarWrapper.style.display === "none") ? expand_sidebar() : collapse_sidebar() + }) - function add_sidebar_button() { - sidebarwrapper.css({ - 'float': 'left', - 'margin-right': '0', - 'width': ssb_width_expanded - 28 - }); - // create the button - sidebar.append( - '
    «
    ' - ); - var sidebarbutton = $('#sidebarbutton'); - light_color = sidebarbutton.css('background-color'); - // find the height of the viewport to center the '<<' in the page - var viewport_height; - if (window.innerHeight) - viewport_height = window.innerHeight; - else - viewport_height = $(window).height(); - sidebarbutton.find('span').css({ - 'display': 'block', - 'margin-top': (viewport_height - sidebar.position().top - 20) / 2 - }); - - sidebarbutton.click(toggle_sidebar); - sidebarbutton.attr('title', _('Collapse sidebar')); - sidebarbutton.css({ - 'color': '#FFFFFF', - 'border-left': '1px solid ' + dark_color, - 'font-size': '1.2em', - 'cursor': 'pointer', - 'height': bodywrapper.height(), - 'padding-top': '1px', - 'margin-left': ssb_width_expanded - 12 - }); - - sidebarbutton.hover( - function () { - $(this).css('background-color', dark_color); - }, - function () { - $(this).css('background-color', light_color); - } - ); - } - - function set_position_from_cookie() { - if (!document.cookie) - return; - var items = document.cookie.split(';'); - for(var k=0; k=e.computed&&(e={value:f,computed:g})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);var e={computed:Infinity};b.each(a,function(f,g,h){g=c?c.call(d,f,g,h):f;gf?1:0}),"value")};b.sortedIndex=function(a,c,d){d=d||b.identity;for(var e=0,f=a.length;e>1;d(a[g])=0})})};b.zip=function(){for(var a=b.toArray(arguments),c=b.max(b.pluck(a,"length")),d=new Array(c),e=0;e0?f-c:c-f)>=0)return e;e[g++]=f}};b.bind=function(a,c){var d=b.rest(arguments,2);return function(){return a.apply(c||j,d.concat(b.toArray(arguments)))}};b.bindAll=function(a){var c=b.rest(arguments);if(c.length==0)c=b.functions(a);b.each(c,function(d){a[d]=b.bind(a[d],a)}); -return a};b.delay=function(a,c){var d=b.rest(arguments,2);return setTimeout(function(){return a.apply(a,d)},c)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(b.rest(arguments)))};b.wrap=function(a,c){return function(){var d=[a].concat(b.toArray(arguments));return c.apply(c,d)}};b.compose=function(){var a=b.toArray(arguments);return function(){for(var c=b.toArray(arguments),d=a.length-1;d>=0;d--)c=[a[d].apply(this,c)];return c[0]}};b.keys=function(a){if(b.isArray(a))return b.range(0,a.length); -var c=[];for(var d in a)q.call(a,d)&&c.push(d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=function(a){return b.select(b.keys(a),function(c){return b.isFunction(a[c])}).sort()};b.extend=function(a,c){for(var d in c)a[d]=c[d];return a};b.clone=function(a){if(b.isArray(a))return a.slice(0);return b.extend({},a)};b.tap=function(a,c){c(a);return a};b.isEqual=function(a,c){if(a===c)return true;var d=typeof a;if(d!=typeof c)return false;if(a==c)return true;if(!a&&c||a&&!c)return false; -if(a.isEqual)return a.isEqual(c);if(b.isDate(a)&&b.isDate(c))return a.getTime()===c.getTime();if(b.isNaN(a)&&b.isNaN(c))return true;if(b.isRegExp(a)&&b.isRegExp(c))return a.source===c.source&&a.global===c.global&&a.ignoreCase===c.ignoreCase&&a.multiline===c.multiline;if(d!=="object")return false;if(a.length&&a.length!==c.length)return false;d=b.keys(a);var e=b.keys(c);if(d.length!=e.length)return false;for(var f in a)if(!b.isEqual(a[f],c[f]))return false;return true};b.isEmpty=function(a){return b.keys(a).length== -0};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=function(a){return!!(a&&a.concat&&a.unshift)};b.isArguments=function(a){return a&&b.isNumber(a.length)&&!b.isArray(a)&&!r.call(a,"length")};b.isFunction=function(a){return!!(a&&a.constructor&&a.call&&a.apply)};b.isString=function(a){return!!(a===""||a&&a.charCodeAt&&a.substr)};b.isNumber=function(a){return p.call(a)==="[object Number]"};b.isDate=function(a){return!!(a&&a.getTimezoneOffset&&a.setUTCFullYear)};b.isRegExp=function(a){return!!(a&& -a.test&&a.exec&&(a.ignoreCase||a.ignoreCase===false))};b.isNaN=function(a){return b.isNumber(a)&&isNaN(a)};b.isNull=function(a){return a===null};b.isUndefined=function(a){return typeof a=="undefined"};b.noConflict=function(){j._=n;return this};b.identity=function(a){return a};b.breakLoop=function(){throw m;};var s=0;b.uniqueId=function(a){var c=s++;return a?a+c:c};b.template=function(a,c){a=new Function("obj","var p=[],print=function(){p.push.apply(p,arguments);};with(obj){p.push('"+a.replace(/[\r\t\n]/g, -" ").replace(/'(?=[^%]*%>)/g,"\t").split("'").join("\\'").split("\t").join("'").replace(/<%=(.+?)%>/g,"',$1,'").split("<%").join("');").split("%>").join("p.push('")+"');}return p.join('');");return c?a(c):a};b.forEach=b.each;b.foldl=b.inject=b.reduce;b.foldr=b.reduceRight;b.filter=b.select;b.every=b.all;b.some=b.any;b.head=b.first;b.tail=b.rest;b.methods=b.functions;var l=function(a,c){return c?b(a).chain():a};b.each(b.functions(b),function(a){var c=b[a];i.prototype[a]=function(){var d=b.toArray(arguments); -o.call(d,this._wrapped);return l(c.apply(b,d),this._chain)}});b.each(["pop","push","reverse","shift","sort","splice","unshift"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){c.apply(this._wrapped,arguments);return l(this._wrapped,this._chain)}});b.each(["concat","join","slice"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){return l(c.apply(this._wrapped,arguments),this._chain)}});i.prototype.chain=function(){this._chain=true;return this};i.prototype.value=function(){return this._wrapped}})(); +!function(n,r){"object"==typeof exports&&"undefined"!=typeof module?module.exports=r():"function"==typeof define&&define.amd?define("underscore",r):(n="undefined"!=typeof globalThis?globalThis:n||self,function(){var t=n._,e=n._=r();e.noConflict=function(){return n._=t,e}}())}(this,(function(){ +// Underscore.js 1.13.1 +// https://underscorejs.org +// (c) 2009-2021 Jeremy Ashkenas, Julian Gonggrijp, and DocumentCloud and Investigative Reporters & Editors +// Underscore may be freely distributed under the MIT license. +var n="1.13.1",r="object"==typeof self&&self.self===self&&self||"object"==typeof global&&global.global===global&&global||Function("return this")()||{},t=Array.prototype,e=Object.prototype,u="undefined"!=typeof Symbol?Symbol.prototype:null,o=t.push,i=t.slice,a=e.toString,f=e.hasOwnProperty,c="undefined"!=typeof ArrayBuffer,l="undefined"!=typeof DataView,s=Array.isArray,p=Object.keys,v=Object.create,h=c&&ArrayBuffer.isView,y=isNaN,d=isFinite,g=!{toString:null}.propertyIsEnumerable("toString"),b=["valueOf","isPrototypeOf","toString","propertyIsEnumerable","hasOwnProperty","toLocaleString"],m=Math.pow(2,53)-1;function j(n,r){return r=null==r?n.length-1:+r,function(){for(var t=Math.max(arguments.length-r,0),e=Array(t),u=0;u=0&&t<=m}}function J(n){return function(r){return null==r?void 0:r[n]}}var G=J("byteLength"),H=K(G),Q=/\[object ((I|Ui)nt(8|16|32)|Float(32|64)|Uint8Clamped|Big(I|Ui)nt64)Array\]/;var X=c?function(n){return h?h(n)&&!q(n):H(n)&&Q.test(a.call(n))}:C(!1),Y=J("length");function Z(n,r){r=function(n){for(var r={},t=n.length,e=0;e":">",'"':""","'":"'","`":"`"},Cn=Ln($n),Kn=Ln(_n($n)),Jn=tn.templateSettings={evaluate:/<%([\s\S]+?)%>/g,interpolate:/<%=([\s\S]+?)%>/g,escape:/<%-([\s\S]+?)%>/g},Gn=/(.)^/,Hn={"'":"'","\\":"\\","\r":"r","\n":"n","\u2028":"u2028","\u2029":"u2029"},Qn=/\\|'|\r|\n|\u2028|\u2029/g;function Xn(n){return"\\"+Hn[n]}var Yn=/^\s*(\w|\$)+\s*$/;var Zn=0;function nr(n,r,t,e,u){if(!(e instanceof r))return n.apply(t,u);var o=Mn(n.prototype),i=n.apply(o,u);return _(i)?i:o}var rr=j((function(n,r){var t=rr.placeholder,e=function(){for(var u=0,o=r.length,i=Array(o),a=0;a1)ur(a,r-1,t,e),u=e.length;else for(var f=0,c=a.length;f0&&(t=r.apply(this,arguments)),n<=1&&(r=null),t}}var lr=rr(cr,2);function sr(n,r,t){r=qn(r,t);for(var e,u=nn(n),o=0,i=u.length;o0?0:u-1;o>=0&&o0?a=o>=0?o:Math.max(o+f,a):f=o>=0?Math.min(o+1,f):o+f+1;else if(t&&o&&f)return e[o=t(e,u)]===u?o:-1;if(u!=u)return(o=r(i.call(e,a,f),$))>=0?o+a:-1;for(o=n>0?a:f-1;o>=0&&o0?0:i-1;for(u||(e=r[o?o[a]:a],a+=n);a>=0&&a=3;return r(n,Fn(t,u,4),e,o)}}var Ar=wr(1),xr=wr(-1);function Sr(n,r,t){var e=[];return r=qn(r,t),jr(n,(function(n,t,u){r(n,t,u)&&e.push(n)})),e}function Or(n,r,t){r=qn(r,t);for(var e=!er(n)&&nn(n),u=(e||n).length,o=0;o=0}var Br=j((function(n,r,t){var e,u;return D(r)?u=r:(r=Nn(r),e=r.slice(0,-1),r=r[r.length-1]),_r(n,(function(n){var o=u;if(!o){if(e&&e.length&&(n=In(n,e)),null==n)return;o=n[r]}return null==o?o:o.apply(n,t)}))}));function Nr(n,r){return _r(n,Rn(r))}function Ir(n,r,t){var e,u,o=-1/0,i=-1/0;if(null==r||"number"==typeof r&&"object"!=typeof n[0]&&null!=n)for(var a=0,f=(n=er(n)?n:jn(n)).length;ao&&(o=e);else r=qn(r,t),jr(n,(function(n,t,e){((u=r(n,t,e))>i||u===-1/0&&o===-1/0)&&(o=n,i=u)}));return o}function Tr(n,r,t){if(null==r||t)return er(n)||(n=jn(n)),n[Wn(n.length-1)];var e=er(n)?En(n):jn(n),u=Y(e);r=Math.max(Math.min(r,u),0);for(var o=u-1,i=0;i1&&(e=Fn(e,r[1])),r=an(n)):(e=qr,r=ur(r,!1,!1),n=Object(n));for(var u=0,o=r.length;u1&&(t=r[1])):(r=_r(ur(r,!1,!1),String),e=function(n,t){return!Er(r,t)}),Ur(n,e,t)}));function zr(n,r,t){return i.call(n,0,Math.max(0,n.length-(null==r||t?1:r)))}function Lr(n,r,t){return null==n||n.length<1?null==r||t?void 0:[]:null==r||t?n[0]:zr(n,n.length-r)}function $r(n,r,t){return i.call(n,null==r||t?1:r)}var Cr=j((function(n,r){return r=ur(r,!0,!0),Sr(n,(function(n){return!Er(r,n)}))})),Kr=j((function(n,r){return Cr(n,r)}));function Jr(n,r,t,e){A(r)||(e=t,t=r,r=!1),null!=t&&(t=qn(t,e));for(var u=[],o=[],i=0,a=Y(n);ir?(e&&(clearTimeout(e),e=null),a=c,i=n.apply(u,o),e||(u=o=null)):e||!1===t.trailing||(e=setTimeout(f,l)),i};return c.cancel=function(){clearTimeout(e),a=0,e=u=o=null},c},debounce:function(n,r,t){var e,u,o,i,a,f=function(){var c=zn()-u;r>c?e=setTimeout(f,r-c):(e=null,t||(i=n.apply(a,o)),e||(o=a=null))},c=j((function(c){return a=this,o=c,u=zn(),e||(e=setTimeout(f,r),t&&(i=n.apply(a,o))),i}));return c.cancel=function(){clearTimeout(e),e=o=a=null},c},wrap:function(n,r){return rr(r,n)},negate:fr,compose:function(){var n=arguments,r=n.length-1;return function(){for(var t=r,e=n[r].apply(this,arguments);t--;)e=n[t].call(this,e);return e}},after:function(n,r){return function(){if(--n<1)return r.apply(this,arguments)}},before:cr,once:lr,findKey:sr,findIndex:vr,findLastIndex:hr,sortedIndex:yr,indexOf:gr,lastIndexOf:br,find:mr,detect:mr,findWhere:function(n,r){return mr(n,Dn(r))},each:jr,forEach:jr,map:_r,collect:_r,reduce:Ar,foldl:Ar,inject:Ar,reduceRight:xr,foldr:xr,filter:Sr,select:Sr,reject:function(n,r,t){return Sr(n,fr(qn(r)),t)},every:Or,all:Or,some:Mr,any:Mr,contains:Er,includes:Er,include:Er,invoke:Br,pluck:Nr,where:function(n,r){return Sr(n,Dn(r))},max:Ir,min:function(n,r,t){var e,u,o=1/0,i=1/0;if(null==r||"number"==typeof r&&"object"!=typeof n[0]&&null!=n)for(var a=0,f=(n=er(n)?n:jn(n)).length;ae||void 0===t)return 1;if(t - - - - + - - - The dggs Module — rHEALPixDGGS 0.5.1 documentation + + + + The dggs Module — rHEALPixDGGS 0.5.4 documentation + + - - + + + + + - - - - - - - + + - - -
    + +
    -
    +
    -
    -

    The dggs Module¶

    -

    This Python 3.3 module implements the rHEALPix discrete global grid system.

    -

    CHANGELOG:

    +
    +

    The dggs Module¶

    +

    This Python 3.11 module implements the rHEALPix discrete global grid system.

      -
    • Alexander Raichev (AR), 2012-11-12: Initial version based upon grids.py.
      • -
    • AR, 2012-12-10: Corrected centroid() and moved some methods from graphics.py to here.
      • -
    • AR, 2012-12-19: Tested all the methods and added examples.
      • -
    • AR, 2013-01-01: Added ellipsoidal functionality to neighbor() and neighbors().
      • -
    • AR, 2013-01-14: Added intersects_meridian(), cell_latitudes(), cells_from_meridian(), cells_from_parallel(), cells_from_region().
      • -
    • AR, 2013-01-16: Changed the string keyword ‘surface’ to a boolean keyword ‘plane’.
      • -
    • AR, 2013-03-11: Added minimal_cover(), boundary(), interior(), triangle(), nw_vertex().
      • -
    • AR, 2013-03-14: Fixed bug in nw_vertex().
      • -
    • AR, 2013-07-23: Ported to Python 3.3.
      • +

    • Alexander Raichev (AR), 2012-11-12: Initial version based upon grids.py.

    NOTES:

    -

    All lengths are measured in meters and all angles are measured in radians +

    All lengths are measured in meters and all angles are measured in radians unless indicated otherwise.

    -

    By ‘ellipsoid’ throughout, i mean an ellipsoid of revolution and not a general (triaxial) ellipsoid.

    +

    By ‘ellipsoid’ throughout, I mean an ellipsoid of revolution and not a general (triaxial) ellipsoid.

    Points lying on the plane are given in rectangular (horizontal, vertical) coordinates, and points lying on the ellipsoid are given in geodetic (longitude, latitude) coordinates unless indicated otherwise.

    -

    DGGS abbreviates ‘discrete global grid system’.

    -

    Except when manipulating positive integers, I avoid the modulo function ‘%’ -and insted write everything in terms of ‘floor()’. -This is because Python interprets the sign of ‘%’ differently than -Java or C, and I don’t want to confuse people who are translating this code +

    DGGS abbreviates ‘discrete global grid system’.

    +

    Except when manipulating positive integers, I avoid the modulo function ‘%’ +and insted write everything in terms of ‘floor()’. +This is because Python interprets the sign of ‘%’ differently than +Java or C, and I don’t want to confuse people who are translating this code to those languages.

    EXAMPLES:

    Create the (1, 2)-rHEALPix DGGS with N_side = 3 that is based on the WGS84 ellipsoid. Use degrees instead of the default radians for angular measurements

    -
    >>> from rhealpix_dggs.ellipsoids import WGS84_ELLIPSOID
+
    >>> from rhealpixdggs.ellipsoids import WGS84_ELLIPSOID
 >>> E = WGS84_ELLIPSOID
 >>> rdggs = RHEALPixDGGS(ellipsoid=E, north_square=1, south_square=2, N_side=3)
->>> print(rdggs)
+>>> print(rdggs)
 rHEALPix DGGS:
     N_side = 3
     north_square = 1
@@ -94,10 +72,10 @@ 
    Navigation
    
     max_areal_resolution = 1
     max_resolution = 15
     ellipsoid:
-        R_A = 6374581.4671
+        R_A = 6374581.467096525
         a = 6378137.0
         b = 6356752.314140356
-        e = 0.0578063088401
+        e = 0.0578063088401125
         f = 0.003352810681182319
         lat_0 = 0
         lon_0 = 0
@@ -105,15 +83,26 @@ 
    Navigation
    
         sphere = False
 
    
 
    
+
    
+
    NOTES::  .. Issue #1 was ..
    
+
    ellipsoid:
    R_A = 6374581.4671 *
+a = 6378137.0
+b = 6356752.314140356 *
+e = 0.0578063088401
+f = 0.003352810681182319
    
+
    
+
    
+
    
+
    
 
    Pick a (longitude-latitude) point on the ellipsoid and find the resolution 1 cell that contains it
    
-
    >>> p = (0, 45)
->>> c = rdggs.cell_from_point(1, p, plane=False); print(c)
+
    >>> p = (0, 45)
+>>> c = rdggs.cell_from_point(1, p, plane=False); print(c)
 N8
 
    
 
    
 
    Find the ellipsoidal (edge) neighbors of this cell
    
-
    >>> for (direction, cell) in sorted(c.neighbors(plane=False).items()):
-...     print(direction, cell) 
+
    >>> for (direction, cell) in sorted(c.neighbors(plane=False).items()):
+...     print(direction, cell)
 east N5
 south_east Q0
 south_west P2
@@ -121,8 +110,8 @@ 
    Navigation
    
 
    
 
    
 
    Find the planar (edge) neighbors of this cell
    
-
    >>> for (direction, cell) in sorted(c.neighbors('plane').items()):
-...     print(direction, cell) 
+
    >>> for (direction, cell) in sorted(c.neighbors('plane').items()):
+...     print(direction, cell)
 down P2
 left N7
 right Q0
@@ -130,40 +119,57 @@ 
    Navigation
    
 
    
 
    
 
    Find all the resolution 1 cells intersecting the longitude-latitude aligned ellipsoidal quadrangle with given northwest and southeast corners
    
-
    >>> nw = (0, 45)
+
    >>> nw = (0, 45)
 >>> se = (90, 0)
->>> cells = rdggs.cells_from_region(1, nw, se, plane=False)
+>>> cells = rdggs.cells_from_region(1, nw, se, plane=False)
 >>> for row in cells:
-...     print([str(cell) for cell in row])
+...     print([str(cell) for cell in row])
 ['N8', 'N5', 'N2']
 ['Q0', 'Q1', 'Q2', 'R0']
 ['Q3', 'Q4', 'Q5', 'R3']
 
    
 
    
 
    Compute the ellipsoidal nuclei of these cells
    
-
    >>> for row in cells:
-...     for cell in row:
-...         print(cell, cell.nucleus(plane=False))
-N8 (0.0, 58.470677829627363)
-N5 (45.000000000000036, 58.470677829627363)
-N2 (90.000000000000028, 58.470677829627355)
-Q0 (14.999999999999998, 26.438744923100096)
-Q1 (45.0, 26.438744923100096)
-Q2 (74.999999999999986, 26.438744923100096)
-R0 (105.00000000000001, 26.438744923100096)
-Q3 (14.999999999999998, 3.560649871414923e-15)
-Q4 (45.0, 3.560649871414923e-15)
-Q5 (74.999999999999986, 3.560649871414923e-15)
-R3 (105.00000000000001, 3.560649871414923e-15)
+
    >>> expected_results = [
+...    [
+...        (0.0, 58.47067782962736),
+...        (45.000000000000036, 58.47067782962734),
+...        (89.99999999999996, 58.47067782962736)
+...    ], [
+...        (14.999999999999998, 26.438744923100096),
+...        (45.0, 26.438744923100096),
+...        (74.99999999999999, 26.438744923100096),
+...        (105.00000000000001, 26.438744923100096)
+...    ], [
+...        (14.999999999999998, 3.560649871414923e-15),
+...        (45.0, 3.560649871414923e-15),
+...        (74.99999999999999, 3.560649871414923e-15),
+...        (105.00000000000001, 3.560649871414923e-15)
+...    ]]
+>>> for i, row in enumerate(cells):
+...     for j, cell in enumerate(row):
+...         print(cell, assert_allclose(cell.nucleus(plane=False), expected_results[i][j], rtol=1e-15, atol=0) == None)
+N8 True
+N5 True
+N2 True
+Q0 True
+Q1 True
+Q2 True
+R0 True
+Q3 True
+Q4 True
+Q5 True
+R3 True
 
    
 
    
-
    Create the (0, 0)-rHEALPix DGGS with N_side = 3 that is based on the WGS84 ellipsoid. Use degrees instead of the default radians for angular measurements
-and orient the DGGS so that the planar origin (0, 0) is on Auckland, New Zealand
    
-
    >>> p = (174, -37)  # Approximate Auckland lon-lat coordinates
->>> from rhealpix_dggs.ellipsoids import *
->>> E = Ellipsoid(a=WGS84_A, f=WGS84_F, radians=False, lon_0=p[0], lat_0=p[1])
+
    Create a (0, 0)-rHEALPix DGGS with N_side = 3 based on the WGS84 ellipsoid.
+Use degrees instead of the default radians for angular measurements and
+orient the DGGS so that the planar origin (0, 0) is on Auckland, New Zealand
    
+
    >>> p = (174, -37)  # Approximate Auckland lon-lat coordinates
+>>> from rhealpixdggs.ellipsoids import *
+>>> E = Ellipsoid(a=WGS84_A, f=WGS84_F, radians=False, lon_0=p[0], lat_0=p[1])
 >>> rdggs = RHEALPixDGGS(E, N_side=3, north_square=0, south_square=0)
->>> print(rdggs)
+>>> print(rdggs)
 rHEALPix DGGS:
     N_side = 3
     north_square = 0
@@ -171,284 +177,322 @@ 
    Navigation
    
     max_areal_resolution = 1
     max_resolution = 15
     ellipsoid:
-        R_A = 6374581.4671
+        R_A = 6374581.467096525
         a = 6378137.0
         b = 6356752.314140356
-        e = 0.0578063088401
+        e = 0.0578063088401125
         f = 0.003352810681182319
         lat_0 = -37
         lon_0 = 174
         radians = False
         sphere = False
->>> print(rdggs.cell_from_point(1, p, plane=False))
+
    
+
    
+
    
+
    NOTES::  .. Issue #1 was ..
    
+
    
+
    ellipsoid:
    R_A = 6374581.4671 *
+a = 6378137.0
+b = 6356752.314140356
+e = 0.0578063088401 *
+f = 0.003352810681182319
    
+
    
+
    
+
    
+
    >>> print(rdggs.cell_from_point(1, p, plane=False))
 Q3
 
    
 
    
-
    
-
    
-class rhealpix_dggs.dggs.Cell(rdggs=<rhealpix_dggs.dggs.RHEALPixDGGS object at 0x102e65f10>, suid=None, level_order_index=None, post_order_index=None)¶
    
-
    Bases: builtins.object
    
+
    
+
    
+
    
+
    
+class rhealpixdggs.dggs.Cell(rdggs=<rhealpixdggs.dggs.RHEALPixDGGS object>, suid=None, level_order_index=None, post_order_index=None)¶
    
+
    Bases: object
    
 
    Represents a cell of the planar or ellipsoidal rHEALPix grid hierarchies.
-Cell identifiers are of the form (p_0, p_1,...,p_l), where p_0 is one of 
-the characters ‘A’, ‘B’, ‘C’, ‘D’, ‘E’, ‘F’ and p_i for i > 0 is one of
-the integers 0, 1,..., N_side**2 - 1, where N_side is the instance 
-attribute from RHEALPixDGGS (the number of children cells along a cell’s
+Cell identifiers are of the form (p_0, p_1,…,p_l), where p_0 is one of
+the characters ‘A’, ‘B’, ‘C’, ‘D’, ‘E’, ‘F’ and p_i for i > 0 is one of
+the integers 0, 1,…, N_side**2 - 1, where N_side is the instance
+attribute from RHEALPixDGGS (the number of children cells along a cell’s
 side).
    
 
    INSTANCE ATTRIBUTES:
    
 
      
-
    • rdggs - The DGGS that the cell comes from.
      • 
-
    • ellipsoid - The underlying ellipsoid of the DGGS.
      • 
-
    • N_side - The N_side attribute of the DGGS
      • 
-
    • suid - The cell’s ID (tuple).  SUID = spatially unique identifier.
-(‘id’ is a reserved word in Python)
      • 
-
    • resolution - The cell’s resolution (nonnegative integer).
      • 
+
    • rdggs - The DGGS that the cell comes from.
      • 
+
    • ellipsoid - The underlying ellipsoid of the DGGS.
      • 
+
    • N_side - The N_side attribute of the DGGS
      • 
+
    • suid - The cell’s ID (tuple).  SUID = spatially unique identifier.
+(‘id’ is a reserved word in Python)
      • 
+
    • resolution - The cell’s resolution (nonnegative integer).
      • 
 
    
 
    NOTE:
    
-
    Several Cell methods have the keyword argument ‘plane’.
-Setting it to True indicates that all input and output points and cells are 
+
    Several Cell methods have the keyword argument ‘plane’.
+Setting it to True indicates that all input and output points and cells are
 to be interpreted as lying in the planar DGGS.
-Setting it to False indicates that they are to be interpreted as lying in 
+Setting it to False indicates that they are to be interpreted as lying in
 the ellipsoidal DGGS.
    
-
    
-
    
-area(self, plane=True)¶
    
+
    
+
    
+area(plane=True)¶
    
 
    Return the area of this cell.
    
 
    
 
-
    
-
    
-boundary(self, n=2, plane=True, interior=False)¶
    
-
    Return a list of 4*n - 4 boundary points of this cell, 
-n on each edge, where n >= 2.  
-List the points in clockwise order starting from the cell’s upper left 
-corner if plane = True, or from the cell’s northwest corner 
+
    
+
    
+boundary(n=2, plane=True, interior=False)¶
    
+
    Return a list of 4*n - 4 boundary points of this cell,
+n on each edge, where n >= 2.
+List the points in clockwise order starting from the cell’s upper left
+corner if plane = True, or from the cell’s northwest corner
 if plane = False.
    
 
    If n = 2, then the output is the same as vertices().
 If interior = True, then push the boundary points slighly into the
 interior of the cell, which is convenient for some graphics methods.
    
 
    EXAMPLES:
    
-
    >>> rdggs = UNIT_003
->>> c = rdggs.cell(['N', 6])
->>> c.boundary(n=2, plane=True) == c.vertices(plane=True)
+
    >>> rdggs = UNIT_003
+>>> c = rdggs.cell(['N', 6])
+>>> c.boundary(n=2, plane=True) == c.vertices(plane=True)
 True
->>> for p in c.boundary(n=3, plane=True):
-...     print(my_round(p, 14))
-(-3.14159265358979, 1.3089969389957501)
-(-2.87979326579064, 1.3089969389957501)
-(-2.61799387799149, 1.3089969389957501)
-(-2.61799387799149, 1.0471975511966001)
-(-2.61799387799149, 0.78539816339745006)
-(-2.87979326579064, 0.78539816339745006)
-(-3.14159265358979, 0.78539816339745006)
-(-3.14159265358979, 1.0471975511966001)
-
->>> for p in c.boundary(n=3, plane=False):
-...     print(my_round(p, 14))
+>>> for p in c.boundary(n=3, plane=True):
+...     print(my_round(p, 14))
+(-3.14159265358979, 1.30899693899575)
+(-2.87979326579064, 1.30899693899575)
+(-2.61799387799149, 1.30899693899575)
+(-2.61799387799149, 1.0471975511966)
+(-2.61799387799149, 0.78539816339745)
+(-2.87979326579064, 0.78539816339745)
+(-3.14159265358979, 0.78539816339745)
+(-3.14159265358979, 1.0471975511966)
+
    
+
    
+
    
+
    NOTES::  .. Issue #1 was ..
    (-3.14159265358979, 1.3089969389957501) *
+(-2.87979326579064, 1.3089969389957501) *
+(-2.61799387799149, 1.3089969389957501) *
+(-2.61799387799149, 1.0471975511966001) *
+(-2.61799387799149, 0.78539816339745006) *
+(-2.87979326579064, 0.78539816339745006) *
+(-3.14159265358979, 0.78539816339745006) *
+(-3.14159265358979, 1.0471975511966001) *
    
+
    >>> for p in c.boundary(n=3, plane=False):
+...     print(my_round(p, 14))
 (-180.0, 74.35752898700072)
-(-157.50000000000003, 58.413661903472082)
-(-150.0, 41.810314895778603)
-(-165.00000000000003, 41.810314895778603)
-(-180.0, 41.810314895778603)
-(165.0, 41.810314895778603)
-(149.99999999999997, 41.810314895778603)
-(157.49999999999997, 58.413661903472082)
+(-157.50000000000003, 58.41366190347208)
+(-150.0, 41.8103148957786)
+(-165.00000000000003, 41.8103148957786)
+(-180.0, 41.8103148957786)
+(165.0, 41.8103148957786)
+(149.99999999999997, 41.8103148957786)
+(157.49999999999997, 58.41366190347208)
 
    
 
    
+
    
+
    NOTES::  .. Issue #1 was ..
    (-180.0, 74.35752898700072)
+(-157.50000000000003, 58.413661903472082) *
+(-150.0, 41.810314895778603) *
+(-165.00000000000003, 41.810314895778603) *
+(-180.0, 41.810314895778603) *
+(165.0, 41.810314895778603) *
+(149.99999999999997, 41.810314895778603) *
+(157.49999999999997, 58.413661903472082) *
    
+
    
+
    
 
    
 
-
    
-
    
-centroid(self, plane=True)¶
    
+
    
+
    
+centroid(plane=True)¶
    
 
    Return the centroid of this planar or ellipsoidal cell.
    
 
    EXAMPLES:
    
-
    >>> rdggs = RHEALPixDGGS()
->>> c = Cell(rdggs, ['P', 0, 2])
+
    >>> rdggs = RHEALPixDGGS()
+>>> c = Cell(rdggs, ['P', 0, 2])
 >>> centroid = c.centroid()
 >>> nucleus = c.nucleus()
->>> print(centroid == nucleus)
+>>> print(centroid == nucleus)
 True
 
    
 
    
 
    
 
-
    
-
    
-color(self, saturation=0.5)¶
    
+
    
+
    
+color(saturation=0.5)¶
    
 
    Return a unique RGB color tuple for this cell.
 Inessential graphics method.
    
 
    
 
-
    
-
    
-contains(self, p, plane=True)¶
    
-
    Return True if this cell contains point p, and return False 
+
    
+
    
+contains(p, plane=True)¶
    
+
    Return True if this cell contains point p, and return False
 otherwise.
    
 
    EXAMPLES:
    
-
    >>> rdggs = WGS84_003_RADIANS
+
    >>> rdggs = WGS84_003_RADIANS
 >>> p = (pi/4, 0)
->>> c = rdggs.cell_from_point(2, p, plane=False)
->>> print(c)
+>>> c = rdggs.cell_from_point(2, p, plane=False)
+>>> print(c)
 Q44
->>> print(c.contains(p, plane=False))
+>>> print(c.contains(p, plane=False))
 True
 
    
 
    
 
    
 
-
    
-
    
-ellipsoidal_shape(self)¶
    
-
    Return the shape of this cell (‘quad’, ‘cap’, ‘dart’, or 
-‘skew_quad’) when viewed on the ellipsoid.
    
+
    
+
    
+ellipsoidal_shape()¶
    
+
    Return the shape of this cell (‘quad’, ‘cap’, ‘dart’, or
+‘skew_quad’) when viewed on the ellipsoid.
    
 
    EXAMPLES:
    
-
    >>> rdggs = RHEALPixDGGS()
->>> print(Cell(rdggs, ['P', 2]).ellipsoidal_shape())
+
    >>> rdggs = RHEALPixDGGS()
+>>> print(Cell(rdggs, ['P', 2]).ellipsoidal_shape())
 quad
->>> print(Cell(rdggs, ['N', 2]).ellipsoidal_shape())
+>>> print(Cell(rdggs, ['N', 2]).ellipsoidal_shape())
 dart
 
    
 
    
 
    
 
-
    
-
    
-index(self, order='resolution')¶
    
-
    Return the index of self when it’s ordered according to order.
-Here order can be ‘resolution’ (default) or ‘post’.        
+
    
+
    
+index(order='resolution')¶
    
+
    Return the index of self when it’s ordered according to order.
+Here order can be ‘resolution’ (default) or ‘post’.
 Indices start at 0.
 The empty cell has index None.
    
-
    The ordering comes from the way of traversing the tree T 
+
    The ordering comes from the way of traversing the tree T
 of all cells defined as follows.
-The root of T is a non-cell place holder. 
-The children of the root are the cells A < B < ... < F.
-The children of a cell in T with suid s are s0 < s1 < ... < sn,
+The root of T is a non-cell place holder.
+The children of the root are the cells A < B < … < F.
+The children of a cell in T with suid s are s0 < s1 < … < sn,
 where n = self.N_side**2.
    
-
    The level order index of a nonempty cell is its position 
+
    The level order index of a nonempty cell is its position
 (starting from 0) in the level order traversal of T starting at cell A.
    
-
    The post order index of a nonempty cell is its position 
+
    The post order index of a nonempty cell is its position
 (starting from 0) in the post order traversal of T.
    
 
    EXAMPLES:
    
-
    >>> rdggs = UNIT_003
->>> c = Cell(rdggs, ['N', 2])
->>> print(c.index(order='resolution'))
+
    >>> rdggs = UNIT_003
+>>> c = Cell(rdggs, ['N', 2])
+>>> print(c.index(order='resolution'))
 8
->>> print(c.index(order='post'))
+>>> print(c.index(order='post'))
 2
 
    
 
    
 
    
 
-
    
-
    
-interior(self, n=2, plane=True, flatten=False)¶
    
+
    
+
    
+interior(n=2, plane=True, flatten=False)¶
    
 
    Return an n x n matrix of interior points of this cell.
 If the cell is planar, space the interior points on a regular
 square grid.
 List the points in standard, row-major matrix order.
 If the cell is ellipsoidal, project the matrix of points to the
-ellipsoid (longitude-latitude points).  
+ellipsoid (longitude-latitude points).
 If flatten = True, then flatten the matrix into a one dimensional
 array of pairs.
    
 
    EXAMPLES:
    
-
    >>> rdggs = UNIT_003
->>> c = rdggs.cell(['N'])
->>> for p in c.interior(n=2, plane=False, flatten=True):
-...     print(my_round(p, 14))
-(90.0, 41.810380145353903)
-(-180.0, 41.810380145353903)
-(-1e-14, 41.810380145353903)
-(-90.0, 41.810380145353903)
->>> all([c.contains(p) for p in c.interior(n=5, plane=True, flatten=True)])
+
    >>> rdggs = UNIT_003
+>>> c = rdggs.cell(['N'])
+>>> for p in c.interior(n=2, plane=False, flatten=True):
+...     print(my_round(p, 13))
+(90.0, 41.8103801453539)
+(-180.0, 41.8103801453539)
+(-0.0, 41.8103801453539)
+(-90.0, 41.8103801453539)
+
+>>> all([c.contains(p) for p in c.interior(n=5, plane=True, flatten=True)])
 True
 
    
 
    
 
    
 
-
    
-
    
-intersects_meridian(self, lam)¶
    
-
    Return True if this ellipsoidal cell’s boundary intersects the 
+
    
+
    
+intersects_meridian(lam)¶
    
+
    Return True if this ellipsoidal cell’s boundary intersects the
 meridian of longitude lam, and return False otherwise.
    
 
    EXAMPLES:
    
-
    >>> rdggs = WGS84_003_RADIANS
->>> c = rdggs.cell(['N', 6])
->>> print(c.intersects_meridian(-pi))
+
    >>> rdggs = WGS84_003_RADIANS
+>>> c = rdggs.cell(['N', 6])
+>>> print(c.intersects_meridian(-pi))
 True
->>> print(c.intersects_meridian(-pi/2))
+>>> print(c.intersects_meridian(-pi/2))
 False
 
    
 
    
 
    
 
-
    
-
    
-intersects_parallel(self, phi)¶
    
-
    Return True if this cell’s boundary intersects the parallel of latitude
+
    
+
    
+intersects_parallel(phi)¶
    
+
    Return True if this cell’s boundary intersects the parallel of latitude
 phi, and return False otherwise.
    
 
    
 
-
    
-
    
-neighbor(self, direction, plane=True)¶
    
-
    Return this cell’s (edge) neighbor in the given direction. 
-If plane = True, then the direction is one of the strings 
-‘up’, ‘right’, ‘down’, ‘left’, which indicates the desired neighbor
-relative to x-y coordinates 
-in the following planar neighbor diagram, (drawn for self.N_side = 3) 
+
    
+
    
+neighbor(direction, plane=True)¶
    
+
    Return this cell’s (edge) neighbor in the given direction.
+If plane = True, then the direction is one of the strings
+‘up’, ‘right’, ‘down’, ‘left’, which indicates the desired neighbor
+relative to x-y coordinates
+in the following planar neighbor diagram, (drawn for self.N_side = 3)
 where self is the middle cell
    
-
                 up
-           *-----*
-           |     |
-           |     |
-           |     |
-     *-----*-----*-----*
-     |     | 012 |     |
-left |     | 345 |     | right 
-     |     | 678 |     |
-     *-----*-----*-----*
-           |     |
-           |     |
-           |     |
-           *-----*
-            down
    
+
                 up
+           *-----*
+           |     |
+           |     |
+           |     |
+     *-----*-----*-----*
+     |     | 012 |     |
+left |     | 345 |     | right
+     |     | 678 |     |
+     *-----*-----*-----*
+           |     |
+           |     |
+           |     |
+           *-----*
+            down
+
    
 
    
-
    If plane = False, then the direction is relative to 
-longitude-latitude coordinates and is one of the strings 
-‘west’, ‘east’, ‘north’, ‘south’ for a quad or skew quad cell; 
-‘west’, ‘east’, ‘southwest’, ‘southeast’ for a northern dart cell;
-‘west’, ‘east’, ‘northwest’, ‘northeast’ for a southern dart cell;
-‘south_0’, ‘south_1’, ‘south_2’, ‘south_3’ for a northern cap cell;
-‘north_0’, ‘north_1’, ‘north_2’, ‘north_3’ for a southern cap cell;
-For a cap cell, neighbor directions are numbered in increasing  
-longitude, so that the longitude of the (nucleus of) north_0 is less 
+
    If plane = False, then the direction is relative to
+longitude-latitude coordinates and is one of the strings
+‘west’, ‘east’, ‘north’, ‘south’ for a quad or skew quad cell;
+‘west’, ‘east’, ‘southwest’, ‘southeast’ for a northern dart cell;
+‘west’, ‘east’, ‘northwest’, ‘northeast’ for a southern dart cell;
+‘south_0’, ‘south_1’, ‘south_2’, ‘south_3’ for a northern cap cell;
+‘north_0’, ‘north_1’, ‘north_2’, ‘north_3’ for a southern cap cell;
+For a cap cell, neighbor directions are numbered in increasing
+longitude, so that the longitude of the (nucleus of) north_0 is less
 than the longitude of north_1 is less than the longitude of north_2 is
 less than the longitude of north_3, and the longitude of the south_0 is
 less than the longitude of south_1, etc.
    
-
    The tricky part in the planar scenario is that the neighbor 
-relationships of the six resolution 0 cells is determined by the 
-positions of those cells on the surface of a cube, 
+
    The tricky part in the planar scenario is that the neighbor
+relationships of the six resolution 0 cells is determined by the
+positions of those cells on the surface of a cube,
 one cell on each face, and not on a plane.
 So sometimes rotating cells is needed to compute neighbors.
    
 
    Return None if the given direction is invalid for this cell.
    
 
    EXAMPLES:
    
-
    >>> c = Cell(RHEALPixDGGS(), ['N', 0])
->>> print(c.neighbor('down'))
+
    >>> c = Cell(RHEALPixDGGS(), ['N', 0])
+>>> print(c.neighbor('down'))
 N3
 
    
 
    
 
    
 
-
    
-
    
-neighbors(self, plane=True)¶
    
-
    Return this cell’s planar or ellipsoidal (edge) neighbors
+
    
+
    
+neighbors(plane=True)¶
    
+
    Return this cell’s planar or ellipsoidal (edge) neighbors
 as a dictionary whose keys are the directions of the neighbors.
 See neighbor() for a list of valid directions.
    
 
    EXAMPLES:
    
-
    >>> c = Cell(RHEALPixDGGS(), ['N', 0])
+
    >>> c = Cell(RHEALPixDGGS(), ['N', 0])
 >>> for k, v in sorted(c.neighbors().items()):
-...     print(k, v)
-... 
+...     print(k, v)
+...
 down N3
 left R0
 right N1
@@ -457,82 +501,93 @@ 
    Navigation
    
 
    
 
    
 
-
    
-
    
-nucleus(self, plane=True)¶
    
+
    
+
    
+nucleus(plane=True)¶
    
 
    Return the nucleus and vertices of this planar or ellipsoidal cell
-in the order (nucleus, upper left corner, lower left corner, 
-lower right corner, upper right corner) with reference to the 
+in the order (nucleus, upper left corner, lower left corner,
+lower right corner, upper right corner) with reference to the
 planar cell.
 The output for ellipsoidal cells is the projection onto the ellipsoid
-of the output for planar cells.  In particular, while the 
-nucleus of a planar cell is its centroid, the nucleus 
+of the output for planar cells.  In particular, while the
+nucleus of a planar cell is its centroid, the nucleus
 of an ellipsoidal cell is not its centroid.
 To compute the centroid of a cell, use centroid() below.
    
 
    EXAMPLES:
    
-
    >>> rdggs = UNIT_003
->>> c = rdggs.cell(['N'])
->>> print(my_round(c.nucleus(), 14))
-(-2.35619449019234, 1.5707963267949001)
+
    >>> rdggs = UNIT_003
+>>> c = rdggs.cell(['N'])
+>>> print(my_round(c.nucleus(), 14))
+(-2.35619449019234, 1.5707963267949)
 
    
 
    
+
    
+
    NOTES:: .. Issue #1 was ..
    (-2.35619449019234, 1.5707963267949001) *
    
+
    
+
    
 
    
 
-
    
-
    
-nw_vertex(self, plane=True)¶
    
+
    
+
    
+nw_vertex(plane=True)¶
    
 
    If plane = False, then return the northwest vertex of this
 ellipsoidal cell.
 If plane = True, then return the projection onto the plane
 of the ellipsoidal northwest vertex.
-On quad cells and cap cells, this function returns the same output 
+On quad cells and cap cells, this function returns the same output
 as ul_vertex().
 On skew quad cells and dart cells, this function returns output
 different from ul_vertex().
    
-
    WARNING: The northwest vertex of a cell might not lie in the cell, 
+
    WARNING: The northwest vertex of a cell might not lie in the cell,
 because not all cells contain their boundary.
    
-
    
-
    EXAMPLES::
    
-
    >>> rdggs = RHEALPixDGGS()
->>> c = rdggs.cell(['P', 5, 7]) # Quad cell.
->>> print(my_round(c.ul_vertex(plane=True), 14))
-(-2225148.7007489, -556287.17518722452)
->>> print(my_round(c.nw_vertex(plane=True), 14))
-(-2225148.7007489, -556287.17518722452)
+
    
+
    EXAMPLES::
    >>> rdggs = RHEALPixDGGS()
+>>> c = rdggs.cell(['P', 5, 7]) # Quad cell.
+>>> print(my_round(c.ul_vertex(plane=True), 14))
+(-2225148.7007489, -556287.1751872245)
+>>> print(my_round(c.nw_vertex(plane=True), 14))
+(-2225148.7007489, -556287.1751872245)
 
    
 
    
-
    >>> c = rdggs.cell(['S', 4])  # Cap cell.
->>> print(my_round(c.ul_vertex(plane=True), 14))
-(-16688615.255616743, -8344307.6278083706)
->>> print(my_round(c.nw_vertex(plane=True), 14))
-(-16688615.255616743, -8344307.6278083706)
+
    
+
    NOTES:: .. Issue #1 was ..
    (-2225148.7007489, -556287.17518722452) * for both above tests
    
+
    >>> c = rdggs.cell(['S', 4])  # Cap cell.
+>>> print(my_round(c.ul_vertex(plane=True), 14))
+(-16688615.255616743, -8344307.627808371)
+>>> print(my_round(c.nw_vertex(plane=True), 14))
+(-16688615.255616743, -8344307.627808371)
 
    
 
    
-
    >>> c = rdggs.cell(['N', 4, 3]) # Skew quad cell.
->>> print(my_round(c.ul_vertex(plane=True), 14))
+
    
+
    NOTES:: .. Issue #1 was ..
    (-16688615.255616743, -8344307.6278083706) * for both above tests
    
+
    >>> c = rdggs.cell(['N', 4, 3]) # Skew quad cell.
+>>> print(my_round(c.ul_vertex(plane=True), 14))
 (-16688615.255616743, 10569456.32855727)
->>> print(my_round(c.nw_vertex(plane=True), 14))
+>>> print(my_round(c.nw_vertex(plane=True), 14))
 (-15576040.905242294, 10569456.32855727)
 
    
 
    
-
    >>> c = rdggs.cell(['S', 4, 3])  # Skew quad cell.
->>> print(my_round(c.ul_vertex(plane=True), 14))
-(-16688615.255616743, -9456881.9781828206)
->>> print(my_round(c.nw_vertex(plane=True), 14))
+
    >>> c = rdggs.cell(['S', 4, 3])  # Skew quad cell.
+>>> print(my_round(c.ul_vertex(plane=True), 14))
+(-16688615.255616743, -9456881.97818282)
+>>> print(my_round(c.nw_vertex(plane=True), 14))
 (-16688615.255616743, -10569456.32855727)
 
    
 
    
-
    >>> c = rdggs.cell(['N', 6, 2])  # Dart cell.
->>> print(my_round(c.ul_vertex(plane=True), 14))
-(-17801189.605991192, 8344307.6278083716)
->>> print(my_round(c.nw_vertex(plane=True), 14))
-(-16688615.255616743, 8344307.6278083716)
+
    
+
    NOTES:: .. Issue #1 was ..
    (-16688615.255616743, -9456881.9781828206) *
    
+
    >>> c = rdggs.cell(['N', 6, 2])  # Dart cell.
+>>> print(my_round(c.ul_vertex(plane=True), 14))
+(-17801189.605991192, 8344307.627808372)
+>>> print(my_round(c.nw_vertex(plane=True), 14))
+(-16688615.255616743, 8344307.627808372)
 
    
 
    
-
    >>> c = rdggs.cell(['S', 6, 2])  # Dart cell.
->>> print(my_round(c.ul_vertex(plane=True), 14))
+
    
+
    NOTES:: .. Issue #1 was ..
    (-16688615.255616743, 8344307.6278083716) * for both above tests
    
+
    >>> c = rdggs.cell(['S', 6, 2])  # Dart cell.
+>>> print(my_round(c.ul_vertex(plane=True), 14))
 (-17801189.605991192, -11682030.678931719)
->>> print(my_round(c.nw_vertex(plane=True), 14))
+>>> print(my_round(c.nw_vertex(plane=True), 14))
 (-16688615.255616743, -12794605.029306168)
 
    
 
    
@@ -540,92 +595,113 @@ 
    Navigation
    
 
    
 
    
 
-
    
-
    
-predecessor(self, resolution=None)¶
    
+
    
+
    
+overlaps(other_cell)¶
    
+
    Determines whether two DGGS cells overlap.
+Where cells are of different resolution, they will have different suid lengths. The zip function truncates the longer
+to be the same length as the shorter, producing two lists for comparison. If these lists are equal, the cells overlap.
+:param cell_one: the first DGGS cell
+:param cell_two: the second DGGS cell
+:return: True if overlaps
    
+
    
+
+
    
+
    
+predecessor(resolution=None)¶
    
 
    Return the greatest resolution resolution cell less than self.
 Note: self need not be a resolution resolution cell.
    
 
    EXAMPLES:
    
-
    >>> c = Cell(RHEALPixDGGS(), ('N', 0, 8))
->>> print(c.predecessor())
+
    >>> c = Cell(RHEALPixDGGS(), ('N', 0, 8))
+>>> print(c.predecessor())
 N07
->>> print(c.predecessor(0))
+>>> print(c.predecessor(0))
 None
->>> print(c.predecessor(1))
+>>> print(c.predecessor(1))
 None
->>> print(c.predecessor(3))
+>>> print(c.predecessor(3))
 N088
 
    
 
    
 
    
 
-
    
-
    
-random_point(self, plane=True)¶
    
+
    
+
    
+random_point(plane=True)¶
    
 
    Return a random point in this cell.
 If plane = True, then choose the point from
 the planar cell.
 Otherwise, choose the point from the ellipsoidal cell.
    
 
    EXAMPLES:
    
-
    >>> c = Cell(RHEALPixDGGS(), ['N', 0])
->>> print(c.random_point(plane=False))  
+
    >>> c = Cell(RHEALPixDGGS(), ['N', 0])
+>>> print(c.random_point(plane=False))  
 (1.4840291937583836, 0.90042819146088571)
 
    
 
    
 
    
 
-
    
-
    
-region(self)¶
    
-
    Return the region of this cell: ‘equatorial’, ‘north_polar’, or
-‘south_polar’.
    
+
    
+
    
+region()¶
    
+
    Return the region of this cell: ‘equatorial’, ‘north_polar’, or
+‘south_polar’.
    
 
    EXAMPLES:
    
-
    >>> rdggs = RHEALPixDGGS()
->>> print(Cell(rdggs, ['P', 2]).region())
+
    >>> rdggs = RHEALPixDGGS()
+>>> print(Cell(rdggs, ['P', 2]).region())
 equatorial
->>> print(Cell(rdggs, ['N', 2]).region())
+>>> print(Cell(rdggs, ['N', 2]).region())
 north_polar
 
    
 
    
 
    
 
-
    
-
    
-rotate(self, quarter_turns)¶
    
-
    Return the cell that is the result of rotating this cell’s
+
    
+
    
+region_overlaps(region: list)¶
    
+
    Determine whether a cell overlaps with any cell in a list of cells
+:param cell: a DGGS cell
+:param region: a list of DGGS cells
+:return: True if any overlapping cells
    
+
    
+
+
    
+
    
+rotate(quarter_turns)¶
    
+
    Return the cell that is the result of rotating this cell’s
 resolution 0 supercell by quarter_turns quarter turns anticlockwise.
 Used in neighbor().
    
 
    EXAMPLES:
    
-
    >>> c = Cell(RHEALPixDGGS(), ['N', 0])
->>> print([str(c.rotate(t)) for t in range(4)])
+
    >>> c = Cell(RHEALPixDGGS(), ['N', 0])
+>>> print([str(c.rotate(t)) for t in range(4)])
 ['N0', 'N2', 'N8', 'N6']
 
    
 
    
 
    
 
-
    
-
    
-rotate_entry(self, x, quarter_turns)¶
    
+
    
+
    
+rotate_entry(x, quarter_turns)¶
    
 
    Let N = self.N_side and rotate the N x N matrix of subcell numbers
    
-
    0        1          ... N - 1
-N        N+1        ... 2*N - 1
-...
-(N-1)*N  (N-1)*N+1  ... N**2-1
    
+
    0        1          ... N - 1
+N        N+1        ... 2*N - 1
+...
+(N-1)*N  (N-1)*N+1  ... N**2-1
+
    
 
    
 
    anticlockwise by quarter_turns quarter turns to obtain a
-new table with entries f(0), f(1), ..., f(N**2 - 1) read from
+new table with entries f(0), f(1), …, f(N**2 - 1) read from
 left to right and top to bottom.
 Given entry number x in the original matrix, return f(x).
 Used in rotate().
    
 
    INPUT:
    
 
      
-
    • x - A letter from RHEALPixDGGS.cells0 or one of the integers
-0, 1, ..., N**2 - 1.
      • 
-
    • quarter_turns - 0, 1, 2, or 3.
      • 
+
    • x - A letter from RHEALPixDGGS.cells0 or one of the integers
+0, 1, …, N**2 - 1.
      • 
+
    • quarter_turns - 0, 1, 2, or 3.
      • 
 
    
 
    EXAMPLES:
    
-
    >>> c = Cell(RHEALPixDGGS(), ['P', 2])
->>> print([c.rotate_entry(0, t) for t in range(4)])
+
    >>> c = Cell(RHEALPixDGGS(), ['P', 2])
+>>> print([c.rotate_entry(0, t) for t in range(4)])
 [0, 2, 8, 6]
 
    
 
    
@@ -635,163 +711,162 @@ 
    Navigation
    
 Only depends on self through self.N_side.
    
 
    
 
-
    
-
    
-subcell(self, other)¶
    
+
    
+
    
+subcell(other)¶
    
 
    Subcell (subset) relation on cells.
    
 
    EXAMPLES:
    
-
    >>> a = Cell(RHEALPixDGGS(), ('N', 1))
->>> b = Cell(RHEALPixDGGS(), ['N'])
->>> print(a.subcell(b))
+
    >>> a = Cell(RHEALPixDGGS(), ('N', 1))
+>>> b = Cell(RHEALPixDGGS(), ['N'])
+>>> print(a.subcell(b))
 True
->>> print(b.subcell(a))
+>>> print(b.subcell(a))
 False
 
    
 
    
 
    
 
-
    
-
    
-subcells(self, resolution=None)¶
    
-
    Generator function for the set of all resolution resolution subcells 
-of this cell.  
+
    
+
    
+subcells(resolution=None)¶
    
+
    Generator function for the set of all resolution resolution subcells
+of this cell.
 If resolution=None, then return a generator function for the children
 of this cell.
    
 
    EXAMPLES:
    
-
    >>> c = Cell(RHEALPixDGGS(), ['N'])
->>> print([str(cell) for cell in c.subcells()])
+
    >>> c = Cell(RHEALPixDGGS(), ['N'])
+>>> print([str(cell) for cell in c.subcells()])
 ['N0', 'N1', 'N2', 'N3', 'N4', 'N5', 'N6', 'N7', 'N8']
 
    
 
    
 
    
 
-
    
-
    
-successor(self, resolution=None)¶
    
+
    
+
    
+successor(resolution=None)¶
    
 
    Return the least resolution resolution cell greater than self.
 Note: self need not be a resolution resolution cell.
    
 
    EXAMPLES:
    
-
    >>> c = Cell(RHEALPixDGGS(), ('N', 8, 2))
->>> print(c.successor())
+
    >>> c = Cell(RHEALPixDGGS(), ('N', 8, 2))
+>>> print(c.successor())
 N83
->>> print(c.successor(0))
+>>> print(c.successor(0))
 O
->>> print(c.successor(1))
+>>> print(c.successor(1))
 O0
->>> print(c.successor(3))
+>>> print(c.successor(3))
 N830
 
    
 
    
 
    
 
-
    
-
    
-suid_from_index(rdggs, index, order='resolution')¶
    
+
    
+
    
+static suid_from_index(rdggs, index, order='resolution')¶
    
 
    Return the suid of a cell from its index.
 The index is according to the cell ordering order,
-which can be ‘resolution’ (default) or ‘post’.
+which can be ‘resolution’ (default) or ‘post’.
 See the index() docstring for more details on orderings.
 For internal use.
    
 
    
 
-
    
-
    
-suid_rowcol(self)¶
    
+
    
+
    
+suid_rowcol()¶
    
 
    Return the pair of row- and column-suids of self, each as tuples.
    
 
    EXAMPLES:
    
-
    >>> rdggs = RHEALPixDGGS()
->>> c = Cell(rdggs, ['N', 7, 3])
+
    >>> rdggs = RHEALPixDGGS()
+>>> c = Cell(rdggs, ['N', 7, 3])
 >>> rsuid, csuid = c.suid_rowcol()
->>> print(rsuid == ('N', 2, 1))
+>>> print(rsuid == ('N', 2, 1))
 True
->>> print(csuid == ('N', 1, 0))
+>>> print(csuid == ('N', 1, 0))
 True
 
    
 
    
 
    
 
-
    
-
    
-ul_vertex(self, plane=True)¶
    
-
    If plane = True, then return the upper left vertex of this 
+
    
+
    
+ul_vertex(plane=True)¶
    
+
    If plane = True, then return the upper left vertex of this
 planar cell.
 If plane = False, then return the projection onto the ellipsoid
 of the planar upper left vertex.
-Note that for polar cells, this projection is not necessarily the 
+Note that for polar cells, this projection is not necessarily the
 northwest vertex.
 For the latter vertex use nw_vertex().
    
-
    WARNING: The upper left vertex of a cell might not lie in the cell, 
+
    WARNING: The upper left vertex of a cell might not lie in the cell,
 because not all cells contain their boundary.
    
 
    EXAMPLES:
    
-
    >>> c = Cell(UNIT_003, ['N', 0])
->>> print(c.ul_vertex() == (-pi, 3*pi/4))
+
    >>> c = Cell(UNIT_003, ['N', 0])
+>>> print(c.ul_vertex() == (-pi, 3*pi/4))
 True
 
    
 
    
 
    
 
-
    
-
    
-vertices(self, plane=True, trim_dart=False)¶
    
-
    If plane = True, then assume this cell is planar and return 
-its four vertices in the order (upper left corner, upper right corner, 
+
    
+
    
+vertices(plane=True, trim_dart=False)¶
    
+
    If plane = True, then assume this cell is planar and return
+its four vertices in the order (upper left corner, upper right corner,
 lower right corner, lower left corner).
 If plane = False, then assume this cell is ellipsoidal and return
 the projection of the planar vertices in the order
 (northwest, northeast, southeast, southwest).
-If plane = False, this cell is a dart cell, and 
+If plane = False, this cell is a dart cell, and
 trim_dart = True, then remove the one non-vertex point from
 the output. (Dart cells only have three vertices.)
    
 
    EXAMPLES:
    
-
    >>> rdggs = UNIT_003
->>> c = rdggs.cell(['N'])
+
    >>> rdggs = UNIT_003
+>>> c = rdggs.cell(['N'])
 >>> for p in c.vertices():
-...     print(my_round(p, 14))
+...     print(my_round(p, 14))
 (-3.14159265358979, 2.35619449019234)
-(-1.5707963267949001, 2.35619449019234)
-(-1.5707963267949001, 0.78539816339745006)
-(-3.14159265358979, 0.78539816339745006)
+(-1.5707963267949, 2.35619449019234)
+(-1.5707963267949, 0.78539816339745)
+(-3.14159265358979, 0.78539816339745)
 
 >>> rdggs = WGS84_003
->>> c = rdggs.cell(['N', 0])
->>> for p in c.vertices(plane=False):
-...     print(my_round(p, 14))
-(89.999999999999929, 74.39069094879062)
-(119.99999999999999, 41.87385774220941)
-(90.0, 41.87385774220941)
-(60.000000000000007, 41.87385774220941)
-
->>> for p in c.vertices(plane=False, trim_dart=True):
-...     print(my_round(p, 14))
-(89.999999999999929, 74.39069094879062)
-(119.99999999999999, 41.87385774220941)
-(60.000000000000007, 41.87385774220941)
-
->>> c = rdggs.cell(['S', 0])
->>> for p in c.vertices(plane=False):
-...     print(my_round(p, 14))
+>>> c = rdggs.cell(['N', 0])
+>>> for p in c.vertices(plane=False):
+...     print(my_round(p, 13))
+(89.9999999999999, 74.3906909487906)
+(120.0, 41.8738577422094)
+(90.0, 41.8738577422094)
+(60.0, 41.8738577422094)
+>>> for p in c.vertices(plane=False, trim_dart=True):
+...     print(my_round(p, 13))
+(89.9999999999999, 74.3906909487906)
+(120.0, 41.8738577422094)
+(60.0, 41.8738577422094)
+
+>>> c = rdggs.cell(['S', 0])
+>>> for p in c.vertices(plane=False):
+...     print(my_round(p, 14))
 (149.99999999999997, -41.87385774220941)
 (-180.0, -41.87385774220941)
 (-150.0, -41.87385774220941)
-(-180.0, -74.390690948790649)
->>> for p in c.vertices(plane=False, trim_dart=True):
-...     print(my_round(p, 14))
+(-180.0, -74.39069094879065)
+>>> for p in c.vertices(plane=False, trim_dart=True):
+...     print(my_round(p, 14))
 (149.99999999999997, -41.87385774220941)
 (-150.0, -41.87385774220941)
-(-180.0, -74.390690948790649)
+(-180.0, -74.39069094879065)
 
    
 
    
 
    
 
-
    
-
    
-width(self, plane=True)¶
    
-
    Return the width of this cell. 
+
    
+
    
+width(plane=True)¶
    
+
    Return the width of this cell.
 If plane = False, then return None, because ellipsoidal cells
-don’t have a fixed width.
    
+don’t have a fixed width.
    
 
    EXAMPLES:
    
-
    >>> c = Cell(UNIT_003, ('N', 8))
->>> print(c)
+
    >>> c = Cell(UNIT_003, ('N', 8))
+>>> print(c)
 N8
 >>> c.width() == pi/2*3**(-1)
 True
@@ -799,14 +874,14 @@ 
    Navigation
    
 
    
 
    
 
-
    
-
    
-xy_range(self)¶
    
-
    Return the x- and y-coordinate extremes of the planar version of 
+
    
+
    
+xy_range()¶
    
+
    Return the x- and y-coordinate extremes of the planar version of
 this cell in the format ((x_min, x_max), (y_min, y_max)).
    
 
    EXAMPLES:
    
-
    >>> rdggs = UNIT_003
->>> c = rdggs.cell(['N'])
+
    >>> rdggs = UNIT_003
+>>> c = rdggs.cell(['N'])
 >>> c.xy_range() == ((-pi, -pi/2), (pi/4, 3*pi/4))
 True
 
    
@@ -815,193 +890,211 @@ 
    Navigation
    
 
 
    
 
-
    
-
    
-class rhealpix_dggs.dggs.RHEALPixDGGS(ellipsoid=<rhealpix_dggs.ellipsoids.Ellipsoid object at 0x102e65d50>, N_side=3, north_square=0, south_square=0, max_areal_resolution=1)¶
    
-
    Bases: builtins.object
    
+
    
+
    
+class rhealpixdggs.dggs.RHEALPixDGGS(ellipsoid=<rhealpixdggs.ellipsoids.Ellipsoid object>, N_side=3, north_square=0, south_square=0, max_areal_resolution=1)¶
    
+
    Bases: object
    
 
    Represents an rHEALPix DGGS on a given ellipsoid.
    
 
    CLASS ATTRIBUTES:
    
 
      
-
    • cells0 - A list of the resolution 0 cell IDs (strings).
      • 
+
    • cells0 - A list of the resolution 0 cell IDs (strings).
      • 
 
    
 
    INSTANCE ATTRIBUTES:
    
 
      
-
    • ellipsoid - The underlying ellipsoid (Ellipsoid instance).
      • 
-
    • N_side - An integer of size at least 2.
-Each planar cell has N_side x N_side child cells.
      • 
-
    • (north_square, south_square) - Integers between 0 and 3 indicating
+
    • ellipsoid - The underlying ellipsoid (Ellipsoid instance).
      • 
+
    • N_side - An integer of size at least 2.
+Each planar cell has N_side x N_side child cells.
      • 
+
    • (north_square, south_square) - Integers between 0 and 3 indicating
 the positions of north polar and south polar squares, respectively,
-of the rHEALPix projection used.
      • 
-
    • max_areal_resolution - An area measured in square meters that 
-upper bounds the area of the smallest ellipsoidal grid cells.
      • 
-
    • max_resolution - A nonnegative integer that is the maximum grid 
+of the rHEALPix projection used.
      • 
+
    • max_areal_resolution - An area measured in square meters that
+upper bounds the area of the smallest ellipsoidal grid cells.
      • 
+
    • max_resolution - A nonnegative integer that is the maximum grid
 resolution needed to have ellipsoidal cells of area at most
-max_areal_resolution.
      • 
-
    • child_order - A dictionary of the ordering (Morton order) of child
+max_areal_resolution.
      • 
+
    • child_order - A dictionary of the ordering (Morton order) of child
 cells of a cell in terms of the row-column coordinates in the matrix
 of child cells.  Child cell are numbered 0 to N_side**2 -1 from
-left to right and top to bottom.
      • 
-
    • ul_vertex - A dictionary with key-value pairs (c, (x, y)), where
+left to right and top to bottom.
      • 
+
    • ul_vertex - A dictionary with key-value pairs (c, (x, y)), where
 c is an element of cells0 and (x, y) is the upper left corner point
-of the resolution 0 planar cell c.
      • 
-
    • atomic_neighbors - A dictionary with key-value pairs 
-(n, {‘up’: a, ‘down’: b, ‘left’: c, ‘right’: d}),
-where n, a, b, c, and d are elements of cells0 or 
-{0, 1, ..., N_side**2 -1}. 
-Describes the planar (edge) neighbors of cell0 letter / child cell number 
-n.
      • 
+of the resolution 0 planar cell c.
      
+
    • atomic_neighbors - A dictionary with key-value pairs
+(n, {‘up’: a, ‘down’: b, ‘left’: c, ‘right’: d}),
+where n, a, b, c, and d are elements of cells0 or
+{0, 1, …, N_side**2 -1}.
+Describes the planar (edge) neighbors of cell0 letter / child cell number
+n.
      • 
 
    
 
    NOTE:
    
-
    Several RHEALPixDGGS methods have the keyword argument ‘plane’.
-Setting it to True indicates that all input and output points and cells are 
+
    Several RHEALPixDGGS methods have the keyword argument ‘plane’.
+Setting it to True indicates that all input and output points and cells are
 interpreted as lying in the planar DGGS.
-Setting it to False indicates that they are interpreted as lying in 
+Setting it to False indicates that they are interpreted as lying in
 the ellipsoidal DGGS.
    
-
    
-
    
-cell(self, suid=None, level_order_index=None, post_order_index=None)¶
    
-
    Return a cell (Cell instance) of this DGGS either from its ID or 
+
    
+
    
+cell(suid=None, level_order_index=None, post_order_index=None)¶
    
+
    Return a cell (Cell instance) of this DGGS either from its ID or
 from its resolution and index.
    
 
    EXAMPLES:
    
-
    >>> rdggs = RHEALPixDGGS()
->>> c = rdggs.cell(('N', 4, 5))
->>> print(isinstance(c, Cell))
+
    >>> rdggs = RHEALPixDGGS()
+>>> c = rdggs.cell(('N', 4, 5))
+>>> print(isinstance(c, Cell))
 True
->>> print(c)
+>>> print(c)
 N45
 
    
 
    
 
    
 
-
    
-
    
-cell_area(self, resolution, plane=True)¶
    
+
    
+
    
+cell_area(resolution, plane=True)¶
    
 
    Return the area of a planar or ellipsoidal cell at the given
 resolution.
    
 
    EXAMPLES:
    
-
    >>> rdggs = UNIT_003
->>> a = rdggs.cell_area(1) 
->>> print(a == (pi/6)**2)
+
    >>> rdggs = UNIT_003
+>>> a = rdggs.cell_area(1)
+>>> print(a == (pi/6)**2)
 True
->>> print(rdggs.cell_area(1, plane=False) == 8/(3*pi)*a)
+>>> print(rdggs.cell_area(1, plane=False) == 8/(3*pi)*a)
 True
 
    
 
    
 
    
 
-
    
-
    
-cell_from_point(self, resolution, p, plane=True)¶
    
+
    
+
    
+cell_from_point(resolution, p, plane=True)¶
    
 
    Return the resolution resolution cell that contains the point p.
 If plane = True, then p and the output cell lie in the
 planar DGGS.
 Otherwise, p and the output cell lie in the ellipsoidal DGGS.
    
 
    EXAMPLES:
    
-
    >>> rdggs = RHEALPixDGGS()
+
    >>> rdggs = RHEALPixDGGS()
 >>> p = (0, 0)
 >>> c = rdggs.cell_from_point(1, p)
->>> print(c)
+>>> print(c)
 Q3
 
    
 
    
 
    
 
-
    
-
    
-cell_from_region(self, ul, dr, plane=True)¶
    
-
    Return the smallest planar or ellipsoidal cell wholly containing 
-the region bounded by the axis-aligned rectangle with upper left 
-and lower right vertices given by the the points ul and dr, 
-respectively.  
+
    
+
    
+cell_from_region(ul, dr, plane=True)¶
    
+
    Return the smallest planar or ellipsoidal cell wholly containing
+the region bounded by the axis-aligned rectangle with upper left
+and lower right vertices given by the the points ul and dr,
+respectively.
 If such as cell does not exist, then return None.
 If plane = True, then ul and dr and the returned cell
 lie in the planar DGGS.
 Otherwise, ul and dr and the returned cell lie in the ellipsoidal
 DGGS.
    
-
    To specify an ellipsoidal cap region, set ul = (-pi, pi/2) and 
-dr = (-pi, phi) for a northern cap from latitudes pi/2 to phi, or 
-set ul = (-pi, phi) and dr = (-pi, -pi/2) for a southern cap from 
-latitudes phi to -pi/2. 
-(As usual, if self.ellipsoid.radians = False, 
+
    To specify an ellipsoidal cap region, set ul = (-pi, pi/2) and
+dr = (-pi, phi) for a northern cap from latitudes pi/2 to phi, or
+set ul = (-pi, phi) and dr = (-pi, -pi/2) for a southern cap from
+latitudes phi to -pi/2.
+(As usual, if self.ellipsoid.radians = False,
 then use degrees instead of radians when specifying ul and dr.)
    
 
    EXAMPLES:
    
-
    >>> rdggs = UNIT_003
+
    >>> rdggs = UNIT_003
 >>> p = (0, pi/12)
 >>> q = (pi/6 - 1e-6, 0)
 >>> c = rdggs.cell_from_region(p, q)
->>> print(c)
+>>> print(c)
 Q3
 
    
 
    
 
    
 
-
    
-
    
-cell_latitudes(self, resolution, phi_min, phi_max, nucleus=True, plane=True)¶
    
+
    
+
    
+cell_latitudes(resolution, phi_min, phi_max, nucleus=True, plane=True)¶
    
 
    Return a list of every latitude phi whose parallel intersects
-a resolution resolution cell nucleus and satisfies 
+a resolution resolution cell nucleus and satisfies
 phi_min < phi < phi_max.
 If plane = True, then use rHEALPix y-coordinates for phi_min,
 phi_max, and the result. Return the list in increasing order.
-If nucleus = False, then return a list of every latitude phi whose   
-parallel intersects the north or south boundary of a resolution 
+If nucleus = False, then return a list of every latitude phi whose
+parallel intersects the north or south boundary of a resolution
 resolution cell and that satisfies phi_min < phi < phi_max.
    
 
    NOTE:
    
-
    By convention, the pole latitudes pi/2 and -pi/2 (or their 
+
    By convention, the pole latitudes pi/2 and -pi/2 (or their
 corresponding rHEALPix y-coordinates) will be excluded.
    
 
    There are 2*self.N_side**resolution - 1 nuclei
-latitudes between the poles if self.N_side is odd and 
+latitudes between the poles if self.N_side is odd and
 2*self.N_side**resolution if self.N_side is even.
-Consequently, there are 2*self.N_side**resolution 
-boundary latitudes between the poles if self.N_side is odd and 
+Consequently, there are 2*self.N_side**resolution
+boundary latitudes between the poles if self.N_side is odd and
 2*self.N_side**resolution - 1 boundary latitudes if self.N_side is
 even.
    
 
    EXAMPLES:
    
-
    >>> rdggs = WGS84_003_RADIANS
->>> for phi in rdggs.cell_latitudes(1, -pi/2, pi/2, plane=False):
-...     print(my_round(phi, 14))
--1.020505844
--0.461443149003
--0
-0.461443149003
-1.020505844
-1.57079632679
->>> for phi in rdggs.cell_latitudes(1, -pi/2, pi/2, nucleus=False, plane=False):
-...     print(my_round(phi, 14)) 
--1.29836248989
--0.730836688113
--0.224577156195
-0.224577156195
-0.730836688113
-1.29836248989
+
    >>> rdggs = WGS84_003_RADIANS
+>>> for phi in rdggs.cell_latitudes(1, -pi/2, pi/2, plane=False):
+...     print(my_round(phi, 14))
+-1.02050584399985
+-0.46144314900303
+-0.0
+0.46144314900303
+1.02050584399985
+1.5707963267949
 
    
 
    
+
    
+
    NOTES:: .. Issue @1 was ..
    -1.020505844
+-0.461443149003
+-0
+0.461443149003
+1.020505844
+1.57079632679
    
+
    >>> for phi in rdggs.cell_latitudes(1, -pi/2, pi/2, nucleus=False, plane=False):
+...     print(my_round(phi, 14))
+-1.29836248988994
+-0.73083668811327
+-0.22457715619516
+0.22457715619516
+0.73083668811327
+1.29836248988994
+
    
+
    
+
    
+
    NOTES:: .. Issue @1 was ..
    -1.29836248989
+-0.730836688113
+-0.224577156195
+0.224577156195
+0.730836688113
+1.29836248989
    
+
    
+
    
 
    
 
-
    
-
    
-cell_width(self, resolution, plane=True)¶
    
+
    
+
    
+cell_width(resolution, plane=True)¶
    
 
    Return the width of a planar cell at the given resolution.
-If plane = False, then return None, 
-because the ellipsoidal cells don’t have constant width.
    
+If plane = False, then return None,
+because the ellipsoidal cells don’t have constant width.
    
 
    EXAMPLES:
    
-
    >>> rdggs = UNIT_003
->>> print(rdggs.cell_width(0) == pi/2)
+
    >>> rdggs = UNIT_003
+>>> print(rdggs.cell_width(0) == pi/2)
 True
->>> print(rdggs.cell_width(1) == pi/6)
+>>> print(rdggs.cell_width(1) == pi/6)
 True
 
    
 
    
 
    
 
-
    
-
    
-cells0 = ['N', 'O', 'P', 'Q', 'R', 'S']¶
    
+
    
+
    
+cells0 = ['N', 'O', 'P', 'Q', 'R', 'S']¶
    
 
    
 
-
    
-
    
-cells_from_meridian(self, resolution, lam, phi_min, phi_max)¶
    
+
    
+
    
+cells_from_meridian(resolution, lam, phi_min, phi_max)¶
    
 
    Return a list of the resolution resolution cells that intersect
 the meridian segment of longitude lam whose least latitude is
 phi_min and whose greatest latitude is phi_max.
@@ -1009,53 +1102,53 @@ 
    Navigation
    
 two cells with the same nucleus latitude intersect the
 meridian.
    
 
    EXAMPLES:
    
-
    >>> rdggs = WGS84_003_RADIANS
+
    >>> rdggs = WGS84_003_RADIANS
 >>> cells = rdggs.cells_from_meridian(1, 0.1, -pi/2, pi/2)
->>> print([str(cell) for cell in cells])
+>>> print([str(cell) for cell in cells])
 ['N4', 'N2', 'N1', 'Q0', 'Q3', 'Q6', 'S8', 'S7', 'S4']
 
    
 
    
 
    
 
-
    
-
    
-cells_from_parallel(self, resolution, phi, lam_min, lam_max)¶
    
+
    
+
    
+cells_from_parallel(resolution, phi, lam_min, lam_max)¶
    
 
    Return a list of the resolution resolution cells that intersect
 the parallel segment of latitude phi whose least longitude is
 lam_min and whose greatest longitude is lam_max.
 Sort the list from west to east.
    
 
    EXAMPLES:
    
-
    >>> rdggs = WGS84_003_RADIANS
+
    >>> rdggs = WGS84_003_RADIANS
 >>> cells = rdggs.cells_from_parallel(1, pi/3, -pi, pi)
->>> print([str(cell) for cell in cells])
+>>> print([str(cell) for cell in cells])
 ['N6', 'N7', 'N8', 'N5', 'N2', 'N1', 'N0', 'N3']
 
    
 
    
 
    
 
-
    
-
    
-cells_from_region(self, resolution, ul, dr, plane=True)¶
    
-
    If plane = True, then return a list of lists of resolution 
-resolution cells that cover the axis-aligned rectangle whose 
-upper left and lower right vertices are the points ul and dr, 
-respectively.  
-In the output, sort each sublist of cells from left to right (in the 
+
    
+
    
+cells_from_region(resolution, ul, dr, plane=True)¶
    
+
    If plane = True, then return a list of lists of resolution
+resolution cells that cover the axis-aligned rectangle whose
+upper left and lower right vertices are the points ul and dr,
+respectively.
+In the output, sort each sublist of cells from left to right (in the
 planar DGGS) and sort the sublists from top to bottom.
    
-
    If plane = False, then return a list of lists of resolution 
-resolution 
-cells that cover the longitude-latitude aligned ellipsoidal quadrangle  
-whose northwest and southeast vertices are the points ul and dr, 
-respectively. Defunct quads with ul = (stuff, pi/2) or 
-dr = (stuff, -pi/2) also work 
-(and rely on the fact that the north and south pole can both 
+
    If plane = False, then return a list of lists of resolution
+resolution
+cells that cover the longitude-latitude aligned ellipsoidal quadrangle
+whose northwest and southeast vertices are the points ul and dr,
+respectively. Defunct quads with ul = (stuff, pi/2) or
+dr = (stuff, -pi/2) also work
+(and rely on the fact that the north and south pole can both
 be specified by infinitely many longitudes).
    
-
    To specify an ellipsoidal cap region, set ul = (-pi, pi/2) and 
-dr = (-pi, phi) for a northern cap from latitudes pi/2 to phi, or 
-set ul = (-pi, phi) and dr = (-pi, -pi/2) for a southern cap from 
-latitudes phi to -pi/2. (As usual, if self.ellipsoid.radians = False, 
+
    To specify an ellipsoidal cap region, set ul = (-pi, pi/2) and
+dr = (-pi, phi) for a northern cap from latitudes pi/2 to phi, or
+set ul = (-pi, phi) and dr = (-pi, -pi/2) for a southern cap from
+latitudes phi to -pi/2. (As usual, if self.ellipsoid.radians = False,
 then use degrees instead of radians when specifying ul and dr.)
    
-
    In the output, sort each sublist of cells from west to east (in the 
+
    In the output, sort each sublist of cells from west to east (in the
 ellipsoidal DGGS) and sort the sublists from north to south.
    
 
    Return the empty list if if ul[0] > dr[0] or ul[1] < dr[1].
    
 
    NOTE:
    
@@ -1063,40 +1156,40 @@ 
    Navigation
    
 each sublist has the same length.  This is not necessarily so if
 plane = False; see the examples below.
    
 
    EXAMPLES:
    
-
    >>> rdggs = WGS84_003_RADIANS
+
    >>> rdggs = WGS84_003_RADIANS
 >>> R_A = rdggs.ellipsoid.R_A
 >>> ul = R_A*array((-0.1, pi/4))
->>> dr = R_A*array((0.1, -pi/4))  # Rectangle 
+>>> dr = R_A*array((0.1, -pi/4))  # Rectangle
 >>> M = rdggs.cells_from_region(1, ul, dr)
 >>> for row in M:
-...     print([str(cell) for cell in row])
+...     print([str(cell) for cell in row])
 ['P2', 'Q0']
 ['P5', 'Q3']
 ['P8', 'Q6']
 
 >>> ul = (0, pi/3)
->>> dr = (pi/2, 0)  # Quad 
->>> M = rdggs.cells_from_region(1, ul, dr, plane=False)
+>>> dr = (pi/2, 0)  # Quad
+>>> M = rdggs.cells_from_region(1, ul, dr, plane=False)
 >>> for row in M:
-...     print([str(cell) for cell in row])
+...     print([str(cell) for cell in row])
 ['N2', 'N1', 'N0']
 ['Q0', 'Q1', 'Q2', 'R0']
 ['Q3', 'Q4', 'Q5', 'R3']
 
 >>> ul = (0, -pi/6)
->>> dr = (pi/2, -pi/2)  # Defunct quad / lune segment 
->>> M = rdggs.cells_from_region(1, ul, dr, plane=False)
+>>> dr = (pi/2, -pi/2)  # Defunct quad / lune segment
+>>> M = rdggs.cells_from_region(1, ul, dr, plane=False)
 >>> for row in M:
-...     print([str(cell) for cell in row])
+...     print([str(cell) for cell in row])
 ['Q6', 'Q7', 'Q8', 'R6']
 ['S8', 'S7', 'S6']
 ['S4']
 
->>> ul = (-pi, -pi/5)  
->>> dr = (-pi, -pi/2)  # Cap
->>> M = rdggs.cells_from_region(1, ul, dr, plane=False)
+>>> ul = (-pi, -pi/5)
+>>> dr = (-pi, -pi/2)  # Cap
+>>> M = rdggs.cells_from_region(1, ul, dr, plane=False)
 >>> for row in M:
-...     print([str(cell) for cell in row])
+...     print([str(cell) for cell in row])
 ['O6', 'O7', 'O8', 'P6', 'P7', 'P8', 'Q6', 'Q7', 'Q8', 'R6', 'R7', 'R8']
 ['S0', 'S1', 'S2', 'S5', 'S8', 'S7', 'S6', 'S3']
 ['S4']
@@ -1104,90 +1197,98 @@ 
    Navigation
    
 
    
 
    
 
-
    
-
    
-combine_triangles(self, u, v, inverse=False)¶
    
-
    Return the combine_triangles() transformation of the point (u, v) 
-(or its inverse if inverse = True) appropriate to the underlying 
+
    
+
    
+combine_triangles(u, v, inverse=False, region='none')¶
    
+
    Return the combine_triangles() transformation of the point (u, v)
+(or its inverse if inverse = True) appropriate to the underlying
 ellipsoid.
 It maps the HEALPix projection to the rHEALPix projection.
    
 
    EXAMPLES:
    
-
    >>> rdggs = UNIT_003
+
    >>> rdggs = UNIT_003
 >>> p = (0, 0)
 >>> q = (-pi/4, pi/2)
->>> print(rdggs.combine_triangles(*p))
+>>> print(rdggs.combine_triangles(*p))
 (0.0, 0.0)
->>> print(my_round(rdggs.combine_triangles(*q), 14))
-(-2.35619449019234, 1.5707963267949001)
+>>> print(my_round(rdggs.combine_triangles(*q), 14))
+(-2.35619449019234, 1.5707963267949)
 
    
 
    
+
    
+
    NOTES:: Issue #1 was ..
    (-2.35619449019234, 1.5707963267949001)
    
+
    
+
    
 
    
 
-
    
-
    
-grid(self, resolution)¶
    
+
    
+
    
+grid(resolution)¶
    
 
    Generator function for all the cells at resolution resolution.
    
 
    EXAMPLES:
    
-
    >>> rdggs = RHEALPixDGGS()
+
    >>> rdggs = RHEALPixDGGS()
 >>> grid0 = rdggs.grid(0)
->>> print([str(x) for x in grid0])
+>>> print([str(x) for x in grid0])
 ['N', 'O', 'P', 'Q', 'R', 'S']
 
    
 
    
 
    
 
-
    
-
    
-healpix(self, u, v, inverse=False)¶
    
-
    Return the HEALPix projection of point (u, v) (or its inverse if 
+
    
+
    
+healpix(u, v, inverse=False)¶
    
+
    Return the HEALPix projection of point (u, v) (or its inverse if
 inverse = True) appropriate to this rHEALPix DGGS.
    
 
    EXAMPLES:
    
-
    >>> rdggs = UNIT_003_RADIANS
->>> print(my_round(rdggs.healpix(-pi, pi/2), 14))
-(-2.35619449019234, 1.5707963267949001)
+
    >>> rdggs = UNIT_003_RADIANS
+>>> print(my_round(rdggs.healpix(-pi, pi/2), 14))
+(-2.35619449019234, 1.5707963267949)
 
    
 
    
+
    
+
    NOTES:: Issue #1 was ..
    (-2.35619449019234, 1.5707963267949001) *
    
+
    
+
    
 
    NOTE:
    
-
    Uses pj_healpix instead of the PROJ.4 version of HEALPix.
    
+
    Uses pj_healpix instead of the PROJ.4 version of HEALPix.
    
 
    
 
-
    
-
    
-interval(self, a, b)¶
    
-
    Generator function for all the resolution 
-max(a.resolution, b.resolution) cells between cell 
-a and cell b (inclusive and with respect to the     
+
    
+
    
+interval(a, b)¶
    
+
    Generator function for all the resolution
+max(a.resolution, b.resolution) cells between cell
+a and cell b (inclusive and with respect to the
 postorder ordering on cells).
-Note that a and b don’t have to lie at the same resolution.
    
+Note that a and b don’t have to lie at the same resolution.
    
 
    EXAMPLES:
    
-
    >>> rdggs = RHEALPixDGGS()
->>> a = rdggs.cell(('N', 1))
->>> b = rdggs.cell(('N',))
->>> print([str(c) for c in list(rdggs.interval(a, b))])
+
    >>> rdggs = RHEALPixDGGS()
+>>> a = rdggs.cell(('N', 1))
+>>> b = rdggs.cell(('N',))
+>>> print([str(c) for c in list(rdggs.interval(a, b))])
 ['N1', 'N2', 'N3', 'N4', 'N5', 'N6', 'N7', 'N8']
 
    
 
    
 
    
 
-
    
-
    
-minimal_cover(self, resolution, points, plane=True)¶
    
+
    
+
    
+minimal_cover(resolution, points, plane=True)¶
    
 
    Find the minimal set of resolution resolution cells that covers
 the list of points points.
-If plane = True, then assume points is a list of x-y 
+If plane = True, then assume points is a list of x-y
 coordinates in the planar DGGS.
-If plane = False, then assume points is a list of 
-longitude-latitude coordinates in the ellipsoidal DGGS.  
-This method will be made redundant by standard GIS rasterization 
+If plane = False, then assume points is a list of
+longitude-latitude coordinates in the ellipsoidal DGGS.
+This method will be made redundant by standard GIS rasterization
 tools that implement the rHEALPix projection.
    
 
    EXAMPLES:
    
-
    >>> rdggs = RHEALPixDGGS()
->>> c1 = rdggs.cell(['N', 0, 2, 1])
->>> c2 = rdggs.cell(['P', 7, 3, 3])
+
    >>> rdggs = RHEALPixDGGS()
+>>> c1 = rdggs.cell(['N', 0, 2, 1])
+>>> c2 = rdggs.cell(['P', 7, 3, 3])
 >>> points = [c.nucleus() for c in [c1, c2]]
 >>> for r in range(5):
 ...     cover = sorted(rdggs.minimal_cover(r, points))
-...     print([str(c) for c in cover])
+...     print([str(c) for c in cover])
 ['N', 'P']
 ['N0', 'P7']
 ['N02', 'P73']
@@ -1197,10 +1298,10 @@ 
    Navigation
    
 
    
 
    
 
-
    
-
    
-num_cells(self, res_1, res_2=None, subcells=False)¶
    
-
    Return the number of cells of resolutions res_1 to res_2 
+
    
+
    
+num_cells(res_1, res_2=None, subcells=False)¶
    
+
    Return the number of cells of resolutions res_1 to res_2
 (inclusive).
 Assume res_1 <= res_2.
 If subcells = True, then return the number of subcells at resolutions
@@ -1210,193 +1311,190 @@ 
    Navigation
    
 If res_2=None and subcells = True, then return the number of
 subcells from resolution res_1 to resolution self.max_resolution.
    
 
    EXAMPLES:
    
-
    >>> rdggs = RHEALPixDGGS()
+
    >>> rdggs = RHEALPixDGGS()
 >>> rdggs.num_cells(0)
 6
 >>> rdggs.num_cells(0, 1)
 60
->>> rdggs.num_cells(0, subcells=True)
+>>> rdggs.num_cells(0, subcells=True)
 231627523606480
->>> rdggs.num_cells(0, 1, subcells=True)
+>>> rdggs.num_cells(0, 1, subcells=True)
 10
->>> rdggs.num_cells(5, 6, subcells=True)
+>>> rdggs.num_cells(5, 6, subcells=True)
 10
 
    
 
    
 
    
 
-
    
-
    
-plot_cells(self, cells, surface='plane', label=True, fontsize=15, saturation=0.5)¶
    
-
    Plot the given list of cells on the given surface. 
-The cells should all come from the same rHEALPix DGGS.
-Inessential graphics method.  
-Requires Sage graphics methods.
    
-
    INPUT:
    
-
      
-
    • cells - A list of cells from a common rHEALPix DGGS.
      • 
-
    • surface - (Optional; default = ‘plane’). 
-One of the strings ‘plane’, ‘plane_lonlat’, ‘cube’, or ‘ellipsoid’.
-Surface to draw cells on.
      • 
-
    • label - (Optional; default = True). If True, then label cells
-with their names. If False, then don’t.
      • 
-
    • saturation - (Optional) Number between 0 and 1 indicating the
-saturation value of the cell color.
      • 
-
    
-
    
-
-
    
-
    
-random_cell(self, resolution=None)¶
    
-
    Return a cell of the given resolution chosen uniformly at random 
+
    
+
    
+random_cell(resolution=None)¶
    
+
    Return a cell of the given resolution chosen uniformly at random
 from all cells at that resolution.
-If resolution=None, then the cell resolution is first chosen 
+If resolution=None, then the cell resolution is first chosen
 uniformly at random from [0,..,self.max_resolution].
    
 
    EXAMPLES:
    
-
    >>> print(RHEALPixDGGS().random_cell()) 
+
    >>> print(RHEALPixDGGS().random_cell()) 
 S480586367780080
 
    
 
    
 
    
 
-
    
-
    
-random_point(self, plane=True)¶
    
+
    
+
    
+random_point(plane=True)¶
    
 
    Return a point in this DGGS sampled uniformly at
 random from the plane or from the ellipsoid.
    
 
    EXAMPLES:
    
-
    >>> rdggs = RHEALPixDGGS()
->>> print(E.random_point()) 
+
    >>> rdggs = RHEALPixDGGS()
+>>> print(E.random_point()) 
 (-1.0999574573422948, 0.21029104897701129)
 
    
 
    
 
    
 
-
    
-
    
-rhealpix(self, u, v, inverse=False)¶
    
-
    Return the rHEALPix projection of the point (u, v) (or its inverse if 
+
    
+
    
+rhealpix(u, v, inverse=False, region='none')¶
    
+
    Return the rHEALPix projection of the point (u, v) (or its inverse if
 inverse = True) appropriate to this rHEALPix DGGS.
    
 
    EXAMPLES:
    
-
    >>> rdggs = UNIT_003_RADIANS
->>> print(my_round(rdggs.rhealpix(0, pi/3), 14))
-(-1.8582720066839999, 2.0687188103032401)
+
    >>> rdggs = UNIT_003_RADIANS
+>>> print(my_round(rdggs.rhealpix(0, pi/3), 14))
+(-1.858272006684, 2.06871881030324)
 
    
 
    
+
    
+
    NOTES:: Issue #1 was ..
    (-1.8582720066839999, 2.0687188103032401)
    
+
    
+
    
 
    NOTE:
    
-
    Uses pj_rhealpix instead of the PROJ.4 version of rHEALPix.
    
+
    Uses pj_rhealpix instead of the PROJ.4 version of rHEALPix.
    
 
    
 
-
    
-
    
-triangle(self, x, y, inverse=True)¶
    
-
    If inverse = False, then assume (x,y) lies in the image of the 
-HEALPix projection that comes with this DGGS, and 
-return the number of the HEALPix polar triangle (0, 1, 2, 3, or None)   
-and the region (‘north_polar’, ‘south_polar’, or ‘equatorial’) that 
-(x, y) lies in. 
+
    
+
    
+triangle(x, y, inverse=True)¶
    
+
    If inverse = False, then assume (x,y) lies in the image of the
+HEALPix projection that comes with this DGGS, and
+return the number of the HEALPix polar triangle (0, 1, 2, 3, or None)
+and the region (‘north_polar’, ‘south_polar’, or ‘equatorial’) that
+(x, y) lies in.
 If inverse = True, then assume (x, y) lies in the image of
 the rHEALPix projection that comes with this DGGS, map (x, y)
-to its HEALPix image (x’, y’), and return the number of the HEALPix 
-polar triangle and the region that (x’, y’) lies in. 
-If (x, y) lies in the equatorial region, then the triangle number 
+to its HEALPix image (x’, y’), and return the number of the HEALPix
+polar triangle and the region that (x’, y’) lies in.
+If (x, y) lies in the equatorial region, then the triangle number
 returned is None.
    
 
    OUTPUT:
    
 
    The pair (triangle_number, region).
    
 
    NOTES:
    
 
    This is a wrapper for pjr.triangle().
    
 
    EXAMPLES:
    
-
    >>> rdggs = RHEALPixDGGS()
->>> c = rdggs.cell(['N', 7])
->>> print(rdggs.triangle(*c.nucleus(), inverse=True))
+
    >>> rdggs = RHEALPixDGGS()
+>>> c = rdggs.cell(['N', 7])
+>>> print(rdggs.triangle(*c.nucleus(), inverse=True))
 (0, 'north_polar')
 
->>> c = rdggs.cell(['N', 3])
->>> print(rdggs.triangle(*c.nucleus(), inverse=True))
+>>> c = rdggs.cell(['N', 3])
+>>> print(rdggs.triangle(*c.nucleus(), inverse=True))
 (3, 'north_polar')
 
->>> c = rdggs.cell(['P', 3])
->>> print(rdggs.triangle(*c.nucleus(), inverse=True))
+>>> c = rdggs.cell(['P', 3])
+>>> print(rdggs.triangle(*c.nucleus(), inverse=True))
 (None, 'equatorial')
 
->>> c = rdggs.cell(['S', 5, 2])
->>> print(rdggs.triangle(*c.nucleus(), inverse=True))
+>>> c = rdggs.cell(['S', 5, 2])
+>>> print(rdggs.triangle(*c.nucleus(), inverse=True))
 (1, 'south_polar')
 
    
 
    
 
    
 
-
    
-
    
-xyz(self, u, v, lonlat=False)¶
    
-
    Given a point (u, v) in the planar image of the rHEALPix projection, 
-project it back to the ellipsoid and return its 3D rectangular 
+
    
+
    
+xyz(u, v, lonlat=False)¶
    
+
    Given a point (u, v) in the planar image of the rHEALPix projection,
+project it back to the ellipsoid and return its 3D rectangular
 coordinates.
 If lonlat = True, then assume (u, v) is a longitude-latitude
 point.
    
 
    EXAMPLES:
    
-
    >>> rdggs = UNIT_003_RADIANS
->>> print(my_round(rdggs.xyz(0, pi/4, lonlat=True), 14))
-(0.70710678118655002, 0.0, 0.70710678118655002)
+
    >>> rdggs = UNIT_003_RADIANS
+>>> print(my_round(rdggs.xyz(0, pi/4, lonlat=True), 14))
+(0.70710678118655, 0.0, 0.70710678118655)
 
    
 
    
+
    
+
    NOTES:: Issue #1 was ..
    (0.70710678118655002, 0.0, 0.70710678118655002)
    
+
    
+
    
 
    
 
-
    
-
    
-xyz_cube(self, u, v, lonlat=False)¶
    
-
    Given a point (u, v) in the planar version of this rHEALPix DGGS, 
-fold the rHEALPix image into a cube centered at the origin, 
-and return the resulting point’s 3D rectangular coordinates.  
+
    
+
    
+xyz_cube(u, v, lonlat=False)¶
    
+
    Given a point (u, v) in the planar version of this rHEALPix DGGS,
+fold the rHEALPix image into a cube centered at the origin,
+and return the resulting point’s 3D rectangular coordinates.
 If lonlat = True, then assume (u, v) is a longitude-latitude
 point.
    
 
    EXAMPLES:
    
-
    >>> rdggs = UNIT_003
->>> print(my_round(rdggs.xyz_cube(0, 0), 14))
-(0.78539816339745006, 0.0, -0.78539816339745006)
+
    >>> rdggs = UNIT_003
+>>> print(my_round(rdggs.xyz_cube(0, 0), 14))
+(0.78539816339745, 0.0, -0.78539816339745)
 
    
 
    
+
    
+
    NOTES:: Issue #1 was ..
    (0.78539816339745006, 0.0, -0.78539816339745006)
    
+
    
+
    
 
    
 
 
    
 
-
    
+
    
+
    
+class rhealpixdggs.dggs.RhealPolygon(rdggs=<rhealpixdggs.dggs.RHEALPixDGGS object>, suid_list=None)¶
    
+
    Bases: object
    
+
    
 
+
    + +
    -
    + -
    + -
    - © Copyright 2013, Alexander Raichev. - Created using Sphinx 1.1.3. + \ No newline at end of file diff --git a/docs/build/html/distortion.html b/docs/build/html/distortion.html deleted file mode 100644 index 1d0765b..0000000 --- a/docs/build/html/distortion.html +++ /dev/null @@ -1,232 +0,0 @@ - - - - - - - - - - The distortion Module — rHEALPixDGGS 0.5.1 documentation - - - - - - - - - - - - - -
    -

    Navigation

    - -
    - -
    -
    -
    -
    - -
    -

    The distortion Module¶

    -

    This Python 3.3 module computes linear and areal distortion statistics of -map projections. -It is used for analysis only and so is not essential to manipulating -the rHEALPix discrete global grid system.

    -

    CHANGELOG:

    -
      -
    • Alexander Raichev (AR), 2012-10-01: Initial version.
      • -
    • AR, 2013-01-21: Wasn’t working in degrees mode. Fixed that bug.
      • -
    • AR, 2013-07-23: Ported to Python 3.3.
      • -
    -
    -
    -rhealpix_dggs.distortion.distortion(T, lam, phi)¶
    -

    Return ((x, y), mad, ld, ad) -Here (x, y) = T(lam, phi), the image under the map projection T -(an projection_tools.Proj or projection_tools.Proj4 instance) -of the longitude-latitude point (lam, phi); -mad = maximum angular distortion at (x, y) = 2*arcsin((A - B)/(A + B)) -ld = linear distortion at (x, y) = A/B; -ad = areal distortion at (x, y) = AB; -A and B are the major and minor radii, respectively, of the Tissot ellipse -at (x, y).

    -

    EXAMPLES:

    -
    >>> from rhealpix_dggs.projection_wrapper import Proj
->>> from rhealpix_dggs.ellipsoids import WGS84_ELLIPSOID_RADIANS
->>> f = Proj(ellipsoid=WGS84_ELLIPSOID_RADIANS, proj='healpix')
->>> print(my_round(distortion(f, 0, pi/6), 15))
-((0.0, 3748655.1150495014), 0.121755482930707, 1.1295629172526771, 1.1780969100283301)
-
    -
    -
    - -
    -
    -rhealpix_dggs.distortion.distortion_stats(T, sample, my_round_numbers=3)¶
    -

    Return the sample minimum, sample maximum, sample median, sample mean, -and sample standard deviation of the maximum angular distortion, linear -distortion, and area distortion functions -for the map projection T -(an projection_tools.Proj or projection_tools.Proj4 instance) -of the list sample of longitude-latitude -points chosen from the surface T.ellipsoid. -Most likely you will want sample to comprise points sampled uniformly -at random from the surface of T.ellipsoid (and not simply sampled -uniformly at random from the rectangle (-pi, pi) x (-pi/2, pi/2)).

    -

    OUTPUT:

    -

    (distortions, stats), where -distortions is a list of distortion() outputs for each longitude- -latitude point sampled; -stats is the list of lists [maximum angular distortion stats, -linear distortion stats, area distortion stats], where each stats sublist -is of the form [sample mean, sample standard deviation, sample minimum, -sample maximum, sample median].

    -

    EXAMPLES:

    -
    >>> from rhealpix_dggs.projection_wrapper import Proj
->>> from rhealpix_dggs.ellipsoids import WGS84_ELLIPSOID_RADIANS
->>> E = WGS84_ELLIPSOID_RADIANS
->>> f = Proj(ellipsoid=E, proj='healpix')
->>> sample = [E.random_point() for i in range(100)]
->>> print(distortion_stats(f, sample)[1])  
-[[0.309, 0.238, 0.001, 0.838, 0.178], [1.41, 0.375, 1.001, 2.372, 1.195], [1.178, 0.0, 1.178, 1.178, 1.178]]
-
    -
    -
    - -
    -
    -rhealpix_dggs.distortion.fff_coeffs(T, lam, phi)¶
    -

    Return numerical approximations of the first fundamental form coefficients -E, F, and G (in that order) of map projection T -(an projection_tools.Proj or projection_tools.Proj4 instance) at longitude lam and -latitude phi.

    -

    EXAMPLES:

    -
    >>> from rhealpix_dggs.projection_wrapper import Proj
->>> from rhealpix_dggs.ellipsoids import WGS84_ELLIPSOID_RADIANS
->>> f = Proj(ellipsoid=WGS84_ELLIPSOID_RADIANS, proj='healpix')
->>> print(my_round(fff_coeffs(f, 0, pi/6), 15))
-(40635288880650.484, 0.0, 42251277118793.328)
-
    -
    -
    - -
    -
    -rhealpix_dggs.distortion.scale_factors(T, lam, phi)¶
    -

    Return numerical approximations of the local scale factors s_M, s_P, and -s_A of the map projection T -(an projection_tools.Proj or projection_tools.Proj4 instance) -at longitude lam and latitude phi, where -s_M is the local linear scale along meridians, -s_P is the local linear scale along parallels, and -s_A is the local area scale. -Also return theta (in radians), the angle between the vectors (delxdellam, delydellam) -and (delxdelphi, delydelphi).

    -

    OUTPUT:

    -

    (s_M, s_P, s_A, theta)

    -

    EXAMPLES:

    -
    >>> from rhealpix_dggs.projection_wrapper import Proj
->>> from rhealpix_dggs.ellipsoids import WGS84_ELLIPSOID_RADIANS
->>> f = Proj(ellipsoid=WGS84_ELLIPSOID_RADIANS, proj='healpix')
->>> print(my_round(scale_factors(f, 0, pi/6), 15))
-(1.0212575853790069, 1.1535746974071359, 1.1780969100283301, 1.5707963267948959)
-
    -
    -
    - -
    -
    -rhealpix_dggs.distortion.utm_zone(lam, phi)¶
    -

    Return the Universal Transverse Mercator zone and hemisphere for longitude -lam and latitude phi given in radians. -Based on the WGS84 ellipsoid. -Return None if phi is out of bounds, that is, if phi is greater than -84 degrees or less than 80 degrees.

    -

    EXAMPLES:

    -
    >>> print(utm_zone(0, 84*pi/180))
-31
->>> print(utm_zone(0, 85*pi/180)) 
-None
-
    -
    -
    - -
    - - -
    -
    -
    -
    -
    -

    Previous topic

    -

    The dggs Module

    -

    This Page

    - - - -
    -
    -
    -
    -
    -

    Navigation

    - -
    -
    - © Copyright 2013, Alexander Raichev. - Created using Sphinx 1.1.3. -
    - - \ No newline at end of file diff --git a/docs/build/html/ellipsoids.html b/docs/build/html/ellipsoids.html index 4ef908c..09c92d2 100644 --- a/docs/build/html/ellipsoids.html +++ b/docs/build/html/ellipsoids.html @@ -1,37 +1,27 @@ + - - - - + - - - The ellipsoids Module — rHEALPixDGGS 0.5.1 documentation + + + + The ellipsoids Module — rHEALPixDGGS 0.5.4 documentation + + - - + + + + + - - - - - - + + - - -
    + +
    -
    +
    -
    -

    The ellipsoids Module¶

    -

    This Python 3.3 code implements ellipsoids of revolution.

    -

    CHANGELOG:

    +
    +

    The ellipsoids Module¶

    +

    This Python 3.11 code implements ellipsoids of revolution.

      -
    • Alexander Raichev (AR), 2012-01-26: Refactored code from release 0.3.
      • -
    • AR, 2013-07-23: Ported to Python 3.3.
      • +

    • Alexander Raichev (AR), 2012-01-26: Refactored code from release 0.3.

    NOTE:

    -

    All lengths are measured in meters and all angles are measured in radians +

    All lengths are measured in meters and all angles are measured in radians unless indicated otherwise.

    -

    By ‘ellipsoid’ throughout, i mean an ellipsoid of revolution and not a general (triaxial) ellipsoid. +

    By ‘ellipsoid’ throughout, I mean an ellipsoid of revolution and not a general (triaxial) ellipsoid. Points lying on an ellipsoid are given in geodetic (longitude, latitude) coordinates.

    -
    -
    -class rhealpix_dggs.ellipsoids.Ellipsoid(R=None, a=6378137.0, b=None, e=None, f=0.003352810681182319, lon_0=0, lat_0=0, radians=False)¶
    -

    Bases: builtins.object

    -

    Represents an ellipsoid of revolution (possibly a sphere) with a +

    +
    +class rhealpixdggs.ellipsoids.Ellipsoid(R=None, a=6378137.0, b=None, e=None, f=0.003352810681182319, lon_0=0, lat_0=0, radians=False)¶
    +

    Bases: object

    +

    Represents an ellipsoid of revolution (possibly a sphere) with a geodetic longitude-latitude coordinate frame.

    INSTANCE ATTRIBUTES:

      -
    • sphere - True if the ellipsoid is a sphere, and False otherwise.
      • -
    • R - The radius of the ellipsoid in meters, implying that it is a -sphere.
      • -
    • a - Major radius of the ellipsoid in meters.
      • -
    • b - Minor radius of the ellipsoid in meters.
      • -
    • e - Eccentricity of the ellipsoid.
      • -
    • f - Flattening of the ellipsoid.
      • -
    • R_A - Authalic radius of the ellipsoid in meters.
      • -
    • lon_0 - Central meridian.
      • -
    • lat_0 - Latitude of origin.
      • -
    • radians - If True, use angles measured in radians for all calculations. -Use degrees otherwise.
      • -
    • phi_0 - The latitude separating the equatorial region and -the north polar region in the context of the (r)HEALPix projection.
      • +

    • sphere - True if the ellipsoid is a sphere, and False otherwise.

      • +

    • R - The radius of the ellipsoid in meters, implying that it is a +sphere.

      • +

    • a - Major radius of the ellipsoid in meters.

      • +

    • b - Minor radius of the ellipsoid in meters.

      • +

    • e - Eccentricity of the ellipsoid.

      • +

    • f - Flattening of the ellipsoid.

      • +

    • R_A - Authalic radius of the ellipsoid in meters.

      • +

    • lon_0 - Central meridian.

      • +

    • lat_0 - Latitude of origin.

      • +

    • radians - If True, use angles measured in radians for all calculations. +Use degrees otherwise.

      • +

    • phi_0 - The latitude separating the equatorial region and +the north polar region in the context of the (r)HEALPix projection.

    -

    Except for phi_0, these attribute names match the names of the +

    Except for phi_0, these attribute names match the names of the PROJ.4 ellipsoid parameters.

    -
    -
    -get_points(self, filename)¶
    +
    +
    +get_points(filename)¶

    Return a list of longitude-latitude points contained in the file with filename filename. -Assume the file is a text file containing at most one -longitude-latitude point per line with the coordinates separated by +Assume the file is a text file containing at most one +longitude-latitude point per line with the coordinates separated by whitespace and angles given in degrees.

    -
    -
    -graticule(self, n=400, spacing=None)¶
    -

    Return a list of longitude-latitude points sampled from a -longitude-latitude graticule on this ellipsoid with the given +

    +
    +graticule(n=400, spacing=None)¶
    +

    Return a list of longitude-latitude points sampled from a +longitude-latitude graticule on this ellipsoid with the given spacing between meridians and between parallels. The number of points on longitude and latitude per pi radians is n. The spacing should be specified in the angle units used for this ellipsoid. If spacing=None, then a default spacing of pi/16 radians will be set.

    EXAMPLES:

    -
    >>> E = UNIT_SPHERE
->>> print(len(E.graticule(n=400)))
+
    >>> E = UNIT_SPHERE
+>>> print(len(E.graticule(n=400)))
 25600
    -
    -
    -lattice(self, n=90)¶
    +
    +
    +lattice(n=90)¶

    Return a 2n x n square lattice of longitude-latitude points.

    EXAMPLES:

    -
    >>> E = UNIT_SPHERE
+
    >>> E = UNIT_SPHERE
 >>> for p in E.lattice(n=3):
-...     print(p)
+...     print(p)
 (-150.0, -60.0)
 (-150.0, 0.0)
 (-150.0, 60.0)
@@ -151,95 +140,103 @@ 
    Navigation
    -
    -
    -meridian(self, lam, n=200)¶
    -

    Return a list of n equispaced longitude-latitude +

    +
    +meridian(lam, n=200)¶
    +

    Return a list of n equispaced longitude-latitude points lying along the meridian of longitude lam. Avoid the poles.

    -
    -
    -parallel(self, phi, n=200)¶
    -

    Return a list of 2*n equispaced longitude-latitude +

    +
    +parallel(phi, n=200)¶
    +

    Return a list of 2*n equispaced longitude-latitude points lying along the parallel of latitude phi.

    -
    -
    -pi(self)¶
    +
    +
    +pi()¶

    Return pi if self.radians = True and 180 otherwise.

    -
    -
    -random_point(self, lam_min=None, lam_max=None, phi_min=None, phi_max=None)¶
    +
    +
    +random_point(lam_min=None, lam_max=None, phi_min=None, phi_max=None)¶

    Return a point (given in geodetic coordinates) sampled uniformly at random from the section of this ellipsoid with longitude in the range -lam_min <= lam < lam_max and latitude in the range -phi_min <= phi < phi_max. +lam_min <= lam < lam_max and latitude in the range +phi_min <= phi < phi_max. But avoid the poles.

    EXAMPLES:

    -
    >>> E = UNIT_SPHERE
->>> print(E.random_point()) 
+
    >>> E = UNIT_SPHERE
+>>> print(E.random_point()) 
 (-1.0999574573422948, 0.21029104897701129)
    -
    -
    -xyz(self, lam, phi)¶
    -

    Given a point on this ellipsoid with longitude-latitude coordinates -(lam, phi), return the point’s 3D rectangular coordinates.

    +
    +
    +xyz(lam, phi)¶
    +

    Given a point on this ellipsoid with longitude-latitude coordinates +(lam, phi), return the point’s 3D rectangular coordinates.

    EXAMPLES:

    -
    >>> E = UNIT_SPHERE
->>> print(my_round(E.xyz(0, 45), 15))
-(0.70710678118654802, 0.0, 0.70710678118654802)
+
    >>> E = UNIT_SPHERE
+>>> print(my_round(E.xyz(0, 45), 15))
+(0.707106781186548, 0.0, 0.707106781186548)
 
    
 
    
+
    
+
    NOTES:: .. Issue #1 was ..
    (0.70710678118654802, 0.0, 0.70710678118654802)
    
+
    
+
    -
    + +
    -
    + -
    + -
    - © Copyright 2013, Alexander Raichev. - Created using Sphinx 1.1.3. + \ No newline at end of file diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index 278841d..8ddf608 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -1,37 +1,24 @@ + - - - - - - + - + + + Index — rHEALPixDGGS 0.5.4 documentation + + - Index — rHEALPixDGGS 0.5.1 documentation + + + + + - - - - - - - - - - - -
    + + + +
    -
    +

    Index

    A + | B | C - | D | E - | F + | G | H | I + | L | M + | N + | O | P | R | S | T | U + | V | W + | X

    A

    - - + +
    - -
    auth_lat() (in module rhealpix_dggs.utils) -
    - -
    - -
    auth_rad() (in module rhealpix_dggs.utils) -
    - -
    -

    C

    +

    B

    - - +
    - -
    Cell (class in rhealpix_dggs.dggs) -
    - - -
    Cell.area() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.boundary() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.centroid() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.color() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.contains() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.ellipsoidal_shape() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.index() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.interior() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.intersects_meridian() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.intersects_parallel() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.neighbor() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.neighbors() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.nucleus() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.nw_vertex() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.predecessor() (in module rhealpix_dggs.dggs) -
    - -
    - -
    Cell.random_point() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.region() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.rotate() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.rotate_entry() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.subcell() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.subcells() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.successor() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.suid_from_index() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.suid_rowcol() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.ul_vertex() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.vertices() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.width() (in module rhealpix_dggs.dggs) -
    - - -
    Cell.xy_range() (in module rhealpix_dggs.dggs) -
    - - -
    cells0 (rhealpix_dggs.dggs.RHEALPixDGGS attribute) -
    - - -
    combine_triangles() (in module rhealpix_dggs.pj_rhealpix) -
    - -
    -

    D

    +

    C

    - - + +
    - -
    distortion() (in module rhealpix_dggs.distortion) -
    - -
    - -
    distortion_stats() (in module rhealpix_dggs.distortion) -
    - -

    E

    - - + +
    - -
    Ellipsoid (class in rhealpix_dggs.ellipsoids) -
    - - -
    Ellipsoid.get_points() (in module rhealpix_dggs.ellipsoids) -
    - - -
    Ellipsoid.graticule() (in module rhealpix_dggs.ellipsoids) -
    - - -
    Ellipsoid.lattice() (in module rhealpix_dggs.ellipsoids) -
    - - -
    Ellipsoid.meridian() (in module rhealpix_dggs.ellipsoids) -
    - -
    - -
    Ellipsoid.parallel() (in module rhealpix_dggs.ellipsoids) -
    - - -
    Ellipsoid.pi() (in module rhealpix_dggs.ellipsoids) -
    - - -
    Ellipsoid.random_point() (in module rhealpix_dggs.ellipsoids) -
    - - -
    Ellipsoid.xyz() (in module rhealpix_dggs.ellipsoids) -
    - -
    -

    F

    +

    G

    - + +
    - -
    fff_coeffs() (in module rhealpix_dggs.distortion) -
    - -

    H

    - - + +
    - -
    healpix() (in module rhealpix_dggs.pj_healpix) -
    - - -
    healpix_diagram() (in module rhealpix_dggs.pj_healpix) -
    - - -
    healpix_ellipsoid() (in module rhealpix_dggs.pj_healpix) -
    - - -
    healpix_ellipsoid_inverse() (in module rhealpix_dggs.pj_healpix) -
    - -
    - -
    healpix_sphere() (in module rhealpix_dggs.pj_healpix) -
    - - -
    healpix_sphere_inverse() (in module rhealpix_dggs.pj_healpix) -
    - - -
    healpix_vertices() (in module rhealpix_dggs.pj_healpix) -
    - -

    I

    - - + +
    - -
    in_healpix_image() (in module rhealpix_dggs.pj_healpix) -
    - -
    - -
    in_rhealpix_image() (in module rhealpix_dggs.pj_rhealpix) -
    - -
    -

    M

    +

    L

    - +
    - -
    my_round() (in module rhealpix_dggs.utils) -
    - -
    -

    P

    +

    M

    - + + +
    - -
    Proj (class in rhealpix_dggs.projection_wrapper) -
    +
    -

    R

    +

    N

    - - + +
    - -
    rhealpix() (in module rhealpix_dggs.pj_rhealpix) -
    - - -
    rhealpix_dggs.dggs (module) -
    - - -
    rhealpix_dggs.distortion (module) -
    - - -
    rhealpix_dggs.ellipsoids (module) -
    - - -
    rhealpix_dggs.pj_healpix (module) -
    - - -
    rhealpix_dggs.pj_rhealpix (module) -
    - - -
    rhealpix_dggs.projection_wrapper (module) -
    - - -
    rhealpix_dggs.utils (module) -
    - - -
    rhealpix_diagram() (in module rhealpix_dggs.pj_rhealpix) -
    - - -
    rhealpix_ellipsoid() (in module rhealpix_dggs.pj_rhealpix) -
    - - -
    rhealpix_ellipsoid_inverse() (in module rhealpix_dggs.pj_rhealpix) -
    - - -
    rhealpix_sphere() (in module rhealpix_dggs.pj_rhealpix) -
    - - -
    rhealpix_sphere_inverse() (in module rhealpix_dggs.pj_rhealpix) -
    - - -
    rhealpix_vertices() (in module rhealpix_dggs.pj_rhealpix) -
    - - -
    RHEALPixDGGS (class in rhealpix_dggs.dggs) -
    - - -
    RHEALPixDGGS.cell() (in module rhealpix_dggs.dggs) -
    - - -
    RHEALPixDGGS.cell_area() (in module rhealpix_dggs.dggs) -
    - - -
    RHEALPixDGGS.cell_from_point() (in module rhealpix_dggs.dggs) -
    - - -
    RHEALPixDGGS.cell_from_region() (in module rhealpix_dggs.dggs) -
    - -
    - -
    RHEALPixDGGS.cell_latitudes() (in module rhealpix_dggs.dggs) -
    - - -
    RHEALPixDGGS.cell_width() (in module rhealpix_dggs.dggs) -
    - - -
    RHEALPixDGGS.cells_from_meridian() (in module rhealpix_dggs.dggs) -
    - - -
    RHEALPixDGGS.cells_from_parallel() (in module rhealpix_dggs.dggs) -
    - - -
    RHEALPixDGGS.cells_from_region() (in module rhealpix_dggs.dggs) -
    - - -
    RHEALPixDGGS.combine_triangles() (in module rhealpix_dggs.dggs) -
    - - -
    RHEALPixDGGS.grid() (in module rhealpix_dggs.dggs) -
    - - -
    RHEALPixDGGS.healpix() (in module rhealpix_dggs.dggs) -
    +
    - -
    RHEALPixDGGS.interval() (in module rhealpix_dggs.dggs) -
    +

    O

    + + +
    - -
    RHEALPixDGGS.minimal_cover() (in module rhealpix_dggs.dggs) -
    +

    P

    + + + +
    - -
    RHEALPixDGGS.num_cells() (in module rhealpix_dggs.dggs) -
    +

    R

    + + + + +
  • RhealPolygon (class in rhealpixdggs.dggs) +
    • +
  • rotate() (rhealpixdggs.dggs.Cell method) +
    • +
  • rotate_entry() (rhealpixdggs.dggs.Cell method) +
    • +

    S

    - + +
    - -
    scale_factors() (in module rhealpix_dggs.distortion) -
    - -

    T

    - + +
    - -
    triangle() (in module rhealpix_dggs.pj_rhealpix) -
    +

    U

    - +
    - -
    utm_zone() (in module rhealpix_dggs.distortion) -
    +
    - +

    V

    + +

    W

    - - + + +
    - -
    wrap_latitude() (in module rhealpix_dggs.utils) -
    - -
    - -
    wrap_longitude() (in module rhealpix_dggs.utils) -
    - -
    + +

    X

    + + +
    +
    -
    + -
    + -
    - © Copyright 2013, Alexander Raichev. - Created using Sphinx 1.1.3. + \ No newline at end of file diff --git a/docs/build/html/index.html b/docs/build/html/index.html index 2da196e..5f28714 100644 --- a/docs/build/html/index.html +++ b/docs/build/html/index.html @@ -1,36 +1,26 @@ + - - - - + - - - Welcome the rHEALPixDGGS documentation! — rHEALPixDGGS 0.5.1 documentation + + + + Welcome the rHEALPixDGGS documentation! — rHEALPixDGGS 0.5.4 documentation + + - - + + + + + - - - - - - + + - - -
    + +
    -
    +
    -
    -

    Welcome the rHEALPixDGGS documentation!¶

    +
    +

    Welcome the rHEALPixDGGS documentation!¶

    -
    -
    -

    Indices and tables¶

    + +
    +

    Indices and tables¶

    -
    + +
    -
    + -
    + -
    - © Copyright 2013, Alexander Raichev. - Created using Sphinx 1.1.3. + \ No newline at end of file diff --git a/docs/build/html/introduction.html b/docs/build/html/introduction.html index aef3aa9..654d021 100644 --- a/docs/build/html/introduction.html +++ b/docs/build/html/introduction.html @@ -1,37 +1,27 @@ + - - - - + - - - Introduction — rHEALPixDGGS 0.5.1 documentation + + + + Introduction — rHEALPixDGGS 0.5.4 documentation + + - - + + + + + - - - - - - + + - - -
    + +
    -
    +
    -
    -

    Introduction¶

    -

    rHEALPixDGGS is a Python 3.3 package that implements the rHEALPix discrete global grid system (DGGS). -This documentation assumes you are familiar with the rHEALPix DGGS as described in [GRS2013] and familiar with basic Python 3.3 usage as described in The Python Tutorial.

    - - - - - -
    [GRS2013](1, 2) Robert Gibb, Alexander Raichev, Michael Speth, The rHEALPix discrete global grid system, in preparation, 2013.
    -
    -

    Requirements¶

    -
      -
    • Python >=3.3
      • -
    • NumPy >=1.7 Base N-dimensional array package
      • -
    • SciPy >=0.12 Fundamental library for scientific computing
      • -
    • Matplotlib >=1.2.1 Comprehensive 2D Plotting
      • -
    • Pyproj >=1.9.3 -Python interface to the PROJ.4 cartographic library
      • -
    • Sage >=5.10 -(Optional) Comprehensive mathematics package. -Needed only for a few optional graphics methods. -To use the optional graphics methods, start a Sage notebook session and import/attach the Python module that contains the methods. -For examples, see the Sage worksheet rhealpix_dggs/tests/test_dggs.sws.
      • -
    +
    +

    Introduction¶

    +

    rHEALPixDGGS is a Python 3 package that implements the rHEALPix discrete global grid system (DGGS). +This documentation assumes you are familiar with the rHEALPix DGGS as described in [GRS2013] and familiar with basic Python 3.3 usage as described in The Python Tutorial.

    +
    +
    +[GRS2013] +

    Robert Gibb, Alexander Raichev, Michael Speth, The rHEALPix discrete global grid system, in preparation, 2013.

    -
    -

    Installation¶

    -

    rHEALPixDGGS is available for download at Landcare Research’s git repository http://code.scenzgrid.org/index.php/p/scenzgrid-py/source/tree/master/rHEALPixDGGS-0.5 and can be cloned via the command git clone git@code.scenzgrid.org:scenzgrid-py.git.

    -

    To install Sage, download and install the appropriate binary file from sagemath.org. -Then install Pyproj within Sage by downloading the Pyproj source, changing to the Pyproj directory, starting a Sage shell via sage -sh, then typing python setup.py build, then python setup.py install. -If that doesn’t work, try again but first start in superuser mode via sudo su.

    -
    -

    Usage¶

    +
    +

    Requirements¶

    + +
    +
    +

    Installation¶

    +

    The package is available on PyPI, the Package Index from where it can be installed as follows:

    +

    pip install rhealpixdggs

    +

    rHEALPixDGGS is also available for download from Landcare Research’s github repository https://github.com/manaakiwhenua/rhealpixdggs-py from wher the latest version can be cloned.

    +
    +
    +

    Usage¶

    To use rHEALPixDGGS after installing it, start a Python session in the directory where you downloaded the modules and import the modules. Here are some examples. For a list of all methods available, see the application programming interface (API) in the following chapters.

    -
    -

    Using the ellipsoids and projection_wrapper Modules¶

    -

    The ellipsoids module implements functions and constants dealing with ellipsoids of revolution (which include spheres but not general triaxial ellipsoids). -For brevity hereafter, the word ‘ellipsoid’ abbreviates ‘ellipsoid of revolution’.

    -

    The module projection_wrapper implements a wrapper for the map projections of ellipsoids defined in pj_healpix, pj_rhealpix, and Pyproj.

    -

    Currently projection_wrapper uses the HEALPix and rHEALPix projections -defined in pj_healpix and pj_rhealpix and not the buggy versions defined in Pyproj 1.9.3 as PJ_healpix.c. -Alternatively, you can download a corrected version of PJ_healpix.c from -trac.osgeo.org/proj/changeset/2378, rebuild Pyproj with it, and use it in dggs by editing the HOMEMADE_PROJECTIONS line in projection_wrapper.

    +
    +

    Using the ellipsoids and projection_wrapper Modules¶

    +

    The ellipsoids module implements functions and constants dealing with ellipsoids of revolution (which include spheres but not general triaxial ellipsoids). +For brevity hereafter, the word ‘ellipsoid’ abbreviates ‘ellipsoid of revolution’.

    +

    The module projection_wrapper implements a wrapper for the map projections of ellipsoids defined in pj_healpix, pj_rhealpix, and Pyproj.

    +

    Currently projection_wrapper uses the HEALPix and rHEALPix projections +defined in pj_healpix and pj_rhealpix and not the buggy versions defined in Pyproj 1.9.3 as PJ_healpix.c. +Alternatively, you can download a corrected version of PJ_healpix.c from +trac.osgeo.org/proj/changeset/2378, rebuild Pyproj with it, and use it in dggs by editing the HOMEMADE_PROJECTIONS line in projection_wrapper.

    Import all the classes, methods, and constants from the module:

    -
    >>> from rhealpix_dggs.projection_wrapper import *
+
    >>> from rhealpixdggs.projection_wrapper import *
+>>> from rhealpixdggs.ellipsoids import *
 
    
 
    
 
    Create an ellipsoid, say, one with major radius 5 and eccentricity 0.8:
    
-
    >>> from rhealpix_dggs.ellipsoids import *
->>> ellps_1 = Ellipsoid(a=5, e=0.8)
->>> print(ellps_1)
+
    >>> ellps_1 = Ellipsoid(a=5, e=0.8)
+>>> print(ellps_1)
 ellipsoid:
-    R_A = 4.32200117119
+    R_A = 4.322001171188888
     a = 5
-    b = 3.0
+    b = 2.999999999999999
     e = 0.8
     f = 0.4
     lat_0 = 0
@@ -123,15 +108,15 @@ 
    Using the ellipsoids
    
 
    
 
    The names of the ellipsoid attributes agree with the names of the PROJ.4 ellipsoid parameters.
-For example, R_A is the authalic radius of the ellipsoid, the radius of the sphere that has the same area as the ellipsoid.
    
+For example, R_A is the authalic radius of the ellipsoid, the radius of the sphere that has the same area as the ellipsoid.
    
 
    By default, angles are measured in degrees.
 If you prefer radians, then do:
    
-
    >>> ellps_2 = Ellipsoid(a=5, e=0.8, radians=True)
->>> print(ellps_2)
+
    >>> ellps_2 = Ellipsoid(a=5, e=0.8, radians=True)
+>>> print(ellps_2)
 ellipsoid:
-    R_A = 4.32200117119
+    R_A = 4.322001171188888
     a = 5
-    b = 3.0
+    b = 2.999999999999999
     e = 0.8
     f = 0.4
     lat_0 = 0
@@ -141,7 +126,7 @@ 
    Using the ellipsoids
    
 
    
 
    Some common ellipsoids are predefined as constants.
    
-
    >>> print(UNIT_SPHERE)
+
    >>> print(UNIT_SPHERE)
 ellipsoid:
     R = 1
     R_A = 1
@@ -153,23 +138,23 @@ 
    Using the ellipsoids    lon_0 = 0
     radians = False
     sphere = True
->>> print(WGS84_ELLIPSOID)
+>>> print(WGS84_ELLIPSOID)
 ellipsoid:
-    R_A = 6374581.4671
+    R_A = 6374581.467096525
     a = 6378137.0
     b = 6356752.314140356
-    e = 0.0578063088401
+    e = 0.057806308840112
     f = 0.003352810681182
     lat_0 = 0
     lon_0 = 0
     radians = False
     sphere = False
->>> print(WGS84_ELLIPSOID_RADIANS)
+>>> print(WGS84_ELLIPSOID_RADIANS)
 ellipsoid:
-    R_A = 6374581.4671
+    R_A = 6374581.467096525
     a = 6378137.0
     b = 6356752.314140356
-    e = 0.0578063088401
+    e = 0.057806308840112
     f = 0.003352810681182
     lat_0 = 0
     lon_0 = 0
@@ -177,33 +162,34 @@ 
    Using the ellipsoids    sphere = False
 
    
 
    
-
    Ellipsoid instances are parametrized by geographic longitude and latitude with the central meridian at lon_0 and the parallel of origin at lat_0.
    
+
    Ellipsoid instances are parametrized by geographic longitude and latitude with the central meridian at lon_0 and the parallel of origin at lat_0.
    
 
    Project some points of the ellipsoid using the HEALPix and rHEALPix projections:
    
-
    >>> h = Proj(ellps_1, 'healpix')
->>> rh = Proj(ellps_1, 'rhealpix', north_square=1, south_square=2)
->>> print(h(0, 60))
-(0.0, 3.351278550178026)
->>> print(rh(0, 60))
-(0.0, 3.351278550178026)
->>> print(h(0, 70))
-(0.864006732389895, 4.2584985144432679)
->>> print(rh(0, 70))
-(-0.86400673238989445, 4.2584985144432679)
+
    >>> from numpy.testing import assert_allclose
+>>> h = Projection(ellps_1, 'healpix')
+>>> rh = Projection(ellps_1, 'rhealpix', north_square=1, south_square=2)
+>>> assert_allclose(h(0, 60), (0.0, 3.35127855017803), rtol=1e-14, atol=0) == None
+True
+>>> assert_allclose(rh(0, 60), (0.0, 3.35127855017803), rtol=1e-14, atol=0) == None
+True
+>>> assert_allclose(h(0, 70), (0.864006732389895, 4.258498514443268), rtol=1e-14, atol=0) == None
+True
+>>> assert_allclose(rh(0, 70), (-0.864006732389895, 4.258498514443268), rtol=1e-14, atol=0) == None
+True
 
    
 
    
-
    
-
    
-
    Using the dggs Module¶
    
-
    The module dggs implements the rHEALPix DGGS and various operations thereupon.
    
+
    +
    +

    Using the dggs Module¶

    +

    The module dggs implements the rHEALPix DGGS and various operations thereupon.

    Import all the classes, methods, and constants from the module

    -
    >>> from rhealpix_dggs.dggs import *
+
    >>> from rhealpixdggs.dggs import *
 
    
 
    
 
    Create the (0, 0)-rHEALPix DGGS with N_side=3 that is based upon the WGS84 ellipsoid:
    
-
    >>> from rhealpix_dggs.ellipsoids import WGS84_ELLIPSOID
+
    >>> from rhealpixdggs.ellipsoids import WGS84_ELLIPSOID
 >>> E = WGS84_ELLIPSOID
 >>> rdggs = RHEALPixDGGS(ellipsoid=E, north_square=0, south_square=0, N_side=3)
->>> print(rdggs)
+>>> print(rdggs)
 rHEALPix DGGS:
     N_side = 3
     north_square = 0
@@ -211,10 +197,10 @@ 
    Using the dggs Mo
     max_areal_resolution = 1
     max_resolution = 15
     ellipsoid:
-        R_A = 6374581.4671
+        R_A = 6374581.467096525
         a = 6378137.0
         b = 6356752.314140356
-        e = 0.0578063088401
+        e = 0.0578063088401125
         f = 0.003352810681182319
         lat_0 = 0
         lon_0 = 0
@@ -223,7 +209,7 @@ 
    Using the dggs Mo
 
    
 
    
 
    Some common rHEALPix DGGSs are predefined as constants:
    
-
    >>> print(UNIT_003)
+
    >>> print(UNIT_003)
 rHEALPix DGGS:
     N_side = 3
     north_square = 0
@@ -241,7 +227,7 @@ 
    Using the dggs Mo
         lon_0 = 0
         radians = False
         sphere = True
->>> print(WGS84_003)
+>>> print(WGS84_003)
 rHEALPix DGGS:
     N_side = 3
     north_square = 0
@@ -249,16 +235,16 @@ 
    Using the dggs Mo
     max_areal_resolution = 1
     max_resolution = 15
     ellipsoid:
-        R_A = 6374581.4671
+        R_A = 6374581.467096525
         a = 6378137.0
         b = 6356752.314140356
-        e = 0.0578063088401
+        e = 0.0578063088401125
         f = 0.003352810681182319
         lat_0 = 0
         lon_0 = 0
         radians = False
         sphere = False
->>> print(UNIT_003_RADIANS)
+>>> print(UNIT_003_RADIANS)
 rHEALPix DGGS:
     N_side = 3
     north_square = 0
@@ -279,14 +265,14 @@ 
    Using the dggs Mo
 
    
 
    
 
    Pick a (longitude-latitude) point on the ellipsoid and find the level 1 cell that contains it
    
-
    >>> p = (0, 15)
->>> c = rdggs.cell_from_point(1, p, plane=False); print(c)
+
    >>> p = (0, 15)
+>>> c = rdggs.cell_from_point(1, p, plane=False); print(c)
 Q0
 
    
 
    
 
    Find the ellipsoidal (edge) neighbors of this cell
    
-
    >>> for (direction, cell) in sorted(c.neighbors(plane=False).items()):
-...     print(direction, cell)
+
    >>> for (direction, cell) in sorted(c.neighbors(plane=False).items()):
+...     print(direction, cell)
 east Q1
 north N2
 south Q3
@@ -294,8 +280,8 @@ 
    Using the dggs Mo
 
    
 
    
 
    Find the planar (edge) neighbors of this cell
    
-
    >>> for (direction, cell) in sorted(c.neighbors('plane').items()):
-...     print(direction, cell)
+
    >>> for (direction, cell) in sorted(c.neighbors('plane').items()):
+...     print(direction, cell)
 down Q3
 left P2
 right Q1
@@ -303,40 +289,56 @@ 
    Using the dggs Mo
 
    
 
    
 
    Find all the level 1 cells intersecting the longitude-latitude aligned ellipsoidal quadrangle with given northwest and southeast corners
    
-
    >>> nw = (0, 45)
+
    >>> nw = (0, 45)
 >>> se = (90, 0)
->>> cells = rdggs.cells_from_region(1, nw, se, plane=False)
+>>> cells = rdggs.cells_from_region(1, nw, se, plane=False)
 >>> for row in cells:
-...     print([str(cell) for cell in row])
+...     print([str(cell) for cell in row])
 ['N2', 'N1', 'N0']
 ['Q0', 'Q1', 'Q2', 'R0']
 ['Q3', 'Q4', 'Q5', 'R3']
 
    
 
    
 
    Compute the ellipsoidal shape and ellipsoidal nuclei of these cells
    
-
    >>> for row in cells:
-...     for cell in row:
-...         print(cell, cell.ellipsoidal_shape(), cell.nucleus(plane=False))
-N2 dart (5.0888874903416268e-14, 58.470677829627355)
-N1 skew_quad (45.000000000000036, 58.470677829627355)
-N0 dart (89.999999999999957, 58.470677829627363)
-Q0 quad (14.999999999999998, 26.438744923100096)
-Q1 quad (45.0, 26.438744923100096)
-Q2 quad (74.999999999999986, 26.438744923100096)
-R0 quad (105.00000000000001, 26.438744923100096)
-Q3 quad (14.999999999999998, 3.560649871414923e-15)
-Q4 quad (45.0, 3.560649871414923e-15)
-Q5 quad (74.999999999999986, 3.560649871414923e-15)
-R3 quad (105.00000000000001, 3.560649871414923e-15)
+
    >>> expected_results = [
+...    [
+...        (5.088887490341627e-14, 58.47067782962734),
+...        (45.000000000000036, 58.47067782962734),
+...        (89.99999999999996, 58.47067782962736)
+...    ], [
+...        (14.999999999999998, 26.438744923100096),
+...        (45.0, 26.438744923100096),
+...        (74.99999999999999, 26.438744923100096),
+...        (105.00000000000001, 26.438744923100096)
+...    ], [
+...        (14.999999999999998, 3.560649871414923e-15),
+...        (45.0, 3.560649871414923e-15),
+...        (74.99999999999999, 3.560649871414923e-15),
+...        (105.00000000000001, 3.560649871414923e-15)
+...    ]]
+>>> for i, row in enumerate(cells):
+...     for j, cell in enumerate(row):
+...         print(cell, cell.ellipsoidal_shape(), assert_allclose(cell.nucleus(plane=False), expected_results[i][j], rtol=1e-15, atol=0) == None)
+N2 dart True
+N1 skew_quad True
+N0 dart True
+Q0 quad True
+Q1 quad True
+Q2 quad True
+R0 quad True
+Q3 quad True
+Q4 quad True
+Q5 quad True
+R3 quad True
 
    
 
    
 
    Create the (0, 0)-rHEALPix DGGS with N_side = 3 that is based on the WGS84 ellipsoid.
 Orient the DGGS so that the planar origin (0, 0) is on Auckland, New Zealand:
    
-
    >>> p = (174, -37)  # Approximate Auckland lon-lat coordinates
->>> from rhealpix_dggs.projection_wrapper import *
->>> E = Ellipsoid(a=WGS84_A, f=WGS84_F, radians=False, lon_0=p[0], lat_0=p[1])
+
    >>> p = (174, -37)  # Approximate Auckland lon-lat coordinates
+>>> from rhealpixdggs.projection_wrapper import *
+>>> E = Ellipsoid(a=WGS84_A, f=WGS84_F, radians=False, lon_0=p[0], lat_0=p[1])
 >>> rdggs = RHEALPixDGGS(E, N_side=3, north_square=0, south_square=0)
->>> print(rdggs)
+>>> print(rdggs)
 rHEALPix DGGS:
     N_side = 3
     north_square = 0
@@ -344,107 +346,78 @@ 
    Using the dggs Mo
     max_areal_resolution = 1
     max_resolution = 15
     ellipsoid:
-        R_A = 6374581.4671
+        R_A = 6374581.467096525
         a = 6378137.0
         b = 6356752.314140356
-        e = 0.0578063088401
+        e = 0.0578063088401125
         f = 0.003352810681182319
         lat_0 = -37
         lon_0 = 174
         radians = False
         sphere = False
->>> print(rdggs.cell_from_point(1, p, plane=False))
+>>> print(rdggs.cell_from_point(1, p, plane=False))
 Q3
 
    
 
    
-
    
-
    
-
    Using the distortion Module¶
    
-
    The module distortion computes distortions of map projections created via projection_wrapper and was used to produce the tables in [GRS2013].
-The module is not necessary for manipulating the rHEALPix DGGS.
    
-
    Import all the classes, methods, and constants from the module:
    
-
    >>> from rhealpix_dggs.distortion import *
-
    
-
    
-
    Import the WGS84 ellipsoid, define the rHEALPix projection on the ellipsoid, and compute linear distortion and areal distortion for the projection at a given point:
    
-
    >>> from rhealpix_dggs.ellipsoids import WGS84_ELLIPSOID
->>> E = WGS84_ELLIPSOID
->>> from rhealpix_dggs.projection_wrapper import Proj
->>> f = Proj(ellipsoid=E, proj='rhealpix', north_square=0, south_square=0)
->>> p = (0, 30)
->>> print(distortion(f, *p)  # First entry of output is f(*p)) 
-((0.0, 3748655.115049511), 6.976075406932126, 1.1295629192757011, 1.1780969079183845)
-
    
-
    
-
    Sample 100 random points from the WGS84 ellipsoid and compute the sample minimum, sample maximum, sample median, sample mean, and sample standard deviation of the linear and area distortion functions of the rHEALPix projection of those points:
    
-
    >>> sample = [E.random_point() for i in range(100)]
->>> print(distortion_stats(f, sample)[1])  
-[[14.918, 13.82, 0.124, 48.086, 8.623], [1.345, 0.371, 1.002, 2.375, 1.163], [1.178, 0.0, 1.178, 1.178, 1.178]]
-
    
-
    
-
    Do the same for 100 points chosen at random from an rHEALPix DGGS dart cell:
    
-
    >>> from rhealpix_dggs.dggs import *
->>> rdggs = WGS84_003
->>> cell = rdggs.cell(['N', 6])
->>> sample = [cell.random_point(plane=False) for i in range(100)]
->>> print(distortion_stats(f, sample)[1])  
-[[38.907, 6.044, 28.189, 48.963, 38.701], [2.013, 0.226, 1.644, 2.415, 1.991], [1.178, 0.0, 1.178, 1.178, 1.178]]
-
    
-
    
-
    
-
    
-
    
+
    +
    +
    +
    -
    + -
    + -
    - © Copyright 2013, Alexander Raichev. - Created using Sphinx 1.1.3. + \ No newline at end of file diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv index 9e9cb58..02dca4e 100644 Binary files a/docs/build/html/objects.inv and b/docs/build/html/objects.inv differ diff --git a/docs/build/html/pj_healpix.html b/docs/build/html/pj_healpix.html index 01c5d8e..9804139 100644 --- a/docs/build/html/pj_healpix.html +++ b/docs/build/html/pj_healpix.html @@ -1,37 +1,27 @@ + - - - - + - - - The pj_healpix Module — rHEALPixDGGS 0.5.1 documentation + + + + The pj_healpix Module — rHEALPixDGGS 0.5.4 documentation + + - - + + + + + - - - - - - + + - - -
    + +
    -
    +
    -
    -

    The pj_healpix Module¶

    -

    This Python 3.3 module implements the HEALPix map projection as described in [CaRo2007].

    - - - - - -
    [CaRo2007]Mark R. Calabretta and Boudewijn F. Roukema, Mapping on the healpix grid, Monthly Notices of the Royal Astronomical Society 381 (2007), no. 2, 865–872.
    -

    CHANGELOG:

    +
    +

    The pj_healpix Module¶

    +

    This Python 3.11 module implements the HEALPix map projection as described in [CaRo2007].

    +
    +
    +[CaRo2007] +

    Mark R. Calabretta and Boudewijn F. Roukema, Mapping on the healpix grid, Monthly Notices of the Royal Astronomical Society 381 (2007), no. 2, 865–872.

    +
    +
      -
    • Alexander Raichev (AR), 2013-01-26: Refactored code from release 0.3.
      • -
    • AR, 2013-03-05: In in_healpix_image() increased eps to 1e-10 to decrease out-of-bounds errors i was getting when drawing figures.
      • -
    • AR, 2013-07-23: Ported to Python 3.3.
      • +

    • Alexander Raichev (AR), 2013-01-26: Refactored code from release 0.3.

    NOTE:

    -

    All lengths are measured in meters and all angles are measured in radians -unless indicated otherwise. -By ‘ellipsoid’ below, i mean an oblate ellipsoid of revolution.

    -
    -
    -rhealpix_dggs.pj_healpix.healpix(a=1, e=0)¶
    +

    All lengths are measured in meters and all angles are measured in radians +unless indicated otherwise. +By ‘ellipsoid’ below, I mean an oblate ellipsoid of revolution.

    +
    +
    +rhealpixdggs.pj_healpix.healpix(a: float = 1, e: float = 0) → Callable[[float, float, bool, bool], tuple[float, float]]¶

    Return a function object that wraps the HEALPix projection and its inverse of an ellipsoid with major radius a and eccentricity e.

    EXAMPLES:

    -
    >>> f = healpix(a=2, e=0)
->>> print(my_round(f(0, pi/3, radians=True), 15))
-(0.57495135977821499, 2.1457476865731109)
->>> p = (0, 60) 
->>> q = f(*p, radians=False); print(my_round(q, 15))
-(0.57495135977821499, 2.1457476865731109)
->>> print(my_round(f(*q, radians=False, inverse=True), 15))
-(5.9999999999999997e-15, 59.999999999999986)
->>> print(my_round(p, 15))
+
    >>> f = healpix(a=2, e=0)
+>>> print(my_round(f(0, pi/3, radians=True), 15))
+(0.574951359778215, 2.145747686573111)
+>>> p = (0, 60)
+>>> q = f(*p, radians=False); print(my_round(q, 15))
+(0.574951359778215, 2.145747686573111)
+>>> print(my_round(f(*q, radians=False, inverse=True), 15))
+(6e-15, 59.999999999999986)
+>>> print(my_round(p, 15))
 (0, 60)
 
    
 
    
 
    OUTPUT:
    
 
      
-
    • A function object of the form f(u, v, radians=False, inverse=False).
      • 
+
    • A function object of the form f(u, v, radians=False, inverse=False).
      •
    -
    -
    -rhealpix_dggs.pj_healpix.healpix_diagram(a=1, e=0, shade_polar_region=True)¶
    -

    Return a Sage Graphics object diagramming the HEALPix projection -boundary and polar triangles for the ellipsoid with major radius a -and eccentricity e. -Inessential graphics method. -Requires Sage graphics methods.

    -
    - -
    -
    -rhealpix_dggs.pj_healpix.healpix_ellipsoid(lam, phi, e=0)¶
    +
    +
    +rhealpixdggs.pj_healpix.healpix_ellipsoid(lam: float, phi: float, e: float = 0) → tuple[float, float]¶

    Compute the signature functions of the HEALPix projection of an oblate ellipsoid with eccentricity e whose authalic sphere is the unit sphere. Works when e = 0 (spherical case) too.

    INPUT:

      -
    • lam, phi - Geodetic longitude-latitude coordinates in radians. -Assume -pi <= lam < pi and -pi/2 <= phi <= pi/2.
      • -
    • e - Eccentricity of the oblate ellipsoid.
      • +

    • lam, phi - Geodetic longitude-latitude coordinates in radians. +Assume -pi <= lam < pi and -pi/2 <= phi <= pi/2.

      • +

    • e - Eccentricity of the oblate ellipsoid.

    EXAMPLES:

    -
    >>> print(my_round(healpix_ellipsoid(0, pi/7), 15))
-(0, 0.51115723774642197)
->>> print(my_round(healpix_ellipsoid(0, pi/7, e=0.8), 15))
-(0, 0.26848445085783701)
+
    >>> print(my_round(healpix_ellipsoid(0, pi/7), 15))
+(0, 0.511157237746422)
+>>> print(my_round(healpix_ellipsoid(0, pi/7, e=0.8), 15))
+(0, 0.268484450857837)
    -
    -
    -rhealpix_dggs.pj_healpix.healpix_ellipsoid_inverse(x, y, e=0)¶
    +
    +
    +rhealpixdggs.pj_healpix.healpix_ellipsoid_inverse(x: float, y: float, e: float = 0) → tuple[float, float]¶

    Compute the inverse of healpix_ellipsoid().

    EXAMPLES:

    -
    >>> p = (0, pi/7)
+
    >>> p = (0, pi/7)
 >>> q = healpix_ellipsoid(*p)
->>> print(my_round(healpix_ellipsoid_inverse(*q), 15))
-(0, 0.44879895051282798)
->>> print(my_round(p, 15))
+>>> print(my_round(healpix_ellipsoid_inverse(*q), 15))
+(0, 0.448798950512828)
+>>> print(my_round(p, 15))
 (0, 0.448798950512828)
    -
    -
    -rhealpix_dggs.pj_healpix.healpix_sphere(lam, phi)¶
    -

    Compute the signature function of the HEALPix +

    +
    +rhealpixdggs.pj_healpix.healpix_sphere(lam: float, phi: float) → tuple[float, float]¶
    +

    Compute the signature function of the HEALPix projection of the unit sphere.

    INPUT:

      -
    • lam, phi - Geodetic longitude-latitude coordinates in radians. -Assume -pi <= lam < pi and -pi/2 <= phi <= pi/2.
      • +

    • lam, phi - Geodetic longitude-latitude coordinates in radians. +Assume -pi <= lam < pi and -pi/2 <= phi <= pi/2.

    EXAMPLES:

    -
    >>> print(healpix_sphere(0, arcsin(2.0/3)) == (0, pi/4))
+
    >>> print(healpix_sphere(0, arcsin(2.0/3)) == (0, pi/4))
 True
    -
    -
    -rhealpix_dggs.pj_healpix.healpix_sphere_inverse(x, y)¶
    +
    +
    +rhealpixdggs.pj_healpix.healpix_sphere_inverse(x: float, y: float) → tuple[float, float]¶

    Compute the inverse of the healpix_sphere().

    INPUT:

      -
    • x, y - Planar coordinates in meters in the image of the -HEALPix projection of the unit sphere.
      • +

    • x, y - Planar coordinates in meters in the image of the +HEALPix projection of the unit sphere.

    EXAMPLES:

    -
    >>> print(healpix_sphere_inverse(0, pi/4) == (0, arcsin(2.0/3)))
+
    >>> print(healpix_sphere_inverse(0, pi/4) == (0, arcsin(2.0/3)))
 True
    -
    -
    -rhealpix_dggs.pj_healpix.healpix_vertices()¶
    -

    Return a list of the planar vertices of the HEALPix projection of +

    +
    +rhealpixdggs.pj_healpix.healpix_vertices() → list[tuple[float, float, float]]¶
    +

    Return a list of the planar vertices of the HEALPix projection of the unit sphere.

    -
    -
    -rhealpix_dggs.pj_healpix.in_healpix_image(x, y)¶
    -

    Return True if and only if (x, y) lies in the image of the HEALPix +

    +
    +rhealpixdggs.pj_healpix.in_healpix_image(x: float, y: float) → bool¶
    +

    Return True if and only if (x, y) lies in the image of the HEALPix projection of the unit sphere.

    EXAMPLES:

    -
    >>> eps = 0     # Test boundary points.
+
    >>> eps = 0     # Test boundary points.
 >>> hp = [
 ... (-pi - eps, pi/4),
 ... (-3*pi/4, pi/2 + eps),
@@ -213,8 +191,8 @@ 
    Navigation
    
 ... ]
 >>> for p in hp:
 ...     if not in_healpix_image(*p):
-...             print('Fail')
-... 
+...             print('Fail')
+...
 >>> in_healpix_image(0, 0)
 True
 >>> in_healpix_image(0, pi/4 + 0.1)
@@ -223,43 +201,47 @@ 
    Navigation
    -
    + +
    -
    + -
    + -
    - © Copyright 2013, Alexander Raichev. - Created using Sphinx 1.1.3. + \ No newline at end of file diff --git a/docs/build/html/pj_rhealpix.html b/docs/build/html/pj_rhealpix.html index 1c48989..1d57d53 100644 --- a/docs/build/html/pj_rhealpix.html +++ b/docs/build/html/pj_rhealpix.html @@ -1,37 +1,27 @@ + - - - - + - - - The pj_rhealpix Module — rHEALPixDGGS 0.5.1 documentation + + + + The pj_rhealpix Module — rHEALPixDGGS 0.5.4 documentation + + - - + + + + + - - - - - - + + - - -
    + +
    -
    +
    -
    -

    The pj_rhealpix Module¶

    -

    This Python 3.3 module implements the rHEALPix map projection.

    -

    CHANGELOG:

    +
    +

    The pj_rhealpix Module¶

    +

    This Python 3.11 module implements the rHEALPix map projection.

      -
    • Alexander Raichev (AR), 2013-01-26: Refactored code from release 0.3.
      • -
    • AR, 2013-07-23: Ported to Python 3.3.
      • +

    • Alexander Raichev (AR), 2013-01-26: Refactored code from release 0.3.

    NOTE:

    -

    All lengths are measured in meters and all angles are measured in radians -unless indicated otherwise. -By ‘ellipsoid’ below, i mean an oblate ellipsoid of revolution.

    -
    -
    -rhealpix_dggs.pj_rhealpix.combine_triangles(x, y, north_square=0, south_square=0, inverse=False)¶
    -

    Rearrange point (x, y) in the HEALPix projection by +

    All lengths are measured in meters and all angles are measured in radians +unless indicated otherwise. +By ‘ellipsoid’ below, I mean an oblate ellipsoid of revolution.

    +
    +
    +rhealpixdggs.pj_rhealpix.combine_triangles(x: float, y: float, north_square: int = 0, south_square: int = 0, inverse: bool = False) → tuple[float, float]¶
    +

    Rearrange point (x, y) in the HEALPix projection by combining the polar triangles into two polar squares. -Put the north polar square in position north_square and +Put the north polar square in position north_square and the south polar square in position south_square. If inverse = True, uncombine the polar triangles.

    INPUT:

      -
    • x, y - Coordinates in the HEALPix projection of the unit sphere.
      • -
    • north_square, south_square - Integers between 0 and 3 indicating -the positions of the north_square polar square and south_square polar +

    • x, y - Coordinates in the HEALPix projection of the unit sphere.

      • +

    • north_square, south_square - Integers between 0 and 3 indicating +the positions of the north_square polar square and south_square polar square respectively. -See rhealpix_sphere() docstring for a diagram.

      • -
    • inverse - (Optional; default = False) Boolean. If False, then compute -forward function. If True, then compute inverse function.
      • +See rhealpix_sphere() docstring for a diagram.

      +

    • inverse - (Optional; default = False) Boolean. If False, then compute +forward function. If True, then compute inverse function.

    EXAMPLES:

    -
    >>> u, v = -pi/4, pi/3
+
    >>> u, v = -pi/4, pi/3
 >>> x, y = combine_triangles(u, v)
->>> print(my_round((x, y), 15))
-(-1.8325957145940459, 1.5707963267948959)
->>> print(my_round(combine_triangles(x, y, inverse=True), 15))
-(-0.78539816339744795, 1.0471975511965981)
->>> print(my_round((u, v), 15))
+>>> print(my_round((x, y), 15))
+(-1.832595714594046, 1.570796326794896)
+>>> print(my_round(combine_triangles(x, y, inverse=True), 15))
+(-0.785398163397448, 1.047197551196598)
+>>> print(my_round((u, v), 15))
 (-0.785398163397448, 1.047197551196598)
    -
    -
    -rhealpix_dggs.pj_rhealpix.in_rhealpix_image(x, y, north_square=0, south_square=0)¶
    -

    Return True if and only if the point (x, y) lies in the image of +

    +
    +rhealpixdggs.pj_rhealpix.in_rhealpix_image(x: float, y: float, north_square: int = 0, south_square: int = 0) → bool¶
    +

    Return True if and only if the point (x, y) lies in the image of the rHEALPix projection of the unit sphere.

    EXAMPLES:

    -
    >>> eps = 0     # Test boundary points.
+
    >>> eps = 0     # Test boundary points.
 >>> north_square, south_square = 0, 0
 >>> rhp = [
 ... (-pi - eps, pi/4 + eps),
@@ -122,253 +111,250 @@ 
    Navigation
    
 ... ]
 >>> for p in rhp:
 ...     if not in_rhealpix_image(*p):
-...             print('Fail')
-... 
->>> print(in_rhealpix_image(0, 0))
+...             print('Fail')
+...
+>>> print(in_rhealpix_image(0, 0))
 True
->>> print(in_rhealpix_image(0, pi/4 + 0.1))
+>>> print(in_rhealpix_image(0, pi/4 + 0.1))
 False
    -
    -
    -rhealpix_dggs.pj_rhealpix.rhealpix(a=1, e=0, north_square=0, south_square=0)¶
    +
    +
    +rhealpixdggs.pj_rhealpix.rhealpix(a: float = 1, e: float = 0, north_square: int = 0, south_square: int = 0, region: str = 'none') → Callable[[float, float, bool, bool], tuple[float, float]]¶

    Return a function object that wraps the rHEALPix projection and its inverse of an ellipsoid with major radius a and eccentricity e.

    EXAMPLES:

    -
    >>> f = rhealpix(a=2, e=0, north_square=1, south_square=2)
->>> print(my_round(f(0, pi/3, radians=True), 15))
-(-0.57495135977821499, 2.1457476865731109)
->>> p = (0, 60) 
->>> q = f(*p, radians=False)
->>> print(my_round(q, 15))
-(-0.57495135977821499, 2.1457476865731109)
->>> print(my_round(f(*q, radians=False, inverse=True), 15))
-(5.9999999999999997e-15, 59.999999999999986)
->>> print(my_round(p, 15))
+
    >>> f = rhealpix(a=2, e=0, north_square=1, south_square=2)
+>>> print(my_round(f(0, pi/3, radians=True), 15))
+(-0.574951359778215, 2.145747686573111)
+>>> p = (0, 60)
+>>> q = f(*p, radians=False)
+>>> print(my_round(q, 15))
+(-0.574951359778215, 2.145747686573111)
+>>> print(my_round(f(*q, radians=False, inverse=True), 15))
+(6e-15, 59.999999999999986)
+>>> print(my_round(p, 15))
 (0, 60)
 
    
 
    
 
    OUTPUT:
    
 
      
-
    • A function object of the form f(u, v, radians=False, inverse=False).
      • 
+
    • A function object of the form f(u, v, radians=False, inverse=False).
      •
    -
    -
    -rhealpix_dggs.pj_rhealpix.rhealpix_diagram(a=1, e=0, north_square=0, south_square=0, shade_polar_region=True)¶
    -

    Return a Sage Graphics object diagramming the rHEALPix projection -boundary and polar triangles for the ellipsoid with major radius a -and eccentricity e. -Inessential graphics method. -Requires Sage graphics methods.

    -
    - -
    -
    -rhealpix_dggs.pj_rhealpix.rhealpix_ellipsoid(lam, phi, e=0, north_square=0, south_square=0)¶
    -

    Compute the signature functions of the rHEALPix map -projection of an oblate ellipsoid with eccentricity e whose -authalic sphere is the unit sphere. -The north polar square is put in position north_square, +

    +
    +rhealpixdggs.pj_rhealpix.rhealpix_ellipsoid(lam: float, phi: float, e: float = 0, north_square: int = 0, south_square: int = 0, region: str = 'none') → tuple[float, float]¶
    +

    Compute the signature functions of the rHEALPix map +projection of an oblate ellipsoid with eccentricity e whose +authalic sphere is the unit sphere. +The north polar square is put in position north_square, and the south polar square is put in position south_square. Works when e = 0 (spherical case) too.

    INPUT:

      -
    • lam, phi - Geographic longitude-latitude coordinates in radian. -Assume -pi <= lam < pi and -pi/2 <= phi <= pi/2.
      • -
    • e - Eccentricity of the ellipsoid.
      • -
    • north_square, south_square - (Optional; defaults = 0, 0) Integers -between 0 and 3 indicating positions of north polar and +

    • lam, phi - Geographic longitude-latitude coordinates in radian. +Assume -pi <= lam < pi and -pi/2 <= phi <= pi/2.

      • +

    • e - Eccentricity of the ellipsoid.

      • +

    • north_square, south_square - (Optional; defaults = 0, 0) Integers +between 0 and 3 indicating positions of north polar and south polar squares, respectively. -See rhealpix_sphere() docstring for a diagram.

      • +See rhealpix_sphere() docstring for a diagram.

    EXAMPLES:

    -
    >>> from numpy import arcsin
->>> print(my_round(rhealpix_ellipsoid(0, arcsin(2.0/3)), 15))
-(0, 0.78539816339744795)
+
    >>> from numpy import arcsin
+>>> print(my_round(rhealpix_ellipsoid(0, arcsin(2.0/3)), 15))
+(0, 0.785398163397448)
    -
    -
    -rhealpix_dggs.pj_rhealpix.rhealpix_ellipsoid_inverse(x, y, e=0, north_square=0, south_square=0)¶
    -

    Compute the inverse of rhealpix_ellipsoid.

    +
    +
    +rhealpixdggs.pj_rhealpix.rhealpix_ellipsoid_inverse(x: float, y: float, e: float = 0, north_square: int = 0, south_square: int = 0, region: str = 'none') → tuple[float, float]¶
    +

    Compute the inverse of rhealpix_ellipsoid().

    EXAMPLES:

    -
    >>> p = (0, pi/4)
+
    >>> p = (0, pi/4)
 >>> q = rhealpix_ellipsoid(*p)
->>> print(my_round(rhealpix_ellipsoid_inverse(*q), 15))
-(0.0, 0.78539816339744795)
->>> print(my_round(p, 15))
+>>> print(my_round(rhealpix_ellipsoid_inverse(*q), 15))
+(0.0, 0.785398163397448)
+>>> print(my_round(p, 15))
 (0, 0.785398163397448)
    -
    -
    -rhealpix_dggs.pj_rhealpix.rhealpix_sphere(lam, phi, north_square=0, south_square=0)¶
    -

    Compute the signature functions of the rHEALPix map projection of -the unit sphere. -The north polar square is put in position north_square, and the +

    +
    +rhealpixdggs.pj_rhealpix.rhealpix_sphere(lam: float, phi: float, north_square: int = 0, south_square: int = 0, region: str = 'none') → tuple[float, float]¶
    +

    Compute the signature functions of the rHEALPix map projection of +the unit sphere. +The north polar square is put in position north_square, and the south polar square is put in position south_square.

    INPUT:

      -
    • lam, phi -Geographic longitude-latitude coordinates in radians. -Assume -pi <= lam < pi and -pi/2 <= phi <= pi/2.
      • -
    • north_square, south_square - (Optional; defaults = 0, 0) Integers -between 0 and 3 indicating positions of north polar and -south polar squares, respectively.
      • +

    • lam, phi -Geographic longitude-latitude coordinates in radians. +Assume -pi <= lam < pi and -pi/2 <= phi <= pi/2.

      • +

    • north_square, south_square - (Optional; defaults = 0, 0) Integers +between 0 and 3 indicating positions of north polar and +south polar squares, respectively.

    EXAMPLES:

    -
    >>> print(my_round(rhealpix_sphere(0, pi/4), 15))
+
    >>> print(my_round(rhealpix_sphere(0, pi/4), 15))
 (-1.619978633413937, 2.307012183573304)
 
    
 
    
 
    NOTE:
    
 
    The polar squares are labeled 0, 1, 2, 3 from east to west like this:
    
-
    east         west        
-*---*---*---*---*
-| 0 | 1 | 2 | 3 |
-*---*---*---*---*
-|   |   |   |   |
-*---*---*---*---*
-| 0 | 1 | 2 | 3 |
-*---*---*---*---*    
    
+
    east         west
+*---*---*---*---*
+| 0 | 1 | 2 | 3 |
+*---*---*---*---*
+|   |   |   |   |
+*---*---*---*---*
+| 0 | 1 | 2 | 3 |
+*---*---*---*---*
+
    -
    -
    -rhealpix_dggs.pj_rhealpix.rhealpix_sphere_inverse(x, y, north_square=0, south_square=0)¶
    +
    +
    +rhealpixdggs.pj_rhealpix.rhealpix_sphere_inverse(x: float, y: float, north_square: int = 0, south_square: int = 0, region: str = 'none') → tuple[float, float]¶

    Compute the inverse of rhealpix_sphere().

    EXAMPLES:

    -
    >>> p = (0, pi/4)
+
    >>> p = (0, pi/4)
 >>> q = rhealpix_sphere(*p)
->>> print(my_round(rhealpix_sphere_inverse(*q), 15))
-(0.0, 0.78539816339744795)
->>> print(my_round(p, 15))
+>>> print(my_round(rhealpix_sphere_inverse(*q), 15))
+(0.0, 0.785398163397448)
+>>> print(my_round(p, 15))
 (0, 0.785398163397448)
    -
    -
    -rhealpix_dggs.pj_rhealpix.rhealpix_vertices(north_square=0, south_square=0)¶
    -

    Return a list of the planar vertices of the rHEALPix projection of +

    +
    +rhealpixdggs.pj_rhealpix.rhealpix_vertices(north_square: int = 0, south_square: int = 0) → list[tuple[float, float]]¶
    +

    Return a list of the planar vertices of the rHEALPix projection of the unit sphere.

    -
    -
    -rhealpix_dggs.pj_rhealpix.triangle(x, y, north_square=0, south_square=0, inverse=False)¶
    +
    +
    +rhealpixdggs.pj_rhealpix.triangle(x: float, y: float, north_square: int = 0, south_square: int = 0, inverse: bool = False) → tuple[int, str]¶

    Return the number of the polar triangle and region that (x, y) lies in. -If inverse = False, then assume (x,y) lies in the image of the HEALPix +If inverse = False, then assume (x,y) lies in the image of the HEALPix projection of the unit sphere. -If inverse = True, then assume (x,y) lies in the image of the +If inverse = True, then assume (x,y) lies in the image of the (north_square, south_square)-rHEALPix projection of the unit sphere.

    INPUT:

      -
    • x, y - Coordinates in the HEALPix or rHEALPix (if inverse = True) -projection of the unit sphere.
      • -
    • north_square, south_square - Integers between 0 and 3 indicating the -positions of the north_square pole square and south_square pole square +

    • x, y - Coordinates in the HEALPix or rHEALPix (if inverse = True) +projection of the unit sphere.

      • +

    • north_square, south_square - Integers between 0 and 3 indicating the +positions of the north_square pole square and south_square pole square respectively. -See rhealpix_sphere() docstring for a diagram.

      • -
    • inverse - (Optional; default = False) Boolean. If False, then compute -forward function. If True, then compute inverse function.
      • +See rhealpix_sphere() docstring for a diagram.

      +

    • inverse - (Optional; default = False) Boolean. If False, then compute +forward function. If True, then compute inverse function.

    OUTPUT:

    The pair (triangle_number, region). -Here region equals ‘north_polar’ (polar), ‘south_polar’ (polar), or -‘equatorial’, indicating where (x, y) lies. -If region = ‘equatorial’, then triangle_number = None. -Suppose now that region != ‘equatorial’. -If inverse = False, then triangle_number is the number (0, 1, 2, or 3) of +Here region equals ‘north_polar’ (polar), ‘south_polar’ (polar), or +‘equatorial’, indicating where (x, y) lies. +If region = ‘equatorial’, then triangle_number = None. +Suppose now that region != ‘equatorial’. +If inverse = False, then triangle_number is the number (0, 1, 2, or 3) of the HEALPix polar triangle Z that (x, y) lies in. -If inverse = True, then triangle_number is the number (0, 1, 2, or 3) of +If inverse = True, then triangle_number is the number (0, 1, 2, or 3) of the HEALPix polar triangle that (x, y) will get moved into.

    EXAMPLES:

    -
    >>> triangle(-pi/4, pi/4 + 0.1)
+
    >>> triangle(-pi/4, pi/4 + 0.1)
 (1, 'north_polar')
->>> triangle(-3*pi/4 + 0.1, pi/2, inverse=True)
+>>> triangle(-3*pi/4 + 0.1, pi/2, inverse=True)
 (1, 'north_polar')
 
    
 
    
 
    NOTES:
    
-
    In the HEALPix projection, the polar triangles are labeled 0–3 from 
+
    In the HEALPix projection, the polar triangles are labeled 0–3 from
 east to west like this:
    
-
        *       *       *       *       
-  * 0 *   * 1 *   * 2 *   * 3 *        
-*-------*-------*-------*-------*
-|       |       |       |       |
-|       |       |       |       |
-|       |       |       |       |
-*-------*-------*-------*-------*
-  * 0 *   * 1 *   * 2 *   * 3 *
-    *       *       *       *
    
+
        *       *       *       *
+  * 0 *   * 1 *   * 2 *   * 3 *
+*-------*-------*-------*-------*
+|       |       |       |       |
+|       |       |       |       |
+|       |       |       |       |
+*-------*-------*-------*-------*
+  * 0 *   * 1 *   * 2 *   * 3 *
+    *       *       *       *
+
    
 
    
 
    In the rHEALPix projection these polar triangles get rearranged
-into a square with the triangles numbered north_square and south_square 
+into a square with the triangles numbered north_square and south_square
 remaining fixed.
-For example, if north_square = 1 and south_square = 3, 
+For example, if north_square = 1 and south_square = 3,
 then the triangles get rearranged this way:
    
-
    North polar square:     *-------*       
-                        | * 3 * |    
-                        | 0 * 2 |    
-                        | * 1 * |    
-                    ----*-------*----
-                    
-South polar square: ----*-------*----
-                        | * 3 * |
-                        | 2 * 0 |
-                        | * 1 * |
-                        *-------*    
    
+
    North polar square:     *-------*
+                        | * 3 * |
+                        | 0 * 2 |
+                        | * 1 * |
+                    ----*-------*----
+
+South polar square: ----*-------*----
+                        | * 3 * |
+                        | 2 * 0 |
+                        | * 1 * |
+                        *-------*
+
    -
    + +
    -
    + -
    + -
    - © Copyright 2013, Alexander Raichev. - Created using Sphinx 1.1.3. + \ No newline at end of file diff --git a/docs/build/html/projection_tools.html b/docs/build/html/projection_tools.html deleted file mode 100644 index 3faa051..0000000 --- a/docs/build/html/projection_tools.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - - - - - The projection_tools Module — rHEALPixDGGS 0.5.1 documentation - - - - - - - - - - - - - - -
    -

    Navigation

    - -
    - -
    -
    -
    -
    - -
    -

    The projection_tools Module¶

    -

    This Python 3.3 module implements several helper functions for coding map projections.

    -

    CHANGELOG:

    -
      -
    • Alexander Raichev (AR), 2012-01-26: Refactored code from release 0.3.
      • -
    • AR, 2013-07-23: Ported to Python 3.3.
      • -
    -

    NOTE:

    -

    All lengths are measured in meters and all angles are measured in radians -unless indicated otherwise.

    -
    -
    -projection_tools.auth_lat(phi, e, inverse=False, radians=False)¶
    -

    Given a point of geographic latitude phi on an ellipse of -eccentricity e, return the authalic latitude of the point. -If inverse =True, then compute its inverse approximately.

    -

    EXAMPLES:

    -
    >>> beta = auth_lat(pi/4, 0.5, radians=True)
->>> print(my_round(beta, 15))
-0.689518212435
->>> print(my_round(auth_lat(beta, 0.5, radians=True, inverse=True), 15))
-0.785126523581
->>> print(my_round(pi/4, 15))
-0.785398163397448
-
    -
    -

    NOTES:

    -

    The power series approximation used for the inverse is -standard in cartography (PROJ.4 uses it, for instance) -and accurate for small eccentricities.

    -
    - -
    -
    -projection_tools.auth_rad(a, e, inverse=False)¶
    -

    Return the radius of the authalic sphere of the ellipsoid with major -radius a and eccentricity e. -If inverse = True, then return the major radius of the ellipsoid -with authalic radius a and eccentricity e.

    -

    EXAMPLES:

    -
    >>> auth_rad(1, 0)
-1
->>> for i in range(2, 11):
-...     e = 1.0/i**2     
-...     print(my_round((e, auth_rad(1, 1.0/i**2)), 15))
-(0.25, 0.98939325967009495)
-(0.111111111111111, 0.99793514742994305)
-(0.0625, 0.99934823645582505)
-(0.04, 0.99973321235361001)
-(0.027777777777778, 0.99987137105187995)
-(0.020408163265306, 0.99993057628561399)
-(0.015625, 0.99995930708084702)
-(0.012345679012346, 0.99997459627121099)
-(0.01, 0.99998333286108898)
-
    -
    -
    - -
    -
    -projection_tools.wrap_latitude(phi, radians=False)¶
    -

    Given a point p on the unit circle at angle phi from the positive x-axis, -if p lies in the right half of the circle, then return its angle that lies -in the interval [-pi/2, pi/2]. -If p lies in the left half of the circle, then reflect it through the -origin, and return the angle of the reflected point that lies in the -interval [-pi/2, pi/2]. -If radians = True, then phi and the output are given in radians. -Otherwise, they are given in degrees.

    -

    EXAMPLES:

    -
    >>> wrap_latitude(45, radians=False)
-45.0
->>> wrap_latitude(-45, radians=False)
--45.0
->>> wrap_latitude(90, radians=False)
-90.0
->>> wrap_latitude(-90, radians=False)
--90.0
->>> wrap_latitude(135, radians=False)
--45.0
->>> wrap_latitude(-135, radians=False)
-45.0
-
    -
    -
    - -
    -
    -projection_tools.wrap_longitude(lam, radians=False)¶
    -

    Given a point p on the unit circle at angle lam from the positive -x-axis, return its angle theta in the range -pi <= theta < pi. -If radians = True, then lam and the output are given in radians. -Otherwise, they are given in degrees.

    -

    EXAMPLES:

    -
    >>> wrap_longitude(2*pi + pi, radians=True)
--3.1415926535897931
->>> wrap_longitude(-185, radians=False)
-175.0
->>> wrap_longitude(-180, radians=False)
--180.0
->>> wrap_longitude(185, radians=False)
--175.0
-
    -
    -
    - -
    - - -
    -
    -
    -
    -
    -

    Previous topic

    -

    Introduction

    -

    Next topic

    -

    The pj_healpix Module

    -

    This Page

    - - - -
    -
    -
    -
    -
    -

    Navigation

    - -
    -
    - © Copyright 2013, Alexander Raichev. - Created using Sphinx 1.1.3. -
    - - \ No newline at end of file diff --git a/docs/build/html/projection_wrapper.html b/docs/build/html/projection_wrapper.html index 3282eb5..b5f8d08 100644 --- a/docs/build/html/projection_wrapper.html +++ b/docs/build/html/projection_wrapper.html @@ -1,37 +1,27 @@ + - - - - + - - - The projection_wrapper Module — rHEALPixDGGS 0.5.1 documentation + + + + The projection_wrapper Module — rHEALPixDGGS 0.5.4 documentation + + - - + + + + + - - - - - - + + - - -
    + +
    -
    +
    -
    -

    The projection_wrapper Module¶

    -

    This Python 3.3 module implements a wrapper for map projections.

    -

    CHANGELOG:

    +
    +

    The projection_wrapper Module¶

    +

    This Python 3.11 module implements a wrapper for map projections.

      -
    • Alexander Raichev (AR), 2013-01-25: Refactored code from release 0.3.
      • -
    • AR, 2013-07-23: Ported to Python 3.3.
      • +

    • Alexander Raichev (AR), 2013-01-25: Refactored code from release 0.3.

    NOTE:

    -

    All lengths are measured in meters and all angles are measured in radians -unless indicated otherwise. -By ‘ellipsoid’ below, i mean an oblate ellipsoid of revolution.

    -
    -
    -class rhealpix_dggs.projection_wrapper.Proj(ellipsoid=<rhealpix_dggs.ellipsoids.Ellipsoid object at 0x102e65d50>, proj=None, **kwargs)¶
    -

    Bases: builtins.object

    +

    All lengths are measured in meters and all angles are measured in radians +unless indicated otherwise. +By ‘ellipsoid’ below, I mean an oblate ellipsoid of revolution.

    +
    +
    +class rhealpixdggs.projection_wrapper.Projection(ellipsoid=<rhealpixdggs.ellipsoids.Ellipsoid object>, proj=None, **kwargs)¶
    +

    Bases: object

    Represents a map projection of a given ellipsoid.

    INSTANCE ATTRIBUTES:

      -
    • ellipsoid - An ellipsoid (Ellipsoid instance) to project.
      • -
    • proj - The name (string) of the map projection, either a valid PROJ.4 -projection name or a valid homemade projection name.
      • -
    • kwargs - Keyword arguments (dictionary) needed for the projection’s -definition, but not for the definition of the ellipsoid. For example, -these could be {‘north_square’:1, ‘south_square’: 2} for the rhealpix -projection.
      • +

    • ellipsoid - An ellipsoid (Ellipsoid instance) to project.

      • +

    • proj - The name (string) of the map projection, either a valid PROJ.4 +projection name or a valid homemade projection name.

      • +

    • kwargs - Keyword arguments (dictionary) needed for the projection’s +definition, but not for the definition of the ellipsoid. For example, +these could be {‘north_square’:1, ‘south_square’: 2} for the rhealpix +projection.

    EXAMPLES:

    -
    >>> from rhealpix_dggs.ellipsoids import WGS84_ELLIPSOID    
->>> f = Proj(ellipsoid=WGS84_ELLIPSOID, proj='rhealpix', north_square=1, south_square=0)
->>> print(my_round(f(0, 30), 15))
+
    >>> from rhealpixdggs.ellipsoids import WGS84_ELLIPSOID
+>>> f = Projection(ellipsoid=WGS84_ELLIPSOID, proj='rhealpix', north_square=1, south_square=0)
+>>> print(my_round(f(0, 30), 15))
 (0.0, 3748655.1150495014)
->>> f = Proj(ellipsoid=WGS84_ELLIPSOID, proj='cea')
->>> print(my_round(f(0, 30), 15))
-(0.0, 3180183.485774971)
+>>> f = Projection(ellipsoid=WGS84_ELLIPSOID, proj='cea')
+>>> print(my_round(f(0, 30), 15))
+(0.0, 3180183.4857749646)
 
    
 
    
+
    
+
    NOTES:: .. Issue #1 was !!! ..
    (0.0, 3180183.485774971) *
    
+
    
+
    
 
    NOTES:
    
 
    When accessing a homemade map projection assume that it can be called via
-a function g(a, e), where a is the major radius of the ellipsoid to be 
+a function g(a, e), where a is the major radius of the ellipsoid to be
 projected and e is its eccentricity.
-The output of g should be a function object of the form 
+The output of g should be a function object of the form
 f(u, v, radians=False, inverse=False).
-For example, see the healpix() function in pj_healpix.py.
    
+For example, see the healpix() function in pj_healpix.py.
    -
    + +
    -
    + -
    + -
    - © Copyright 2013, Alexander Raichev. - Created using Sphinx 1.1.3. + \ No newline at end of file diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html index 2d6a9a1..2783f55 100644 --- a/docs/build/html/py-modindex.html +++ b/docs/build/html/py-modindex.html @@ -1,38 +1,27 @@ + - - - - + - + + + Python Module Index — rHEALPixDGGS 0.5.4 documentation + + - Python Module Index — rHEALPixDGGS 0.5.1 documentation + + + + + - - - - - - - - - + + - - -
    + +
    -
    +

    Python Module Index

    @@ -57,77 +47,70 @@

    Python Module Index

    r
    - - +
     
    + - - - - - - - - -
     
    r
    - rhealpix_dggs + rhealpixdggs
        - rhealpix_dggs.dggs +     + rhealpixdggs.dggs
        - rhealpix_dggs.distortion +     + rhealpixdggs.ellipsoids
        - rhealpix_dggs.ellipsoids +     + rhealpixdggs.pj_healpix
        - rhealpix_dggs.pj_healpix +     + rhealpixdggs.pj_rhealpix
        - rhealpix_dggs.pj_rhealpix +     + rhealpixdggs.projection_wrapper
        - rhealpix_dggs.projection_wrapper -
        - rhealpix_dggs.utils +     + rhealpixdggs.utils
    +
    -
    + -
    + -
    - © Copyright 2013, Alexander Raichev. - Created using Sphinx 1.1.3. + \ No newline at end of file diff --git a/docs/build/html/rhealpix_dggs.html b/docs/build/html/rhealpix_dggs.html deleted file mode 100644 index 9cb14d5..0000000 --- a/docs/build/html/rhealpix_dggs.html +++ /dev/null @@ -1,1402 +0,0 @@ - - - - - - - - - - The dggs Module — rHEALPixDGGS 0.5.1 documentation - - - - - - - - - - - - -
    -

    Navigation

    - -
    - -
    -
    -
    -
    - -
    -

    The dggs Module¶

    -

    This Python 3.3 module implements the rHEALPix discrete global grid system.

    -

    CHANGELOG:

    -
      -
    • Alexander Raichev (AR), 2012-11-12: Initial version based upon grids.py.
      • -
    • AR, 2012-12-10: Corrected centroid() and moved some methods from graphics.py to here.
      • -
    • AR, 2012-12-19: Tested all the methods and added examples.
      • -
    • AR, 2013-01-01: Added ellipsoidal functionality to neighbor() and neighbors().
      • -
    • AR, 2013-01-14: Added intersects_meridian(), cell_latitudes(), cells_from_meridian(), cells_from_parallel(), cells_from_region().
      • -
    • AR, 2013-01-16: Changed the string keyword ‘surface’ to a boolean keyword ‘plane’.
      • -
    • AR, 2013-03-11: Added minimal_cover(), boundary(), interior(), triangle(), nw_vertex().
      • -
    • AR, 2013-03-14: Fixed bug in nw_vertex().
      • -
    • AR, 2013-07-23: Ported to Python 3.3.
      • -
    -

    NOTES:

    -

    All lengths are measured in meters and all angles are measured in radians -unless indicated otherwise.

    -

    By ‘ellipsoid’ throughout, i mean an ellipsoid of revolution and not a general (triaxial) ellipsoid.

    -

    Points lying on the plane are given in rectangular (horizontal, vertical) coordinates, and points lying on the ellipsoid are given in geodetic (longitude, latitude) coordinates unless indicated otherwise.

    -

    DGGS abbreviates ‘discrete global grid system’.

    -

    Except when manipulating positive integers, I avoid the modulo function ‘%’ -and insted write everything in terms of ‘floor()’. -This is because Python interprets the sign of ‘%’ differently than -Java or C, and I don’t want to confuse people who are translating this code -to those languages.

    -

    EXAMPLES:

    -

    Create the (1, 2)-rHEALPix DGGS with N_side = 3 that is based on the WGS84 ellipsoid. Use degrees instead of the default radians for angular measurements

    -
    >>> from rhealpix_dggs.ellipsoids import WGS84_ELLIPSOID
->>> E = WGS84_ELLIPSOID
->>> rdggs = RHEALPixDGGS(ellipsoid=E, north_square=1, south_square=2, N_side=3)
->>> print(rdggs)
-rHEALPix DGGS:
-    N_side = 3
-    north_square = 1
-    south_square = 2
-    max_areal_resolution = 1
-    max_resolution = 15
-    ellipsoid:
-        R_A = 6374581.4671
-        a = 6378137.0
-        b = 6356752.314140356
-        e = 0.0578063088401
-        f = 0.003352810681182319
-        lat_0 = 0
-        lon_0 = 0
-        radians = False
-        sphere = False
-
    -
    -

    Pick a (longitude-latitude) point on the ellipsoid and find the resolution 1 cell that contains it

    -
    >>> p = (0, 45)
->>> c = rdggs.cell_from_point(1, p, plane=False); print(c)
-N8
-
    -
    -

    Find the ellipsoidal (edge) neighbors of this cell

    -
    >>> for (direction, cell) in sorted(c.neighbors(plane=False).items()):
-...     print(direction, cell) 
-east N5
-south_east Q0
-south_west P2
-west N7
-
    -
    -

    Find the planar (edge) neighbors of this cell

    -
    >>> for (direction, cell) in sorted(c.neighbors('plane').items()):
-...     print(direction, cell) 
-down P2
-left N7
-right Q0
-up N5
-
    -
    -

    Find all the resolution 1 cells intersecting the longitude-latitude aligned ellipsoidal quadrangle with given northwest and southeast corners

    -
    >>> nw = (0, 45)
->>> se = (90, 0)
->>> cells = rdggs.cells_from_region(1, nw, se, plane=False)
->>> for row in cells:
-...     print([str(cell) for cell in row])
-['N8', 'N5', 'N2']
-['Q0', 'Q1', 'Q2', 'R0']
-['Q3', 'Q4', 'Q5', 'R3']
-
    -
    -

    Compute the ellipsoidal nuclei of these cells

    -
    >>> for row in cells:
-...     for cell in row:
-...         print(cell, cell.nucleus(plane=False))
-N8 (0.0, 58.470677829627363)
-N5 (45.000000000000036, 58.470677829627363)
-N2 (90.000000000000028, 58.470677829627355)
-Q0 (14.999999999999998, 26.438744923100096)
-Q1 (45.0, 26.438744923100096)
-Q2 (74.999999999999986, 26.438744923100096)
-R0 (105.00000000000001, 26.438744923100096)
-Q3 (14.999999999999998, 3.560649871414923e-15)
-Q4 (45.0, 3.560649871414923e-15)
-Q5 (74.999999999999986, 3.560649871414923e-15)
-R3 (105.00000000000001, 3.560649871414923e-15)
-
    -
    -

    Create the (0, 0)-rHEALPix DGGS with N_side = 3 that is based on the WGS84 ellipsoid. Use degrees instead of the default radians for angular measurements -and orient the DGGS so that the planar origin (0, 0) is on Auckland, New Zealand

    -
    >>> p = (174, -37)  # Approximate Auckland lon-lat coordinates
->>> from rhealpix_dggs.ellipsoids import *
->>> E = Ellipsoid(a=WGS84_A, f=WGS84_F, radians=False, lon_0=p[0], lat_0=p[1])
->>> rdggs = RHEALPixDGGS(E, N_side=3, north_square=0, south_square=0)
->>> print(rdggs)
-rHEALPix DGGS:
-    N_side = 3
-    north_square = 0
-    south_square = 0
-    max_areal_resolution = 1
-    max_resolution = 15
-    ellipsoid:
-        R_A = 6374581.4671
-        a = 6378137.0
-        b = 6356752.314140356
-        e = 0.0578063088401
-        f = 0.003352810681182319
-        lat_0 = -37
-        lon_0 = 174
-        radians = False
-        sphere = False
->>> print(rdggs.cell_from_point(1, p, plane=False))
-Q3
-
    -
    -
    -
    -class rhealpix_dggs.dggs.Cell(rdggs=<rhealpix_dggs.dggs.RHEALPixDGGS object at 0x1035d7e10>, suid=None, level_order_index=None, post_order_index=None)¶
    -

    Bases: object

    -

    Represents a cell of the planar or ellipsoidal rHEALPix grid hierarchies. -Cell identifiers are of the form (p_0, p_1,...,p_l), where p_0 is one of -the characters ‘A’, ‘B’, ‘C’, ‘D’, ‘E’, ‘F’ and p_i for i > 0 is one of -the integers 0, 1,..., N_side**2 - 1, where N_side is the instance -attribute from RHEALPixDGGS (the number of children cells along a cell’s -side).

    -

    INSTANCE ATTRIBUTES:

    -
      -
    • rdggs - The DGGS that the cell comes from.
      • -
    • ellipsoid - The underlying ellipsoid of the DGGS.
      • -
    • N_side - The N_side attribute of the DGGS
      • -
    • suid - The cell’s ID (tuple). SUID = spatially unique identifier. -(‘id’ is a reserved word in Python)
      • -
    • resolution - The cell’s resolution (nonnegative integer).
      • -
    -

    NOTE:

    -

    Several Cell methods have the keyword argument ‘plane’. -Setting it to True indicates that all input and output points and cells are -to be interpreted as lying in the planar DGGS. -Setting it to False indicates that they are to be interpreted as lying in -the ellipsoidal DGGS.

    -
    -
    -area(plane=True)¶
    -

    Return the area of this cell.

    -
    - -
    -
    -boundary(n=2, plane=True, interior=False)¶
    -

    Return a list of 4*n - 4 boundary points of this cell, -n on each edge, where n >= 2. -List the points in clockwise order starting from the cell’s upper left -corner if plane = True, or from the cell’s northwest corner -if plane = False.

    -

    If n = 2, then the output is the same as vertices(). -If interior = True, then push the boundary points slighly into the -interior of the cell, which is convenient for some graphics methods.

    -

    EXAMPLES:

    -
    >>> rdggs = UNIT_003
->>> c = rdggs.cell(['N', 6])
->>> c.boundary(n=2, plane=True) == c.vertices(plane=True)
-True
->>> for p in c.boundary(n=3, plane=True):
-...     print(my_round(p, 14))
-(-3.14159265358979, 1.3089969389957501)
-(-2.87979326579064, 1.3089969389957501)
-(-2.61799387799149, 1.3089969389957501)
-(-2.61799387799149, 1.0471975511966001)
-(-2.61799387799149, 0.78539816339745006)
-(-2.87979326579064, 0.78539816339745006)
-(-3.14159265358979, 0.78539816339745006)
-(-3.14159265358979, 1.0471975511966001)
-
->>> for p in c.boundary(n=3, plane=False):
-...     print(my_round(p, 14))
-(-180.0, 74.35752898700072)
-(-157.50000000000003, 58.413661903472082)
-(-150.0, 41.810314895778603)
-(-165.00000000000003, 41.810314895778603)
-(-180.0, 41.810314895778603)
-(165.0, 41.810314895778603)
-(149.99999999999997, 41.810314895778603)
-(157.49999999999997, 58.413661903472082)
-
    -
    -
    - -
    -
    -centroid(plane=True)¶
    -

    Return the centroid of this planar or ellipsoidal cell.

    -

    EXAMPLES:

    -
    >>> rdggs = RHEALPixDGGS()
->>> c = Cell(rdggs, ['P', 0, 2])
->>> centroid = c.centroid()
->>> nucleus = c.nucleus()
->>> print(centroid == nucleus)
-True
-
    -
    -
    - -
    -
    -color(saturation=0.5)¶
    -

    Return a unique RGB color tuple for this cell. -Inessential graphics method.

    -
    - -
    -
    -contains(p, plane=True)¶
    -

    Return True if this cell contains point p, and return False -otherwise.

    -

    EXAMPLES:

    -
    >>> rdggs = WGS84_003_RADIANS
->>> p = (pi/4, 0)
->>> c = rdggs.cell_from_point(2, p, plane=False)
->>> print(c)
-Q44
->>> print(c.contains(p, plane=False))
-True
-
    -
    -
    - -
    -
    -ellipsoidal_shape()¶
    -

    Return the shape of this cell (‘quad’, ‘cap’, ‘dart’, or -‘skew_quad’) when viewed on the ellipsoid.

    -

    EXAMPLES:

    -
    >>> rdggs = RHEALPixDGGS()
->>> print(Cell(rdggs, ['P', 2]).ellipsoidal_shape())
-quad
->>> print(Cell(rdggs, ['N', 2]).ellipsoidal_shape())
-dart
-
    -
    -
    - -
    -
    -index(order='resolution')¶
    -

    Return the index of self when it’s ordered according to order. -Here order can be ‘resolution’ (default) or ‘post’. -Indices start at 0. -The empty cell has index None.

    -

    The ordering comes from the way of traversing the tree T -of all cells defined as follows. -The root of T is a non-cell place holder. -The children of the root are the cells A < B < ... < F. -The children of a cell in T with suid s are s0 < s1 < ... < sn, -where n = self.N_side**2.

    -

    The level order index of a nonempty cell is its position -(starting from 0) in the level order traversal of T starting at cell A.

    -

    The post order index of a nonempty cell is its position -(starting from 0) in the post order traversal of T.

    -

    EXAMPLES:

    -
    >>> rdggs = UNIT_003
->>> c = Cell(rdggs, ['N', 2])
->>> print(c.index(order='resolution'))
-8
->>> print(c.index(order='post'))
-2
-
    -
    -
    - -
    -
    -interior(n=2, plane=True, flatten=False)¶
    -

    Return an n x n matrix of interior points of this cell. -If the cell is planar, space the interior points on a regular -square grid. -List the points in standard, row-major matrix order. -If the cell is ellipsoidal, project the matrix of points to the -ellipsoid (longitude-latitude points). -If flatten = True, then flatten the matrix into a one dimensional -array of pairs.

    -

    EXAMPLES:

    -
    >>> rdggs = UNIT_003
->>> c = rdggs.cell(['N'])
->>> for p in c.interior(n=2, plane=False, flatten=True):
-...     print(my_round(p, 14))
-(90.0, 41.810380145353903)
-(-180.0, 41.810380145353903)
-(-1e-14, 41.810380145353903)
-(-90.0, 41.810380145353903)
->>> all([c.contains(p) for p in c.interior(n=5, plane=True, flatten=True)])
-True
-
    -
    -
    - -
    -
    -intersects_meridian(lam)¶
    -

    Return True if this ellipsoidal cell’s boundary intersects the -meridian of longitude lam, and return False otherwise.

    -

    EXAMPLES:

    -
    >>> rdggs = WGS84_003_RADIANS
->>> c = rdggs.cell(['N', 6])
->>> print(c.intersects_meridian(-pi))
-True
->>> print(c.intersects_meridian(-pi/2))
-False
-
    -
    -
    - -
    -
    -intersects_parallel(phi)¶
    -

    Return True if this cell’s boundary intersects the parallel of latitude -phi, and return False otherwise.

    -
    - -
    -
    -neighbor(direction, plane=True)¶
    -

    Return this cell’s (edge) neighbor in the given direction. -If plane = True, then the direction is one of the strings -‘up’, ‘right’, ‘down’, ‘left’, which indicates the desired neighbor -relative to x-y coordinates -in the following planar neighbor diagram, (drawn for self.N_side = 3) -where self is the middle cell

    -
                 up
-           *-----*
-           |     |
-           |     |
-           |     |
-     *-----*-----*-----*
-     |     | 012 |     |
-left |     | 345 |     | right 
-     |     | 678 |     |
-     *-----*-----*-----*
-           |     |
-           |     |
-           |     |
-           *-----*
-            down
    -
    -

    If plane = False, then the direction is relative to -longitude-latitude coordinates and is one of the strings -‘west’, ‘east’, ‘north’, ‘south’ for a quad or skew quad cell; -‘west’, ‘east’, ‘southwest’, ‘southeast’ for a northern dart cell; -‘west’, ‘east’, ‘northwest’, ‘northeast’ for a southern dart cell; -‘south_0’, ‘south_1’, ‘south_2’, ‘south_3’ for a northern cap cell; -‘north_0’, ‘north_1’, ‘north_2’, ‘north_3’ for a southern cap cell; -For a cap cell, neighbor directions are numbered in increasing -longitude, so that the longitude of the (nucleus of) north_0 is less -than the longitude of north_1 is less than the longitude of north_2 is -less than the longitude of north_3, and the longitude of the south_0 is -less than the longitude of south_1, etc.

    -

    The tricky part in the planar scenario is that the neighbor -relationships of the six resolution 0 cells is determined by the -positions of those cells on the surface of a cube, -one cell on each face, and not on a plane. -So sometimes rotating cells is needed to compute neighbors.

    -

    Return None if the given direction is invalid for this cell.

    -

    EXAMPLES:

    -
    >>> c = Cell(RHEALPixDGGS(), ['N', 0])
->>> print(c.neighbor('down'))
-N3
-
    -
    -
    - -
    -
    -neighbors(plane=True)¶
    -

    Return this cell’s planar or ellipsoidal (edge) neighbors -as a dictionary whose keys are the directions of the neighbors. -See neighbor() for a list of valid directions.

    -

    EXAMPLES:

    -
    >>> c = Cell(RHEALPixDGGS(), ['N', 0])
->>> for k, v in sorted(c.neighbors().items()):
-...     print(k, v)
-... 
-down N3
-left R0
-right N1
-up Q2
-
    -
    -
    - -
    -
    -nucleus(plane=True)¶
    -

    Return the nucleus and vertices of this planar or ellipsoidal cell -in the order (nucleus, upper left corner, lower left corner, -lower right corner, upper right corner) with reference to the -planar cell. -The output for ellipsoidal cells is the projection onto the ellipsoid -of the output for planar cells. In particular, while the -nucleus of a planar cell is its centroid, the nucleus -of an ellipsoidal cell is not its centroid. -To compute the centroid of a cell, use centroid() below.

    -

    EXAMPLES:

    -
    >>> rdggs = UNIT_003
->>> c = rdggs.cell(['N'])
->>> print(my_round(c.nucleus(), 14))
-(-2.35619449019234, 1.5707963267949001)
-
    -
    -
    - -
    -
    -nw_vertex(plane=True)¶
    -

    If plane = False, then return the northwest vertex of this -ellipsoidal cell. -If plane = True, then return the projection onto the plane -of the ellipsoidal northwest vertex. -On quad cells and cap cells, this function returns the same output -as ul_vertex(). -On skew quad cells and dart cells, this function returns output -different from ul_vertex().

    -

    WARNING: The northwest vertex of a cell might not lie in the cell, -because not all cells contain their boundary.

    -
    -
    EXAMPLES::
    -
    >>> rdggs = RHEALPixDGGS()
->>> c = rdggs.cell(['P', 5, 7]) # Quad cell.
->>> print(my_round(c.ul_vertex(plane=True), 14))
-(-2225148.7007489, -556287.17518722452)
->>> print(my_round(c.nw_vertex(plane=True), 14))
-(-2225148.7007489, -556287.17518722452)
-
    -
    -
    >>> c = rdggs.cell(['S', 4])  # Cap cell.
->>> print(my_round(c.ul_vertex(plane=True), 14))
-(-16688615.255616743, -8344307.6278083706)
->>> print(my_round(c.nw_vertex(plane=True), 14))
-(-16688615.255616743, -8344307.6278083706)
-
    -
    -
    >>> c = rdggs.cell(['N', 4, 3]) # Skew quad cell.
->>> print(my_round(c.ul_vertex(plane=True), 14))
-(-16688615.255616743, 10569456.32855727)
->>> print(my_round(c.nw_vertex(plane=True), 14))
-(-15576040.905242294, 10569456.32855727)
-
    -
    -
    >>> c = rdggs.cell(['S', 4, 3])  # Skew quad cell.
->>> print(my_round(c.ul_vertex(plane=True), 14))
-(-16688615.255616743, -9456881.9781828206)
->>> print(my_round(c.nw_vertex(plane=True), 14))
-(-16688615.255616743, -10569456.32855727)
-
    -
    -
    >>> c = rdggs.cell(['N', 6, 2])  # Dart cell.
->>> print(my_round(c.ul_vertex(plane=True), 14))
-(-17801189.605991192, 8344307.6278083716)
->>> print(my_round(c.nw_vertex(plane=True), 14))
-(-16688615.255616743, 8344307.6278083716)
-
    -
    -
    >>> c = rdggs.cell(['S', 6, 2])  # Dart cell.
->>> print(my_round(c.ul_vertex(plane=True), 14))
-(-17801189.605991192, -11682030.678931719)
->>> print(my_round(c.nw_vertex(plane=True), 14))
-(-16688615.255616743, -12794605.029306168)
-
    -
    -
    -
    -
    - -
    -
    -predecessor(resolution=None)¶
    -

    Return the greatest resolution resolution cell less than self. -Note: self need not be a resolution resolution cell.

    -

    EXAMPLES:

    -
    >>> c = Cell(RHEALPixDGGS(), ('N', 0, 8))
->>> print(c.predecessor())
-N07
->>> print(c.predecessor(0))
-None
->>> print(c.predecessor(1))
-None
->>> print(c.predecessor(3))
-N088
-
    -
    -
    - -
    -
    -random_point(plane=True)¶
    -

    Return a random point in this cell. -If plane = True, then choose the point from -the planar cell. -Otherwise, choose the point from the ellipsoidal cell.

    -

    EXAMPLES:

    -
    >>> c = Cell(RHEALPixDGGS(), ['N', 0])
->>> print(c.random_point(plane=False))  
-(1.4840291937583836, 0.90042819146088571)
-
    -
    -
    - -
    -
    -region()¶
    -

    Return the region of this cell: ‘equatorial’, ‘north_polar’, or -‘south_polar’.

    -

    EXAMPLES:

    -
    >>> rdggs = RHEALPixDGGS()
->>> print(Cell(rdggs, ['P', 2]).region())
-equatorial
->>> print(Cell(rdggs, ['N', 2]).region())
-north_polar
-
    -
    -
    - -
    -
    -rotate(quarter_turns)¶
    -

    Return the cell that is the result of rotating this cell’s -resolution 0 supercell by quarter_turns quarter turns anticlockwise. -Used in neighbor().

    -

    EXAMPLES:

    -
    >>> c = Cell(RHEALPixDGGS(), ['N', 0])
->>> print([str(c.rotate(t)) for t in range(4)])
-['N0', 'N2', 'N8', 'N6']
-
    -
    -
    - -
    -
    -rotate_entry(x, quarter_turns)¶
    -

    Let N = self.N_side and rotate the N x N matrix of subcell numbers

    -
    0        1          ... N - 1
-N        N+1        ... 2*N - 1
-...
-(N-1)*N  (N-1)*N+1  ... N**2-1
    -
    -

    anticlockwise by quarter_turns quarter turns to obtain a -new table with entries f(0), f(1), ..., f(N**2 - 1) read from -left to right and top to bottom. -Given entry number x in the original matrix, return f(x). -Used in rotate().

    -

    INPUT:

    -
      -
    • x - A letter from RHEALPixDGGS.cells0 or one of the integers -0, 1, ..., N**2 - 1.
      • -
    • quarter_turns - 0, 1, 2, or 3.
      • -
    -

    EXAMPLES:

    -
    >>> c = Cell(RHEALPixDGGS(), ['P', 2])
->>> print([c.rotate_entry(0, t) for t in range(4)])
-[0, 2, 8, 6]
-
    -
    -

    NOTES:

    -

    Operates on letters from RHEALPixDGGS.cells0 too. -They stay fixed under f. -Only depends on self through self.N_side.

    -
    - -
    -
    -subcell(other)¶
    -

    Subcell (subset) relation on cells.

    -

    EXAMPLES:

    -
    >>> a = Cell(RHEALPixDGGS(), ('N', 1))
->>> b = Cell(RHEALPixDGGS(), ['N'])
->>> print(a.subcell(b))
-True
->>> print(b.subcell(a))
-False
-
    -
    -
    - -
    -
    -subcells(resolution=None)¶
    -

    Generator function for the set of all resolution resolution subcells -of this cell. -If resolution=None, then return a generator function for the children -of this cell.

    -

    EXAMPLES:

    -
    >>> c = Cell(RHEALPixDGGS(), ['N'])
->>> print([str(cell) for cell in c.subcells()])
-['N0', 'N1', 'N2', 'N3', 'N4', 'N5', 'N6', 'N7', 'N8']
-
    -
    -
    - -
    -
    -successor(resolution=None)¶
    -

    Return the least resolution resolution cell greater than self. -Note: self need not be a resolution resolution cell.

    -

    EXAMPLES:

    -
    >>> c = Cell(RHEALPixDGGS(), ('N', 8, 2))
->>> print(c.successor())
-N83
->>> print(c.successor(0))
-O
->>> print(c.successor(1))
-O0
->>> print(c.successor(3))
-N830
-
    -
    -
    - -
    -
    -static suid_from_index(rdggs, index, order='resolution')¶
    -

    Return the suid of a cell from its index. -The index is according to the cell ordering order, -which can be ‘resolution’ (default) or ‘post’. -See the index() docstring for more details on orderings. -For internal use.

    -
    - -
    -
    -suid_rowcol()¶
    -

    Return the pair of row- and column-suids of self, each as tuples.

    -

    EXAMPLES:

    -
    >>> rdggs = RHEALPixDGGS()
->>> c = Cell(rdggs, ['N', 7, 3])
->>> rsuid, csuid = c.suid_rowcol()
->>> print(rsuid == ('N', 2, 1))
-True
->>> print(csuid == ('N', 1, 0))
-True
-
    -
    -
    - -
    -
    -ul_vertex(plane=True)¶
    -

    If plane = True, then return the upper left vertex of this -planar cell. -If plane = False, then return the projection onto the ellipsoid -of the planar upper left vertex. -Note that for polar cells, this projection is not necessarily the -northwest vertex. -For the latter vertex use nw_vertex().

    -

    WARNING: The upper left vertex of a cell might not lie in the cell, -because not all cells contain their boundary.

    -

    EXAMPLES:

    -
    >>> c = Cell(UNIT_003, ['N', 0])
->>> print(c.ul_vertex() == (-pi, 3*pi/4))
-True
-
    -
    -
    - -
    -
    -vertices(plane=True, trim_dart=False)¶
    -

    If plane = True, then assume this cell is planar and return -its four vertices in the order (upper left corner, upper right corner, -lower right corner, lower left corner). -If plane = False, then assume this cell is ellipsoidal and return -the projection of the planar vertices in the order -(northwest, northeast, southeast, southwest). -If plane = False, this cell is a dart cell, and -trim_dart = True, then remove the one non-vertex point from -the output. (Dart cells only have three vertices.)

    -

    EXAMPLES:

    -
    >>> rdggs = UNIT_003
->>> c = rdggs.cell(['N'])
->>> for p in c.vertices():
-...     print(my_round(p, 14))
-(-3.14159265358979, 2.35619449019234)
-(-1.5707963267949001, 2.35619449019234)
-(-1.5707963267949001, 0.78539816339745006)
-(-3.14159265358979, 0.78539816339745006)
-
->>> rdggs = WGS84_003
->>> c = rdggs.cell(['N', 0])
->>> for p in c.vertices(plane=False):
-...     print(my_round(p, 14))
-(89.999999999999929, 74.39069094879062)
-(119.99999999999999, 41.87385774220941)
-(90.0, 41.87385774220941)
-(60.000000000000007, 41.87385774220941)
-
->>> for p in c.vertices(plane=False, trim_dart=True):
-...     print(my_round(p, 14))
-(89.999999999999929, 74.39069094879062)
-(119.99999999999999, 41.87385774220941)
-(60.000000000000007, 41.87385774220941)
-
->>> c = rdggs.cell(['S', 0])
->>> for p in c.vertices(plane=False):
-...     print(my_round(p, 14))
-(149.99999999999997, -41.87385774220941)
-(-180.0, -41.87385774220941)
-(-150.0, -41.87385774220941)
-(-180.0, -74.390690948790649)
->>> for p in c.vertices(plane=False, trim_dart=True):
-...     print(my_round(p, 14))
-(149.99999999999997, -41.87385774220941)
-(-150.0, -41.87385774220941)
-(-180.0, -74.390690948790649)
-
    -
    -
    - -
    -
    -width(plane=True)¶
    -

    Return the width of this cell. -If plane = False, then return None, because ellipsoidal cells -don’t have a fixed width.

    -

    EXAMPLES:

    -
    >>> c = Cell(UNIT_003, ('N', 8))
->>> print(c)
-N8
->>> c.width() == pi/2*3**(-1)
-True
-
    -
    -
    - -
    -
    -xy_range()¶
    -

    Return the x- and y-coordinate extremes of the planar version of -this cell in the format ((x_min, x_max), (y_min, y_max)).

    -

    EXAMPLES:

    -
    >>> rdggs = UNIT_003
->>> c = rdggs.cell(['N'])
->>> c.xy_range() == ((-pi, -pi/2), (pi/4, 3*pi/4))
-True
-
    -
    -
    - -
    - -
    -
    -class rhealpix_dggs.dggs.RHEALPixDGGS(ellipsoid=<rhealpix_dggs.ellipsoids.Ellipsoid object at 0x102a08b90>, N_side=3, north_square=0, south_square=0, max_areal_resolution=1)¶
    -

    Bases: object

    -

    Represents an rHEALPix DGGS on a given ellipsoid.

    -

    CLASS ATTRIBUTES:

    -
      -
    • cells0 - A list of the resolution 0 cell IDs (strings).
      • -
    -

    INSTANCE ATTRIBUTES:

    -
      -
    • ellipsoid - The underlying ellipsoid (Ellipsoid instance).
      • -
    • N_side - An integer of size at least 2. -Each planar cell has N_side x N_side child cells.
      • -
    • (north_square, south_square) - Integers between 0 and 3 indicating -the positions of north polar and south polar squares, respectively, -of the rHEALPix projection used.
      • -
    • max_areal_resolution - An area measured in square meters that -upper bounds the area of the smallest ellipsoidal grid cells.
      • -
    • max_resolution - A nonnegative integer that is the maximum grid -resolution needed to have ellipsoidal cells of area at most -max_areal_resolution.
      • -
    • child_order - A dictionary of the ordering (Morton order) of child -cells of a cell in terms of the row-column coordinates in the matrix -of child cells. Child cell are numbered 0 to N_side**2 -1 from -left to right and top to bottom.
      • -
    • ul_vertex - A dictionary with key-value pairs (c, (x, y)), where -c is an element of cells0 and (x, y) is the upper left corner point -of the resolution 0 planar cell c.
      • -
    • atomic_neighbors - A dictionary with key-value pairs -(n, {‘up’: a, ‘down’: b, ‘left’: c, ‘right’: d}), -where n, a, b, c, and d are elements of cells0 or -{0, 1, ..., N_side**2 -1}. -Describes the planar (edge) neighbors of cell0 letter / child cell number -n.
      • -
    -

    NOTE:

    -

    Several RHEALPixDGGS methods have the keyword argument ‘plane’. -Setting it to True indicates that all input and output points and cells are -interpreted as lying in the planar DGGS. -Setting it to False indicates that they are interpreted as lying in -the ellipsoidal DGGS.

    -
    -
    -cell(suid=None, level_order_index=None, post_order_index=None)¶
    -

    Return a cell (Cell instance) of this DGGS either from its ID or -from its resolution and index.

    -

    EXAMPLES:

    -
    >>> rdggs = RHEALPixDGGS()
->>> c = rdggs.cell(('N', 4, 5))
->>> print(isinstance(c, Cell))
-True
->>> print(c)
-N45
-
    -
    -
    - -
    -
    -cell_area(resolution, plane=True)¶
    -

    Return the area of a planar or ellipsoidal cell at the given -resolution.

    -

    EXAMPLES:

    -
    >>> rdggs = UNIT_003
->>> a = rdggs.cell_area(1) 
->>> print(a == (pi/6)**2)
-True
->>> print(rdggs.cell_area(1, plane=False) == 8/(3*pi)*a)
-True
-
    -
    -
    - -
    -
    -cell_from_point(resolution, p, plane=True)¶
    -

    Return the resolution resolution cell that contains the point p. -If plane = True, then p and the output cell lie in the -planar DGGS. -Otherwise, p and the output cell lie in the ellipsoidal DGGS.

    -

    EXAMPLES:

    -
    >>> rdggs = RHEALPixDGGS()
->>> p = (0, 0)
->>> c = rdggs.cell_from_point(1, p)
->>> print(c)
-Q3
-
    -
    -
    - -
    -
    -cell_from_region(ul, dr, plane=True)¶
    -

    Return the smallest planar or ellipsoidal cell wholly containing -the region bounded by the axis-aligned rectangle with upper left -and lower right vertices given by the the points ul and dr, -respectively. -If such as cell does not exist, then return None. -If plane = True, then ul and dr and the returned cell -lie in the planar DGGS. -Otherwise, ul and dr and the returned cell lie in the ellipsoidal -DGGS.

    -

    To specify an ellipsoidal cap region, set ul = (-pi, pi/2) and -dr = (-pi, phi) for a northern cap from latitudes pi/2 to phi, or -set ul = (-pi, phi) and dr = (-pi, -pi/2) for a southern cap from -latitudes phi to -pi/2. -(As usual, if self.ellipsoid.radians = False, -then use degrees instead of radians when specifying ul and dr.)

    -

    EXAMPLES:

    -
    >>> rdggs = UNIT_003
->>> p = (0, pi/12)
->>> q = (pi/6 - 1e-6, 0)
->>> c = rdggs.cell_from_region(p, q)
->>> print(c)
-Q3
-
    -
    -
    - -
    -
    -cell_latitudes(resolution, phi_min, phi_max, nucleus=True, plane=True)¶
    -

    Return a list of every latitude phi whose parallel intersects -a resolution resolution cell nucleus and satisfies -phi_min < phi < phi_max. -If plane = True, then use rHEALPix y-coordinates for phi_min, -phi_max, and the result. Return the list in increasing order. -If nucleus = False, then return a list of every latitude phi whose -parallel intersects the north or south boundary of a resolution -resolution cell and that satisfies phi_min < phi < phi_max.

    -

    NOTE:

    -

    By convention, the pole latitudes pi/2 and -pi/2 (or their -corresponding rHEALPix y-coordinates) will be excluded.

    -

    There are 2*self.N_side**resolution - 1 nuclei -latitudes between the poles if self.N_side is odd and -2*self.N_side**resolution if self.N_side is even. -Consequently, there are 2*self.N_side**resolution -boundary latitudes between the poles if self.N_side is odd and -2*self.N_side**resolution - 1 boundary latitudes if self.N_side is -even.

    -

    EXAMPLES:

    -
    >>> rdggs = WGS84_003_RADIANS
->>> for phi in rdggs.cell_latitudes(1, -pi/2, pi/2, plane=False):
-...     print(my_round(phi, 14))
--1.020505844
--0.461443149003
--0
-0.461443149003
-1.020505844
-1.57079632679
->>> for phi in rdggs.cell_latitudes(1, -pi/2, pi/2, nucleus=False, plane=False):
-...     print(my_round(phi, 14)) 
--1.29836248989
--0.730836688113
--0.224577156195
-0.224577156195
-0.730836688113
-1.29836248989
-
    -
    -
    - -
    -
    -cell_width(resolution, plane=True)¶
    -

    Return the width of a planar cell at the given resolution. -If plane = False, then return None, -because the ellipsoidal cells don’t have constant width.

    -

    EXAMPLES:

    -
    >>> rdggs = UNIT_003
->>> print(rdggs.cell_width(0) == pi/2)
-True
->>> print(rdggs.cell_width(1) == pi/6)
-True
-
    -
    -
    - -
    -
    -cells0 = ['N', 'O', 'P', 'Q', 'R', 'S']¶
    -
    - -
    -
    -cells_from_meridian(resolution, lam, phi_min, phi_max)¶
    -

    Return a list of the resolution resolution cells that intersect -the meridian segment of longitude lam whose least latitude is -phi_min and whose greatest latitude is phi_max. -Sort the cells from north to south and west to east in case -two cells with the same nucleus latitude intersect the -meridian.

    -

    EXAMPLES:

    -
    >>> rdggs = WGS84_003_RADIANS
->>> cells = rdggs.cells_from_meridian(1, 0.1, -pi/2, pi/2)
->>> print([str(cell) for cell in cells])
-['N4', 'N2', 'N1', 'Q0', 'Q3', 'Q6', 'S8', 'S7', 'S4']
-
    -
    -
    - -
    -
    -cells_from_parallel(resolution, phi, lam_min, lam_max)¶
    -

    Return a list of the resolution resolution cells that intersect -the parallel segment of latitude phi whose least longitude is -lam_min and whose greatest longitude is lam_max. -Sort the list from west to east.

    -

    EXAMPLES:

    -
    >>> rdggs = WGS84_003_RADIANS
->>> cells = rdggs.cells_from_parallel(1, pi/3, -pi, pi)
->>> print([str(cell) for cell in cells])
-['N6', 'N7', 'N8', 'N5', 'N2', 'N1', 'N0', 'N3']
-
    -
    -
    - -
    -
    -cells_from_region(resolution, ul, dr, plane=True)¶
    -

    If plane = True, then return a list of lists of resolution -resolution cells that cover the axis-aligned rectangle whose -upper left and lower right vertices are the points ul and dr, -respectively. -In the output, sort each sublist of cells from left to right (in the -planar DGGS) and sort the sublists from top to bottom.

    -

    If plane = False, then return a list of lists of resolution -resolution -cells that cover the longitude-latitude aligned ellipsoidal quadrangle -whose northwest and southeast vertices are the points ul and dr, -respectively. Defunct quads with ul = (stuff, pi/2) or -dr = (stuff, -pi/2) also work -(and rely on the fact that the north and south pole can both -be specified by infinitely many longitudes).

    -

    To specify an ellipsoidal cap region, set ul = (-pi, pi/2) and -dr = (-pi, phi) for a northern cap from latitudes pi/2 to phi, or -set ul = (-pi, phi) and dr = (-pi, -pi/2) for a southern cap from -latitudes phi to -pi/2. (As usual, if self.ellipsoid.radians = False, -then use degrees instead of radians when specifying ul and dr.)

    -

    In the output, sort each sublist of cells from west to east (in the -ellipsoidal DGGS) and sort the sublists from north to south.

    -

    Return the empty list if if ul[0] > dr[0] or ul[1] < dr[1].

    -

    NOTE:

    -

    If plane = True, then the resulting list is a matrix, that is, -each sublist has the same length. This is not necessarily so if -plane = False; see the examples below.

    -

    EXAMPLES:

    -
    >>> rdggs = WGS84_003_RADIANS
->>> R_A = rdggs.ellipsoid.R_A
->>> ul = R_A*array((-0.1, pi/4))
->>> dr = R_A*array((0.1, -pi/4))  # Rectangle 
->>> M = rdggs.cells_from_region(1, ul, dr)
->>> for row in M:
-...     print([str(cell) for cell in row])
-['P2', 'Q0']
-['P5', 'Q3']
-['P8', 'Q6']
-
->>> ul = (0, pi/3)
->>> dr = (pi/2, 0)  # Quad 
->>> M = rdggs.cells_from_region(1, ul, dr, plane=False)
->>> for row in M:
-...     print([str(cell) for cell in row])
-['N2', 'N1', 'N0']
-['Q0', 'Q1', 'Q2', 'R0']
-['Q3', 'Q4', 'Q5', 'R3']
-
->>> ul = (0, -pi/6)
->>> dr = (pi/2, -pi/2)  # Defunct quad / lune segment 
->>> M = rdggs.cells_from_region(1, ul, dr, plane=False)
->>> for row in M:
-...     print([str(cell) for cell in row])
-['Q6', 'Q7', 'Q8', 'R6']
-['S8', 'S7', 'S6']
-['S4']
-
->>> ul = (-pi, -pi/5)  
->>> dr = (-pi, -pi/2)  # Cap
->>> M = rdggs.cells_from_region(1, ul, dr, plane=False)
->>> for row in M:
-...     print([str(cell) for cell in row])
-['O6', 'O7', 'O8', 'P6', 'P7', 'P8', 'Q6', 'Q7', 'Q8', 'R6', 'R7', 'R8']
-['S0', 'S1', 'S2', 'S5', 'S8', 'S7', 'S6', 'S3']
-['S4']
-
    -
    -
    - -
    -
    -combine_triangles(u, v, inverse=False)¶
    -

    Return the combine_triangles() transformation of the point (u, v) -(or its inverse if inverse = True) appropriate to the underlying -ellipsoid. -It maps the HEALPix projection to the rHEALPix projection.

    -

    EXAMPLES:

    -
    >>> rdggs = UNIT_003
->>> p = (0, 0)
->>> q = (-pi/4, pi/2)
->>> print(rdggs.combine_triangles(*p))
-(0.0, 0.0)
->>> print(my_round(rdggs.combine_triangles(*q), 14))
-(-2.35619449019234, 1.5707963267949001)
-
    -
    -
    - -
    -
    -grid(resolution)¶
    -

    Generator function for all the cells at resolution resolution.

    -

    EXAMPLES:

    -
    >>> rdggs = RHEALPixDGGS()
->>> grid0 = rdggs.grid(0)
->>> print([str(x) for x in grid0])
-['N', 'O', 'P', 'Q', 'R', 'S']
-
    -
    -
    - -
    -
    -healpix(u, v, inverse=False)¶
    -

    Return the HEALPix projection of point (u, v) (or its inverse if -inverse = True) appropriate to this rHEALPix DGGS.

    -

    EXAMPLES:

    -
    >>> rdggs = UNIT_003_RADIANS
->>> print(my_round(rdggs.healpix(-pi, pi/2), 14))
-(-2.35619449019234, 1.5707963267949001)
-
    -
    -

    NOTE:

    -

    Uses pj_healpix instead of the PROJ.4 version of HEALPix.

    -
    - -
    -
    -interval(a, b)¶
    -

    Generator function for all the resolution -max(a.resolution, b.resolution) cells between cell -a and cell b (inclusive and with respect to the -postorder ordering on cells). -Note that a and b don’t have to lie at the same resolution.

    -

    EXAMPLES:

    -
    >>> rdggs = RHEALPixDGGS()
->>> a = rdggs.cell(('N', 1))
->>> b = rdggs.cell(('N',))
->>> print([str(c) for c in list(rdggs.interval(a, b))])
-['N1', 'N2', 'N3', 'N4', 'N5', 'N6', 'N7', 'N8']
-
    -
    -
    - -
    -
    -minimal_cover(resolution, points, plane=True)¶
    -

    Find the minimal set of resolution resolution cells that covers -the list of points points. -If plane = True, then assume points is a list of x-y -coordinates in the planar DGGS. -If plane = False, then assume points is a list of -longitude-latitude coordinates in the ellipsoidal DGGS. -This method will be made redundant by standard GIS rasterization -tools that implement the rHEALPix projection.

    -

    EXAMPLES:

    -
    >>> rdggs = RHEALPixDGGS()
->>> c1 = rdggs.cell(['N', 0, 2, 1])
->>> c2 = rdggs.cell(['P', 7, 3, 3])
->>> points = [c.nucleus() for c in [c1, c2]]
->>> for r in range(5):
-...     cover = sorted(rdggs.minimal_cover(r, points))
-...     print([str(c) for c in cover])
-['N', 'P']
-['N0', 'P7']
-['N02', 'P73']
-['N021', 'P733']
-['N0214', 'P7334']
-
    -
    -
    - -
    -
    -num_cells(res_1, res_2=None, subcells=False)¶
    -

    Return the number of cells of resolutions res_1 to res_2 -(inclusive). -Assume res_1 <= res_2. -If subcells = True, then return the number of subcells at resolutions -res_1 to res_2 (inclusive) of a cell at resolution res_1. -If res_2=None and subcells=False, then return the number of -cells at resolution `res_1. -If res_2=None and subcells = True, then return the number of -subcells from resolution res_1 to resolution self.max_resolution.

    -

    EXAMPLES:

    -
    >>> rdggs = RHEALPixDGGS()
->>> rdggs.num_cells(0)
-6
->>> rdggs.num_cells(0, 1)
-60
->>> rdggs.num_cells(0, subcells=True)
-231627523606480
->>> rdggs.num_cells(0, 1, subcells=True)
-10
->>> rdggs.num_cells(5, 6, subcells=True)
-10
-
    -
    -
    - -
    -
    -plot_cells(cells, surface='plane', label=True, fontsize=15, saturation=0.5)¶
    -

    Plot the given list of cells on the given surface. -The cells should all come from the same rHEALPix DGGS. -Inessential graphics method. -Requires Sage graphics methods.

    -

    INPUT:

    -
      -
    • cells - A list of cells from a common rHEALPix DGGS.
      • -
    • surface - (Optional; default = ‘plane’). -One of the strings ‘plane’, ‘plane_lonlat’, ‘cube’, or ‘ellipsoid’. -Surface to draw cells on.
      • -
    • label - (Optional; default = True). If True, then label cells -with their names. If False, then don’t.
      • -
    • saturation - (Optional) Number between 0 and 1 indicating the -saturation value of the cell color.
      • -
    -
    - -
    -
    -random_cell(resolution=None)¶
    -

    Return a cell of the given resolution chosen uniformly at random -from all cells at that resolution. -If resolution=None, then the cell resolution is first chosen -uniformly at random from [0,..,self.max_resolution].

    -

    EXAMPLES:

    -
    >>> print(RHEALPixDGGS().random_cell()) 
-S480586367780080
-
    -
    -
    - -
    -
    -random_point(plane=True)¶
    -

    Return a point in this DGGS sampled uniformly at -random from the plane or from the ellipsoid.

    -

    EXAMPLES:

    -
    >>> rdggs = RHEALPixDGGS()
->>> print(E.random_point()) 
-(-1.0999574573422948, 0.21029104897701129)
-
    -
    -
    - -
    -
    -rhealpix(u, v, inverse=False)¶
    -

    Return the rHEALPix projection of the point (u, v) (or its inverse if -inverse = True) appropriate to this rHEALPix DGGS.

    -

    EXAMPLES:

    -
    >>> rdggs = UNIT_003_RADIANS
->>> print(my_round(rdggs.rhealpix(0, pi/3), 14))
-(-1.8582720066839999, 2.0687188103032401)
-
    -
    -

    NOTE:

    -

    Uses pj_rhealpix instead of the PROJ.4 version of rHEALPix.

    -
    - -
    -
    -triangle(x, y, inverse=True)¶
    -

    If inverse = False, then assume (x,y) lies in the image of the -HEALPix projection that comes with this DGGS, and -return the number of the HEALPix polar triangle (0, 1, 2, 3, or None) -and the region (‘north_polar’, ‘south_polar’, or ‘equatorial’) that -(x, y) lies in. -If inverse = True, then assume (x, y) lies in the image of -the rHEALPix projection that comes with this DGGS, map (x, y) -to its HEALPix image (x’, y’), and return the number of the HEALPix -polar triangle and the region that (x’, y’) lies in. -If (x, y) lies in the equatorial region, then the triangle number -returned is None.

    -

    OUTPUT:

    -

    The pair (triangle_number, region).

    -

    NOTES:

    -

    This is a wrapper for pjr.triangle().

    -

    EXAMPLES:

    -
    >>> rdggs = RHEALPixDGGS()
->>> c = rdggs.cell(['N', 7])
->>> print(rdggs.triangle(*c.nucleus(), inverse=True))
-(0, 'north_polar')
-
->>> c = rdggs.cell(['N', 3])
->>> print(rdggs.triangle(*c.nucleus(), inverse=True))
-(3, 'north_polar')
-
->>> c = rdggs.cell(['P', 3])
->>> print(rdggs.triangle(*c.nucleus(), inverse=True))
-(None, 'equatorial')
-
->>> c = rdggs.cell(['S', 5, 2])
->>> print(rdggs.triangle(*c.nucleus(), inverse=True))
-(1, 'south_polar')
-
    -
    -
    - -
    -
    -xyz(u, v, lonlat=False)¶
    -

    Given a point (u, v) in the planar image of the rHEALPix projection, -project it back to the ellipsoid and return its 3D rectangular -coordinates. -If lonlat = True, then assume (u, v) is a longitude-latitude -point.

    -

    EXAMPLES:

    -
    >>> rdggs = UNIT_003_RADIANS
->>> print(my_round(rdggs.xyz(0, pi/4, lonlat=True), 14))
-(0.70710678118655002, 0.0, 0.70710678118655002)
-
    -
    -
    - -
    -
    -xyz_cube(u, v, lonlat=False)¶
    -

    Given a point (u, v) in the planar version of this rHEALPix DGGS, -fold the rHEALPix image into a cube centered at the origin, -and return the resulting point’s 3D rectangular coordinates. -If lonlat = True, then assume (u, v) is a longitude-latitude -point.

    -

    EXAMPLES:

    -
    >>> rdggs = UNIT_003
->>> print(my_round(rdggs.xyz_cube(0, 0), 14))
-(0.78539816339745006, 0.0, -0.78539816339745006)
-
    -
    -
    - -
    - -
    - - -
    -
    -
    -
    -
    -

    This Page

    - - - -
    -
    -
    -
    -
    -

    Navigation

    - -
    -
    - © Copyright 2013, Alexander Raichev. - Created using Sphinx 1.1.3. -
    - - \ No newline at end of file diff --git a/docs/build/html/search.html b/docs/build/html/search.html index 00e7c66..34b740e 100644 --- a/docs/build/html/search.html +++ b/docs/build/html/search.html @@ -1,41 +1,30 @@ + - - - - + - + + + Search — rHEALPixDGGS 0.5.4 documentation + + - Search — rHEALPixDGGS 0.5.1 documentation - - + + + + + - - - - - - - - + + + + + - - -
    + +
    -
    +

    Search

    -
    - + + + +

    - From here you can search these documents. Enter your search - words into the box below and click "search". Note that the search - function will automatically search for all of the words. Pages - containing fewer words won't appear in the result list. + Searching for multiple words only shows matches that contain + all words.

    + +
    - +
    + +
    + +
    -
    +
    -
    + -
    - © Copyright 2013, Alexander Raichev. - Created using Sphinx 1.1.3. + \ No newline at end of file diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index 6c7a687..ed8689d 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:attribute"},filenames:["distortion","projection_wrapper","pj_healpix","pj_rhealpix","ellipsoids","index","utils","introduction","dggs"],titles:["The distortion Module","The projection_wrapper Module","The pj_healpix Module","The pj_rhealpix Module","The ellipsoids Module","Welcome the rHEALPixDGGS documentation!","The utils Module","Introduction","The dggs Module"],objects:{"rhealpix_dggs.ellipsoids":{Ellipsoid:[4,2,1,""]},rhealpix_dggs:{distortion:[0,0,1,""],dggs:[8,0,1,""],ellipsoids:[4,0,1,""],pj_rhealpix:[3,0,1,""],utils:[6,0,1,""],projection_wrapper:[1,0,1,""],pj_healpix:[2,0,1,""]},"rhealpix_dggs.dggs.RHEALPixDGGS":{cell_area:[8,1,1,""],num_cells:[8,1,1,""],cell:[8,1,1,""],random_point:[8,1,1,""],cells_from_parallel:[8,1,1,""],interval:[8,1,1,""],cells_from_region:[8,1,1,""],random_cell:[8,1,1,""],cell_from_region:[8,1,1,""],rhealpix:[8,1,1,""],minimal_cover:[8,1,1,""],combine_triangles:[8,1,1,""],cell_from_point:[8,1,1,""],cell_latitudes:[8,1,1,""],cells0:[8,3,1,""],triangle:[8,1,1,""],cells_from_meridian:[8,1,1,""],cell_width:[8,1,1,""],healpix:[8,1,1,""],plot_cells:[8,1,1,""],xyz:[8,1,1,""],xyz_cube:[8,1,1,""],grid:[8,1,1,""]},"rhealpix_dggs.ellipsoids.Ellipsoid":{pi:[4,1,1,""],graticule:[4,1,1,""],meridian:[4,1,1,""],get_points:[4,1,1,""],lattice:[4,1,1,""],xyz:[4,1,1,""],parallel:[4,1,1,""],random_point:[4,1,1,""]},"rhealpix_dggs.dggs":{RHEALPixDGGS:[8,2,1,""],Cell:[8,2,1,""]},"rhealpix_dggs.utils":{my_round:[6,1,1,""],wrap_latitude:[6,1,1,""],wrap_longitude:[6,1,1,""],auth_rad:[6,1,1,""],auth_lat:[6,1,1,""]},"rhealpix_dggs.distortion":{distortion:[0,1,1,""],distortion_stats:[0,1,1,""],utm_zone:[0,1,1,""],fff_coeffs:[0,1,1,""],scale_factors:[0,1,1,""]},"rhealpix_dggs.dggs.Cell":{subcell:[8,1,1,""],vertices:[8,1,1,""],color:[8,1,1,""],suid_rowcol:[8,1,1,""],random_point:[8,1,1,""],predecessor:[8,1,1,""],xy_range:[8,1,1,""],boundary:[8,1,1,""],neighbor:[8,1,1,""],nucleus:[8,1,1,""],intersects_parallel:[8,1,1,""],index:[8,1,1,""],ul_vertex:[8,1,1,""],ellipsoidal_shape:[8,1,1,""],rotate:[8,1,1,""],subcells:[8,1,1,""],rotate_entry:[8,1,1,""],intersects_meridian:[8,1,1,""],successor:[8,1,1,""],interior:[8,1,1,""],width:[8,1,1,""],neighbors:[8,1,1,""],contains:[8,1,1,""],centroid:[8,1,1,""],area:[8,1,1,""],region:[8,1,1,""],nw_vertex:[8,1,1,""],suid_from_index:[8,1,1,""]},"rhealpix_dggs.pj_rhealpix":{in_rhealpix_image:[3,1,1,""],triangle:[3,1,1,""],rhealpix_ellipsoid:[3,1,1,""],combine_triangles:[3,1,1,""],rhealpix_ellipsoid_inverse:[3,1,1,""],rhealpix_vertices:[3,1,1,""],rhealpix_sphere_inverse:[3,1,1,""],rhealpix_sphere:[3,1,1,""],rhealpix:[3,1,1,""],rhealpix_diagram:[3,1,1,""]},"rhealpix_dggs.pj_healpix":{in_healpix_image:[2,1,1,""],healpix_diagram:[2,1,1,""],healpix_ellipsoid_inverse:[2,1,1,""],healpix:[2,1,1,""],healpix_vertices:[2,1,1,""],healpix_ellipsoid:[2,1,1,""],healpix_sphere:[2,1,1,""],healpix_sphere_inverse:[2,1,1,""]},"rhealpix_dggs.projection_wrapper":{Proj:[1,2,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","attribute","Python attribute"]},terms:{build:7,alexand:[0,1,2,6,8,4,3,7],packag:7,imag:[0,8,2,3],cap:8,don:8,you:[0,7],slighli:8,get:[2,3],equatori:[8,4,3],correspond:8,n0214:8,minimal_cov:8,context:4,each:[0,8],discret:[0,8,7],upper:8,proj:[0,1,7,8,4,6],relationship:8,"0x102a08b90":[],string:[1,8],n83:8,grid0:8,util:[5,6],dggss:7,latitud:[0,2,8,4,3,7,6],section:4,research:7,atomic_neighbor:8,"0888874903416268e":7,direct:[8,7],holder:8,shell:7,lat:[8,7],welcom:5,vertex:8,whose:[8,2,3],quarter_turn:8,radiu:[1,2,4,3,7,6],q44:8,calcul:4,arcsin:[0,2,3],cells0:8,paramet:[4,7],"0x102e65dd0":[],want:[0,8],cell0:8,radii:0,southeast:[8,7],after:7,healpix_sphere_invers:2,"24290127534e":[],desir:8,north_2:8,north_3:8,north_0:8,north_1:8,auckland:[8,7],univers:0,plane:[8,7],http:7,bound:[0,8,2],valu:8,contain:[8,4,7],argument:[1,8],flatten:[8,4],comput:[0,2,8,3,7,6],reserv:8,s_a:0,extrem:8,rdgg:[8,7],increas:[8,2],push:8,rhp:3,round:6,who:8,subset:8,invers:[6,1,2,3,8],triaxial:[8,4,7],hereaft:7,northern:8,lat_0:[8,4,7],triangle_numb:[8,3],healpix_vertic:2,isinst:8,match:4,find:[8,7],doesn:7,angular:[0,8],geodet:[8,2,4],standard:[0,6,8,7],becaus:8,ellipsoidal_shap:[8,7],max_areal_r:[],wai:[8,3],object:[1,2,3,4,8],trim_dart:8,thei:[8,6],system:[0,8,7],authal:[6,2,3,4,7],delxdellam:0,fff_coeff:0,sphere:[2,8,4,3,7,6],floor:8,neighbor:[8,7],south_polar:[8,3],requir:[5,8,2,3,7],rotat:8,mean:[0,1,2,8,4,3,7],statist:0,n45:8,child:8,otherwis:[1,2,8,4,3,6],setup:7,northeast:8,clone:7,"function":[0,1,2,8,3,7,6],particular:8,segment:8,shape:[8,7],interv:[8,6],below:[1,2,3,8],filenam:4,phi:[0,2,8,4,3,6],out:[0,2],in_rhealpix_imag:3,numer:0,php:7,interior:8,few:7,integ:[8,3],"while":8,buggi:7,thi:[0,1,2,6,8,4,3,7],necessari:7,measur:[1,2,8,4,3,7,6],phi_max:[8,4],level_order_index:8,rectangl:[0,8],subcel:8,chapter:7,str:[8,7],mercat:0,through:[8,6],s_p:0,delydellam:0,none:[0,1,4,3,8],combin:3,accord:8,print:[0,1,2,6,8,4,3,7],grid:[0,8,2,7],s_m:0,fold:8,oper:[8,7],mathemat:7,combine_triangl:[8,3],correct:[8,7],"2722218725854067e":[],defunct:8,global:[0,8,7],non:8,refer:8,tree:[8,7],repres:[1,4,8],rhealpix_ellipsoid:3,scale:0,need:[1,7,8],both:8,"0x103b63a50":[],grs2013:7,result:8,rhealpix_vertic:3,reflect:6,healpix:[0,1,2,8,4,3,7],projection_wrapp:[0,5,1,7],"0x102e65f10":8,simpli:0,rgb:8,format:8,wgs84_ellipsoid:[1,7,8],includ:7,spheric:[2,3],oblat:[1,2,3],xy_rang:8,projection_tool:0,deviat:[0,7],inclus:8,mark:2,rsuid:8,pj_healpix:[5,1,2,8,7],matplotlib:7,"0x102e86950":[],column:8,port:[0,1,2,8,4,3,6],inst:8,write:8,manipul:[0,8,7],separ:4,nw_vertex:8,nucleu:[8,7],n07:8,n02:8,scale_factor:0,quad:[8,7],odd:8,wrap_latitud:6,my_round:[0,1,2,8,4,3,6],degre:[0,6,8,4,7],now:3,hierarchi:8,kwarg:1,half:6,remain:3,identifi:8,fact:8,transvers:0,impli:4,superus:7,lie:8,edit:7,whitespac:4,file:[4,7],method:[8,2,3,7],cea:1,throughout:[8,4],cells_from_parallel:8,fals:[1,2,8,4,3,7,6],org:7,when:[1,2,3,8],landcar:7,thereupon:7,index:[5,8,7],sampl:[0,8,4,7],max_resolut:[8,7],in_healpix_imag:2,utm_zon:0,notic:2,"0x103fb0750":[],analysi:0,r_a:[8,4,7],lon_0:[8,4,7],roukema:2,major:[0,1,2,6,8,4,3,7],even:8,six:8,satur:8,trac:7,cell_latitud:8,smallest:8,homemade_project:7,areal:[0,7],phi_0:4,cell_width:8,scipi:7,proj4:0,doe:8,base:[0,1,4,8,7],repositori:7,skew:8,speth:7,raster:8,radian:[0,1,2,6,8,4,3,7],"0x1024399d0":[],suid:8,meridian:[0,8,4,7],between:[0,8,4,3],lune:8,via:[1,7],travers:8,"0x102425790":[],num_cel:8,rang:[0,6,8,4,7],test:[8,2,3,7],level:[8,7],"try":7,instanc:[0,1,7,8,4,6],invalid:8,y_max:8,definit:1,attribut:[1,4,8,7],bug:[0,8],healpix_ellipsoid_invers:2,postord:8,max_level:[],pyproj:7,item:[8,7],size:8,deal:7,squar:[8,4,3],minimum:[0,7],length:[1,2,8,4,3,6],south_squar:[1,7,3,8],compris:0,wgs84_ellipsoid_radian:[0,7],distortion_stat:[0,7],cells_from_meridian:8,everi:8,can:[1,7,8],call:[1,6],coordin:[8,2,3,4,7],down:[8,7],surfac:[0,8],nucleus_and_vertic:[],region:[8,4,3],southern:8,cover:8,set:[8,4],tricki:8,translat:8,indic:[1,2,8,4,3,5,6],uniqu:8,auth_rad:6,turn:8,south:[8,7,3],monthli:2,upon:[8,7],"class":[1,4,8,7],see:[1,7,3,8],n830:8,"2204460492503131e":[],seri:6,parallel:[0,8,4,7],worksheet:7,current:7,south_2:8,south_3:8,made:8,random:[0,8,4,7],"0x102e86b50":[],session:7,"0x102e65d50":[1,8],directori:7,wholli:8,accur:6,python:[0,1,2,6,8,4,3,7],some:[8,7],latter:8,figur:2,exampl:[0,1,2,6,8,4,3,7],variou:7,"0x103f05510":[],sign:8,greatest:8,implement:[1,2,8,4,3,7,6],spatial:8,gener:[8,4,7],ellps_1:7,"default":[8,4,3,7],constant:[8,7],polar:[8,2,3,4],orient:[8,7],view:8,output:[0,1,2,8,3,7,6],minor:[0,4],area:[0,8,7],fail:[2,3],left:[6,8,7],kei:8,cell_area:8,languag:8,pick:[8,7],calabretta:2,specifi:[8,4],also:[0,8],longitud:[0,2,8,4,3,7],satisfi:8,doc:[],more:8,north_squar:[1,7,3,8],north_polar:[8,3],random_cel:8,less:[0,8],program:7,sudo:7,self:[8,4],label:[8,3],chang:[8,7],diagram:[8,2,3],than:[0,8],sever:[8,6],etc:8,per:4,wrapper:[1,7,8],onto:8,other:8,resolut:8,row:[8,7],releas:[6,1,2,3,4],list:[0,2,8,4,3,7,6],version:[0,8,7],fix:[0,8,3],numpi:[7,3],child_ord:8,exist:8,mode:[0,7],sublist:[0,8],p73:8,option:[8,7,3],keyword:[1,8],cartograph:7,chosen:[0,8,7],right:[6,8,7],prepar:7,again:7,first:[0,8,7],"static":[],differ:8,lam:[0,2,8,4,3,6],coeffici:0,east:[8,7,3],modulo:8,dart:[8,7],nuclei:[8,7],predecessor:8,predefin:7,top:8,equal:3,cells_from_region:[8,7],"case":[8,2,3],"import":[0,1,7,3,8],document:[5,7],south_1:8,pair:[8,3],nonneg:8,parametr:7,max_areal_resolut:[8,7],lattic:4,necessarili:8,xyz:[8,4],here:[0,8,7,3],graphic:[8,2,3,7],infinit:8,quarter:8,supercel:8,nonempti:8,my_round_numb:0,raichev:[0,1,2,6,8,4,3,7],south_0:8,dgg:[5,8,7],letter:8,healpix_spher:2,modul:[0,1,2,6,8,4,3,5,7],least:8,java:8,helper:6,res_2:8,breviti:7,under:[0,8],tool:8,search:5,successor:8,societi:2,cell:[8,7],term:8,common:[8,7],access:1,random_point:[0,8,4,7],zone:0,equispac:4,rearrang:3,posit:[8,6,3],ellipsoid:[0,1,2,6,8,4,3,5,7],project:[0,1,2,6,8,4,3,7],move:[8,3],lower:8,delydelphi:0,centroid:8,sort:[8,7],entri:[8,7],essenti:0,fundament:[0,7],meter:[1,2,8,4,3,6],ellips:[0,6],describ:[8,2,7],introduct:[5,7],creat:[8,7],work:[0,8,2,3,7],except:[8,4],decreas:2,unit_spher:[4,7],page:5,anticlockwis:8,from:[0,1,2,6,8,4,3,7],auth_lat:6,align:[8,7],within:7,homemad:1,draw:[8,2],signatur:[2,3],rhealpix_ellipsoid_invers:3,two:[8,3],rhealpix_sphere_invers:3,unit_003_radian:[8,7],factor:0,obtain:8,librari:7,suid_from_index:8,minim:8,face:8,wrap_longitud:6,git:7,abbrevi:[8,7],boudewijn:2,mad:0,have:8,side:8,rel:8,basic:7,lonlat:8,circl:6,max:8,binari:7,"0x10297f850":[],text:4,everyth:8,map:[0,1,2,8,3,7,6],rectangular:[8,4],four:8,same:[8,7],west:[8,7,3],plot_cel:8,rhealpix_diagram:3,post:8,royal:2,axi:[8,6],prefer:7,suid_rowcol:8,x_max:8,command:7,skip:[0,8,4,7],planar:[8,2,3,7],warn:8,part:8,round_numb:[],delxdelphi:0,usual:8,skew_quad:[8,7],tutori:7,could:1,north:[8,4,3,7],avail:7,corner:[8,7],should:[1,4,8],come:8,form:[0,1,2,3,8],most:[0,8,4],color:8,respect:[0,8,3],docstr:[8,3],arrai:[8,7],"true":[2,8,4,3,7,6],interfac:7,name:[1,4,8,7],changelog:[0,1,2,8,4,3,6],digit:6,"return":[0,2,8,4,3,6],instead:8,cell_from_region:8,point:[0,2,8,4,3,7,6],code:[1,2,8,4,3,7,6],forward:3,test_dgg:7,power:6,place:8,valid:[1,8],"3611093629270335e":[],rhealpix_spher:3,comprehens:7,"0x102e64b50":[],p733:8,wrap:[2,3],assum:[1,2,8,4,3,7],error:2,ellps_2:7,plane_lonlat:8,uniformli:[0,8,4],children:8,drawn:8,sage:[8,2,3,7],cartographi:6,interpret:8,robert:7,"560649871414923e":[8,7],median:[0,7],stai:8,sagemath:7,hemispher:0,"9999999999999997e":[2,3],onli:[0,8,2,3,7],charact:8,post_order_index:8,underli:8,stat:0,note:[1,2,8,4,3,6],get_point:4,where:[0,1,7,3,8],wgs84_003:[8,7],notebook:7,quadrangl:[8,7],line:[4,7],exclud:8,like:[0,3],n088:8,empti:8,wgs84:[0,8,7],attach:7,south_east:8,tabl:[5,8,7],builtin:[1,4,8],northwest:[8,7],intersects_parallel:8,caro2007:2,origin:[6,8,4,7],inessenti:[8,2,3],sai:7,order:[0,8],element:8,wgs84_a:[8,7],wgs84_f:[8,7],intern:8,which:[8,7],pjr:8,reli:8,either:[1,8],determin:8,michael:7,matrix:8,p_0:8,refactor:[6,1,2,3,4],tissot:0,mani:8,astronom:2,altern:7,angl:[0,1,2,6,8,4,3,7],pole:[8,4,3],number:[6,8,4,3],lon:[8,7],intersect:[8,7],sometim:8,tupl:[8,6],center:8,s480586367780080:8,unless:[1,2,8,4,3,6],input:[8,2,3],fontsiz:8,p_l:8,beta:6,p_i:8,appropri:[8,7],defin:[8,7],"0x1035d7e10":[],peopl:8,small:6,back:8,morton:8,changeset:7,uncombin:3,intersects_meridian:8,doctest:[0,8,4,7],regular:8,plot:[8,7],xyz_cub:8,central:[4,7],detail:8,lam_min:[8,4],master:7,rebuild:7,y_min:8,possibl:4,healpix_diagram:2,given:[0,1,7,8,4,6],pj_rhealpix:[5,8,7,3],test_rhealpix_dgg:[],south_west:8,api:7,initi:[0,8],ul_vertex:8,wgs84_003_radian:8,download:7,cube:8,horizont:8,linear:[0,7],word:[8,7],familiar:7,distort:[0,5,7],n021:8,middl:8,choos:8,stuff:8,width:8,applic:7,agre:7,"0x102e65bd0":[],csuid:8,instal:[5,7],root:8,maximum:[0,8,7],let:8,wasn:0,vertic:[8,2,3],follow:[8,7],len:4,"float":6,dictionari:[1,8],dimension:[8,7],unit:[6,2,3,4],greater:[0,8],geograph:[6,7,3],p7334:8,vector:0,revolut:[1,2,8,4,3,7],bottom:8,space:[8,4],redund:8,rhealpixdgg:[5,8,7],phi_min:[8,4],lam_max:[8,4],too:[8,2,3],boundari:[8,2,3],rhealpix:[0,1,7,3,8],p_1:8,unit_003:[8,7],x_min:8,"0x102e64950":[],triangl:[8,2,3],theta:[0,6],remov:8,osgeo:7,conveni:8,read:8,put:3,gibb:7,avoid:[8,4],depend:8,consequ:8,confus:8,suppos:3,local:0,rotate_entri:8,"new":[8,7],along:[0,8,4],convent:8,three:8,zealand:[8,7],res_1:8,start:[8,7],eccentr:[1,2,4,3,7,6],all:[1,2,8,4,3,7,6],edg:[8,7],sourc:7,shade_polar_region:[2,3],graticul:4,approxim:[0,6,8,7],southwest:8,clockwis:8,scientif:7,usag:[5,7],produc:7,cell_from_point:[8,7],"boolean":[8,3],healpix_ellipsoid:2,scenzgrid:7,n_side:[8,7],frame:4,might:8,type:7,transform:8,relat:8,rhealpix_dgg:[0,1,2,6,8,4,3,7],scenario:8,those:[8,7]}}) \ No newline at end of file +Search.setIndex({"docnames": ["dggs", "ellipsoids", "index", "introduction", "pj_healpix", "pj_rhealpix", "projection_wrapper", "utils"], "filenames": ["dggs.rst", "ellipsoids.rst", "index.rst", "introduction.rst", "pj_healpix.rst", "pj_rhealpix.rst", "projection_wrapper.rst", "utils.rst"], "titles": ["The dggs Module", "The ellipsoids Module", "Welcome the rHEALPixDGGS documentation!", "Introduction", "The pj_healpix Module", "The pj_rhealpix Module", "The projection_wrapper Module", "The utils Module"], "terms": {"thi": [0, 1, 3, 4, 5, 6, 7], "python": [0, 1, 3, 4, 5, 6, 7], "3": [0, 1, 3, 4, 5, 6, 7], "11": [0, 1, 3, 4, 5, 6, 7], "implement": [0, 1, 3, 4, 5, 6, 7], "rhealpix": [0, 3, 5, 6], "discret": [0, 3], "global": [0, 3], "grid": [0, 3, 4], "system": [0, 3], "alexand": [0, 1, 3, 4, 5, 6, 7], "raichev": [0, 1, 3, 4, 5, 6, 7], "ar": [0, 1, 3, 4, 5, 6, 7], "2012": [0, 1, 7], "12": 0, "initi": 0, "version": [0, 3], "base": [0, 1, 3, 6], "upon": [0, 3], "py": [0, 3, 6], "note": [0, 1, 4, 5, 6, 7], "all": [0, 1, 3, 4, 5, 6, 7], "length": [0, 1, 4, 5, 6, 7], "measur": [0, 1, 3, 4, 5, 6, 7], "meter": [0, 1, 4, 5, 6, 7], "angl": [0, 1, 3, 4, 5, 6, 7], "radian": [0, 1, 3, 4, 5, 6, 7], "unless": [0, 1, 4, 5, 6, 7], "indic": [0, 1, 4, 5, 6, 7], "otherwis": [0, 1, 4, 5, 6, 7], "By": [0, 1, 3, 4, 5, 6], "ellipsoid": [0, 2, 4, 5, 6, 7], "throughout": [0, 1], "i": [0, 1, 3, 4, 5, 6, 7], "mean": [0, 1, 4, 5, 6], "an": [0, 1, 3, 4, 5, 6, 7], "revolut": [0, 1, 3, 4, 5, 6], "gener": [0, 1, 3], "triaxial": [0, 1, 3], "point": [0, 1, 3, 4, 5, 7], "ly": [0, 1], "plane": [0, 3], "given": [0, 1, 3, 6, 7], "rectangular": [0, 1], "horizont": 0, "vertic": [0, 4, 5], "coordin": [0, 1, 3, 4, 5], "geodet": [0, 1, 4], "longitud": [0, 1, 3, 4, 5], "latitud": [0, 1, 3, 4, 5, 7], "abbrevi": [0, 3], "except": [0, 1], "when": [0, 4, 5, 6], "manipul": 0, "posit": [0, 5, 7], "integ": [0, 5], "avoid": [0, 1], "modulo": 0, "function": [0, 3, 4, 5, 6, 7], "inst": 0, "write": 0, "everyth": 0, "term": 0, "floor": 0, "becaus": 0, "interpret": 0, "sign": 0, "differ": 0, "than": 0, "java": 0, "c": [0, 3], "don": 0, "t": 0, "want": 0, "confus": 0, "peopl": 0, "who": 0, "translat": 0, "code": [0, 1, 4, 5, 6, 7], "those": 0, "languag": 0, "exampl": [0, 1, 3, 4, 5, 6, 7], "creat": [0, 3], "1": [0, 1, 3, 4, 5, 6, 7], "2": [0, 1, 3, 4, 5, 6, 7], "n_side": [0, 3], "wgs84": [0, 3], "us": [0, 1, 7], "degre": [0, 1, 3, 7], "instead": 0, "default": [0, 1, 3, 5], "angular": 0, "from": [0, 1, 3, 4, 5, 6, 7], "rhealpixdgg": [0, 1, 3, 4, 5, 6, 7], "import": [0, 3, 5, 6], "wgs84_ellipsoid": [0, 3, 6], "e": [0, 1, 3, 4, 5, 6, 7], "rdgg": [0, 3], "north_squar": [0, 3, 5, 6], "south_squar": [0, 3, 5, 6], "print": [0, 1, 3, 4, 5, 6, 7], "max_areal_resolut": [0, 3], "max_resolut": [0, 3], "15": [0, 1, 3, 4, 5, 6, 7], "r_a": [0, 1, 3], "6374581": [0, 3], "467096525": [0, 3], "6378137": [0, 1, 3], "0": [0, 1, 3, 4, 5, 6, 7], "b": [0, 1, 3], "6356752": [0, 3], "314140356": [0, 3], "0578063088401125": [0, 3], "f": [0, 1, 3, 4, 5, 6], "003352810681182319": [0, 1, 3], "lat_0": [0, 1, 3], "lon_0": [0, 1, 3], "fals": [0, 1, 3, 4, 5, 6, 7], "sphere": [0, 1, 3, 4, 5, 7], "issu": [0, 1, 6, 7], "wa": [0, 1, 6, 7], "4671": 0, "0578063088401": 0, "pick": [0, 3], "find": [0, 3], "resolut": 0, "cell": [0, 3], "contain": [0, 1, 3], "p": [0, 1, 3, 4, 5, 7], "45": [0, 1, 3, 7], "cell_from_point": [0, 3], "n8": 0, "edg": [0, 3], "neighbor": [0, 3], "direct": [0, 3], "sort": [0, 3], "item": [0, 3], "east": [0, 3, 5], "n5": 0, "south_east": 0, "q0": [0, 3], "south_west": 0, "p2": [0, 3], "west": [0, 3, 5], "n7": 0, "planar": [0, 3, 4, 5], "down": [0, 3], "left": [0, 3, 7], "right": [0, 3, 7], "up": [0, 3], "intersect": [0, 3], "align": [0, 3], "quadrangl": [0, 3], "northwest": [0, 3], "southeast": [0, 3], "corner": [0, 3], "nw": [0, 3], "se": [0, 3], "90": [0, 1, 3, 7], "cells_from_region": [0, 3], "row": [0, 3], "str": [0, 3, 5], "n2": [0, 3], "q1": [0, 3], "q2": [0, 3], "r0": [0, 3], "q3": [0, 3], "q4": [0, 3], "q5": [0, 3], "r3": [0, 3], "comput": [0, 3, 4, 5, 7], "nuclei": [0, 3], "expected_result": [0, 3], "58": [0, 3], "47067782962736": [0, 3], "000000000000036": [0, 3], "47067782962734": [0, 3], "89": [0, 3], "99999999999996": [0, 3], "14": [0, 3], "999999999999998": [0, 3], "26": [0, 1, 3, 4, 5, 7], "438744923100096": [0, 3], "74": [0, 3], "99999999999999": [0, 3], "105": [0, 3], "00000000000001": [0, 3], "560649871414923e": [0, 3], "enumer": [0, 3], "j": [0, 3], "assert_allclos": [0, 3], "nucleu": [0, 3], "rtol": [0, 3], "1e": [0, 3], "atol": [0, 3], "none": [0, 1, 3, 5, 6], "true": [0, 1, 3, 4, 5, 7], "orient": [0, 3], "so": [0, 3], "origin": [0, 1, 3, 7], "auckland": [0, 3], "new": [0, 3], "zealand": [0, 3], "174": [0, 3], "37": [0, 3], "approxim": [0, 3, 7], "lon": [0, 3], "lat": [0, 3], "wgs84_a": [0, 3], "wgs84_f": [0, 3], "class": [0, 1, 3, 6], "object": [0, 1, 4, 5, 6], "suid": 0, "level_order_index": 0, "post_order_index": 0, "repres": [0, 1, 6], "hierarchi": 0, "identifi": 0, "form": [0, 4, 5, 6], "p_0": 0, "p_1": 0, "p_l": 0, "where": [0, 3, 5, 6], "one": [0, 1, 3], "charact": 0, "A": [0, 4, 5], "d": 0, "p_i": 0, "instanc": [0, 1, 3, 6, 7], "attribut": [0, 1, 3, 6], "number": [0, 1, 5, 7], "children": 0, "along": [0, 1], "s": [0, 1, 3, 6, 7], "side": 0, "come": 0, "underli": 0, "id": 0, "tupl": [0, 4, 5, 7], "spatial": 0, "uniqu": 0, "reserv": 0, "word": [0, 3], "nonneg": 0, "sever": [0, 7], "method": [0, 3], "have": 0, "keyword": [0, 6], "argument": [0, 6], "set": [0, 1], "input": [0, 4, 5], "output": [0, 4, 5, 6, 7], "thei": [0, 7], "area": [0, 3], "return": [0, 1, 4, 5, 7], "boundari": [0, 4, 5], "n": [0, 1, 3], "interior": 0, "list": [0, 1, 3, 4, 5, 7], "4": [0, 1, 3, 4, 5, 6, 7], "each": 0, "clockwis": 0, "order": 0, "start": [0, 3], "upper": 0, "If": [0, 1, 3, 5, 7], "same": [0, 3], "push": 0, "slighli": 0, "which": [0, 3], "conveni": 0, "some": [0, 3], "graphic": 0, "unit_003": [0, 3], "6": [0, 3, 7], "my_round": [0, 1, 4, 5, 6, 7], "14159265358979": 0, "30899693899575": 0, "87979326579064": 0, "61799387799149": 0, "0471975511966": 0, "78539816339745": 0, "3089969389957501": 0, "0471975511966001": 0, "78539816339745006": 0, "180": [0, 1, 7], "35752898700072": 0, "157": 0, "50000000000003": 0, "41366190347208": 0, "150": [0, 1], "41": 0, "8103148957786": 0, "165": 0, "00000000000003": 0, "149": 0, "99999999999997": 0, "49999999999997": 0, "413661903472082": 0, "810314895778603": 0, "centroid": 0, "color": 0, "satur": 0, "5": [0, 3, 7], "rgb": 0, "inessenti": 0, "wgs84_003_radian": 0, "pi": [0, 1, 4, 5, 7], "q44": 0, "ellipsoidal_shap": [0, 3], "shape": [0, 3], "quad": [0, 3], "cap": 0, "dart": [0, 3], "skew_quad": [0, 3], "view": 0, "index": [0, 2, 3], "self": [0, 1], "accord": 0, "here": [0, 3, 5], "can": [0, 3, 6], "post": 0, "empti": 0, "ha": [0, 3], "wai": [0, 5], "travers": 0, "tree": 0, "defin": [0, 3], "follow": [0, 3], "root": 0, "non": 0, "place": 0, "holder": 0, "s0": 0, "s1": 0, "sn": 0, "level": [0, 3], "nonempti": 0, "its": [0, 4, 5, 6, 7], "8": [0, 3, 4], "flatten": [0, 1], "x": [0, 1, 4, 5, 7], "matrix": 0, "space": [0, 1], "regular": 0, "squar": [0, 1, 5], "standard": [0, 7], "major": [0, 1, 3, 4, 5, 6, 7], "project": [0, 1, 3, 4, 5, 6, 7], "dimension": [0, 3], "arrai": [0, 3], "pair": [0, 5], "13": 0, "8103801453539": 0, "intersects_meridian": 0, "lam": [0, 1, 4, 5, 7], "meridian": [0, 1, 3], "intersects_parallel": 0, "phi": [0, 1, 4, 5, 7], "parallel": [0, 1, 3], "string": [0, 6], "desir": 0, "rel": 0, "y": [0, 4, 5], "diagram": [0, 5], "drawn": 0, "middl": 0, "012": 0, "345": 0, "678": 0, "north": [0, 1, 3, 5], "south": [0, 3, 5], "skew": 0, "southwest": 0, "northern": 0, "northeast": 0, "southern": 0, "south_0": 0, "south_1": 0, "south_2": 0, "south_3": 0, "north_0": 0, "north_1": 0, "north_2": 0, "north_3": 0, "For": [0, 3, 5, 6], "increas": 0, "less": 0, "etc": 0, "tricki": 0, "part": 0, "scenario": 0, "relationship": 0, "six": 0, "determin": 0, "surfac": 0, "cube": 0, "face": 0, "sometim": 0, "rotat": 0, "need": [0, 6], "invalid": 0, "n3": 0, "dictionari": [0, 6], "whose": [0, 4, 5], "kei": 0, "see": [0, 3, 5, 6], "valid": [0, 6], "k": 0, "v": [0, 4, 5, 6], "n1": [0, 3], "lower": 0, "refer": 0, "onto": 0, "In": [0, 5], "particular": 0, "while": 0, "To": [0, 3], "below": [0, 4, 5, 6], "35619449019234": 0, "5707963267949": 0, "5707963267949001": 0, "nw_vertex": 0, "vertex": 0, "On": 0, "ul_vertex": 0, "warn": 0, "might": 0, "lie": 0, "7": [0, 3, 4, 7], "2225148": 0, "7007489": 0, "556287": 0, "1751872245": 0, "17518722452": 0, "both": 0, "abov": 0, "test": [0, 3, 4, 5], "16688615": 0, "255616743": 0, "8344307": 0, "627808371": 0, "6278083706": 0, "10569456": 0, "32855727": 0, "15576040": 0, "905242294": 0, "9456881": 0, "97818282": 0, "9781828206": 0, "17801189": 0, "605991192": 0, "627808372": 0, "6278083716": 0, "11682030": 0, "678931719": 0, "12794605": 0, "029306168": 0, "overlap": 0, "other_cel": 0, "whether": 0, "two": [0, 5], "zip": 0, "truncat": 0, "longer": 0, "shorter": 0, "produc": 0, "comparison": 0, "equal": [0, 5], "param": 0, "cell_on": 0, "first": 0, "cell_two": 0, "second": 0, "predecessor": 0, "greatest": 0, "n07": 0, "n088": 0, "random_point": [0, 1], "random": [0, 1], "choos": 0, "4840291937583836": 0, "90042819146088571": 0, "region": [0, 1, 5], "equatori": [0, 1, 5], "north_polar": [0, 5], "south_polar": [0, 5], "region_overlap": 0, "ani": [0, 7], "quarter_turn": 0, "result": 0, "supercel": 0, "quarter": 0, "turn": 0, "anticlockwis": 0, "rang": [0, 1, 7], "n0": [0, 3], "n6": 0, "rotate_entri": 0, "let": 0, "subcel": 0, "obtain": 0, "tabl": 0, "entri": 0, "read": 0, "top": 0, "bottom": 0, "letter": 0, "cells0": 0, "oper": [0, 3], "too": [0, 4, 5], "stai": 0, "fix": [0, 5], "under": 0, "onli": [0, 4, 5], "depend": 0, "through": [0, 7], "other": 0, "subset": 0, "relat": 0, "n4": 0, "successor": 0, "least": 0, "greater": 0, "n83": 0, "o": 0, "o0": 0, "n830": 0, "static": 0, "suid_from_index": 0, "docstr": [0, 5], "more": 0, "detail": 0, "intern": 0, "suid_rowcol": 0, "column": 0, "rsuid": 0, "csuid": 0, "polar": [0, 1, 5], "necessarili": 0, "latter": 0, "trim_dart": 0, "assum": [0, 1, 3, 4, 5, 6], "four": 0, "remov": 0, "three": 0, "wgs84_003": [0, 3], "9999999999999": 0, "3906909487906": 0, "120": 0, "8738577422094": 0, "60": [0, 1, 3, 4, 5], "87385774220941": 0, "39069094879065": 0, "width": 0, "xy_rang": 0, "extrem": 0, "format": 0, "x_min": 0, "x_max": 0, "y_min": 0, "y_max": 0, "size": 0, "child": 0, "between": [0, 1, 5], "respect": [0, 5], "bound": 0, "smallest": 0, "maximum": 0, "most": [0, 1], "child_ord": 0, "morton": 0, "valu": 0, "element": 0, "atomic_neighbor": 0, "describ": [0, 3, 4], "cell0": 0, "either": [0, 6], "isinst": 0, "n45": 0, "cell_area": 0, "cell_from_region": 0, "ul": 0, "dr": 0, "wholli": 0, "axi": [0, 7], "rectangl": 0, "doe": 0, "exist": 0, "specifi": [0, 1], "As": 0, "usual": 0, "q": [0, 4, 5], "cell_latitud": 0, "phi_min": [0, 1], "phi_max": [0, 1], "everi": 0, "satisfi": 0, "convent": 0, "pole": [0, 1, 5], "correspond": 0, "exclud": 0, "There": 0, "odd": 0, "even": 0, "consequ": 0, "02050584399985": 0, "46144314900303": 0, "020505844": 0, "461443149003": 0, "57079632679": 0, "29836248988994": 0, "73083668811327": 0, "22457715619516": 0, "29836248989": 0, "730836688113": 0, "224577156195": 0, "cell_width": 0, "constant": [0, 3], "r": [0, 1, 3, 4], "cells_from_meridian": 0, "segment": 0, "case": [0, 4, 5], "q6": 0, "s8": 0, "s7": 0, "s4": 0, "cells_from_parallel": 0, "lam_min": [0, 1], "lam_max": [0, 1], "cover": 0, "sublist": 0, "defunct": 0, "stuff": 0, "also": [0, 3], "work": [0, 4, 5], "reli": 0, "fact": 0, "infinit": 0, "mani": 0, "m": 0, "p5": 0, "p8": 0, "lune": 0, "q7": 0, "q8": 0, "r6": 0, "s6": 0, "o6": 0, "o7": 0, "o8": 0, "p6": 0, "p7": 0, "r7": 0, "r8": 0, "s2": 0, "s5": 0, "s3": 0, "combine_triangl": [0, 5], "u": [0, 4, 5, 6], "invers": [0, 4, 5, 6, 7], "transform": 0, "appropri": 0, "It": 0, "map": [0, 3, 4, 5, 6, 7], "healpix": [0, 1, 3, 4, 5, 6], "grid0": 0, "unit_003_radian": [0, 3], "pj_healpix": [0, 2, 3, 6], "proj": [0, 1, 3, 6, 7], "interv": [0, 7], "max": 0, "inclus": 0, "postord": 0, "minimal_cov": 0, "minim": 0, "made": 0, "redund": 0, "gi": 0, "raster": 0, "tool": 0, "c1": 0, "c2": 0, "n02": 0, "p73": 0, "n021": 0, "p733": 0, "n0214": 0, "p7334": 0, "num_cel": 0, "res_1": 0, "res_2": 0, "231627523606480": 0, "10": 0, "random_cel": 0, "chosen": 0, "uniformli": [0, 1], "s480586367780080": 0, "sampl": [0, 1], "0999574573422948": [0, 1], "21029104897701129": [0, 1], "858272006684": 0, "06871881030324": 0, "8582720066839999": 0, "0687188103032401": 0, "pj_rhealpix": [0, 2, 3], "triangl": [0, 5], "li": [0, 4, 5, 7], "imag": [0, 4, 5], "triangle_numb": [0, 5], "wrapper": [0, 3, 6], "pjr": 0, "xyz": [0, 1], "lonlat": 0, "back": 0, "3d": [0, 1], "70710678118655": 0, "70710678118655002": 0, "xyz_cub": 0, "fold": 0, "center": 0, "rhealpolygon": 0, "suid_list": 0, "01": [1, 4, 5, 6, 7], "refactor": [1, 4, 5, 6, 7], "releas": [1, 4, 5, 6, 7], "possibl": 1, "frame": 1, "radiu": [1, 3, 4, 5, 6, 7], "impli": 1, "minor": 1, "eccentr": [1, 3, 4, 5, 6, 7], "authal": [1, 3, 4, 5, 7], "central": [1, 3], "calcul": 1, "phi_0": 1, "separ": 1, "context": 1, "name": [1, 3, 6], "match": 1, "paramet": [1, 3], "get_point": 1, "filenam": 1, "file": 1, "text": 1, "per": 1, "line": [1, 3], "whitespac": 1, "graticul": 1, "400": 1, "should": [1, 6], "unit": [1, 4, 5, 7], "16": 1, "unit_spher": [1, 3], "len": 1, "25600": 1, "lattic": 1, "2n": 1, "30": [1, 6], "200": 1, "equispac": 1, "section": 1, "But": 1, "707106781186548": 1, "70710678118654802": 1, "introduct": 2, "requir": 2, "instal": 2, "usag": 2, "The": [2, 3], "util": 2, "modul": 2, "projection_wrapp": 2, "dgg": 2, "search": 2, "page": 2, "packag": 3, "document": 3, "you": 3, "familiar": 3, "grs2013": 3, "basic": 3, "tutori": 3, "robert": 3, "gibb": 3, "michael": 3, "speth": 3, "prepar": 3, "2013": [3, 4, 5, 6], "numpi": [3, 5], "25": [3, 6, 7], "scipi": 3, "fundament": 3, "librari": 3, "scientif": 3, "matplotlib": 3, "comprehens": 3, "2d": 3, "plot": 3, "pyproj": 3, "interfac": 3, "cartograph": 3, "avail": 3, "pypi": 3, "pip": 3, "download": 3, "landcar": 3, "research": 3, "github": 3, "repositori": 3, "http": 3, "com": 3, "manaakiwhenua": 3, "wher": 3, "latest": 3, "clone": 3, "after": 3, "session": 3, "directori": 3, "applic": 3, "program": 3, "api": 3, "chapter": 3, "deal": 3, "includ": 3, "breviti": 3, "hereaft": 3, "current": 3, "buggi": 3, "9": 3, "altern": 3, "correct": 3, "trac": 3, "osgeo": 3, "org": 3, "changeset": 3, "2378": 3, "rebuild": 3, "edit": 3, "homemade_project": 3, "sai": 3, "ellps_1": 3, "322001171188888": 3, "999999999999999": 3, "agre": 3, "prefer": 3, "do": 3, "ellps_2": 3, "common": 3, "predefin": 3, "057806308840112": 3, "003352810681182": 3, "wgs84_ellipsoid_radian": 3, "parametr": 3, "geograph": [3, 5, 7], "h": 3, "rh": 3, "35127855017803": 3, "70": 3, "864006732389895": 3, "258498514443268": 3, "variou": 3, "thereupon": 3, "dggss": 3, "088887490341627e": 3, "caro2007": 4, "mark": 4, "calabretta": 4, "boudewijn": 4, "roukema": 4, "monthli": 4, "notic": 4, "royal": 4, "astronom": 4, "societi": 4, "381": 4, "2007": 4, "865": 4, "872": 4, "oblat": [4, 5, 6], "float": [4, 5, 7], "callabl": [4, 5], "bool": [4, 5, 7], "wrap": [4, 5], "574951359778215": [4, 5], "145747686573111": [4, 5], "6e": [4, 5], "59": [4, 5], "999999999999986": [4, 5], "healpix_ellipsoid": 4, "signatur": [4, 5], "spheric": [4, 5], "511157237746422": 4, "268484450857837": 4, "healpix_ellipsoid_invers": 4, "448798950512828": 4, "healpix_spher": 4, "arcsin": [4, 5], "healpix_sphere_invers": 4, "healpix_vertic": 4, "in_healpix_imag": 4, "ep": [4, 5], "hp": 4, "fail": [4, 5], "int": [5, 7], "rearrang": 5, "combin": 5, "put": 5, "uncombin": 5, "rhealpix_spher": 5, "option": 5, "boolean": 5, "forward": 5, "832595714594046": 5, "570796326794896": 5, "785398163397448": [5, 7], "047197551196598": 5, "in_rhealpix_imag": 5, "rhp": 5, "rhealpix_ellipsoid": 5, "rhealpix_ellipsoid_invers": 5, "619978633413937": 5, "307012183573304": 5, "label": 5, "like": 5, "rhealpix_sphere_invers": 5, "rhealpix_vertic": 5, "suppos": 5, "now": 5, "z": 5, "get": 5, "move": 5, "remain": 5, "kwarg": 6, "homemad": 6, "definit": 6, "could": 6, "3748655": 6, "1150495014": 6, "cea": 6, "3180183": 6, "4857749646": 6, "485774971": 6, "access": 6, "call": [6, 7], "via": 6, "g": 6, "helper": 7, "auth_lat": 7, "ellips": 7, "beta": 7, "68951821243544": 7, "689518212435": 7, "785126523581272": 7, "785126523581": 7, "power": 7, "seri": 7, "cartographi": 7, "accur": 7, "small": 7, "auth_rad": 7, "989393259670095": 7, "111111111111111": 7, "997935147429943": 7, "0625": 7, "999348236455825": 7, "04": 7, "99973321235361": 7, "027777777777778": 7, "99987137105188": 7, "020408163265306": 7, "999930576285614": 7, "015625": 7, "999959307080847": 7, "012345679012346": 7, "999974596271211": 7, "999983332861089": 7, "98939325967009495": 7, "99793514742994305": 7, "99934823645582505": 7, "99973321235361001": 7, "99987137105187995": 7, "99993057628561399": 7, "99995930708084702": 7, "99997459627121099": 7, "99998333286108898": 7, "digit": 7, "round": 7, "142857": 7, "333333": 7, "wrap_latitud": 7, "circl": 7, "half": 7, "reflect": 7, "135": 7, "wrap_longitud": 7, "theta": 7, "141592653589793": 7, "1415926535897931": 7, "185": 7, "175": 7}, "objects": {"rhealpixdggs": [[0, 0, 0, "-", "dggs"], [1, 0, 0, "-", "ellipsoids"], [4, 0, 0, "-", "pj_healpix"], [5, 0, 0, "-", "pj_rhealpix"], [6, 0, 0, "-", "projection_wrapper"], [7, 0, 0, "-", "utils"]], "rhealpixdggs.dggs": [[0, 1, 1, "", "Cell"], [0, 1, 1, "", "RHEALPixDGGS"], [0, 1, 1, "", "RhealPolygon"]], "rhealpixdggs.dggs.Cell": [[0, 2, 1, "", "area"], [0, 2, 1, "", "boundary"], [0, 2, 1, "", "centroid"], [0, 2, 1, "", "color"], [0, 2, 1, "", "contains"], [0, 2, 1, "", "ellipsoidal_shape"], [0, 2, 1, "", "index"], [0, 2, 1, "", "interior"], [0, 2, 1, "", "intersects_meridian"], [0, 2, 1, "", "intersects_parallel"], [0, 2, 1, "", "neighbor"], [0, 2, 1, "", "neighbors"], [0, 2, 1, "", "nucleus"], [0, 2, 1, "", "nw_vertex"], [0, 2, 1, "", "overlaps"], [0, 2, 1, "", "predecessor"], [0, 2, 1, "", "random_point"], [0, 2, 1, "", "region"], [0, 2, 1, "", "region_overlaps"], [0, 2, 1, "", "rotate"], [0, 2, 1, "", "rotate_entry"], [0, 2, 1, "", "subcell"], [0, 2, 1, "", "subcells"], [0, 2, 1, "", "successor"], [0, 2, 1, "", "suid_from_index"], [0, 2, 1, "", "suid_rowcol"], [0, 2, 1, "", "ul_vertex"], [0, 2, 1, "", "vertices"], [0, 2, 1, "", "width"], [0, 2, 1, "", "xy_range"]], "rhealpixdggs.dggs.RHEALPixDGGS": [[0, 2, 1, "", "cell"], [0, 2, 1, "", "cell_area"], [0, 2, 1, "", "cell_from_point"], [0, 2, 1, "", "cell_from_region"], [0, 2, 1, "", "cell_latitudes"], [0, 2, 1, "", "cell_width"], [0, 3, 1, "", "cells0"], [0, 2, 1, "", "cells_from_meridian"], [0, 2, 1, "", "cells_from_parallel"], [0, 2, 1, "", "cells_from_region"], [0, 2, 1, "", "combine_triangles"], [0, 2, 1, "", "grid"], [0, 2, 1, "", "healpix"], [0, 2, 1, "", "interval"], [0, 2, 1, "", "minimal_cover"], [0, 2, 1, "", "num_cells"], [0, 2, 1, "", "random_cell"], [0, 2, 1, "", "random_point"], [0, 2, 1, "", "rhealpix"], [0, 2, 1, "", "triangle"], [0, 2, 1, "", "xyz"], [0, 2, 1, "", "xyz_cube"]], "rhealpixdggs.ellipsoids": [[1, 1, 1, "", "Ellipsoid"]], "rhealpixdggs.ellipsoids.Ellipsoid": [[1, 2, 1, "", "get_points"], [1, 2, 1, "", "graticule"], [1, 2, 1, "", "lattice"], [1, 2, 1, "", "meridian"], [1, 2, 1, "", "parallel"], [1, 2, 1, "", "pi"], [1, 2, 1, "", "random_point"], [1, 2, 1, "", "xyz"]], "rhealpixdggs.pj_healpix": [[4, 4, 1, "", "healpix"], [4, 4, 1, "", "healpix_ellipsoid"], [4, 4, 1, "", "healpix_ellipsoid_inverse"], [4, 4, 1, "", "healpix_sphere"], [4, 4, 1, "", "healpix_sphere_inverse"], [4, 4, 1, "", "healpix_vertices"], [4, 4, 1, "", "in_healpix_image"]], "rhealpixdggs.pj_rhealpix": [[5, 4, 1, "", "combine_triangles"], [5, 4, 1, "", "in_rhealpix_image"], [5, 4, 1, "", "rhealpix"], [5, 4, 1, "", "rhealpix_ellipsoid"], [5, 4, 1, "", "rhealpix_ellipsoid_inverse"], [5, 4, 1, "", "rhealpix_sphere"], [5, 4, 1, "", "rhealpix_sphere_inverse"], [5, 4, 1, "", "rhealpix_vertices"], [5, 4, 1, "", "triangle"]], "rhealpixdggs.projection_wrapper": [[6, 1, 1, "", "Projection"]], "rhealpixdggs.utils": [[7, 4, 1, "", "auth_lat"], [7, 4, 1, "", "auth_rad"], [7, 4, 1, "", "my_round"], [7, 4, 1, "", "wrap_latitude"], [7, 4, 1, "", "wrap_longitude"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute", "4": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "function", "Python function"]}, "titleterms": {"The": [0, 1, 4, 5, 6, 7], "dgg": [0, 3], "modul": [0, 1, 3, 4, 5, 6, 7], "ellipsoid": [1, 3], "welcom": 2, "rhealpixdgg": 2, "document": 2, "indic": 2, "tabl": 2, "introduct": 3, "requir": 3, "instal": 3, "usag": 3, "us": 3, "projection_wrapp": [3, 6], "pj_healpix": 4, "pj_rhealpix": 5, "util": 7}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.todo": 2, "sphinx": 56}}) \ No newline at end of file diff --git a/docs/build/html/utils.html b/docs/build/html/utils.html index f7754ce..14e5e01 100644 --- a/docs/build/html/utils.html +++ b/docs/build/html/utils.html @@ -1,37 +1,27 @@ + - - - - + - - - The utils Module — rHEALPixDGGS 0.5.1 documentation + + + + The utils Module — rHEALPixDGGS 0.5.4 documentation + + - - + + + + + - - - - - - + + - - -
    + +
    -
    +
    -
    -

    The utils Module¶

    -

    This Python 3.3 module implements several helper functions for coding map projections.

    -

    CHANGELOG:

    +
    +

    The utils Module¶

    +

    This Python 3.11 module implements several helper functions for coding map projections.

      -
    • Alexander Raichev (AR), 2012-01-26: Refactored code from release 0.3.
      • -
    • AR, 2013-07-23: Ported to Python 3.3.
      • +

    • Alexander Raichev (AR), 2012-01-26: Refactored code from release 0.3.

    NOTE:

    -

    All lengths are measured in meters and all angles are measured in radians +

    All lengths are measured in meters and all angles are measured in radians unless indicated otherwise.

    -
    -
    -rhealpix_dggs.utils.auth_lat(phi, e, inverse=False, radians=False)¶
    -

    Given a point of geographic latitude phi on an ellipse of +

    +
    +rhealpixdggs.utils.auth_lat(phi: float, e: float, inverse: bool = False, radians: bool = False) → float¶
    +

    Given a point of geographic latitude phi on an ellipse of eccentricity e, return the authalic latitude of the point. If inverse =True, then compute its inverse approximately.

    EXAMPLES:

    -
    >>> beta = auth_lat(pi/4, 0.5, radians=True)
->>> print(my_round(beta, 15))
-0.689518212435
->>> print(my_round(auth_lat(beta, 0.5, radians=True, inverse=True), 15))
-0.785126523581
->>> print(my_round(pi/4, 15))
+
    >>> beta = auth_lat(pi/4, 0.5, radians=True)
+>>> print(my_round(beta, 15))
+0.68951821243544
+
    
+
    
+
    
+
    NOTES:: .. Issue #1 was ..
    0.689518212435
    
+
    >>> print(my_round(auth_lat(beta, 0.5, radians=True, inverse=True), 15))
+0.785126523581272
+
    
+
    
+
    
+
    NOTES:: .. Issue #1 was ..
    0.785126523581
    
+
    >>> print(my_round(pi/4, 15))
 0.785398163397448
 
    
 
    
+
    
+
    
 
    NOTES:
    
 
    The power series approximation used for the inverse is
 standard in cartography (PROJ.4 uses it, for instance)
 and accurate for small eccentricities.
    -
    -
    -rhealpix_dggs.utils.auth_rad(a, e, inverse=False)¶
    +
    +
    +rhealpixdggs.utils.auth_rad(a: float, e: float, inverse: bool = False) → float¶

    Return the radius of the authalic sphere of the ellipsoid with major radius a and eccentricity e. If inverse = True, then return the major radius of the ellipsoid with authalic radius a and eccentricity e.

    EXAMPLES:

    -
    >>> auth_rad(1, 0)
+
    >>> auth_rad(1, 0)
 1
 >>> for i in range(2, 11):
-...     e = 1.0/i**2     
-...     print(my_round((e, auth_rad(1, 1.0/i**2)), 15))
-(0.25, 0.98939325967009495)
-(0.111111111111111, 0.99793514742994305)
-(0.0625, 0.99934823645582505)
-(0.04, 0.99973321235361001)
-(0.027777777777778, 0.99987137105187995)
-(0.020408163265306, 0.99993057628561399)
-(0.015625, 0.99995930708084702)
-(0.012345679012346, 0.99997459627121099)
-(0.01, 0.99998333286108898)
+...     e = 1.0/i**2
+...     print(my_round((e, auth_rad(1, 1.0/i**2)), 15))
+(0.25, 0.989393259670095)
+(0.111111111111111, 0.997935147429943)
+(0.0625, 0.999348236455825)
+(0.04, 0.99973321235361)
+(0.027777777777778, 0.99987137105188)
+(0.020408163265306, 0.999930576285614)
+(0.015625, 0.999959307080847)
+(0.012345679012346, 0.999974596271211)
+(0.01, 0.999983332861089)
 
    
 
    
+
    
+
    NOTES:: .. Issue #1 was ..
    (0.25, 0.98939325967009495) *
+(0.111111111111111, 0.99793514742994305) *
+(0.0625, 0.99934823645582505) *
+(0.04, 0.99973321235361001) *
+(0.027777777777778, 0.99987137105187995) *
+(0.020408163265306, 0.99993057628561399) *
+(0.015625, 0.99995930708084702) *
+(0.012345679012346, 0.99997459627121099) *
+(0.01, 0.99998333286108898) *
    
+
    
+
    -
    -
    -rhealpix_dggs.utils.my_round(x, digits=0)¶
    +
    +
    +rhealpixdggs.utils.my_round(x: Any, digits: int = 0) → Any¶

    Round the floating point number or list/tuple of floating point -numbers to digits number of digits. -Calls Python’s round() function.

    +numbers to digits number of digits. +Calls Python’s round() function.

    EXAMPLES:

    -
    >>> print(my_round(1./7, 6))
+
    >>> print(my_round(1./7, 6))
 0.142857
->>> print(my_round((1./3, 1./7), 6))
+>>> print(my_round((1./3, 1./7), 6))
 (0.333333, 0.142857)
    -
    -
    -rhealpix_dggs.utils.wrap_latitude(phi, radians=False)¶
    +
    +
    +rhealpixdggs.utils.wrap_latitude(phi: float, radians: bool = False) → float¶

    Given a point p on the unit circle at angle phi from the positive x-axis, -if p lies in the right half of the circle, then return its angle that lies +if p lies in the right half of the circle, then return its angle that lies in the interval [-pi/2, pi/2]. -If p lies in the left half of the circle, then reflect it through the -origin, and return the angle of the reflected point that lies in the +If p lies in the left half of the circle, then reflect it through the +origin, and return the angle of the reflected point that lies in the interval [-pi/2, pi/2]. If radians = True, then phi and the output are given in radians. Otherwise, they are given in degrees.

    EXAMPLES:

    -
    >>> wrap_latitude(45, radians=False)
+
    >>> wrap_latitude(45, radians=False)
 45.0
->>> wrap_latitude(-45, radians=False)
+>>> wrap_latitude(-45, radians=False)
 -45.0
->>> wrap_latitude(90, radians=False)
+>>> wrap_latitude(90, radians=False)
 90.0
->>> wrap_latitude(-90, radians=False)
+>>> wrap_latitude(-90, radians=False)
 -90.0
->>> wrap_latitude(135, radians=False)
+>>> wrap_latitude(135, radians=False)
 -45.0
->>> wrap_latitude(-135, radians=False)
+>>> wrap_latitude(-135, radians=False)
 45.0
    -
    -
    -rhealpix_dggs.utils.wrap_longitude(lam, radians=False)¶
    -

    Given a point p on the unit circle at angle lam from the positive +

    +
    +rhealpixdggs.utils.wrap_longitude(lam: float, radians: bool = False) → float¶
    +

    Given a point p on the unit circle at angle lam from the positive x-axis, return its angle theta in the range -pi <= theta < pi. If radians = True, then lam and the output are given in radians. Otherwise, they are given in degrees.

    EXAMPLES:

    -
    >>> wrap_longitude(2*pi + pi, radians=True)
--3.1415926535897931
->>> wrap_longitude(-185, radians=False)
+
    >>> wrap_longitude(2*pi + pi, radians=True)
+-3.141592653589793
+
    
+
    
+
    
+
    NOTES:: .. Issue #1 was ..
    -3.1415926535897931
    
+
    >>> wrap_longitude(-185, radians=False)
 175.0
->>> wrap_longitude(-180, radians=False)
+>>> wrap_longitude(-180, radians=False)
 -180.0
->>> wrap_longitude(185, radians=False)
+>>> wrap_longitude(185, radians=False)
 -175.0
 
    
 
    
+
    
+
    -
    + +
    -
    + -
    + -
    - © Copyright 2013, Alexander Raichev. - Created using Sphinx 1.1.3. + \ No newline at end of file diff --git a/docs/build/latex/Makefile b/docs/build/latex/Makefile index 76e7c3e..e4653f2 100644 --- a/docs/build/latex/Makefile +++ b/docs/build/latex/Makefile @@ -3,27 +3,38 @@ ALLDOCS = $(basename $(wildcard *.tex)) ALLPDF = $(addsuffix .pdf,$(ALLDOCS)) ALLDVI = $(addsuffix .dvi,$(ALLDOCS)) +ALLXDV = +ALLPS = $(addsuffix .ps,$(ALLDOCS)) # Prefix for archive names -ARCHIVEPRREFIX = -# Additional LaTeX options -LATEXOPTS = +ARCHIVEPREFIX = +# Additional LaTeX options (passed via variables in latexmkrc/latexmkjarc file) +export LATEXOPTS ?= +# Additional latexmk options +LATEXMKOPTS ?= +# format: pdf or dvi (used only by archive targets) +FMT = pdf + +LATEX = latexmk -dvi +PDFLATEX = latexmk -pdf -dvi- -ps- + + +%.dvi: %.tex FORCE_MAKE + $(LATEX) $(LATEXMKOPTS) '$<' + +%.ps: %.dvi + dvips '$<' + +%.pdf: %.tex FORCE_MAKE + $(PDFLATEX) $(LATEXMKOPTS) '$<' all: $(ALLPDF) -all-pdf: $(ALLPDF) + all-dvi: $(ALLDVI) -all-ps: all-dvi - for f in *.dvi; do dvips $$f; done - -all-pdf-ja: - for f in *.pdf *.png *.gif *.jpg *.jpeg; do ebb $$f; done - for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done - for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done - for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done - for f in *.idx; do mendex -U -f -d "`basename $$f .idx`.dic" -s python.ist $$f; done - for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done - for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done - for f in *.dvi; do dvipdfmx $$f; done + +all-ps: $(ALLPS) + +all-pdf: $(ALLPDF) zip: all-$(FMT) mkdir $(ARCHIVEPREFIX)docs-$(FMT) @@ -37,30 +48,17 @@ tar: all-$(FMT) tar cf $(ARCHIVEPREFIX)docs-$(FMT).tar $(ARCHIVEPREFIX)docs-$(FMT) rm -r $(ARCHIVEPREFIX)docs-$(FMT) +gz: tar + gzip -9 < $(ARCHIVEPREFIX)docs-$(FMT).tar > $(ARCHIVEPREFIX)docs-$(FMT).tar.gz + bz2: tar bzip2 -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar -# The number of LaTeX runs is quite conservative, but I don't expect it -# to get run often, so the little extra time won't hurt. -%.dvi: %.tex - latex $(LATEXOPTS) '$<' - latex $(LATEXOPTS) '$<' - latex $(LATEXOPTS) '$<' - -makeindex -s python.ist '$(basename $<).idx' - latex $(LATEXOPTS) '$<' - latex $(LATEXOPTS) '$<' - -%.pdf: %.tex - pdflatex $(LATEXOPTS) '$<' - pdflatex $(LATEXOPTS) '$<' - pdflatex $(LATEXOPTS) '$<' - -makeindex -s python.ist '$(basename $<).idx' - pdflatex $(LATEXOPTS) '$<' - pdflatex $(LATEXOPTS) '$<' +xz: tar + xz -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar clean: - rm -f *.dvi *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla - -.PHONY: all all-pdf all-dvi all-ps clean -.PHONY: all-pdf-ja + rm -f *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla *.ps *.tar *.tar.gz *.tar.bz2 *.tar.xz $(ALLPDF) $(ALLDVI) $(ALLXDV) *.fls *.fdb_latexmk +.PHONY: all all-pdf all-dvi all-ps clean zip tar gz bz2 xz +.PHONY: FORCE_MAKE \ No newline at end of file diff --git a/docs/build/latex/fncychap.sty b/docs/build/latex/fncychap.sty deleted file mode 100644 index 9a56c04..0000000 --- a/docs/build/latex/fncychap.sty +++ /dev/null @@ -1,683 +0,0 @@ -%%% Copyright Ulf A. Lindgren -%%% -%%% Note Premission is granted to modify this file under -%%% the condition that it is saved using another -%%% file and package name. -%%% -%%% Revision 1.1 (1997) -%%% -%%% Jan. 8th Modified package name base date option -%%% Jan. 22th Modified FmN and FmTi for error in book.cls -%%% \MakeUppercase{#}->{\MakeUppercase#} -%%% Apr. 6th Modified Lenny option to prevent undesired -%%% skip of line. -%%% Nov. 8th Fixed \@chapapp for AMS -%%% -%%% Revision 1.2 (1998) -%%% -%%% Feb. 11th Fixed appendix problem related to Bjarne -%%% Aug. 11th Fixed problem related to 11pt and 12pt -%%% suggested by Tomas Lundberg. THANKS! -%%% -%%% Revision 1.3 (2004) -%%% Sep. 20th problem with frontmatter, mainmatter and -%%% backmatter, pointed out by Lapo Mori -%%% -%%% Revision 1.31 (2004) -%%% Sep. 21th problem with the Rejne definition streched text -%%% caused ugly gaps in the vrule aligned with the title -%%% text. Kindly pointed out to me by Hendri Adriaens -%%% -%%% Revision 1.32 (2005) -%%% Jun. 23th compatibility problem with the KOMA class 'scrbook.cls' -%%% a remedy is a redefinition of '\@schapter' in -%%% line with that used in KOMA. The problem was pointed -%%% out to me by Mikkel Holm Olsen -%%% -%%% Revision 1.33 (2005) -%%% Aug. 9th misspelled ``TWELV'' corrected, the error was pointed -%%% out to me by George Pearson -%%% -%%% Revision 1.34 (2007) -%%% Added an alternative to Lenny provided by Peter -%%% Osborne (2005-11-28) -%%% Corrected front, main and back matter, based on input -%%% from Bas van Gils (2006-04-24) -%%% Jul. 30th Added Bjornstrup option provided by Jean-Marc -%%% Francois (2007-01-05). -%%% Reverted to \MakeUppercase{#} see rev 1.1, solved -%%% problem with MakeUppercase and MakeLowercase pointed -%%% out by Marco Feuerstein (2007-06-06) - - -%%% Last modified Jul. 2007 - -\NeedsTeXFormat{LaTeX2e}[1995/12/01] -\ProvidesPackage{fncychap} - [2007/07/30 v1.34 - LaTeX package (Revised chapters)] - -%%%% For conditional inclusion of color -\newif\ifusecolor -\usecolorfalse - - - -%%%% DEFINITION OF Chapapp variables -\newcommand{\CNV}{\huge\bfseries} -\newcommand{\ChNameVar}[1]{\renewcommand{\CNV}{#1}} - - -%%%% DEFINITION OF TheChapter variables -\newcommand{\CNoV}{\huge\bfseries} -\newcommand{\ChNumVar}[1]{\renewcommand{\CNoV}{#1}} - -\newif\ifUCN -\UCNfalse -\newif\ifLCN -\LCNfalse -\def\ChNameLowerCase{\LCNtrue\UCNfalse} -\def\ChNameUpperCase{\UCNtrue\LCNfalse} -\def\ChNameAsIs{\UCNfalse\LCNfalse} - -%%%%% Fix for AMSBook 971008 - -\@ifundefined{@chapapp}{\let\@chapapp\chaptername}{} - - -%%%%% Fix for Bjarne and appendix 980211 - -\newif\ifinapp -\inappfalse -\renewcommand\appendix{\par - \setcounter{chapter}{0}% - \setcounter{section}{0}% - \inapptrue% - \renewcommand\@chapapp{\appendixname}% - \renewcommand\thechapter{\@Alph\c@chapter}} - -%%%%% Fix for frontmatter, mainmatter, and backmatter 040920 - -\@ifundefined{@mainmatter}{\newif\if@mainmatter \@mainmattertrue}{} - -%%%%% - - - -\newcommand{\FmN}[1]{% -\ifUCN - {\MakeUppercase{#1}}\LCNfalse -\else - \ifLCN - {\MakeLowercase{#1}}\UCNfalse - \else #1 - \fi -\fi} - - -%%%% DEFINITION OF Title variables -\newcommand{\CTV}{\Huge\bfseries} -\newcommand{\ChTitleVar}[1]{\renewcommand{\CTV}{#1}} - -%%%% DEFINITION OF the basic rule width -\newlength{\RW} -\setlength{\RW}{1pt} -\newcommand{\ChRuleWidth}[1]{\setlength{\RW}{#1}} - -\newif\ifUCT -\UCTfalse -\newif\ifLCT -\LCTfalse -\def\ChTitleLowerCase{\LCTtrue\UCTfalse} -\def\ChTitleUpperCase{\UCTtrue\LCTfalse} -\def\ChTitleAsIs{\UCTfalse\LCTfalse} -\newcommand{\FmTi}[1]{% -\ifUCT - {\MakeUppercase{#1}}\LCTfalse -\else - \ifLCT - {\MakeLowercase{#1}}\UCTfalse - \else {#1} - \fi -\fi} - - - -\newlength{\mylen} -\newlength{\myhi} -\newlength{\px} -\newlength{\py} -\newlength{\pyy} -\newlength{\pxx} - - -\def\mghrulefill#1{\leavevmode\leaders\hrule\@height #1\hfill\kern\z@} - -\newcommand{\DOCH}{% - \CNV\FmN{\@chapapp}\space \CNoV\thechapter - \par\nobreak - \vskip 20\p@ - } -\newcommand{\DOTI}[1]{% - \CTV\FmTi{#1}\par\nobreak - \vskip 40\p@ - } -\newcommand{\DOTIS}[1]{% - \CTV\FmTi{#1}\par\nobreak - \vskip 40\p@ - } - -%%%%%% SONNY DEF - -\DeclareOption{Sonny}{% - \ChNameVar{\Large\sf} - \ChNumVar{\Huge} - \ChTitleVar{\Large\sf} - \ChRuleWidth{0.5pt} - \ChNameUpperCase - \renewcommand{\DOCH}{% - \raggedleft - \CNV\FmN{\@chapapp}\space \CNoV\thechapter - \par\nobreak - \vskip 40\p@} - \renewcommand{\DOTI}[1]{% - \CTV\raggedleft\mghrulefill{\RW}\par\nobreak - \vskip 5\p@ - \CTV\FmTi{#1}\par\nobreak - \mghrulefill{\RW}\par\nobreak - \vskip 40\p@} - \renewcommand{\DOTIS}[1]{% - \CTV\raggedleft\mghrulefill{\RW}\par\nobreak - \vskip 5\p@ - \CTV\FmTi{#1}\par\nobreak - \mghrulefill{\RW}\par\nobreak - \vskip 40\p@} -} - -%%%%%% LENNY DEF - -\DeclareOption{Lenny}{% - - \ChNameVar{\fontsize{14}{16}\usefont{OT1}{phv}{m}{n}\selectfont} - \ChNumVar{\fontsize{60}{62}\usefont{OT1}{ptm}{m}{n}\selectfont} - \ChTitleVar{\Huge\bfseries\rm} - \ChRuleWidth{1pt} - \renewcommand{\DOCH}{% - \settowidth{\px}{\CNV\FmN{\@chapapp}} - \addtolength{\px}{2pt} - \settoheight{\py}{\CNV\FmN{\@chapapp}} - \addtolength{\py}{1pt} - - \settowidth{\mylen}{\CNV\FmN{\@chapapp}\space\CNoV\thechapter} - \addtolength{\mylen}{1pt} - \settowidth{\pxx}{\CNoV\thechapter} - \addtolength{\pxx}{-1pt} - - \settoheight{\pyy}{\CNoV\thechapter} - \addtolength{\pyy}{-2pt} - \setlength{\myhi}{\pyy} - \addtolength{\myhi}{-1\py} - \par - \parbox[b]{\textwidth}{% - \rule[\py]{\RW}{\myhi}% - \hskip -\RW% - \rule[\pyy]{\px}{\RW}% - \hskip -\px% - \raggedright% - \CNV\FmN{\@chapapp}\space\CNoV\thechapter% - \hskip1pt% - \mghrulefill{\RW}% - \rule{\RW}{\pyy}\par\nobreak% - \vskip -\baselineskip% - \vskip -\pyy% - \hskip \mylen% - \mghrulefill{\RW}\par\nobreak% - \vskip \pyy}% - \vskip 20\p@} - - - \renewcommand{\DOTI}[1]{% - \raggedright - \CTV\FmTi{#1}\par\nobreak - \vskip 40\p@} - - \renewcommand{\DOTIS}[1]{% - \raggedright - \CTV\FmTi{#1}\par\nobreak - \vskip 40\p@} - } - -%%%%%% Peter Osbornes' version of LENNY DEF - -\DeclareOption{PetersLenny}{% - -% five new lengths -\newlength{\bl} % bottom left : orig \space -\setlength{\bl}{6pt} -\newcommand{\BL}[1]{\setlength{\bl}{#1}} -\newlength{\br} % bottom right : orig 1pt -\setlength{\br}{1pt} -\newcommand{\BR}[1]{\setlength{\br}{#1}} -\newlength{\tl} % top left : orig 2pt -\setlength{\tl}{2pt} -\newcommand{\TL}[1]{\setlength{\tl}{#1}} -\newlength{\trr} % top right :orig 1pt -\setlength{\trr}{1pt} -\newcommand{\TR}[1]{\setlength{\trr}{#1}} -\newlength{\blrule} % top right :orig 1pt -\setlength{\trr}{0pt} -\newcommand{\BLrule}[1]{\setlength{\blrule}{#1}} - - - \ChNameVar{\fontsize{14}{16}\usefont{OT1}{phv}{m}{n}\selectfont} - \ChNumVar{\fontsize{60}{62}\usefont{OT1}{ptm}{m}{n}\selectfont} - \ChTitleVar{\Huge\bfseries\rm} - \ChRuleWidth{1pt} -\renewcommand{\DOCH}{% - - -%%%%%%% tweaks for 1--9 and A--Z -\ifcase\c@chapter\relax% -\or\BL{-3pt}\TL{-4pt}\BR{0pt}\TR{-6pt}%1 -\or\BL{0pt}\TL{-4pt}\BR{2pt}\TR{-4pt}%2 -\or\BL{0pt}\TL{-4pt}\BR{2pt}\TR{-4pt}%3 -\or\BL{0pt}\TL{5pt}\BR{2pt}\TR{-4pt}%4 -\or\BL{0pt}\TL{3pt}\BR{2pt}\TR{-4pt}%5 -\or\BL{-1pt}\TL{0pt}\BR{2pt}\TR{-2pt}%6 -\or\BL{0pt}\TL{-3pt}\BR{2pt}\TR{-2pt}%7 -\or\BL{0pt}\TL{-3pt}\BR{2pt}\TR{-2pt}%8 -\or\BL{0pt}\TL{-3pt}\BR{-4pt}\TR{-2pt}%9 -\or\BL{-3pt}\TL{-3pt}\BR{2pt}\TR{-7pt}%10 -\or\BL{-6pt}\TL{-6pt}\BR{0pt}\TR{-9pt}%11 -\or\BL{-6pt}\TL{-6pt}\BR{2pt}\TR{-7pt}%12 -\or\BL{-5pt}\TL{-5pt}\BR{0pt}\TR{-9pt}%13 -\or\BL{-6pt}\TL{-6pt}\BR{0pt}\TR{-9pt}%14 -\or\BL{-3pt}\TL{-3pt}\BR{3pt}\TR{-6pt}%15 -\or\BL{-3pt}\TL{-3pt}\BR{3pt}\TR{-6pt}%16 -\or\BL{-5pt}\TL{-3pt}\BR{-8pt}\TR{-6pt}%17 -\or\BL{-5pt}\TL{-5pt}\BR{0pt}\TR{-9pt}%18 -\or\BL{-3pt}\TL{-3pt}\BR{-6pt}\TR{-9pt}%19 -\or\BL{0pt}\TL{0pt}\BR{0pt}\TR{-5pt}%20 -\fi - -\ifinapp\ifcase\c@chapter\relax% -\or\BL{0pt}\TL{14pt}\BR{5pt}\TR{-19pt}%A -\or\BL{0pt}\TL{-5pt}\BR{-3pt}\TR{-8pt}%B -\or\BL{-3pt}\TL{-2pt}\BR{1pt}\TR{-6pt}\BLrule{0pt}%C -\or\BL{0pt}\TL{-5pt}\BR{-3pt}\TR{-8pt}\BLrule{0pt}%D -\or\BL{0pt}\TL{-5pt}\BR{2pt}\TR{-3pt}%E -\or\BL{0pt}\TL{-5pt}\BR{-10pt}\TR{-1pt}%F -\or\BL{-3pt}\TL{0pt}\BR{0pt}\TR{-7pt}%G -\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}%H -\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}%I -\or\BL{2pt}\TL{0pt}\BR{-3pt}\TR{1pt}%J -\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}%K -\or\BL{0pt}\TL{-5pt}\BR{2pt}\TR{-19pt}%L -\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}%M -\or\BL{0pt}\TL{-5pt}\BR{-2pt}\TR{-1pt}%N -\or\BL{-3pt}\TL{-2pt}\BR{-3pt}\TR{-11pt}%O -\or\BL{0pt}\TL{-5pt}\BR{-9pt}\TR{-3pt}%P -\or\BL{-3pt}\TL{-2pt}\BR{-3pt}\TR{-11pt}%Q -\or\BL{0pt}\TL{-5pt}\BR{4pt}\TR{-8pt}%R -\or\BL{-2pt}\TL{-2pt}\BR{-2pt}\TR{-7pt}%S -\or\BL{-3pt}\TL{0pt}\BR{-5pt}\TR{4pt}\BLrule{8pt}%T -\or\BL{-7pt}\TL{-11pt}\BR{-5pt}\TR{-7pt}\BLrule{0pt}%U -\or\BL{-14pt}\TL{-5pt}\BR{-14pt}\TR{-1pt}\BLrule{14pt}%V -\or\BL{-10pt}\TL{-9pt}\BR{-13pt}\TR{-3pt}\BLrule{7pt}%W -\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}\BLrule{0pt}%X -\or\BL{-6pt}\TL{-4pt}\BR{-7pt}\TR{1pt}\BLrule{7pt}%Y -\or\BL{0pt}\TL{-5pt}\BR{3pt}\TR{-1pt}\BLrule{0pt}%Z -\fi\fi -%%%%%%% - \settowidth{\px}{\CNV\FmN{\@chapapp}} - \addtolength{\px}{\tl} %MOD change 2pt to \tl - \settoheight{\py}{\CNV\FmN{\@chapapp}} - \addtolength{\py}{1pt} - - \settowidth{\mylen}{\CNV\FmN{\@chapapp}\space\CNoV\thechapter} - \addtolength{\mylen}{\trr}% MOD change 1pt to \tr - \settowidth{\pxx}{\CNoV\thechapter} - \addtolength{\pxx}{-1pt} - - \settoheight{\pyy}{\CNoV\thechapter} - \addtolength{\pyy}{-2pt} - \setlength{\myhi}{\pyy} - \addtolength{\myhi}{-1\py} - \par - \parbox[b]{\textwidth}{% - \rule[\py]{\RW}{\myhi}% - \hskip -\RW% - \rule[\pyy]{\px}{\RW}% - \hskip -\px% - \raggedright% - \CNV\FmN{\@chapapp}\rule{\blrule}{\RW}\hskip\bl\CNoV\thechapter%MOD -% \CNV\FmN{\@chapapp}\space\CNoV\thechapter %ORIGINAL - \hskip\br% %MOD 1pt to \br - \mghrulefill{\RW}% - \rule{\RW}{\pyy}\par\nobreak% - \vskip -\baselineskip% - \vskip -\pyy% - \hskip \mylen% - \mghrulefill{\RW}\par\nobreak% - \vskip \pyy}% - \vskip 20\p@} - - - \renewcommand{\DOTI}[1]{% - \raggedright - \CTV\FmTi{#1}\par\nobreak - \vskip 40\p@} - - \renewcommand{\DOTIS}[1]{% - \raggedright - \CTV\FmTi{#1}\par\nobreak - \vskip 40\p@} - } - - -% - - -%%%%%% BJORNSTRUP DEF - -\DeclareOption{Bjornstrup}{% - \usecolortrue - % pzc (Zapf Chancelery) is nice. ppl (Palatino) is cool too. - \ChNumVar{\fontsize{76}{80}\usefont{OT1}{pzc}{m}{n}\selectfont} - \ChTitleVar{\raggedleft\Large\sffamily\bfseries} - - \setlength{\myhi}{10pt} % Space between grey box border and text - \setlength{\mylen}{\textwidth} - \addtolength{\mylen}{-2\myhi} - \renewcommand{\DOCH}{% - \settowidth{\py}{\CNoV\thechapter} - \addtolength{\py}{-10pt} % Amount of space by which the -% % number is shifted right - \fboxsep=0pt% - \colorbox[gray]{.85}{\rule{0pt}{40pt}\parbox[b]{\textwidth}{\hfill}}% - \kern-\py\raise20pt% - \hbox{\color[gray]{.5}\CNoV\thechapter}\\% - } - - \renewcommand{\DOTI}[1]{% - \nointerlineskip\raggedright% - \fboxsep=\myhi% - \vskip-1ex% - \colorbox[gray]{.85}{\parbox[t]{\mylen}{\CTV\FmTi{#1}}}\par\nobreak% - \vskip 40\p@% - } - - \renewcommand{\DOTIS}[1]{% - \fboxsep=0pt - \colorbox[gray]{.85}{\rule{0pt}{40pt}\parbox[b]{\textwidth}{\hfill}}\\% - \nointerlineskip\raggedright% - \fboxsep=\myhi% - \colorbox[gray]{.85}{\parbox[t]{\mylen}{\CTV\FmTi{#1}}}\par\nobreak% - \vskip 40\p@% - } -} - - -%%%%%%% GLENN DEF - - -\DeclareOption{Glenn}{% - \ChNameVar{\bfseries\Large\sf} - \ChNumVar{\Huge} - \ChTitleVar{\bfseries\Large\rm} - \ChRuleWidth{1pt} - \ChNameUpperCase - \ChTitleUpperCase - \renewcommand{\DOCH}{% - \settoheight{\myhi}{\CTV\FmTi{Test}} - \setlength{\py}{\baselineskip} - \addtolength{\py}{\RW} - \addtolength{\py}{\myhi} - \setlength{\pyy}{\py} - \addtolength{\pyy}{-1\RW} - - \raggedright - \CNV\FmN{\@chapapp}\space\CNoV\thechapter - \hskip 3pt\mghrulefill{\RW}\rule[-1\pyy]{2\RW}{\py}\par\nobreak} - - \renewcommand{\DOTI}[1]{% - \addtolength{\pyy}{-4pt} - \settoheight{\myhi}{\CTV\FmTi{#1}} - \addtolength{\myhi}{\py} - \addtolength{\myhi}{-1\RW} - \vskip -1\pyy - \rule{2\RW}{\myhi}\mghrulefill{\RW}\hskip 2pt - \raggedleft\CTV\FmTi{#1}\par\nobreak - \vskip 80\p@} - -\newlength{\backskip} - \renewcommand{\DOTIS}[1]{% -% \setlength{\py}{10pt} -% \setlength{\pyy}{\py} -% \addtolength{\pyy}{\RW} -% \setlength{\myhi}{\baselineskip} -% \addtolength{\myhi}{\pyy} -% \mghrulefill{\RW}\rule[-1\py]{2\RW}{\pyy}\par\nobreak -% \addtolength{}{} -%\vskip -1\baselineskip -% \rule{2\RW}{\myhi}\mghrulefill{\RW}\hskip 2pt -% \raggedleft\CTV\FmTi{#1}\par\nobreak -% \vskip 60\p@} -%% Fix suggested by Tomas Lundberg - \setlength{\py}{25pt} % eller vad man vill - \setlength{\pyy}{\py} - \setlength{\backskip}{\py} - \addtolength{\backskip}{2pt} - \addtolength{\pyy}{\RW} - \setlength{\myhi}{\baselineskip} - \addtolength{\myhi}{\pyy} - \mghrulefill{\RW}\rule[-1\py]{2\RW}{\pyy}\par\nobreak - \vskip -1\backskip - \rule{2\RW}{\myhi}\mghrulefill{\RW}\hskip 3pt % - \raggedleft\CTV\FmTi{#1}\par\nobreak - \vskip 40\p@} - } - -%%%%%%% CONNY DEF - -\DeclareOption{Conny}{% - \ChNameUpperCase - \ChTitleUpperCase - \ChNameVar{\centering\Huge\rm\bfseries} - \ChNumVar{\Huge} - \ChTitleVar{\centering\Huge\rm} - \ChRuleWidth{2pt} - - \renewcommand{\DOCH}{% - \mghrulefill{3\RW}\par\nobreak - \vskip -0.5\baselineskip - \mghrulefill{\RW}\par\nobreak - \CNV\FmN{\@chapapp}\space \CNoV\thechapter - \par\nobreak - \vskip -0.5\baselineskip - } - \renewcommand{\DOTI}[1]{% - \mghrulefill{\RW}\par\nobreak - \CTV\FmTi{#1}\par\nobreak - \vskip 60\p@ - } - \renewcommand{\DOTIS}[1]{% - \mghrulefill{\RW}\par\nobreak - \CTV\FmTi{#1}\par\nobreak - \vskip 60\p@ - } - } - -%%%%%%% REJNE DEF - -\DeclareOption{Rejne}{% - - \ChNameUpperCase - \ChTitleUpperCase - \ChNameVar{\centering\Large\rm} - \ChNumVar{\Huge} - \ChTitleVar{\centering\Huge\rm} - \ChRuleWidth{1pt} - \renewcommand{\DOCH}{% - \settoheight{\py}{\CNoV\thechapter} - \parskip=0pt plus 1pt % Set parskip to default, just in case v1.31 - \addtolength{\py}{-1pt} - \CNV\FmN{\@chapapp}\par\nobreak - \vskip 20\p@ - \setlength{\myhi}{2\baselineskip} - \setlength{\px}{\myhi} - \addtolength{\px}{-1\RW} - \rule[-1\px]{\RW}{\myhi}\mghrulefill{\RW}\hskip - 10pt\raisebox{-0.5\py}{\CNoV\thechapter}\hskip 10pt\mghrulefill{\RW}\rule[-1\px]{\RW}{\myhi}\par\nobreak - \vskip -3\p@% Added -2pt vskip to correct for streched text v1.31 - } - \renewcommand{\DOTI}[1]{% - \setlength{\mylen}{\textwidth} - \parskip=0pt plus 1pt % Set parskip to default, just in case v1.31 - \addtolength{\mylen}{-2\RW} - {\vrule width\RW}\parbox{\mylen}{\CTV\FmTi{#1}}{\vrule width\RW}\par\nobreak% - \vskip -3pt\rule{\RW}{2\baselineskip}\mghrulefill{\RW}\rule{\RW}{2\baselineskip}% - \vskip 60\p@% Added -2pt in vskip to correct for streched text v1.31 - } - \renewcommand{\DOTIS}[1]{% - \setlength{\py}{\fboxrule} - \setlength{\fboxrule}{\RW} - \setlength{\mylen}{\textwidth} - \addtolength{\mylen}{-2\RW} - \fbox{\parbox{\mylen}{\vskip 2\baselineskip\CTV\FmTi{#1}\par\nobreak\vskip \baselineskip}} - \setlength{\fboxrule}{\py} - \vskip 60\p@ - } - } - - -%%%%%%% BJARNE DEF - -\DeclareOption{Bjarne}{% - \ChNameUpperCase - \ChTitleUpperCase - \ChNameVar{\raggedleft\normalsize\rm} - \ChNumVar{\raggedleft \bfseries\Large} - \ChTitleVar{\raggedleft \Large\rm} - \ChRuleWidth{1pt} - - -%% Note thechapter -> c@chapter fix appendix bug -%% Fixed misspelled 12 - - \newcounter{AlphaCnt} - \newcounter{AlphaDecCnt} - \newcommand{\AlphaNo}{% - \ifcase\number\theAlphaCnt - \ifnum\c@chapter=0 - ZERO\else{}\fi - \or ONE\or TWO\or THREE\or FOUR\or FIVE - \or SIX\or SEVEN\or EIGHT\or NINE\or TEN - \or ELEVEN\or TWELVE\or THIRTEEN\or FOURTEEN\or FIFTEEN - \or SIXTEEN\or SEVENTEEN\or EIGHTEEN\or NINETEEN\fi -} - - \newcommand{\AlphaDecNo}{% - \setcounter{AlphaDecCnt}{0} - \@whilenum\number\theAlphaCnt>0\do - {\addtocounter{AlphaCnt}{-10} - \addtocounter{AlphaDecCnt}{1}} - \ifnum\number\theAlphaCnt=0 - \else - \addtocounter{AlphaDecCnt}{-1} - \addtocounter{AlphaCnt}{10} - \fi - - - \ifcase\number\theAlphaDecCnt\or TEN\or TWENTY\or THIRTY\or - FORTY\or FIFTY\or SIXTY\or SEVENTY\or EIGHTY\or NINETY\fi - } - \newcommand{\TheAlphaChapter}{% - - \ifinapp - \thechapter - \else - \setcounter{AlphaCnt}{\c@chapter} - \ifnum\c@chapter<20 - \AlphaNo - \else - \AlphaDecNo\AlphaNo - \fi - \fi - } - \renewcommand{\DOCH}{% - \mghrulefill{\RW}\par\nobreak - \CNV\FmN{\@chapapp}\par\nobreak - \CNoV\TheAlphaChapter\par\nobreak - \vskip -1\baselineskip\vskip 5pt\mghrulefill{\RW}\par\nobreak - \vskip 20\p@ - } - \renewcommand{\DOTI}[1]{% - \CTV\FmTi{#1}\par\nobreak - \vskip 40\p@ - } - \renewcommand{\DOTIS}[1]{% - \CTV\FmTi{#1}\par\nobreak - \vskip 40\p@ - } -} - -\DeclareOption*{% - \PackageWarning{fancychapter}{unknown style option} - } - -\ProcessOptions* \relax - -\ifusecolor - \RequirePackage{color} -\fi -\def\@makechapterhead#1{% - \vspace*{50\p@}% - {\parindent \z@ \raggedright \normalfont - \ifnum \c@secnumdepth >\m@ne - \if@mainmatter%%%%% Fix for frontmatter, mainmatter, and backmatter 040920 - \DOCH - \fi - \fi - \interlinepenalty\@M - \if@mainmatter%%%%% Fix for frontmatter, mainmatter, and backmatter 060424 - \DOTI{#1}% - \else% - \DOTIS{#1}% - \fi - }} - - -%%% Begin: To avoid problem with scrbook.cls (fncychap version 1.32) - -%%OUT: -%\def\@schapter#1{\if@twocolumn -% \@topnewpage[\@makeschapterhead{#1}]% -% \else -% \@makeschapterhead{#1}% -% \@afterheading -% \fi} - -%%IN: -\def\@schapter#1{% -\if@twocolumn% - \@makeschapterhead{#1}% -\else% - \@makeschapterhead{#1}% - \@afterheading% -\fi} - -%%% End: To avoid problem with scrbook.cls (fncychap version 1.32) - -\def\@makeschapterhead#1{% - \vspace*{50\p@}% - {\parindent \z@ \raggedright - \normalfont - \interlinepenalty\@M - \DOTIS{#1} - \vskip 40\p@ - }} - -\endinput - - diff --git a/docs/build/latex/python.ist b/docs/build/latex/python.ist index 9ffa0f9..70536a6 100644 --- a/docs/build/latex/python.ist +++ b/docs/build/latex/python.ist @@ -2,10 +2,15 @@ line_max 100 headings_flag 1 heading_prefix " \\bigletter " -preamble "\\begin{theindex} -\\def\\bigletter#1{{\\Large\\sffamily#1}\\nopagebreak\\vspace{1mm}} +preamble "\\begin{sphinxtheindex} +\\let\\bigletter\\sphinxstyleindexlettergroup +\\let\\spxpagem \\sphinxstyleindexpagemain +\\let\\spxentry \\sphinxstyleindexentry +\\let\\spxextra \\sphinxstyleindexextra " -symhead_positive "{Symbols}" -numhead_positive "{Numbers}" +postamble "\n\n\\end{sphinxtheindex}\n" + +symhead_positive "{\\sphinxsymbolsname}" +numhead_positive "{\\sphinxnumbersname}" diff --git a/docs/build/latex/rHEALPixDGGS.aux b/docs/build/latex/rHEALPixDGGS.aux index 7a5ac30..9d77c8f 100644 --- a/docs/build/latex/rHEALPixDGGS.aux +++ b/docs/build/latex/rHEALPixDGGS.aux @@ -1,5 +1,7 @@ \relax \providecommand\hyper@newdestlabel[2]{} +\providecommand\babel@aux[2]{} +\@nameuse{bbl@beforestart} \providecommand\HyperFirstAtBeginDocument{\AtBeginDocument} \HyperFirstAtBeginDocument{\ifx\hyper@anchor\@undefined \global\let\oldcontentsline\contentsline @@ -15,170 +17,155 @@ \global\let\hyper@last\relax \gdef\HyperFirstAtBeginDocument#1{#1} \providecommand\HyField@AuxAddToFields[1]{} -\select@language{english} -\@writefile{toc}{\select@language{english}} -\@writefile{lof}{\select@language{english}} -\@writefile{lot}{\select@language{english}} +\providecommand\HyField@AuxAddToCoFields[2]{} +\babel@aux{english}{} +\citation{introduction:grs2013} \newlabel{index::doc}{{}{1}{}{section*.2}{}} -\@writefile{toc}{\contentsline {chapter}{\numberline {1}Introduction}{1}{chapter.1}} +\@writefile{toc}{\contentsline {chapter}{\numberline {1}Introduction}{1}{chapter.1}\protected@file@percent } \@writefile{lof}{\addvspace {10\p@ }} \@writefile{lot}{\addvspace {10\p@ }} -\newlabel{introduction::doc}{{1}{1}{Introduction}{chapter.1}{}} -\newlabel{introduction:welcome-the-rhealpixdggs-documentation}{{1}{1}{Introduction}{chapter.1}{}} \newlabel{introduction:introduction}{{1}{1}{Introduction}{chapter.1}{}} -\@writefile{toc}{\contentsline {section}{\numberline {1.1}Requirements}{1}{section.1.1}} +\newlabel{introduction::doc}{{1}{1}{Introduction}{chapter.1}{}} +\@writefile{toc}{\contentsline {section}{\numberline {1.1}Requirements}{1}{section.1.1}\protected@file@percent } \newlabel{introduction:requirements}{{1.1}{1}{Requirements}{section.1.1}{}} -\@writefile{toc}{\contentsline {section}{\numberline {1.2}Installation}{1}{section.1.2}} +\@writefile{toc}{\contentsline {section}{\numberline {1.2}Installation}{1}{section.1.2}\protected@file@percent } \newlabel{introduction:installation}{{1.2}{1}{Installation}{section.1.2}{}} -\@writefile{toc}{\contentsline {section}{\numberline {1.3}Usage}{1}{section.1.3}} +\@writefile{toc}{\contentsline {section}{\numberline {1.3}Usage}{1}{section.1.3}\protected@file@percent } \newlabel{introduction:usage}{{1.3}{1}{Usage}{section.1.3}{}} -\@writefile{toc}{\contentsline {subsection}{\numberline {1.3.1}Using the \texttt {ellipsoids} and \texttt {projection\_wrapper} Modules}{2}{subsection.1.3.1}} -\newlabel{introduction:using-the-ellipsoids-and-projection-wrapper-modules}{{1.3.1}{2}{Using the \texttt {ellipsoids} and \texttt {projection\_wrapper} Modules}{subsection.1.3.1}{}} -\@writefile{toc}{\contentsline {subsection}{\numberline {1.3.2}Using the \texttt {dggs} Module}{3}{subsection.1.3.2}} -\newlabel{introduction:using-the-dggs-module}{{1.3.2}{3}{Using the \texttt {dggs} Module}{subsection.1.3.2}{}} -\@writefile{toc}{\contentsline {subsection}{\numberline {1.3.3}Using the \texttt {distortion} Module}{6}{subsection.1.3.3}} -\newlabel{introduction:using-the-distortion-module}{{1.3.3}{6}{Using the \texttt {distortion} Module}{subsection.1.3.3}{}} -\@writefile{toc}{\contentsline {chapter}{\numberline {2}The utils Module}{7}{chapter.2}} +\@writefile{toc}{\contentsline {subsection}{\numberline {1.3.1}Using the \sphinxstyleliteralintitle {\sphinxupquote {ellipsoids}} and \sphinxstyleliteralintitle {\sphinxupquote {projection\_wrapper}} Modules}{1}{subsection.1.3.1}\protected@file@percent } +\newlabel{introduction:using-the-ellipsoids-and-projection-wrapper-modules}{{1.3.1}{1}{Using the \sphinxstyleliteralintitle {\sphinxupquote {ellipsoids}} and \sphinxstyleliteralintitle {\sphinxupquote {projection\_wrapper}} Modules}{subsection.1.3.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {1.3.2}Using the \sphinxstyleliteralintitle {\sphinxupquote {dggs}} Module}{3}{subsection.1.3.2}\protected@file@percent } +\newlabel{introduction:using-the-dggs-module}{{1.3.2}{3}{Using the \sphinxstyleliteralintitle {\sphinxupquote {dggs}} Module}{subsection.1.3.2}{}} +\@writefile{toc}{\contentsline {chapter}{\numberline {2}The utils Module}{7}{chapter.2}\protected@file@percent } \@writefile{lof}{\addvspace {10\p@ }} \@writefile{lot}{\addvspace {10\p@ }} -\newlabel{utils::doc}{{2}{7}{The utils Module}{chapter.2}{}} +\newlabel{utils:module-rhealpixdggs.utils}{{2}{7}{The utils Module}{chapter.2}{}} \newlabel{utils:the-utils-module}{{2}{7}{The utils Module}{chapter.2}{}} -\newlabel{utils:module-rhealpix_dggs.utils}{{2}{7}{The utils Module}{chapter.2}{}} -\newlabel{utils:rhealpix_dggs.utils.auth_lat}{{2}{7}{The utils Module}{section*.3}{}} -\newlabel{utils:rhealpix_dggs.utils.auth_rad}{{2}{7}{The utils Module}{section*.4}{}} -\newlabel{utils:rhealpix_dggs.utils.my_round}{{2}{7}{The utils Module}{section*.5}{}} -\newlabel{utils:rhealpix_dggs.utils.wrap_latitude}{{2}{8}{The utils Module}{section*.6}{}} -\newlabel{utils:rhealpix_dggs.utils.wrap_longitude}{{2}{8}{The utils Module}{section*.7}{}} -\@writefile{toc}{\contentsline {chapter}{\numberline {3}The pj\_healpix Module}{9}{chapter.3}} -\@writefile{lof}{\addvspace {10\p@ }} -\@writefile{lot}{\addvspace {10\p@ }} -\newlabel{pj_healpix::doc}{{3}{9}{The pj\_healpix Module}{chapter.3}{}} -\newlabel{pj_healpix:the-pj-healpix-module}{{3}{9}{The pj\_healpix Module}{chapter.3}{}} -\newlabel{pj_healpix:module-rhealpix_dggs.pj_healpix}{{3}{9}{The pj\_healpix Module}{chapter.3}{}} -\newlabel{pj_healpix:rhealpix_dggs.pj_healpix.healpix}{{3}{9}{The pj\_healpix Module}{section*.8}{}} -\newlabel{pj_healpix:rhealpix_dggs.pj_healpix.healpix_diagram}{{3}{9}{The pj\_healpix Module}{section*.9}{}} -\newlabel{pj_healpix:rhealpix_dggs.pj_healpix.healpix_ellipsoid}{{3}{9}{The pj\_healpix Module}{section*.10}{}} -\newlabel{pj_healpix:rhealpix_dggs.pj_healpix.healpix_ellipsoid_inverse}{{3}{10}{The pj\_healpix Module}{section*.11}{}} -\newlabel{pj_healpix:rhealpix_dggs.pj_healpix.healpix_sphere}{{3}{10}{The pj\_healpix Module}{section*.12}{}} -\newlabel{pj_healpix:rhealpix_dggs.pj_healpix.healpix_sphere_inverse}{{3}{10}{The pj\_healpix Module}{section*.13}{}} -\newlabel{pj_healpix:rhealpix_dggs.pj_healpix.healpix_vertices}{{3}{10}{The pj\_healpix Module}{section*.14}{}} -\newlabel{pj_healpix:rhealpix_dggs.pj_healpix.in_healpix_image}{{3}{10}{The pj\_healpix Module}{section*.15}{}} -\@writefile{toc}{\contentsline {chapter}{\numberline {4}The pj\_rhealpix Module}{12}{chapter.4}} +\newlabel{utils::doc}{{2}{7}{The utils Module}{chapter.2}{}} +\newlabel{utils:rhealpixdggs.utils.auth_lat}{{2}{7}{The utils Module}{section*.3}{}} +\newlabel{utils:rhealpixdggs.utils.auth_rad}{{2}{7}{The utils Module}{section*.4}{}} +\newlabel{utils:rhealpixdggs.utils.my_round}{{2}{8}{The utils Module}{section*.5}{}} +\newlabel{utils:rhealpixdggs.utils.wrap_latitude}{{2}{8}{The utils Module}{section*.6}{}} +\newlabel{utils:rhealpixdggs.utils.wrap_longitude}{{2}{8}{The utils Module}{section*.7}{}} +\citation{pj_healpix:caro2007} +\@writefile{toc}{\contentsline {chapter}{\numberline {3}The pj\_healpix Module}{10}{chapter.3}\protected@file@percent } \@writefile{lof}{\addvspace {10\p@ }} \@writefile{lot}{\addvspace {10\p@ }} -\newlabel{pj_rhealpix::doc}{{4}{12}{The pj\_rhealpix Module}{chapter.4}{}} -\newlabel{pj_rhealpix:module-rhealpix_dggs.pj_rhealpix}{{4}{12}{The pj\_rhealpix Module}{chapter.4}{}} -\newlabel{pj_rhealpix:the-pj-rhealpix-module}{{4}{12}{The pj\_rhealpix Module}{chapter.4}{}} -\newlabel{pj_rhealpix:rhealpix_dggs.pj_rhealpix.combine_triangles}{{4}{12}{The pj\_rhealpix Module}{section*.16}{}} -\newlabel{pj_rhealpix:rhealpix_dggs.pj_rhealpix.in_rhealpix_image}{{4}{12}{The pj\_rhealpix Module}{section*.17}{}} -\newlabel{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix}{{4}{13}{The pj\_rhealpix Module}{section*.18}{}} -\newlabel{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix_diagram}{{4}{13}{The pj\_rhealpix Module}{section*.19}{}} -\newlabel{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix_ellipsoid}{{4}{13}{The pj\_rhealpix Module}{section*.20}{}} -\newlabel{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix_ellipsoid_inverse}{{4}{14}{The pj\_rhealpix Module}{section*.21}{}} -\newlabel{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix_sphere}{{4}{14}{The pj\_rhealpix Module}{section*.22}{}} -\newlabel{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix_sphere_inverse}{{4}{14}{The pj\_rhealpix Module}{section*.23}{}} -\newlabel{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix_vertices}{{4}{14}{The pj\_rhealpix Module}{section*.24}{}} -\newlabel{pj_rhealpix:rhealpix_dggs.pj_rhealpix.triangle}{{4}{14}{The pj\_rhealpix Module}{section*.25}{}} -\@writefile{toc}{\contentsline {chapter}{\numberline {5}The ellipsoids Module}{16}{chapter.5}} +\newlabel{pj_healpix:module-rhealpixdggs.pj_healpix}{{3}{10}{The pj\_healpix Module}{chapter.3}{}} +\newlabel{pj_healpix:the-pj-healpix-module}{{3}{10}{The pj\_healpix Module}{chapter.3}{}} +\newlabel{pj_healpix::doc}{{3}{10}{The pj\_healpix Module}{chapter.3}{}} +\newlabel{pj_healpix:rhealpixdggs.pj_healpix.healpix}{{3}{10}{The pj\_healpix Module}{section*.8}{}} +\newlabel{pj_healpix:rhealpixdggs.pj_healpix.healpix_ellipsoid}{{3}{10}{The pj\_healpix Module}{section*.9}{}} +\newlabel{pj_healpix:rhealpixdggs.pj_healpix.healpix_ellipsoid_inverse}{{3}{11}{The pj\_healpix Module}{section*.10}{}} +\newlabel{pj_healpix:rhealpixdggs.pj_healpix.healpix_sphere}{{3}{11}{The pj\_healpix Module}{section*.11}{}} +\newlabel{pj_healpix:rhealpixdggs.pj_healpix.healpix_sphere_inverse}{{3}{11}{The pj\_healpix Module}{section*.12}{}} +\newlabel{pj_healpix:rhealpixdggs.pj_healpix.healpix_vertices}{{3}{11}{The pj\_healpix Module}{section*.13}{}} +\newlabel{pj_healpix:rhealpixdggs.pj_healpix.in_healpix_image}{{3}{11}{The pj\_healpix Module}{section*.14}{}} +\@writefile{toc}{\contentsline {chapter}{\numberline {4}The pj\_rhealpix Module}{13}{chapter.4}\protected@file@percent } \@writefile{lof}{\addvspace {10\p@ }} \@writefile{lot}{\addvspace {10\p@ }} -\newlabel{ellipsoids::doc}{{5}{16}{The ellipsoids Module}{chapter.5}{}} -\newlabel{ellipsoids:the-ellipsoids-module}{{5}{16}{The ellipsoids Module}{chapter.5}{}} -\newlabel{ellipsoids:module-rhealpix_dggs.ellipsoids}{{5}{16}{The ellipsoids Module}{chapter.5}{}} -\newlabel{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid}{{5}{16}{The ellipsoids Module}{section*.26}{}} -\newlabel{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.get_points}{{5}{16}{The ellipsoids Module}{section*.27}{}} -\newlabel{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.graticule}{{5}{16}{The ellipsoids Module}{section*.28}{}} -\newlabel{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.lattice}{{5}{17}{The ellipsoids Module}{section*.29}{}} -\newlabel{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.meridian}{{5}{17}{The ellipsoids Module}{section*.30}{}} -\newlabel{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.parallel}{{5}{17}{The ellipsoids Module}{section*.31}{}} -\newlabel{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.pi}{{5}{17}{The ellipsoids Module}{section*.32}{}} -\newlabel{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.random_point}{{5}{17}{The ellipsoids Module}{section*.33}{}} -\newlabel{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.xyz}{{5}{17}{The ellipsoids Module}{section*.34}{}} -\@writefile{toc}{\contentsline {chapter}{\numberline {6}The projection\_wrapper Module}{19}{chapter.6}} +\newlabel{pj_rhealpix:module-rhealpixdggs.pj_rhealpix}{{4}{13}{The pj\_rhealpix Module}{chapter.4}{}} +\newlabel{pj_rhealpix:the-pj-rhealpix-module}{{4}{13}{The pj\_rhealpix Module}{chapter.4}{}} +\newlabel{pj_rhealpix::doc}{{4}{13}{The pj\_rhealpix Module}{chapter.4}{}} +\newlabel{pj_rhealpix:rhealpixdggs.pj_rhealpix.combine_triangles}{{4}{13}{The pj\_rhealpix Module}{section*.15}{}} +\newlabel{pj_rhealpix:rhealpixdggs.pj_rhealpix.in_rhealpix_image}{{4}{13}{The pj\_rhealpix Module}{section*.16}{}} +\newlabel{pj_rhealpix:rhealpixdggs.pj_rhealpix.rhealpix}{{4}{14}{The pj\_rhealpix Module}{section*.17}{}} +\newlabel{pj_rhealpix:rhealpixdggs.pj_rhealpix.rhealpix_ellipsoid}{{4}{14}{The pj\_rhealpix Module}{section*.18}{}} +\newlabel{pj_rhealpix:rhealpixdggs.pj_rhealpix.rhealpix_ellipsoid_inverse}{{4}{15}{The pj\_rhealpix Module}{section*.19}{}} +\newlabel{pj_rhealpix:rhealpixdggs.pj_rhealpix.rhealpix_sphere}{{4}{15}{The pj\_rhealpix Module}{section*.20}{}} +\newlabel{pj_rhealpix:rhealpixdggs.pj_rhealpix.rhealpix_sphere_inverse}{{4}{15}{The pj\_rhealpix Module}{section*.21}{}} +\newlabel{pj_rhealpix:rhealpixdggs.pj_rhealpix.rhealpix_vertices}{{4}{16}{The pj\_rhealpix Module}{section*.22}{}} +\newlabel{pj_rhealpix:rhealpixdggs.pj_rhealpix.triangle}{{4}{16}{The pj\_rhealpix Module}{section*.23}{}} +\@writefile{toc}{\contentsline {chapter}{\numberline {5}The ellipsoids Module}{18}{chapter.5}\protected@file@percent } \@writefile{lof}{\addvspace {10\p@ }} \@writefile{lot}{\addvspace {10\p@ }} -\newlabel{projection_wrapper::doc}{{6}{19}{The projection\_wrapper Module}{chapter.6}{}} -\newlabel{projection_wrapper:module-rhealpix_dggs.projection_wrapper}{{6}{19}{The projection\_wrapper Module}{chapter.6}{}} -\newlabel{projection_wrapper:the-projection-wrapper-module}{{6}{19}{The projection\_wrapper Module}{chapter.6}{}} -\newlabel{projection_wrapper:rhealpix_dggs.projection_wrapper.Proj}{{6}{19}{The projection\_wrapper Module}{section*.35}{}} -\@writefile{toc}{\contentsline {chapter}{\numberline {7}The dggs Module}{20}{chapter.7}} +\newlabel{ellipsoids:module-rhealpixdggs.ellipsoids}{{5}{18}{The ellipsoids Module}{chapter.5}{}} +\newlabel{ellipsoids:the-ellipsoids-module}{{5}{18}{The ellipsoids Module}{chapter.5}{}} +\newlabel{ellipsoids::doc}{{5}{18}{The ellipsoids Module}{chapter.5}{}} +\newlabel{ellipsoids:rhealpixdggs.ellipsoids.Ellipsoid}{{5}{18}{The ellipsoids Module}{section*.24}{}} +\newlabel{ellipsoids:rhealpixdggs.ellipsoids.Ellipsoid.get_points}{{5}{18}{The ellipsoids Module}{section*.25}{}} +\newlabel{ellipsoids:rhealpixdggs.ellipsoids.Ellipsoid.graticule}{{5}{18}{The ellipsoids Module}{section*.26}{}} +\newlabel{ellipsoids:rhealpixdggs.ellipsoids.Ellipsoid.lattice}{{5}{19}{The ellipsoids Module}{section*.27}{}} +\newlabel{ellipsoids:rhealpixdggs.ellipsoids.Ellipsoid.meridian}{{5}{19}{The ellipsoids Module}{section*.28}{}} +\newlabel{ellipsoids:rhealpixdggs.ellipsoids.Ellipsoid.parallel}{{5}{19}{The ellipsoids Module}{section*.29}{}} +\newlabel{ellipsoids:rhealpixdggs.ellipsoids.Ellipsoid.pi}{{5}{19}{The ellipsoids Module}{section*.30}{}} +\newlabel{ellipsoids:rhealpixdggs.ellipsoids.Ellipsoid.random_point}{{5}{19}{The ellipsoids Module}{section*.31}{}} +\newlabel{ellipsoids:rhealpixdggs.ellipsoids.Ellipsoid.xyz}{{5}{19}{The ellipsoids Module}{section*.32}{}} +\@writefile{toc}{\contentsline {chapter}{\numberline {6}The projection\_wrapper Module}{21}{chapter.6}\protected@file@percent } \@writefile{lof}{\addvspace {10\p@ }} \@writefile{lot}{\addvspace {10\p@ }} -\newlabel{dggs::doc}{{7}{20}{The dggs Module}{chapter.7}{}} -\newlabel{dggs:module-rhealpix_dggs.dggs}{{7}{20}{The dggs Module}{chapter.7}{}} -\newlabel{dggs:the-dggs-module}{{7}{20}{The dggs Module}{chapter.7}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell}{{7}{22}{The dggs Module}{section*.36}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.area}{{7}{22}{The dggs Module}{section*.37}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.boundary}{{7}{22}{The dggs Module}{section*.38}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.centroid}{{7}{23}{The dggs Module}{section*.39}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.color}{{7}{23}{The dggs Module}{section*.40}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.contains}{{7}{23}{The dggs Module}{section*.41}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.ellipsoidal_shape}{{7}{23}{The dggs Module}{section*.42}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.index}{{7}{23}{The dggs Module}{section*.43}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.interior}{{7}{24}{The dggs Module}{section*.44}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.intersects_meridian}{{7}{24}{The dggs Module}{section*.45}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.intersects_parallel}{{7}{24}{The dggs Module}{section*.46}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.neighbor}{{7}{24}{The dggs Module}{section*.47}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.neighbors}{{7}{25}{The dggs Module}{section*.48}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.nucleus}{{7}{25}{The dggs Module}{section*.49}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.nw_vertex}{{7}{25}{The dggs Module}{section*.50}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.predecessor}{{7}{26}{The dggs Module}{section*.51}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.random_point}{{7}{26}{The dggs Module}{section*.52}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.region}{{7}{27}{The dggs Module}{section*.53}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.rotate}{{7}{27}{The dggs Module}{section*.54}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.rotate_entry}{{7}{27}{The dggs Module}{section*.55}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.subcell}{{7}{27}{The dggs Module}{section*.56}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.subcells}{{7}{28}{The dggs Module}{section*.57}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.successor}{{7}{28}{The dggs Module}{section*.58}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.suid_from_index}{{7}{28}{The dggs Module}{section*.59}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.suid_rowcol}{{7}{28}{The dggs Module}{section*.60}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.ul_vertex}{{7}{28}{The dggs Module}{section*.61}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.vertices}{{7}{28}{The dggs Module}{section*.62}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.width}{{7}{29}{The dggs Module}{section*.63}{}} -\newlabel{dggs:rhealpix_dggs.dggs.Cell.xy_range}{{7}{29}{The dggs Module}{section*.64}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS}{{7}{29}{The dggs Module}{section*.65}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cell}{{7}{30}{The dggs Module}{section*.66}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cell_area}{{7}{30}{The dggs Module}{section*.67}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cell_from_point}{{7}{30}{The dggs Module}{section*.68}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cell_from_region}{{7}{31}{The dggs Module}{section*.69}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cell_latitudes}{{7}{31}{The dggs Module}{section*.70}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cell_width}{{7}{32}{The dggs Module}{section*.71}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cells0}{{7}{32}{The dggs Module}{section*.72}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cells_from_meridian}{{7}{32}{The dggs Module}{section*.73}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cells_from_parallel}{{7}{32}{The dggs Module}{section*.74}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cells_from_region}{{7}{32}{The dggs Module}{section*.75}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.combine_triangles}{{7}{33}{The dggs Module}{section*.76}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.grid}{{7}{33}{The dggs Module}{section*.77}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.healpix}{{7}{33}{The dggs Module}{section*.78}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.interval}{{7}{34}{The dggs Module}{section*.79}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.minimal_cover}{{7}{34}{The dggs Module}{section*.80}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.num_cells}{{7}{34}{The dggs Module}{section*.81}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.plot_cells}{{7}{35}{The dggs Module}{section*.82}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.random_cell}{{7}{35}{The dggs Module}{section*.83}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.random_point}{{7}{35}{The dggs Module}{section*.84}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.rhealpix}{{7}{35}{The dggs Module}{section*.85}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.triangle}{{7}{35}{The dggs Module}{section*.86}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.xyz}{{7}{36}{The dggs Module}{section*.87}{}} -\newlabel{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.xyz_cube}{{7}{36}{The dggs Module}{section*.88}{}} -\@writefile{toc}{\contentsline {chapter}{\numberline {8}The distortion Module}{37}{chapter.8}} +\newlabel{projection_wrapper:module-rhealpixdggs.projection_wrapper}{{6}{21}{The projection\_wrapper Module}{chapter.6}{}} +\newlabel{projection_wrapper:the-projection-wrapper-module}{{6}{21}{The projection\_wrapper Module}{chapter.6}{}} +\newlabel{projection_wrapper::doc}{{6}{21}{The projection\_wrapper Module}{chapter.6}{}} +\newlabel{projection_wrapper:rhealpixdggs.projection_wrapper.Proj}{{6}{21}{The projection\_wrapper Module}{section*.33}{}} +\@writefile{toc}{\contentsline {chapter}{\numberline {7}The dggs Module}{23}{chapter.7}\protected@file@percent } \@writefile{lof}{\addvspace {10\p@ }} \@writefile{lot}{\addvspace {10\p@ }} -\newlabel{distortion::doc}{{8}{37}{The distortion Module}{chapter.8}{}} -\newlabel{distortion:the-distortion-module}{{8}{37}{The distortion Module}{chapter.8}{}} -\newlabel{distortion:module-rhealpix_dggs.distortion}{{8}{37}{The distortion Module}{chapter.8}{}} -\newlabel{distortion:rhealpix_dggs.distortion.distortion}{{8}{37}{The distortion Module}{section*.89}{}} -\newlabel{distortion:rhealpix_dggs.distortion.distortion_stats}{{8}{37}{The distortion Module}{section*.90}{}} -\newlabel{distortion:rhealpix_dggs.distortion.fff_coeffs}{{8}{37}{The distortion Module}{section*.91}{}} -\newlabel{distortion:rhealpix_dggs.distortion.scale_factors}{{8}{38}{The distortion Module}{section*.92}{}} -\newlabel{distortion:rhealpix_dggs.distortion.utm_zone}{{8}{38}{The distortion Module}{section*.93}{}} -\@writefile{toc}{\contentsline {chapter}{\numberline {9}Indices and tables}{39}{chapter.9}} +\newlabel{dggs:module-rhealpixdggs.dggs}{{7}{23}{The dggs Module}{chapter.7}{}} +\newlabel{dggs:the-dggs-module}{{7}{23}{The dggs Module}{chapter.7}{}} +\newlabel{dggs::doc}{{7}{23}{The dggs Module}{chapter.7}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell}{{7}{25}{The dggs Module}{section*.34}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.area}{{7}{26}{The dggs Module}{section*.35}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.boundary}{{7}{26}{The dggs Module}{section*.36}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.centroid}{{7}{27}{The dggs Module}{section*.37}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.color}{{7}{27}{The dggs Module}{section*.38}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.contains}{{7}{27}{The dggs Module}{section*.39}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.ellipsoidal_shape}{{7}{27}{The dggs Module}{section*.40}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.index}{{7}{27}{The dggs Module}{section*.41}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.interior}{{7}{28}{The dggs Module}{section*.42}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.intersects_meridian}{{7}{28}{The dggs Module}{section*.43}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.intersects_parallel}{{7}{28}{The dggs Module}{section*.44}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.neighbor}{{7}{28}{The dggs Module}{section*.45}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.neighbors}{{7}{29}{The dggs Module}{section*.46}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.nucleus}{{7}{29}{The dggs Module}{section*.47}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.nw_vertex}{{7}{30}{The dggs Module}{section*.48}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.overlaps}{{7}{31}{The dggs Module}{section*.49}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.predecessor}{{7}{31}{The dggs Module}{section*.50}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.random_point}{{7}{31}{The dggs Module}{section*.51}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.region}{{7}{31}{The dggs Module}{section*.52}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.region_overlaps}{{7}{31}{The dggs Module}{section*.53}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.rotate}{{7}{32}{The dggs Module}{section*.54}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.rotate_entry}{{7}{32}{The dggs Module}{section*.55}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.subcell}{{7}{32}{The dggs Module}{section*.56}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.subcells}{{7}{32}{The dggs Module}{section*.57}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.successor}{{7}{33}{The dggs Module}{section*.58}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.suid_from_index}{{7}{33}{The dggs Module}{section*.59}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.suid_rowcol}{{7}{33}{The dggs Module}{section*.60}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.ul_vertex}{{7}{33}{The dggs Module}{section*.61}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.vertices}{{7}{33}{The dggs Module}{section*.62}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.width}{{7}{34}{The dggs Module}{section*.63}{}} +\newlabel{dggs:rhealpixdggs.dggs.Cell.xy_range}{{7}{35}{The dggs Module}{section*.64}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS}{{7}{35}{The dggs Module}{section*.65}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.cell}{{7}{35}{The dggs Module}{section*.66}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.cell_area}{{7}{36}{The dggs Module}{section*.67}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.cell_from_point}{{7}{36}{The dggs Module}{section*.68}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.cell_from_region}{{7}{36}{The dggs Module}{section*.69}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.cell_latitudes}{{7}{36}{The dggs Module}{section*.70}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.cell_width}{{7}{37}{The dggs Module}{section*.71}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.cells0}{{7}{37}{The dggs Module}{section*.72}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.cells_from_meridian}{{7}{37}{The dggs Module}{section*.73}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.cells_from_parallel}{{7}{38}{The dggs Module}{section*.74}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.cells_from_region}{{7}{38}{The dggs Module}{section*.75}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.combine_triangles}{{7}{39}{The dggs Module}{section*.76}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.grid}{{7}{39}{The dggs Module}{section*.77}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.healpix}{{7}{39}{The dggs Module}{section*.78}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.interval}{{7}{40}{The dggs Module}{section*.79}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.minimal_cover}{{7}{40}{The dggs Module}{section*.80}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.num_cells}{{7}{40}{The dggs Module}{section*.81}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.random_cell}{{7}{41}{The dggs Module}{section*.82}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.random_point}{{7}{41}{The dggs Module}{section*.83}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.rhealpix}{{7}{41}{The dggs Module}{section*.84}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.triangle}{{7}{41}{The dggs Module}{section*.85}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.xyz}{{7}{42}{The dggs Module}{section*.86}{}} +\newlabel{dggs:rhealpixdggs.dggs.RHEALPixDGGS.xyz_cube}{{7}{42}{The dggs Module}{section*.87}{}} +\newlabel{dggs:rhealpixdggs.dggs.RhealPolygon}{{7}{42}{The dggs Module}{section*.88}{}} +\@writefile{toc}{\contentsline {chapter}{\numberline {8}Indices and tables}{43}{chapter.8}\protected@file@percent } \@writefile{lof}{\addvspace {10\p@ }} \@writefile{lot}{\addvspace {10\p@ }} -\newlabel{index:indices-and-tables}{{9}{39}{Indices and tables}{chapter.9}{}} -\bibcite{GRS2013}{GRS2013} -\bibcite{CaRo2007}{CaRo2007} -\@writefile{toc}{\contentsline {chapter}{Bibliography}{40}{chapter*.95}} -\newlabel{introduction:grs2013}{{9}{40}{\bibname }{section*.96}{}} -\newlabel{pj_healpix:caro2007}{{9}{40}{\bibname }{section*.97}{}} -\@writefile{toc}{\contentsline {chapter}{Python Module Index}{41}{section*.98}} -\@writefile{toc}{\contentsline {chapter}{Index}{42}{section*.99}} +\newlabel{index:indices-and-tables}{{8}{43}{Indices and tables}{chapter.8}{}} +\bibcite{introduction:grs2013}{GRS2013} +\bibcite{pj_healpix:caro2007}{CaRo2007} +\@writefile{toc}{\contentsline {chapter}{Bibliography}{44}{chapter*.89}\protected@file@percent } +\@writefile{toc}{\contentsline {chapter}{Python Module Index}{45}{section*.90}\protected@file@percent } +\@writefile{toc}{\contentsline {chapter}{Index}{46}{section*.91}\protected@file@percent } +\gdef \@abspage@last{49} diff --git a/docs/build/latex/rHEALPixDGGS.idx b/docs/build/latex/rHEALPixDGGS.idx index d67bdc4..5ae2fbf 100644 --- a/docs/build/latex/rHEALPixDGGS.idx +++ b/docs/build/latex/rHEALPixDGGS.idx @@ -1,98 +1,98 @@ -\indexentry{rhealpix\_dggs.utils (module)|hyperpage}{7} -\indexentry{auth\_lat() (in module rhealpix\_dggs.utils)|hyperpage}{7} -\indexentry{auth\_rad() (in module rhealpix\_dggs.utils)|hyperpage}{7} -\indexentry{my\_round() (in module rhealpix\_dggs.utils)|hyperpage}{7} -\indexentry{wrap\_latitude() (in module rhealpix\_dggs.utils)|hyperpage}{8} -\indexentry{wrap\_longitude() (in module rhealpix\_dggs.utils)|hyperpage}{8} -\indexentry{rhealpix\_dggs.pj\_healpix (module)|hyperpage}{9} -\indexentry{healpix() (in module rhealpix\_dggs.pj\_healpix)|hyperpage}{9} -\indexentry{healpix\_diagram() (in module rhealpix\_dggs.pj\_healpix)|hyperpage}{9} -\indexentry{healpix\_ellipsoid() (in module rhealpix\_dggs.pj\_healpix)|hyperpage}{9} -\indexentry{healpix\_ellipsoid\_inverse() (in module rhealpix\_dggs.pj\_healpix)|hyperpage}{10} -\indexentry{healpix\_sphere() (in module rhealpix\_dggs.pj\_healpix)|hyperpage}{10} -\indexentry{healpix\_sphere\_inverse() (in module rhealpix\_dggs.pj\_healpix)|hyperpage}{10} -\indexentry{healpix\_vertices() (in module rhealpix\_dggs.pj\_healpix)|hyperpage}{10} -\indexentry{in\_healpix\_image() (in module rhealpix\_dggs.pj\_healpix)|hyperpage}{10} -\indexentry{rhealpix\_dggs.pj\_rhealpix (module)|hyperpage}{12} -\indexentry{combine\_triangles() (in module rhealpix\_dggs.pj\_rhealpix)|hyperpage}{12} -\indexentry{in\_rhealpix\_image() (in module rhealpix\_dggs.pj\_rhealpix)|hyperpage}{12} -\indexentry{rhealpix() (in module rhealpix\_dggs.pj\_rhealpix)|hyperpage}{13} -\indexentry{rhealpix\_diagram() (in module rhealpix\_dggs.pj\_rhealpix)|hyperpage}{13} -\indexentry{rhealpix\_ellipsoid() (in module rhealpix\_dggs.pj\_rhealpix)|hyperpage}{13} -\indexentry{rhealpix\_ellipsoid\_inverse() (in module rhealpix\_dggs.pj\_rhealpix)|hyperpage}{14} -\indexentry{rhealpix\_sphere() (in module rhealpix\_dggs.pj\_rhealpix)|hyperpage}{14} -\indexentry{rhealpix\_sphere\_inverse() (in module rhealpix\_dggs.pj\_rhealpix)|hyperpage}{14} -\indexentry{rhealpix\_vertices() (in module rhealpix\_dggs.pj\_rhealpix)|hyperpage}{14} -\indexentry{triangle() (in module rhealpix\_dggs.pj\_rhealpix)|hyperpage}{14} -\indexentry{rhealpix\_dggs.ellipsoids (module)|hyperpage}{16} -\indexentry{Ellipsoid (class in rhealpix\_dggs.ellipsoids)|hyperpage}{16} -\indexentry{Ellipsoid.get\_points() (in module rhealpix\_dggs.ellipsoids)|hyperpage}{16} -\indexentry{Ellipsoid.graticule() (in module rhealpix\_dggs.ellipsoids)|hyperpage}{16} -\indexentry{Ellipsoid.lattice() (in module rhealpix\_dggs.ellipsoids)|hyperpage}{17} -\indexentry{Ellipsoid.meridian() (in module rhealpix\_dggs.ellipsoids)|hyperpage}{17} -\indexentry{Ellipsoid.parallel() (in module rhealpix\_dggs.ellipsoids)|hyperpage}{17} -\indexentry{Ellipsoid.pi() (in module rhealpix\_dggs.ellipsoids)|hyperpage}{17} -\indexentry{Ellipsoid.random\_point() (in module rhealpix\_dggs.ellipsoids)|hyperpage}{17} -\indexentry{Ellipsoid.xyz() (in module rhealpix\_dggs.ellipsoids)|hyperpage}{17} -\indexentry{rhealpix\_dggs.projection\_wrapper (module)|hyperpage}{19} -\indexentry{Proj (class in rhealpix\_dggs.projection\_wrapper)|hyperpage}{19} -\indexentry{rhealpix\_dggs.dggs (module)|hyperpage}{20} -\indexentry{Cell (class in rhealpix\_dggs.dggs)|hyperpage}{22} -\indexentry{Cell.area() (in module rhealpix\_dggs.dggs)|hyperpage}{22} -\indexentry{Cell.boundary() (in module rhealpix\_dggs.dggs)|hyperpage}{22} -\indexentry{Cell.centroid() (in module rhealpix\_dggs.dggs)|hyperpage}{23} -\indexentry{Cell.color() (in module rhealpix\_dggs.dggs)|hyperpage}{23} -\indexentry{Cell.contains() (in module rhealpix\_dggs.dggs)|hyperpage}{23} -\indexentry{Cell.ellipsoidal\_shape() (in module rhealpix\_dggs.dggs)|hyperpage}{23} -\indexentry{Cell.index() (in module rhealpix\_dggs.dggs)|hyperpage}{23} -\indexentry{Cell.interior() (in module rhealpix\_dggs.dggs)|hyperpage}{24} -\indexentry{Cell.intersects\_meridian() (in module rhealpix\_dggs.dggs)|hyperpage}{24} -\indexentry{Cell.intersects\_parallel() (in module rhealpix\_dggs.dggs)|hyperpage}{24} -\indexentry{Cell.neighbor() (in module rhealpix\_dggs.dggs)|hyperpage}{24} -\indexentry{Cell.neighbors() (in module rhealpix\_dggs.dggs)|hyperpage}{25} -\indexentry{Cell.nucleus() (in module rhealpix\_dggs.dggs)|hyperpage}{25} -\indexentry{Cell.nw\_vertex() (in module rhealpix\_dggs.dggs)|hyperpage}{25} -\indexentry{Cell.predecessor() (in module rhealpix\_dggs.dggs)|hyperpage}{26} -\indexentry{Cell.random\_point() (in module rhealpix\_dggs.dggs)|hyperpage}{26} -\indexentry{Cell.region() (in module rhealpix\_dggs.dggs)|hyperpage}{27} -\indexentry{Cell.rotate() (in module rhealpix\_dggs.dggs)|hyperpage}{27} -\indexentry{Cell.rotate\_entry() (in module rhealpix\_dggs.dggs)|hyperpage}{27} -\indexentry{Cell.subcell() (in module rhealpix\_dggs.dggs)|hyperpage}{27} -\indexentry{Cell.subcells() (in module rhealpix\_dggs.dggs)|hyperpage}{28} -\indexentry{Cell.successor() (in module rhealpix\_dggs.dggs)|hyperpage}{28} -\indexentry{Cell.suid\_from\_index() (in module rhealpix\_dggs.dggs)|hyperpage}{28} -\indexentry{Cell.suid\_rowcol() (in module rhealpix\_dggs.dggs)|hyperpage}{28} -\indexentry{Cell.ul\_vertex() (in module rhealpix\_dggs.dggs)|hyperpage}{28} -\indexentry{Cell.vertices() (in module rhealpix\_dggs.dggs)|hyperpage}{28} -\indexentry{Cell.width() (in module rhealpix\_dggs.dggs)|hyperpage}{29} -\indexentry{Cell.xy\_range() (in module rhealpix\_dggs.dggs)|hyperpage}{29} -\indexentry{RHEALPixDGGS (class in rhealpix\_dggs.dggs)|hyperpage}{29} -\indexentry{RHEALPixDGGS.cell() (in module rhealpix\_dggs.dggs)|hyperpage}{30} -\indexentry{RHEALPixDGGS.cell\_area() (in module rhealpix\_dggs.dggs)|hyperpage}{30} -\indexentry{RHEALPixDGGS.cell\_from\_point() (in module rhealpix\_dggs.dggs)|hyperpage}{30} -\indexentry{RHEALPixDGGS.cell\_from\_region() (in module rhealpix\_dggs.dggs)|hyperpage}{31} -\indexentry{RHEALPixDGGS.cell\_latitudes() (in module rhealpix\_dggs.dggs)|hyperpage}{31} -\indexentry{RHEALPixDGGS.cell\_width() (in module rhealpix\_dggs.dggs)|hyperpage}{32} -\indexentry{cells0 (rhealpix\_dggs.dggs.RHEALPixDGGS attribute)|hyperpage}{32} -\indexentry{RHEALPixDGGS.cells\_from\_meridian() (in module rhealpix\_dggs.dggs)|hyperpage}{32} -\indexentry{RHEALPixDGGS.cells\_from\_parallel() (in module rhealpix\_dggs.dggs)|hyperpage}{32} -\indexentry{RHEALPixDGGS.cells\_from\_region() (in module rhealpix\_dggs.dggs)|hyperpage}{32} -\indexentry{RHEALPixDGGS.combine\_triangles() (in module rhealpix\_dggs.dggs)|hyperpage}{33} -\indexentry{RHEALPixDGGS.grid() (in module rhealpix\_dggs.dggs)|hyperpage}{33} -\indexentry{RHEALPixDGGS.healpix() (in module rhealpix\_dggs.dggs)|hyperpage}{33} -\indexentry{RHEALPixDGGS.interval() (in module rhealpix\_dggs.dggs)|hyperpage}{34} -\indexentry{RHEALPixDGGS.minimal\_cover() (in module rhealpix\_dggs.dggs)|hyperpage}{34} -\indexentry{RHEALPixDGGS.num\_cells() (in module rhealpix\_dggs.dggs)|hyperpage}{34} -\indexentry{RHEALPixDGGS.plot\_cells() (in module rhealpix\_dggs.dggs)|hyperpage}{35} -\indexentry{RHEALPixDGGS.random\_cell() (in module rhealpix\_dggs.dggs)|hyperpage}{35} -\indexentry{RHEALPixDGGS.random\_point() (in module rhealpix\_dggs.dggs)|hyperpage}{35} -\indexentry{RHEALPixDGGS.rhealpix() (in module rhealpix\_dggs.dggs)|hyperpage}{35} -\indexentry{RHEALPixDGGS.triangle() (in module rhealpix\_dggs.dggs)|hyperpage}{35} -\indexentry{RHEALPixDGGS.xyz() (in module rhealpix\_dggs.dggs)|hyperpage}{36} -\indexentry{RHEALPixDGGS.xyz\_cube() (in module rhealpix\_dggs.dggs)|hyperpage}{36} -\indexentry{rhealpix\_dggs.distortion (module)|hyperpage}{37} -\indexentry{distortion() (in module rhealpix\_dggs.distortion)|hyperpage}{37} -\indexentry{distortion\_stats() (in module rhealpix\_dggs.distortion)|hyperpage}{37} -\indexentry{fff\_coeffs() (in module rhealpix\_dggs.distortion)|hyperpage}{37} -\indexentry{scale\_factors() (in module rhealpix\_dggs.distortion)|hyperpage}{38} -\indexentry{utm\_zone() (in module rhealpix\_dggs.distortion)|hyperpage}{38} +\indexentry{module@\spxentry{module}!rhealpixdggs.utils@\spxentry{rhealpixdggs.utils}|hyperpage}{7} +\indexentry{rhealpixdggs.utils@\spxentry{rhealpixdggs.utils}!module@\spxentry{module}|hyperpage}{7} +\indexentry{auth\_lat() (in module rhealpixdggs.utils)@\spxentry{auth\_lat()}\spxextra{in module rhealpixdggs.utils}|hyperpage}{7} +\indexentry{auth\_rad() (in module rhealpixdggs.utils)@\spxentry{auth\_rad()}\spxextra{in module rhealpixdggs.utils}|hyperpage}{7} +\indexentry{my\_round() (in module rhealpixdggs.utils)@\spxentry{my\_round()}\spxextra{in module rhealpixdggs.utils}|hyperpage}{8} +\indexentry{wrap\_latitude() (in module rhealpixdggs.utils)@\spxentry{wrap\_latitude()}\spxextra{in module rhealpixdggs.utils}|hyperpage}{8} +\indexentry{wrap\_longitude() (in module rhealpixdggs.utils)@\spxentry{wrap\_longitude()}\spxextra{in module rhealpixdggs.utils}|hyperpage}{8} +\indexentry{module@\spxentry{module}!rhealpixdggs.pj\_healpix@\spxentry{rhealpixdggs.pj\_healpix}|hyperpage}{10} +\indexentry{rhealpixdggs.pj\_healpix@\spxentry{rhealpixdggs.pj\_healpix}!module@\spxentry{module}|hyperpage}{10} +\indexentry{healpix() (in module rhealpixdggs.pj\_healpix)@\spxentry{healpix()}\spxextra{in module rhealpixdggs.pj\_healpix}|hyperpage}{10} +\indexentry{healpix\_ellipsoid() (in module rhealpixdggs.pj\_healpix)@\spxentry{healpix\_ellipsoid()}\spxextra{in module rhealpixdggs.pj\_healpix}|hyperpage}{10} +\indexentry{healpix\_ellipsoid\_inverse() (in module rhealpixdggs.pj\_healpix)@\spxentry{healpix\_ellipsoid\_inverse()}\spxextra{in module rhealpixdggs.pj\_healpix}|hyperpage}{11} +\indexentry{healpix\_sphere() (in module rhealpixdggs.pj\_healpix)@\spxentry{healpix\_sphere()}\spxextra{in module rhealpixdggs.pj\_healpix}|hyperpage}{11} +\indexentry{healpix\_sphere\_inverse() (in module rhealpixdggs.pj\_healpix)@\spxentry{healpix\_sphere\_inverse()}\spxextra{in module rhealpixdggs.pj\_healpix}|hyperpage}{11} +\indexentry{healpix\_vertices() (in module rhealpixdggs.pj\_healpix)@\spxentry{healpix\_vertices()}\spxextra{in module rhealpixdggs.pj\_healpix}|hyperpage}{11} +\indexentry{in\_healpix\_image() (in module rhealpixdggs.pj\_healpix)@\spxentry{in\_healpix\_image()}\spxextra{in module rhealpixdggs.pj\_healpix}|hyperpage}{11} +\indexentry{module@\spxentry{module}!rhealpixdggs.pj\_rhealpix@\spxentry{rhealpixdggs.pj\_rhealpix}|hyperpage}{13} +\indexentry{rhealpixdggs.pj\_rhealpix@\spxentry{rhealpixdggs.pj\_rhealpix}!module@\spxentry{module}|hyperpage}{13} +\indexentry{combine\_triangles() (in module rhealpixdggs.pj\_rhealpix)@\spxentry{combine\_triangles()}\spxextra{in module rhealpixdggs.pj\_rhealpix}|hyperpage}{13} +\indexentry{in\_rhealpix\_image() (in module rhealpixdggs.pj\_rhealpix)@\spxentry{in\_rhealpix\_image()}\spxextra{in module rhealpixdggs.pj\_rhealpix}|hyperpage}{13} +\indexentry{rhealpix() (in module rhealpixdggs.pj\_rhealpix)@\spxentry{rhealpix()}\spxextra{in module rhealpixdggs.pj\_rhealpix}|hyperpage}{14} +\indexentry{rhealpix\_ellipsoid() (in module rhealpixdggs.pj\_rhealpix)@\spxentry{rhealpix\_ellipsoid()}\spxextra{in module rhealpixdggs.pj\_rhealpix}|hyperpage}{14} +\indexentry{rhealpix\_ellipsoid\_inverse() (in module rhealpixdggs.pj\_rhealpix)@\spxentry{rhealpix\_ellipsoid\_inverse()}\spxextra{in module rhealpixdggs.pj\_rhealpix}|hyperpage}{15} +\indexentry{rhealpix\_sphere() (in module rhealpixdggs.pj\_rhealpix)@\spxentry{rhealpix\_sphere()}\spxextra{in module rhealpixdggs.pj\_rhealpix}|hyperpage}{15} +\indexentry{rhealpix\_sphere\_inverse() (in module rhealpixdggs.pj\_rhealpix)@\spxentry{rhealpix\_sphere\_inverse()}\spxextra{in module rhealpixdggs.pj\_rhealpix}|hyperpage}{15} +\indexentry{rhealpix\_vertices() (in module rhealpixdggs.pj\_rhealpix)@\spxentry{rhealpix\_vertices()}\spxextra{in module rhealpixdggs.pj\_rhealpix}|hyperpage}{16} +\indexentry{triangle() (in module rhealpixdggs.pj\_rhealpix)@\spxentry{triangle()}\spxextra{in module rhealpixdggs.pj\_rhealpix}|hyperpage}{16} +\indexentry{module@\spxentry{module}!rhealpixdggs.ellipsoids@\spxentry{rhealpixdggs.ellipsoids}|hyperpage}{18} +\indexentry{rhealpixdggs.ellipsoids@\spxentry{rhealpixdggs.ellipsoids}!module@\spxentry{module}|hyperpage}{18} +\indexentry{Ellipsoid (class in rhealpixdggs.ellipsoids)@\spxentry{Ellipsoid}\spxextra{class in rhealpixdggs.ellipsoids}|hyperpage}{18} +\indexentry{get\_points() (rhealpixdggs.ellipsoids.Ellipsoid method)@\spxentry{get\_points()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}|hyperpage}{18} +\indexentry{graticule() (rhealpixdggs.ellipsoids.Ellipsoid method)@\spxentry{graticule()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}|hyperpage}{18} +\indexentry{lattice() (rhealpixdggs.ellipsoids.Ellipsoid method)@\spxentry{lattice()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}|hyperpage}{19} +\indexentry{meridian() (rhealpixdggs.ellipsoids.Ellipsoid method)@\spxentry{meridian()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}|hyperpage}{19} +\indexentry{parallel() (rhealpixdggs.ellipsoids.Ellipsoid method)@\spxentry{parallel()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}|hyperpage}{19} +\indexentry{pi() (rhealpixdggs.ellipsoids.Ellipsoid method)@\spxentry{pi()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}|hyperpage}{19} +\indexentry{random\_point() (rhealpixdggs.ellipsoids.Ellipsoid method)@\spxentry{random\_point()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}|hyperpage}{19} +\indexentry{xyz() (rhealpixdggs.ellipsoids.Ellipsoid method)@\spxentry{xyz()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}|hyperpage}{19} +\indexentry{module@\spxentry{module}!rhealpixdggs.projection\_wrapper@\spxentry{rhealpixdggs.projection\_wrapper}|hyperpage}{21} +\indexentry{rhealpixdggs.projection\_wrapper@\spxentry{rhealpixdggs.projection\_wrapper}!module@\spxentry{module}|hyperpage}{21} +\indexentry{Proj (class in rhealpixdggs.projection\_wrapper)@\spxentry{Proj}\spxextra{class in rhealpixdggs.projection\_wrapper}|hyperpage}{21} +\indexentry{module@\spxentry{module}!rhealpixdggs.dggs@\spxentry{rhealpixdggs.dggs}|hyperpage}{23} +\indexentry{rhealpixdggs.dggs@\spxentry{rhealpixdggs.dggs}!module@\spxentry{module}|hyperpage}{23} +\indexentry{Cell (class in rhealpixdggs.dggs)@\spxentry{Cell}\spxextra{class in rhealpixdggs.dggs}|hyperpage}{25} +\indexentry{area() (rhealpixdggs.dggs.Cell method)@\spxentry{area()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{26} +\indexentry{boundary() (rhealpixdggs.dggs.Cell method)@\spxentry{boundary()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{26} +\indexentry{centroid() (rhealpixdggs.dggs.Cell method)@\spxentry{centroid()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{27} +\indexentry{color() (rhealpixdggs.dggs.Cell method)@\spxentry{color()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{27} +\indexentry{contains() (rhealpixdggs.dggs.Cell method)@\spxentry{contains()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{27} +\indexentry{ellipsoidal\_shape() (rhealpixdggs.dggs.Cell method)@\spxentry{ellipsoidal\_shape()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{27} +\indexentry{index() (rhealpixdggs.dggs.Cell method)@\spxentry{index()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{27} +\indexentry{interior() (rhealpixdggs.dggs.Cell method)@\spxentry{interior()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{28} +\indexentry{intersects\_meridian() (rhealpixdggs.dggs.Cell method)@\spxentry{intersects\_meridian()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{28} +\indexentry{intersects\_parallel() (rhealpixdggs.dggs.Cell method)@\spxentry{intersects\_parallel()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{28} +\indexentry{neighbor() (rhealpixdggs.dggs.Cell method)@\spxentry{neighbor()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{28} +\indexentry{neighbors() (rhealpixdggs.dggs.Cell method)@\spxentry{neighbors()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{29} +\indexentry{nucleus() (rhealpixdggs.dggs.Cell method)@\spxentry{nucleus()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{29} +\indexentry{nw\_vertex() (rhealpixdggs.dggs.Cell method)@\spxentry{nw\_vertex()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{30} +\indexentry{overlaps() (rhealpixdggs.dggs.Cell method)@\spxentry{overlaps()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{31} +\indexentry{predecessor() (rhealpixdggs.dggs.Cell method)@\spxentry{predecessor()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{31} +\indexentry{random\_point() (rhealpixdggs.dggs.Cell method)@\spxentry{random\_point()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{31} +\indexentry{region() (rhealpixdggs.dggs.Cell method)@\spxentry{region()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{31} +\indexentry{region\_overlaps() (rhealpixdggs.dggs.Cell method)@\spxentry{region\_overlaps()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{31} +\indexentry{rotate() (rhealpixdggs.dggs.Cell method)@\spxentry{rotate()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{32} +\indexentry{rotate\_entry() (rhealpixdggs.dggs.Cell method)@\spxentry{rotate\_entry()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{32} +\indexentry{subcell() (rhealpixdggs.dggs.Cell method)@\spxentry{subcell()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{32} +\indexentry{subcells() (rhealpixdggs.dggs.Cell method)@\spxentry{subcells()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{32} +\indexentry{successor() (rhealpixdggs.dggs.Cell method)@\spxentry{successor()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{33} +\indexentry{suid\_from\_index() (rhealpixdggs.dggs.Cell static method)@\spxentry{suid\_from\_index()}\spxextra{rhealpixdggs.dggs.Cell static method}|hyperpage}{33} +\indexentry{suid\_rowcol() (rhealpixdggs.dggs.Cell method)@\spxentry{suid\_rowcol()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{33} +\indexentry{ul\_vertex() (rhealpixdggs.dggs.Cell method)@\spxentry{ul\_vertex()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{33} +\indexentry{vertices() (rhealpixdggs.dggs.Cell method)@\spxentry{vertices()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{33} +\indexentry{width() (rhealpixdggs.dggs.Cell method)@\spxentry{width()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{34} +\indexentry{xy\_range() (rhealpixdggs.dggs.Cell method)@\spxentry{xy\_range()}\spxextra{rhealpixdggs.dggs.Cell method}|hyperpage}{35} +\indexentry{RHEALPixDGGS (class in rhealpixdggs.dggs)@\spxentry{RHEALPixDGGS}\spxextra{class in rhealpixdggs.dggs}|hyperpage}{35} +\indexentry{cell() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{cell()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{35} +\indexentry{cell\_area() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{cell\_area()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{36} +\indexentry{cell\_from\_point() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{cell\_from\_point()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{36} +\indexentry{cell\_from\_region() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{cell\_from\_region()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{36} +\indexentry{cell\_latitudes() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{cell\_latitudes()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{36} +\indexentry{cell\_width() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{cell\_width()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{37} +\indexentry{cells0 (rhealpixdggs.dggs.RHEALPixDGGS attribute)@\spxentry{cells0}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS attribute}|hyperpage}{37} +\indexentry{cells\_from\_meridian() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{cells\_from\_meridian()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{37} +\indexentry{cells\_from\_parallel() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{cells\_from\_parallel()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{38} +\indexentry{cells\_from\_region() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{cells\_from\_region()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{38} +\indexentry{combine\_triangles() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{combine\_triangles()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{39} +\indexentry{grid() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{grid()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{39} +\indexentry{healpix() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{healpix()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{39} +\indexentry{interval() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{interval()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{40} +\indexentry{minimal\_cover() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{minimal\_cover()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{40} +\indexentry{num\_cells() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{num\_cells()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{40} +\indexentry{random\_cell() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{random\_cell()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{41} +\indexentry{random\_point() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{random\_point()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{41} +\indexentry{rhealpix() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{rhealpix()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{41} +\indexentry{triangle() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{triangle()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{41} +\indexentry{xyz() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{xyz()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{42} +\indexentry{xyz\_cube() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{xyz\_cube()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}|hyperpage}{42} +\indexentry{RhealPolygon (class in rhealpixdggs.dggs)@\spxentry{RhealPolygon}\spxextra{class in rhealpixdggs.dggs}|hyperpage}{42} diff --git a/docs/build/latex/rHEALPixDGGS.ilg b/docs/build/latex/rHEALPixDGGS.ilg index ffb0763..c40d4e0 100644 --- a/docs/build/latex/rHEALPixDGGS.ilg +++ b/docs/build/latex/rHEALPixDGGS.ilg @@ -1,7 +1,7 @@ -This is makeindex, version 2.15 [TeX Live 2012] (kpathsea + Thai support). -Scanning style file ./python.ist......done (6 attributes redefined, 0 ignored). +This is makeindex, version 2.15 [TeX Live 2022/dev] (kpathsea + Thai support). +Scanning style file ./python.ist.......done (7 attributes redefined, 0 ignored). Scanning input file rHEALPixDGGS.idx....done (98 entries accepted, 0 rejected). -Sorting entries....done (673 comparisons). -Generating output file rHEALPixDGGS.ind....done (143 lines written, 0 warnings). +Sorting entries....done (651 comparisons). +Generating output file rHEALPixDGGS.ind....done (187 lines written, 0 warnings). Output written in rHEALPixDGGS.ind. Transcript written in rHEALPixDGGS.ilg. diff --git a/docs/build/latex/rHEALPixDGGS.ind b/docs/build/latex/rHEALPixDGGS.ind index a92b928..97cf102 100644 --- a/docs/build/latex/rHEALPixDGGS.ind +++ b/docs/build/latex/rHEALPixDGGS.ind @@ -1,143 +1,187 @@ -\begin{theindex} -\def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}} +\begin{sphinxtheindex} +\let\bigletter\sphinxstyleindexlettergroup +\let\spxpagem \sphinxstyleindexpagemain +\let\spxentry \sphinxstyleindexentry +\let\spxextra \sphinxstyleindexextra \bigletter A - \item auth\_lat() (in module rhealpix\_dggs.utils), \hyperpage{7} - \item auth\_rad() (in module rhealpix\_dggs.utils), \hyperpage{7} + \item \spxentry{area()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{26} + \item \spxentry{auth\_lat()}\spxextra{in module rhealpixdggs.utils}, \hyperpage{7} + \item \spxentry{auth\_rad()}\spxextra{in module rhealpixdggs.utils}, \hyperpage{7} + + \indexspace + \bigletter B + \item \spxentry{boundary()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{26} \indexspace \bigletter C - \item Cell (class in rhealpix\_dggs.dggs), \hyperpage{22} - \item Cell.area() (in module rhealpix\_dggs.dggs), \hyperpage{22} - \item Cell.boundary() (in module rhealpix\_dggs.dggs), \hyperpage{22} - \item Cell.centroid() (in module rhealpix\_dggs.dggs), \hyperpage{23} - \item Cell.color() (in module rhealpix\_dggs.dggs), \hyperpage{23} - \item Cell.contains() (in module rhealpix\_dggs.dggs), \hyperpage{23} - \item Cell.ellipsoidal\_shape() (in module rhealpix\_dggs.dggs), \hyperpage{23} - \item Cell.index() (in module rhealpix\_dggs.dggs), \hyperpage{23} - \item Cell.interior() (in module rhealpix\_dggs.dggs), \hyperpage{24} - \item Cell.intersects\_meridian() (in module rhealpix\_dggs.dggs), \hyperpage{24} - \item Cell.intersects\_parallel() (in module rhealpix\_dggs.dggs), \hyperpage{24} - \item Cell.neighbor() (in module rhealpix\_dggs.dggs), \hyperpage{24} - \item Cell.neighbors() (in module rhealpix\_dggs.dggs), \hyperpage{25} - \item Cell.nucleus() (in module rhealpix\_dggs.dggs), \hyperpage{25} - \item Cell.nw\_vertex() (in module rhealpix\_dggs.dggs), \hyperpage{25} - \item Cell.predecessor() (in module rhealpix\_dggs.dggs), \hyperpage{26} - \item Cell.random\_point() (in module rhealpix\_dggs.dggs), \hyperpage{26} - \item Cell.region() (in module rhealpix\_dggs.dggs), \hyperpage{27} - \item Cell.rotate() (in module rhealpix\_dggs.dggs), \hyperpage{27} - \item Cell.rotate\_entry() (in module rhealpix\_dggs.dggs), \hyperpage{27} - \item Cell.subcell() (in module rhealpix\_dggs.dggs), \hyperpage{27} - \item Cell.subcells() (in module rhealpix\_dggs.dggs), \hyperpage{28} - \item Cell.successor() (in module rhealpix\_dggs.dggs), \hyperpage{28} - \item Cell.suid\_from\_index() (in module rhealpix\_dggs.dggs), \hyperpage{28} - \item Cell.suid\_rowcol() (in module rhealpix\_dggs.dggs), \hyperpage{28} - \item Cell.ul\_vertex() (in module rhealpix\_dggs.dggs), \hyperpage{28} - \item Cell.vertices() (in module rhealpix\_dggs.dggs), \hyperpage{28} - \item Cell.width() (in module rhealpix\_dggs.dggs), \hyperpage{29} - \item Cell.xy\_range() (in module rhealpix\_dggs.dggs), \hyperpage{29} - \item cells0 (rhealpix\_dggs.dggs.RHEALPixDGGS attribute), \hyperpage{32} - \item combine\_triangles() (in module rhealpix\_dggs.pj\_rhealpix), \hyperpage{12} - - \indexspace - \bigletter D - \item distortion() (in module rhealpix\_dggs.distortion), \hyperpage{37} - \item distortion\_stats() (in module rhealpix\_dggs.distortion), \hyperpage{37} + \item \spxentry{Cell}\spxextra{class in rhealpixdggs.dggs}, \hyperpage{25} + \item \spxentry{cell()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, \hyperpage{35} + \item \spxentry{cell\_area()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, \hyperpage{36} + \item \spxentry{cell\_from\_point()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, + \hyperpage{36} + \item \spxentry{cell\_from\_region()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, + \hyperpage{36} + \item \spxentry{cell\_latitudes()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, + \hyperpage{36} + \item \spxentry{cell\_width()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, \hyperpage{37} + \item \spxentry{cells0}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS attribute}, \hyperpage{37} + \item \spxentry{cells\_from\_meridian()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, + \hyperpage{37} + \item \spxentry{cells\_from\_parallel()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, + \hyperpage{38} + \item \spxentry{cells\_from\_region()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, + \hyperpage{38} + \item \spxentry{centroid()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{27} + \item \spxentry{color()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{27} + \item \spxentry{combine\_triangles()}\spxextra{in module rhealpixdggs.pj\_rhealpix}, + \hyperpage{13} + \item \spxentry{combine\_triangles()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, + \hyperpage{39} + \item \spxentry{contains()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{27} \indexspace \bigletter E - \item Ellipsoid (class in rhealpix\_dggs.ellipsoids), \hyperpage{16} - \item Ellipsoid.get\_points() (in module rhealpix\_dggs.ellipsoids), \hyperpage{16} - \item Ellipsoid.graticule() (in module rhealpix\_dggs.ellipsoids), \hyperpage{16} - \item Ellipsoid.lattice() (in module rhealpix\_dggs.ellipsoids), \hyperpage{17} - \item Ellipsoid.meridian() (in module rhealpix\_dggs.ellipsoids), \hyperpage{17} - \item Ellipsoid.parallel() (in module rhealpix\_dggs.ellipsoids), \hyperpage{17} - \item Ellipsoid.pi() (in module rhealpix\_dggs.ellipsoids), \hyperpage{17} - \item Ellipsoid.random\_point() (in module rhealpix\_dggs.ellipsoids), \hyperpage{17} - \item Ellipsoid.xyz() (in module rhealpix\_dggs.ellipsoids), \hyperpage{17} + \item \spxentry{Ellipsoid}\spxextra{class in rhealpixdggs.ellipsoids}, \hyperpage{18} + \item \spxentry{ellipsoidal\_shape()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{27} \indexspace - \bigletter F - \item fff\_coeffs() (in module rhealpix\_dggs.distortion), \hyperpage{37} + \bigletter G + \item \spxentry{get\_points()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}, \hyperpage{18} + \item \spxentry{graticule()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}, \hyperpage{18} + \item \spxentry{grid()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, \hyperpage{39} \indexspace \bigletter H - \item healpix() (in module rhealpix\_dggs.pj\_healpix), \hyperpage{9} - \item healpix\_diagram() (in module rhealpix\_dggs.pj\_healpix), \hyperpage{9} - \item healpix\_ellipsoid() (in module rhealpix\_dggs.pj\_healpix), \hyperpage{9} - \item healpix\_ellipsoid\_inverse() (in module rhealpix\_dggs.pj\_healpix), \hyperpage{10} - \item healpix\_sphere() (in module rhealpix\_dggs.pj\_healpix), \hyperpage{10} - \item healpix\_sphere\_inverse() (in module rhealpix\_dggs.pj\_healpix), \hyperpage{10} - \item healpix\_vertices() (in module rhealpix\_dggs.pj\_healpix), \hyperpage{10} + \item \spxentry{healpix()}\spxextra{in module rhealpixdggs.pj\_healpix}, \hyperpage{10} + \item \spxentry{healpix()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, \hyperpage{39} + \item \spxentry{healpix\_ellipsoid()}\spxextra{in module rhealpixdggs.pj\_healpix}, + \hyperpage{10} + \item \spxentry{healpix\_ellipsoid\_inverse()}\spxextra{in module rhealpixdggs.pj\_healpix}, + \hyperpage{11} + \item \spxentry{healpix\_sphere()}\spxextra{in module rhealpixdggs.pj\_healpix}, \hyperpage{11} + \item \spxentry{healpix\_sphere\_inverse()}\spxextra{in module rhealpixdggs.pj\_healpix}, + \hyperpage{11} + \item \spxentry{healpix\_vertices()}\spxextra{in module rhealpixdggs.pj\_healpix}, \hyperpage{11} \indexspace \bigletter I - \item in\_healpix\_image() (in module rhealpix\_dggs.pj\_healpix), \hyperpage{10} - \item in\_rhealpix\_image() (in module rhealpix\_dggs.pj\_rhealpix), \hyperpage{12} + \item \spxentry{in\_healpix\_image()}\spxextra{in module rhealpixdggs.pj\_healpix}, + \hyperpage{11} + \item \spxentry{in\_rhealpix\_image()}\spxextra{in module rhealpixdggs.pj\_rhealpix}, + \hyperpage{13} + \item \spxentry{index()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{27} + \item \spxentry{interior()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{28} + \item \spxentry{intersects\_meridian()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{28} + \item \spxentry{intersects\_parallel()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{28} + \item \spxentry{interval()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, \hyperpage{40} + + \indexspace + \bigletter L + \item \spxentry{lattice()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}, \hyperpage{19} \indexspace \bigletter M - \item my\_round() (in module rhealpix\_dggs.utils), \hyperpage{7} + \item \spxentry{meridian()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}, \hyperpage{19} + \item \spxentry{minimal\_cover()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, \hyperpage{40} + \item \spxentry{module} + \subitem \spxentry{rhealpixdggs.dggs}, \hyperpage{23} + \subitem \spxentry{rhealpixdggs.ellipsoids}, \hyperpage{18} + \subitem \spxentry{rhealpixdggs.pj\_healpix}, \hyperpage{10} + \subitem \spxentry{rhealpixdggs.pj\_rhealpix}, \hyperpage{13} + \subitem \spxentry{rhealpixdggs.projection\_wrapper}, \hyperpage{21} + \subitem \spxentry{rhealpixdggs.utils}, \hyperpage{7} + \item \spxentry{my\_round()}\spxextra{in module rhealpixdggs.utils}, \hyperpage{8} + + \indexspace + \bigletter N + \item \spxentry{neighbor()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{28} + \item \spxentry{neighbors()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{29} + \item \spxentry{nucleus()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{29} + \item \spxentry{num\_cells()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, \hyperpage{40} + \item \spxentry{nw\_vertex()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{30} + + \indexspace + \bigletter O + \item \spxentry{overlaps()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{31} \indexspace \bigletter P - \item Proj (class in rhealpix\_dggs.projection\_wrapper), \hyperpage{19} + \item \spxentry{parallel()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}, \hyperpage{19} + \item \spxentry{pi()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}, \hyperpage{19} + \item \spxentry{predecessor()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{31} + \item \spxentry{Proj}\spxextra{class in rhealpixdggs.projection\_wrapper}, \hyperpage{21} \indexspace \bigletter R - \item rhealpix() (in module rhealpix\_dggs.pj\_rhealpix), \hyperpage{13} - \item rhealpix\_dggs.dggs (module), \hyperpage{20} - \item rhealpix\_dggs.distortion (module), \hyperpage{37} - \item rhealpix\_dggs.ellipsoids (module), \hyperpage{16} - \item rhealpix\_dggs.pj\_healpix (module), \hyperpage{9} - \item rhealpix\_dggs.pj\_rhealpix (module), \hyperpage{12} - \item rhealpix\_dggs.projection\_wrapper (module), \hyperpage{19} - \item rhealpix\_dggs.utils (module), \hyperpage{7} - \item rhealpix\_diagram() (in module rhealpix\_dggs.pj\_rhealpix), \hyperpage{13} - \item rhealpix\_ellipsoid() (in module rhealpix\_dggs.pj\_rhealpix), \hyperpage{13} - \item rhealpix\_ellipsoid\_inverse() (in module rhealpix\_dggs.pj\_rhealpix), \hyperpage{14} - \item rhealpix\_sphere() (in module rhealpix\_dggs.pj\_rhealpix), \hyperpage{14} - \item rhealpix\_sphere\_inverse() (in module rhealpix\_dggs.pj\_rhealpix), \hyperpage{14} - \item rhealpix\_vertices() (in module rhealpix\_dggs.pj\_rhealpix), \hyperpage{14} - \item RHEALPixDGGS (class in rhealpix\_dggs.dggs), \hyperpage{29} - \item RHEALPixDGGS.cell() (in module rhealpix\_dggs.dggs), \hyperpage{30} - \item RHEALPixDGGS.cell\_area() (in module rhealpix\_dggs.dggs), \hyperpage{30} - \item RHEALPixDGGS.cell\_from\_point() (in module rhealpix\_dggs.dggs), \hyperpage{30} - \item RHEALPixDGGS.cell\_from\_region() (in module rhealpix\_dggs.dggs), \hyperpage{31} - \item RHEALPixDGGS.cell\_latitudes() (in module rhealpix\_dggs.dggs), \hyperpage{31} - \item RHEALPixDGGS.cell\_width() (in module rhealpix\_dggs.dggs), \hyperpage{32} - \item RHEALPixDGGS.cells\_from\_meridian() (in module rhealpix\_dggs.dggs), \hyperpage{32} - \item RHEALPixDGGS.cells\_from\_parallel() (in module rhealpix\_dggs.dggs), \hyperpage{32} - \item RHEALPixDGGS.cells\_from\_region() (in module rhealpix\_dggs.dggs), \hyperpage{32} - \item RHEALPixDGGS.combine\_triangles() (in module rhealpix\_dggs.dggs), \hyperpage{33} - \item RHEALPixDGGS.grid() (in module rhealpix\_dggs.dggs), \hyperpage{33} - \item RHEALPixDGGS.healpix() (in module rhealpix\_dggs.dggs), \hyperpage{33} - \item RHEALPixDGGS.interval() (in module rhealpix\_dggs.dggs), \hyperpage{34} - \item RHEALPixDGGS.minimal\_cover() (in module rhealpix\_dggs.dggs), \hyperpage{34} - \item RHEALPixDGGS.num\_cells() (in module rhealpix\_dggs.dggs), \hyperpage{34} - \item RHEALPixDGGS.plot\_cells() (in module rhealpix\_dggs.dggs), \hyperpage{35} - \item RHEALPixDGGS.random\_cell() (in module rhealpix\_dggs.dggs), \hyperpage{35} - \item RHEALPixDGGS.random\_point() (in module rhealpix\_dggs.dggs), \hyperpage{35} - \item RHEALPixDGGS.rhealpix() (in module rhealpix\_dggs.dggs), \hyperpage{35} - \item RHEALPixDGGS.triangle() (in module rhealpix\_dggs.dggs), \hyperpage{35} - \item RHEALPixDGGS.xyz() (in module rhealpix\_dggs.dggs), \hyperpage{36} - \item RHEALPixDGGS.xyz\_cube() (in module rhealpix\_dggs.dggs), \hyperpage{36} + \item \spxentry{random\_cell()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, \hyperpage{41} + \item \spxentry{random\_point()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{31} + \item \spxentry{random\_point()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, \hyperpage{41} + \item \spxentry{random\_point()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}, + \hyperpage{19} + \item \spxentry{region()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{31} + \item \spxentry{region\_overlaps()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{31} + \item \spxentry{rhealpix()}\spxextra{in module rhealpixdggs.pj\_rhealpix}, \hyperpage{14} + \item \spxentry{rhealpix()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, \hyperpage{41} + \item \spxentry{rhealpix\_ellipsoid()}\spxextra{in module rhealpixdggs.pj\_rhealpix}, + \hyperpage{14} + \item \spxentry{rhealpix\_ellipsoid\_inverse()}\spxextra{in module rhealpixdggs.pj\_rhealpix}, + \hyperpage{15} + \item \spxentry{rhealpix\_sphere()}\spxextra{in module rhealpixdggs.pj\_rhealpix}, \hyperpage{15} + \item \spxentry{rhealpix\_sphere\_inverse()}\spxextra{in module rhealpixdggs.pj\_rhealpix}, + \hyperpage{15} + \item \spxentry{rhealpix\_vertices()}\spxextra{in module rhealpixdggs.pj\_rhealpix}, + \hyperpage{16} + \item \spxentry{RHEALPixDGGS}\spxextra{class in rhealpixdggs.dggs}, \hyperpage{35} + \item \spxentry{rhealpixdggs.dggs} + \subitem \spxentry{module}, \hyperpage{23} + \item \spxentry{rhealpixdggs.ellipsoids} + \subitem \spxentry{module}, \hyperpage{18} + \item \spxentry{rhealpixdggs.pj\_healpix} + \subitem \spxentry{module}, \hyperpage{10} + \item \spxentry{rhealpixdggs.pj\_rhealpix} + \subitem \spxentry{module}, \hyperpage{13} + \item \spxentry{rhealpixdggs.projection\_wrapper} + \subitem \spxentry{module}, \hyperpage{21} + \item \spxentry{rhealpixdggs.utils} + \subitem \spxentry{module}, \hyperpage{7} + \item \spxentry{RhealPolygon}\spxextra{class in rhealpixdggs.dggs}, \hyperpage{42} + \item \spxentry{rotate()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{32} + \item \spxentry{rotate\_entry()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{32} \indexspace \bigletter S - \item scale\_factors() (in module rhealpix\_dggs.distortion), \hyperpage{38} + \item \spxentry{subcell()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{32} + \item \spxentry{subcells()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{32} + \item \spxentry{successor()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{33} + \item \spxentry{suid\_from\_index()}\spxextra{rhealpixdggs.dggs.Cell static method}, + \hyperpage{33} + \item \spxentry{suid\_rowcol()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{33} \indexspace \bigletter T - \item triangle() (in module rhealpix\_dggs.pj\_rhealpix), \hyperpage{14} + \item \spxentry{triangle()}\spxextra{in module rhealpixdggs.pj\_rhealpix}, \hyperpage{16} + \item \spxentry{triangle()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, \hyperpage{41} \indexspace \bigletter U - \item utm\_zone() (in module rhealpix\_dggs.distortion), \hyperpage{38} + \item \spxentry{ul\_vertex()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{33} + + \indexspace + \bigletter V + \item \spxentry{vertices()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{33} \indexspace \bigletter W - \item wrap\_latitude() (in module rhealpix\_dggs.utils), \hyperpage{8} - \item wrap\_longitude() (in module rhealpix\_dggs.utils), \hyperpage{8} + \item \spxentry{width()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{34} + \item \spxentry{wrap\_latitude()}\spxextra{in module rhealpixdggs.utils}, \hyperpage{8} + \item \spxentry{wrap\_longitude()}\spxextra{in module rhealpixdggs.utils}, \hyperpage{8} + + \indexspace + \bigletter X + \item \spxentry{xy\_range()}\spxextra{rhealpixdggs.dggs.Cell method}, \hyperpage{35} + \item \spxentry{xyz()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, \hyperpage{42} + \item \spxentry{xyz()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}, \hyperpage{19} + \item \spxentry{xyz\_cube()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}, \hyperpage{42} -\end{theindex} +\end{sphinxtheindex} diff --git a/docs/build/latex/rHEALPixDGGS.log b/docs/build/latex/rHEALPixDGGS.log index 85d21f4..b7cd1aa 100644 --- a/docs/build/latex/rHEALPixDGGS.log +++ b/docs/build/latex/rHEALPixDGGS.log @@ -1,803 +1,725 @@ -This is pdfTeX, Version 3.1415926-2.4-1.40.13 (TeX Live 2012) (format=pdflatex 2012.8.16) 12 AUG 2013 16:44 +This is pdfTeX, Version 3.141592653-2.6-1.40.22 (TeX Live 2022/dev/Debian) (preloaded format=pdflatex 2023.8.29) 29 AUG 2023 13:43 entering extended mode restricted \write18 enabled. %&-line parsing enabled. **rHEALPixDGGS.tex (./rHEALPixDGGS.tex -LaTeX2e <2011/06/27> -Babel and hyphenation patterns for english, dumylang, nohyphenation, ge -rman-x-2012-05-30, ngerman-x-2012-05-30, afrikaans, ancientgreek, ibycus, arabi -c, armenian, basque, bulgarian, catalan, pinyin, coptic, croatian, czech, danis -h, dutch, ukenglish, usenglishmax, esperanto, estonian, ethiopic, farsi, finnis -h, french, friulan, galician, german, ngerman, swissgerman, monogreek, greek, h -ungarian, icelandic, assamese, bengali, gujarati, hindi, kannada, malayalam, ma -rathi, oriya, panjabi, tamil, telugu, indonesian, interlingua, irish, italian, -kurmanji, latin, latvian, lithuanian, mongolian, mongolianlmc, bokmal, nynorsk, - polish, portuguese, romanian, romansh, russian, sanskrit, serbian, serbianc, s -lovak, slovenian, spanish, swedish, turkish, turkmen, ukrainian, uppersorbian, -welsh, loaded. -(./sphinxmanual.cls -Document Class: sphinxmanual 2009/06/02 Document class (Sphinx manual) -(/usr/local/texlive/2012/texmf-dist/tex/latex/base/report.cls -Document Class: report 2007/10/19 v1.4h Standard LaTeX document class -(/usr/local/texlive/2012/texmf-dist/tex/latex/base/size10.clo -File: size10.clo 2007/10/19 v1.4h Standard LaTeX file (size option) -) -\c@part=\count79 -\c@chapter=\count80 -\c@section=\count81 -\c@subsection=\count82 -\c@subsubsection=\count83 -\c@paragraph=\count84 -\c@subparagraph=\count85 -\c@figure=\count86 -\c@table=\count87 -\abovecaptionskip=\skip41 -\belowcaptionskip=\skip42 -\bibindent=\dimen102 -)) -(/usr/local/texlive/2012/texmf-dist/tex/latex/base/inputenc.sty -Package: inputenc 2008/03/30 v1.1d Input encoding file -\inpenc@prehook=\toks14 -\inpenc@posthook=\toks15 - -(/usr/local/texlive/2012/texmf-dist/tex/latex/base/utf8.def -File: utf8.def 2008/04/05 v1.1m UTF-8 support for inputenc -Now handling font encoding OML ... -... no UTF-8 mapping file for font encoding OML -Now handling font encoding T1 ... -... processing UTF-8 mapping file for font encoding T1 - -(/usr/local/texlive/2012/texmf-dist/tex/latex/base/t1enc.dfu -File: t1enc.dfu 2008/04/05 v1.1m UTF-8 support for inputenc - defining Unicode char U+00A1 (decimal 161) - defining Unicode char U+00A3 (decimal 163) - defining Unicode char U+00AB (decimal 171) - defining Unicode char U+00BB (decimal 187) - defining Unicode char U+00BF (decimal 191) - defining Unicode char U+00C0 (decimal 192) - defining Unicode char U+00C1 (decimal 193) - defining Unicode char U+00C2 (decimal 194) - defining Unicode char U+00C3 (decimal 195) - defining Unicode char U+00C4 (decimal 196) - defining Unicode char U+00C5 (decimal 197) - defining Unicode char U+00C6 (decimal 198) - defining Unicode char U+00C7 (decimal 199) - defining Unicode char U+00C8 (decimal 200) - defining Unicode char U+00C9 (decimal 201) - defining Unicode char U+00CA (decimal 202) - defining Unicode char U+00CB (decimal 203) - defining Unicode char U+00CC (decimal 204) - defining Unicode char U+00CD (decimal 205) - defining Unicode char U+00CE (decimal 206) - defining Unicode char U+00CF (decimal 207) - defining Unicode char U+00D0 (decimal 208) - defining Unicode char U+00D1 (decimal 209) - defining Unicode char U+00D2 (decimal 210) - defining Unicode char U+00D3 (decimal 211) - defining Unicode char U+00D4 (decimal 212) - defining Unicode char U+00D5 (decimal 213) - defining Unicode char U+00D6 (decimal 214) - defining Unicode char U+00D8 (decimal 216) - defining Unicode char U+00D9 (decimal 217) - defining Unicode char U+00DA (decimal 218) - defining Unicode char U+00DB (decimal 219) - defining Unicode char U+00DC (decimal 220) - defining Unicode char U+00DD (decimal 221) - defining Unicode char U+00DE (decimal 222) - defining Unicode char U+00DF (decimal 223) - defining Unicode char U+00E0 (decimal 224) - defining Unicode char U+00E1 (decimal 225) - defining Unicode char U+00E2 (decimal 226) - defining Unicode char U+00E3 (decimal 227) - defining Unicode char U+00E4 (decimal 228) - defining Unicode char U+00E5 (decimal 229) - defining Unicode char U+00E6 (decimal 230) - defining Unicode char U+00E7 (decimal 231) - defining Unicode char U+00E8 (decimal 232) - defining Unicode char U+00E9 (decimal 233) - defining Unicode char U+00EA (decimal 234) - defining Unicode char U+00EB (decimal 235) - defining Unicode char U+00EC (decimal 236) - defining Unicode char U+00ED (decimal 237) - defining Unicode char U+00EE (decimal 238) - defining Unicode char U+00EF (decimal 239) - defining Unicode char U+00F0 (decimal 240) - defining Unicode char U+00F1 (decimal 241) - defining Unicode char U+00F2 (decimal 242) - defining Unicode char U+00F3 (decimal 243) - defining Unicode char U+00F4 (decimal 244) - defining Unicode char U+00F5 (decimal 245) - defining Unicode char U+00F6 (decimal 246) - defining Unicode char U+00F8 (decimal 248) - defining Unicode char U+00F9 (decimal 249) - defining Unicode char U+00FA (decimal 250) - defining Unicode char U+00FB (decimal 251) - defining Unicode char U+00FC (decimal 252) - defining Unicode char U+00FD (decimal 253) - defining Unicode char U+00FE (decimal 254) - defining Unicode char U+00FF (decimal 255) - defining Unicode char U+0102 (decimal 258) - defining Unicode char U+0103 (decimal 259) - defining Unicode char U+0104 (decimal 260) - defining Unicode char U+0105 (decimal 261) - defining Unicode char U+0106 (decimal 262) - defining Unicode char U+0107 (decimal 263) - defining Unicode char U+010C (decimal 268) - defining Unicode char U+010D (decimal 269) - defining Unicode char U+010E (decimal 270) - defining Unicode char U+010F (decimal 271) - defining Unicode char U+0110 (decimal 272) - defining Unicode char U+0111 (decimal 273) - defining Unicode char U+0118 (decimal 280) - defining Unicode char U+0119 (decimal 281) - defining Unicode char U+011A (decimal 282) - defining Unicode char U+011B (decimal 283) - defining Unicode char U+011E (decimal 286) - defining Unicode char U+011F (decimal 287) - defining Unicode char U+0130 (decimal 304) - defining Unicode char U+0131 (decimal 305) - defining Unicode char U+0132 (decimal 306) - defining Unicode char U+0133 (decimal 307) - defining Unicode char U+0139 (decimal 313) - defining Unicode char U+013A (decimal 314) - defining Unicode char U+013D (decimal 317) - defining Unicode char U+013E (decimal 318) - defining Unicode char U+0141 (decimal 321) - defining Unicode char U+0142 (decimal 322) - defining Unicode char U+0143 (decimal 323) - defining Unicode char U+0144 (decimal 324) - defining Unicode char U+0147 (decimal 327) - defining Unicode char U+0148 (decimal 328) - defining Unicode char U+014A (decimal 330) - defining Unicode char U+014B (decimal 331) - defining Unicode char U+0150 (decimal 336) - defining Unicode char U+0151 (decimal 337) - defining Unicode char U+0152 (decimal 338) - defining Unicode char U+0153 (decimal 339) - defining Unicode char U+0154 (decimal 340) - defining Unicode char U+0155 (decimal 341) - defining Unicode char U+0158 (decimal 344) - defining Unicode char U+0159 (decimal 345) - defining Unicode char U+015A (decimal 346) - defining Unicode char U+015B (decimal 347) - defining Unicode char U+015E (decimal 350) - defining Unicode char U+015F (decimal 351) - defining Unicode char U+0160 (decimal 352) - defining Unicode char U+0161 (decimal 353) - defining Unicode char U+0162 (decimal 354) - defining Unicode char U+0163 (decimal 355) - defining Unicode char U+0164 (decimal 356) - defining Unicode char U+0165 (decimal 357) - defining Unicode char U+016E (decimal 366) - defining Unicode char U+016F (decimal 367) - defining Unicode char U+0170 (decimal 368) - defining Unicode char U+0171 (decimal 369) - defining Unicode char U+0178 (decimal 376) - defining Unicode char U+0179 (decimal 377) - defining Unicode char U+017A (decimal 378) - defining Unicode char U+017B (decimal 379) - defining Unicode char U+017C (decimal 380) - defining Unicode char U+017D (decimal 381) - defining Unicode char U+017E (decimal 382) - defining Unicode char U+200C (decimal 8204) - defining Unicode char U+2013 (decimal 8211) - defining Unicode char U+2014 (decimal 8212) - defining Unicode char U+2018 (decimal 8216) - defining Unicode char U+2019 (decimal 8217) - defining Unicode char U+201A (decimal 8218) - defining Unicode char U+201C (decimal 8220) - defining Unicode char U+201D (decimal 8221) - defining Unicode char U+201E (decimal 8222) - defining Unicode char U+2030 (decimal 8240) - defining Unicode char U+2031 (decimal 8241) - defining Unicode char U+2039 (decimal 8249) - defining Unicode char U+203A (decimal 8250) - defining Unicode char U+2423 (decimal 9251) -) -Now handling font encoding OT1 ... -... processing UTF-8 mapping file for font encoding OT1 - -(/usr/local/texlive/2012/texmf-dist/tex/latex/base/ot1enc.dfu -File: ot1enc.dfu 2008/04/05 v1.1m UTF-8 support for inputenc - defining Unicode char U+00A1 (decimal 161) - defining Unicode char U+00A3 (decimal 163) - defining Unicode char U+00B8 (decimal 184) - defining Unicode char U+00BF (decimal 191) - defining Unicode char U+00C5 (decimal 197) - defining Unicode char U+00C6 (decimal 198) - defining Unicode char U+00D8 (decimal 216) - defining Unicode char U+00DF (decimal 223) - defining Unicode char U+00E6 (decimal 230) - defining Unicode char U+00EC (decimal 236) - defining Unicode char U+00ED (decimal 237) - defining Unicode char U+00EE (decimal 238) - defining Unicode char U+00EF (decimal 239) - defining Unicode char U+00F8 (decimal 248) - defining Unicode char U+0131 (decimal 305) - defining Unicode char U+0141 (decimal 321) - defining Unicode char U+0142 (decimal 322) - defining Unicode char U+0152 (decimal 338) - defining Unicode char U+0153 (decimal 339) - defining Unicode char U+2013 (decimal 8211) - defining Unicode char U+2014 (decimal 8212) - defining Unicode char U+2018 (decimal 8216) - defining Unicode char U+2019 (decimal 8217) - defining Unicode char U+201C (decimal 8220) - defining Unicode char U+201D (decimal 8221) -) -Now handling font encoding OMS ... -... processing UTF-8 mapping file for font encoding OMS - -(/usr/local/texlive/2012/texmf-dist/tex/latex/base/omsenc.dfu -File: omsenc.dfu 2008/04/05 v1.1m UTF-8 support for inputenc - defining Unicode char U+00A7 (decimal 167) - defining Unicode char U+00B6 (decimal 182) - defining Unicode char U+00B7 (decimal 183) - defining Unicode char U+2020 (decimal 8224) - defining Unicode char U+2021 (decimal 8225) - defining Unicode char U+2022 (decimal 8226) -) -Now handling font encoding OMX ... -... no UTF-8 mapping file for font encoding OMX -Now handling font encoding U ... -... no UTF-8 mapping file for font encoding U - defining Unicode char U+00A9 (decimal 169) - defining Unicode char U+00AA (decimal 170) - defining Unicode char U+00AE (decimal 174) - defining Unicode char U+00BA (decimal 186) - defining Unicode char U+02C6 (decimal 710) - defining Unicode char U+02DC (decimal 732) - defining Unicode char U+200C (decimal 8204) - defining Unicode char U+2026 (decimal 8230) - defining Unicode char U+2122 (decimal 8482) - defining Unicode char U+2423 (decimal 9251) -)) +LaTeX2e <2021-11-15> patch level 1 +L3 programming layer <2022-01-21> (./sphinxmanual.cls +Document Class: sphinxmanual 2019/12/01 v2.3.0 Document class (Sphinx manual) +(/usr/share/texlive/texmf-dist/tex/latex/base/report.cls +Document Class: report 2021/10/04 v1.4n Standard LaTeX document class +(/usr/share/texlive/texmf-dist/tex/latex/base/size10.clo +File: size10.clo 2021/10/04 v1.4n Standard LaTeX file (size option) +) +\c@part=\count185 +\c@chapter=\count186 +\c@section=\count187 +\c@subsection=\count188 +\c@subsubsection=\count189 +\c@paragraph=\count190 +\c@subparagraph=\count191 +\c@figure=\count192 +\c@table=\count193 +\abovecaptionskip=\skip47 +\belowcaptionskip=\skip48 +\bibindent=\dimen138 +) +LaTeX Info: Redefining \and on input line 35. +) +(/usr/share/texlive/texmf-dist/tex/latex/base/inputenc.sty +Package: inputenc 2021/02/14 v1.3d Input encoding file +\inpenc@prehook=\toks16 +\inpenc@posthook=\toks17 +) defining Unicode char U+00A0 (decimal 160) + defining Unicode char U+2500 (decimal 9472) + defining Unicode char U+2502 (decimal 9474) + defining Unicode char U+2514 (decimal 9492) + defining Unicode char U+251C (decimal 9500) + defining Unicode char U+2572 (decimal 9586) + +(/usr/share/texlive/texmf-dist/tex/latex/cmap/cmap.sty +Package: cmap 2021/02/06 v1.0j CMap support: searchable PDF +) +(/usr/share/texlive/texmf-dist/tex/latex/base/fontenc.sty +Package: fontenc 2021/04/29 v2.0v Standard LaTeX package +<>) +(/usr/share/texlive/texmf-dist/tex/latex/amsmath/amsmath.sty +Package: amsmath 2021/10/15 v2.17l AMS math features +\@mathmargin=\skip49 -(/usr/local/texlive/2012/texmf-dist/tex/latex/base/fontenc.sty -Package: fontenc 2005/09/27 v1.99g Standard LaTeX package +For additional information on amsmath, use the `?' option. +(/usr/share/texlive/texmf-dist/tex/latex/amsmath/amstext.sty +Package: amstext 2021/08/26 v2.01 AMS text -(/usr/local/texlive/2012/texmf-dist/tex/latex/base/t1enc.def -File: t1enc.def 2005/09/27 v1.99g Standard LaTeX file -LaTeX Font Info: Redeclaring font encoding T1 on input line 43. +(/usr/share/texlive/texmf-dist/tex/latex/amsmath/amsgen.sty +File: amsgen.sty 1999/11/30 v2.0 generic functions +\@emptytoks=\toks18 +\ex@=\dimen139 )) -(/usr/local/texlive/2012/texmf-dist/tex/generic/babel/babel.sty -Package: babel 2008/07/08 v3.8m The Babel package - -(/usr/local/texlive/2012/texmf-dist/tex/generic/babel/english.ldf -Language: english 2005/03/30 v3.3o English support from the babel system - -(/usr/local/texlive/2012/texmf-dist/tex/generic/babel/babel.def -File: babel.def 2008/07/08 v3.8m Babel common definitions -\babel@savecnt=\count88 -\U@D=\dimen103 +(/usr/share/texlive/texmf-dist/tex/latex/amsmath/amsbsy.sty +Package: amsbsy 1999/11/29 v1.2d Bold Symbols +\pmbraise@=\dimen140 +) +(/usr/share/texlive/texmf-dist/tex/latex/amsmath/amsopn.sty +Package: amsopn 2021/08/26 v2.02 operator names +) +\inf@bad=\count194 +LaTeX Info: Redefining \frac on input line 234. +\uproot@=\count195 +\leftroot@=\count196 +LaTeX Info: Redefining \overline on input line 399. +\classnum@=\count197 +\DOTSCASE@=\count198 +LaTeX Info: Redefining \ldots on input line 496. +LaTeX Info: Redefining \dots on input line 499. +LaTeX Info: Redefining \cdots on input line 620. +\Mathstrutbox@=\box50 +\strutbox@=\box51 +\big@size=\dimen141 +LaTeX Font Info: Redeclaring font encoding OML on input line 743. +LaTeX Font Info: Redeclaring font encoding OMS on input line 744. +\macc@depth=\count199 +\c@MaxMatrixCols=\count266 +\dotsspace@=\muskip16 +\c@parentequation=\count267 +\dspbrk@lvl=\count268 +\tag@help=\toks19 +\row@=\count269 +\column@=\count270 +\maxfields@=\count271 +\andhelp@=\toks20 +\eqnshift@=\dimen142 +\alignsep@=\dimen143 +\tagshift@=\dimen144 +\tagwidth@=\dimen145 +\totwidth@=\dimen146 +\lineht@=\dimen147 +\@envbody=\toks21 +\multlinegap=\skip50 +\multlinetaggap=\skip51 +\mathdisplay@stack=\toks22 +LaTeX Info: Redefining \[ on input line 2938. +LaTeX Info: Redefining \] on input line 2939. ) -\l@canadian = a dialect from \language\l@american -\l@australian = a dialect from \language\l@british -\l@newzealand = a dialect from \language\l@british +(/usr/share/texlive/texmf-dist/tex/latex/amsfonts/amssymb.sty +Package: amssymb 2013/01/14 v3.01 AMS font symbols + +(/usr/share/texlive/texmf-dist/tex/latex/amsfonts/amsfonts.sty +Package: amsfonts 2013/01/14 v3.01 Basic AMSFonts support +\symAMSa=\mathgroup4 +\symAMSb=\mathgroup5 +LaTeX Font Info: Redeclaring math symbol \hbar on input line 98. +LaTeX Font Info: Overwriting math alphabet `\mathfrak' in version `bold' +(Font) U/euf/m/n --> U/euf/b/n on input line 106. )) -(/usr/local/texlive/2012/texmf-dist/tex/latex/psnfss/times.sty -Package: times 2005/04/12 PSNFSS-v9.2a (SPQR) -) (./fncychap.sty -Package: fncychap 2007/07/30 v1.34 LaTeX package (Revised chapters) -\RW=\skip43 -\mylen=\skip44 -\myhi=\skip45 -\px=\skip46 -\py=\skip47 -\pyy=\skip48 -\pxx=\skip49 -\c@AlphaCnt=\count89 -\c@AlphaDecCnt=\count90 -) (/usr/local/texlive/2012/texmf-dist/tex/latex/tools/longtable.sty -Package: longtable 2004/02/01 v4.11 Multi-page Table package (DPC) -\LTleft=\skip50 -\LTright=\skip51 -\LTpre=\skip52 -\LTpost=\skip53 -\LTchunksize=\count91 -\LTcapwidth=\dimen104 -\LT@head=\box26 -\LT@firsthead=\box27 -\LT@foot=\box28 -\LT@lastfoot=\box29 -\LT@cols=\count92 -\LT@rows=\count93 -\c@LT@tables=\count94 -\c@LT@chunks=\count95 -\LT@p@ftn=\toks16 -) -(./sphinx.sty -Package: sphinx 2010/01/15 LaTeX package (Sphinx markup) - (/usr/local/texlive/2012/texmf-dist/tex/latex/base/textcomp.sty -Package: textcomp 2005/09/27 v1.99g Standard LaTeX package -Package textcomp Info: Sub-encoding information: -(textcomp) 5 = only ISO-Adobe without \textcurrency -(textcomp) 4 = 5 + \texteuro -(textcomp) 3 = 4 + \textohm -(textcomp) 2 = 3 + \textestimated + \textcurrency -(textcomp) 1 = TS1 - \textcircled - \t -(textcomp) 0 = TS1 (full) -(textcomp) Font families with sub-encoding setting implement -(textcomp) only a restricted character set as indicated. -(textcomp) Family '?' is the default used for unknown fonts. -(textcomp) See the documentation for details. -Package textcomp Info: Setting ? sub-encoding to TS1/1 on input line 71. - -(/usr/local/texlive/2012/texmf-dist/tex/latex/base/ts1enc.def -File: ts1enc.def 2001/06/05 v3.0e (jk/car/fm) Standard LaTeX file -Now handling font encoding TS1 ... -... processing UTF-8 mapping file for font encoding TS1 - -(/usr/local/texlive/2012/texmf-dist/tex/latex/base/ts1enc.dfu -File: ts1enc.dfu 2008/04/05 v1.1m UTF-8 support for inputenc - defining Unicode char U+00A2 (decimal 162) - defining Unicode char U+00A3 (decimal 163) - defining Unicode char U+00A4 (decimal 164) - defining Unicode char U+00A5 (decimal 165) - defining Unicode char U+00A6 (decimal 166) - defining Unicode char U+00A7 (decimal 167) - defining Unicode char U+00A8 (decimal 168) - defining Unicode char U+00A9 (decimal 169) - defining Unicode char U+00AA (decimal 170) - defining Unicode char U+00AC (decimal 172) - defining Unicode char U+00AE (decimal 174) - defining Unicode char U+00AF (decimal 175) - defining Unicode char U+00B0 (decimal 176) - defining Unicode char U+00B1 (decimal 177) - defining Unicode char U+00B2 (decimal 178) - defining Unicode char U+00B3 (decimal 179) - defining Unicode char U+00B4 (decimal 180) - defining Unicode char U+00B5 (decimal 181) - defining Unicode char U+00B6 (decimal 182) - defining Unicode char U+00B7 (decimal 183) - defining Unicode char U+00B9 (decimal 185) - defining Unicode char U+00BA (decimal 186) - defining Unicode char U+00BC (decimal 188) - defining Unicode char U+00BD (decimal 189) - defining Unicode char U+00BE (decimal 190) - defining Unicode char U+00D7 (decimal 215) - defining Unicode char U+00F7 (decimal 247) - defining Unicode char U+0192 (decimal 402) - defining Unicode char U+02C7 (decimal 711) - defining Unicode char U+02D8 (decimal 728) - defining Unicode char U+02DD (decimal 733) - defining Unicode char U+0E3F (decimal 3647) - defining Unicode char U+2016 (decimal 8214) - defining Unicode char U+2020 (decimal 8224) - defining Unicode char U+2021 (decimal 8225) - defining Unicode char U+2022 (decimal 8226) - defining Unicode char U+2030 (decimal 8240) - defining Unicode char U+2031 (decimal 8241) - defining Unicode char U+203B (decimal 8251) - defining Unicode char U+203D (decimal 8253) - defining Unicode char U+2044 (decimal 8260) - defining Unicode char U+204E (decimal 8270) - defining Unicode char U+2052 (decimal 8274) - defining Unicode char U+20A1 (decimal 8353) - defining Unicode char U+20A4 (decimal 8356) - defining Unicode char U+20A6 (decimal 8358) - defining Unicode char U+20A9 (decimal 8361) - defining Unicode char U+20AB (decimal 8363) - defining Unicode char U+20AC (decimal 8364) - defining Unicode char U+20B1 (decimal 8369) - defining Unicode char U+2103 (decimal 8451) - defining Unicode char U+2116 (decimal 8470) - defining Unicode char U+2117 (decimal 8471) - defining Unicode char U+211E (decimal 8478) - defining Unicode char U+2120 (decimal 8480) - defining Unicode char U+2122 (decimal 8482) - defining Unicode char U+2126 (decimal 8486) - defining Unicode char U+2127 (decimal 8487) - defining Unicode char U+212E (decimal 8494) - defining Unicode char U+2190 (decimal 8592) - defining Unicode char U+2191 (decimal 8593) - defining Unicode char U+2192 (decimal 8594) - defining Unicode char U+2193 (decimal 8595) - defining Unicode char U+2329 (decimal 9001) - defining Unicode char U+232A (decimal 9002) - defining Unicode char U+2422 (decimal 9250) - defining Unicode char U+25E6 (decimal 9702) - defining Unicode char U+25EF (decimal 9711) - defining Unicode char U+266A (decimal 9834) +(/usr/share/texlive/texmf-dist/tex/generic/babel/babel.sty +Package: babel 2022/01/26 3.70 The Babel package +\babel@savecnt=\count272 +\U@D=\dimen148 +\l@unhyphenated=\language3 + +(/usr/share/texlive/texmf-dist/tex/generic/babel/txtbabel.def) +\bbl@readstream=\read2 +\bbl@dirlevel=\count273 + +(/usr/share/texlive/texmf-dist/tex/generic/babel-english/english.ldf +Language: english 2017/06/06 v3.3r English support from the babel system +Package babel Info: Hyphen rules for 'british' set to \l@english +(babel) (\language0). Reported on input line 82. +Package babel Info: Hyphen rules for 'UKenglish' set to \l@english +(babel) (\language0). Reported on input line 83. +Package babel Info: Hyphen rules for 'canadian' set to \l@english +(babel) (\language0). Reported on input line 102. +Package babel Info: Hyphen rules for 'australian' set to \l@english +(babel) (\language0). Reported on input line 105. +Package babel Info: Hyphen rules for 'newzealand' set to \l@english +(babel) (\language0). Reported on input line 108. )) -LaTeX Info: Redefining \oldstylenums on input line 266. -Package textcomp Info: Setting cmr sub-encoding to TS1/0 on input line 281. -Package textcomp Info: Setting cmss sub-encoding to TS1/0 on input line 282. -Package textcomp Info: Setting cmtt sub-encoding to TS1/0 on input line 283. -Package textcomp Info: Setting cmvtt sub-encoding to TS1/0 on input line 284. -Package textcomp Info: Setting cmbr sub-encoding to TS1/0 on input line 285. -Package textcomp Info: Setting cmtl sub-encoding to TS1/0 on input line 286. -Package textcomp Info: Setting ccr sub-encoding to TS1/0 on input line 287. -Package textcomp Info: Setting ptm sub-encoding to TS1/4 on input line 288. -Package textcomp Info: Setting pcr sub-encoding to TS1/4 on input line 289. -Package textcomp Info: Setting phv sub-encoding to TS1/4 on input line 290. -Package textcomp Info: Setting ppl sub-encoding to TS1/3 on input line 291. -Package textcomp Info: Setting pag sub-encoding to TS1/4 on input line 292. -Package textcomp Info: Setting pbk sub-encoding to TS1/4 on input line 293. -Package textcomp Info: Setting pnc sub-encoding to TS1/4 on input line 294. -Package textcomp Info: Setting pzc sub-encoding to TS1/4 on input line 295. -Package textcomp Info: Setting bch sub-encoding to TS1/4 on input line 296. -Package textcomp Info: Setting put sub-encoding to TS1/5 on input line 297. -Package textcomp Info: Setting uag sub-encoding to TS1/5 on input line 298. -Package textcomp Info: Setting ugq sub-encoding to TS1/5 on input line 299. -Package textcomp Info: Setting ul8 sub-encoding to TS1/4 on input line 300. -Package textcomp Info: Setting ul9 sub-encoding to TS1/4 on input line 301. -Package textcomp Info: Setting augie sub-encoding to TS1/5 on input line 302. -Package textcomp Info: Setting dayrom sub-encoding to TS1/3 on input line 303. -Package textcomp Info: Setting dayroms sub-encoding to TS1/3 on input line 304. - -Package textcomp Info: Setting pxr sub-encoding to TS1/0 on input line 305. -Package textcomp Info: Setting pxss sub-encoding to TS1/0 on input line 306. -Package textcomp Info: Setting pxtt sub-encoding to TS1/0 on input line 307. -Package textcomp Info: Setting txr sub-encoding to TS1/0 on input line 308. -Package textcomp Info: Setting txss sub-encoding to TS1/0 on input line 309. -Package textcomp Info: Setting txtt sub-encoding to TS1/0 on input line 310. -Package textcomp Info: Setting lmr sub-encoding to TS1/0 on input line 311. -Package textcomp Info: Setting lmdh sub-encoding to TS1/0 on input line 312. -Package textcomp Info: Setting lmss sub-encoding to TS1/0 on input line 313. -Package textcomp Info: Setting lmssq sub-encoding to TS1/0 on input line 314. -Package textcomp Info: Setting lmvtt sub-encoding to TS1/0 on input line 315. -Package textcomp Info: Setting qhv sub-encoding to TS1/0 on input line 316. -Package textcomp Info: Setting qag sub-encoding to TS1/0 on input line 317. -Package textcomp Info: Setting qbk sub-encoding to TS1/0 on input line 318. -Package textcomp Info: Setting qcr sub-encoding to TS1/0 on input line 319. -Package textcomp Info: Setting qcs sub-encoding to TS1/0 on input line 320. -Package textcomp Info: Setting qpl sub-encoding to TS1/0 on input line 321. -Package textcomp Info: Setting qtm sub-encoding to TS1/0 on input line 322. -Package textcomp Info: Setting qzc sub-encoding to TS1/0 on input line 323. -Package textcomp Info: Setting qhvc sub-encoding to TS1/0 on input line 324. -Package textcomp Info: Setting futs sub-encoding to TS1/4 on input line 325. -Package textcomp Info: Setting futx sub-encoding to TS1/4 on input line 326. -Package textcomp Info: Setting futj sub-encoding to TS1/4 on input line 327. -Package textcomp Info: Setting hlh sub-encoding to TS1/3 on input line 328. -Package textcomp Info: Setting hls sub-encoding to TS1/3 on input line 329. -Package textcomp Info: Setting hlst sub-encoding to TS1/3 on input line 330. -Package textcomp Info: Setting hlct sub-encoding to TS1/5 on input line 331. -Package textcomp Info: Setting hlx sub-encoding to TS1/5 on input line 332. -Package textcomp Info: Setting hlce sub-encoding to TS1/5 on input line 333. -Package textcomp Info: Setting hlcn sub-encoding to TS1/5 on input line 334. -Package textcomp Info: Setting hlcw sub-encoding to TS1/5 on input line 335. -Package textcomp Info: Setting hlcf sub-encoding to TS1/5 on input line 336. -Package textcomp Info: Setting pplx sub-encoding to TS1/3 on input line 337. -Package textcomp Info: Setting pplj sub-encoding to TS1/3 on input line 338. -Package textcomp Info: Setting ptmx sub-encoding to TS1/4 on input line 339. -Package textcomp Info: Setting ptmj sub-encoding to TS1/4 on input line 340. -) -(/usr/local/texlive/2012/texmf-dist/tex/latex/fancyhdr/fancyhdr.sty -\fancy@headwidth=\skip54 -\f@ncyO@elh=\skip55 -\f@ncyO@erh=\skip56 -\f@ncyO@olh=\skip57 -\f@ncyO@orh=\skip58 -\f@ncyO@elf=\skip59 -\f@ncyO@erf=\skip60 -\f@ncyO@olf=\skip61 -\f@ncyO@orf=\skip62 -) -(/usr/local/texlive/2012/texmf-dist/tex/latex/fancybox/fancybox.sty -Package: fancybox 2010/05/15 1.4 - -Style option: `fancybox' v1.4 <2010/05/15> (tvz) -\@fancybox=\box30 -\shadowsize=\dimen105 -\@Sbox=\box31 -\do@VerbBox=\toks17 -\the@fancyput=\toks18 -\this@fancyput=\toks19 -\EndVerbatimTokens=\toks20 -\Verbatim@Outfile=\write3 -\Verbatim@Infile=\read1 -) (/usr/local/texlive/2012/texmf-dist/tex/latex/titlesec/titlesec.sty -Package: titlesec 2011/12/15 v2.10.0 Sectioning titles -\ttl@box=\box32 -\beforetitleunit=\skip63 -\aftertitleunit=\skip64 -\ttl@plus=\dimen106 -\ttl@minus=\dimen107 -\ttl@toksa=\toks21 -\titlewidth=\dimen108 -\titlewidthlast=\dimen109 -\titlewidthfirst=\dimen110 -) -(./tabulary.sty -Package: tabulary 2007/10/02 v0.9 tabulary package (DPC) - (/usr/local/texlive/2012/texmf-dist/tex/latex/tools/array.sty -Package: array 2008/09/09 v2.4c Tabular extension package (FMi) -\col@sep=\dimen111 -\extrarowheight=\dimen112 -\NC@list=\toks22 -\extratabsurround=\skip65 -\backup@length=\skip66 -) -\TY@count=\count96 -\TY@linewidth=\dimen113 -\tymin=\dimen114 -\tymax=\dimen115 -\TY@tablewidth=\dimen116 -) (/usr/local/texlive/2012/texmf-dist/tex/latex/amsmath/amsmath.sty -Package: amsmath 2000/07/18 v2.13 AMS math features -\@mathmargin=\skip67 +(/usr/share/texmf/tex/latex/tex-gyre/tgtermes.sty +Package: tgtermes 2009/09/27 v1.2 TeX Gyre Termes as default roman family -For additional information on amsmath, use the `?' option. -(/usr/local/texlive/2012/texmf-dist/tex/latex/amsmath/amstext.sty -Package: amstext 2000/06/29 v2.01 +(/usr/share/texlive/texmf-dist/tex/latex/kvoptions/kvoptions.sty +Package: kvoptions 2020-10-07 v3.14 Key value format for package options (HO) -(/usr/local/texlive/2012/texmf-dist/tex/latex/amsmath/amsgen.sty -File: amsgen.sty 1999/11/30 v2.0 -\@emptytoks=\toks23 -\ex@=\dimen117 -)) -(/usr/local/texlive/2012/texmf-dist/tex/latex/amsmath/amsbsy.sty -Package: amsbsy 1999/11/29 v1.2d -\pmbraise@=\dimen118 -) -(/usr/local/texlive/2012/texmf-dist/tex/latex/amsmath/amsopn.sty -Package: amsopn 1999/12/14 v2.01 operator names -) -\inf@bad=\count97 -LaTeX Info: Redefining \frac on input line 211. -\uproot@=\count98 -\leftroot@=\count99 -LaTeX Info: Redefining \overline on input line 307. -\classnum@=\count100 -\DOTSCASE@=\count101 -LaTeX Info: Redefining \ldots on input line 379. -LaTeX Info: Redefining \dots on input line 382. -LaTeX Info: Redefining \cdots on input line 467. -\Mathstrutbox@=\box33 -\strutbox@=\box34 -\big@size=\dimen119 -LaTeX Font Info: Redeclaring font encoding OML on input line 567. -LaTeX Font Info: Redeclaring font encoding OMS on input line 568. -\macc@depth=\count102 -\c@MaxMatrixCols=\count103 -\dotsspace@=\muskip10 -\c@parentequation=\count104 -\dspbrk@lvl=\count105 -\tag@help=\toks24 -\row@=\count106 -\column@=\count107 -\maxfields@=\count108 -\andhelp@=\toks25 -\eqnshift@=\dimen120 -\alignsep@=\dimen121 -\tagshift@=\dimen122 -\tagwidth@=\dimen123 -\totwidth@=\dimen124 -\lineht@=\dimen125 -\@envbody=\toks26 -\multlinegap=\skip68 -\multlinetaggap=\skip69 -\mathdisplay@stack=\toks27 -LaTeX Info: Redefining \[ on input line 2666. -LaTeX Info: Redefining \] on input line 2667. -) -(/usr/local/texlive/2012/texmf-dist/tex/latex/base/makeidx.sty -Package: makeidx 2000/03/29 v1.0m Standard LaTeX package -) -(/usr/local/texlive/2012/texmf-dist/tex/latex/framed/framed.sty -Package: framed 2011/10/22 v 0.96: framed or shaded text with page breaks -\OuterFrameSep=\skip70 -\fb@frw=\dimen126 -\fb@frh=\dimen127 -\FrameRule=\dimen128 -\FrameSep=\dimen129 +(/usr/share/texlive/texmf-dist/tex/latex/graphics/keyval.sty +Package: keyval 2014/10/28 v1.15 key=value parser (DPC) +\KV@toks@=\toks23 +) +(/usr/share/texlive/texmf-dist/tex/generic/ltxcmds/ltxcmds.sty +Package: ltxcmds 2020-05-10 v1.25 LaTeX kernel commands for general use (HO) ) -(/usr/local/texlive/2012/texmf-dist/tex/latex/base/ifthen.sty -Package: ifthen 2001/05/26 v1.1c Standard LaTeX ifthen package (DPC) +(/usr/share/texlive/texmf-dist/tex/generic/kvsetkeys/kvsetkeys.sty +Package: kvsetkeys 2019/12/15 v1.18 Key value parser (HO) +))) +(/usr/share/texmf/tex/latex/tex-gyre/tgheros.sty +Package: tgheros 2009/09/27 v1.2 TeX Gyre Heros as default sans serif family ) -(/usr/local/texlive/2012/texmf-dist/tex/latex/graphics/color.sty -Package: color 2005/11/14 v1.0j Standard LaTeX Color (DPC) +(/usr/share/texlive/texmf-dist/tex/latex/fncychap/fncychap.sty +Package: fncychap 2007/07/30 v1.34 LaTeX package (Revised chapters) +\RW=\skip52 +\mylen=\skip53 +\myhi=\skip54 +\px=\skip55 +\py=\skip56 +\pyy=\skip57 +\pxx=\skip58 +\c@AlphaCnt=\count274 +\c@AlphaDecCnt=\count275 +) (./sphinx.sty +Package: sphinx 2023/03/19 v6.2.0 LaTeX package (Sphinx markup) + +(/usr/share/texlive/texmf-dist/tex/latex/xcolor/xcolor.sty +Package: xcolor 2021/10/31 v2.13 LaTeX color extensions (UK) + +(/usr/share/texlive/texmf-dist/tex/latex/graphics-cfg/color.cfg +File: color.cfg 2016/01/02 v1.6 sample color configuration +) +Package xcolor Info: Driver file: pdftex.def on input line 227. -(/usr/local/texlive/2012/texmf-dist/tex/latex/latexconfig/color.cfg -File: color.cfg 2007/01/18 v1.5 color configuration of teTeX/TeXLive +(/usr/share/texlive/texmf-dist/tex/latex/graphics-def/pdftex.def +File: pdftex.def 2020/10/05 v1.2a Graphics/color driver for pdftex +) +Package xcolor Info: Model `cmy' substituted by `cmy0' on input line 1352. +Package xcolor Info: Model `hsb' substituted by `rgb' on input line 1356. +Package xcolor Info: Model `RGB' extended on input line 1368. +Package xcolor Info: Model `HTML' substituted by `rgb' on input line 1370. +Package xcolor Info: Model `Hsb' substituted by `hsb' on input line 1371. +Package xcolor Info: Model `tHsb' substituted by `hsb' on input line 1372. +Package xcolor Info: Model `HSB' substituted by `hsb' on input line 1373. +Package xcolor Info: Model `Gray' substituted by `gray' on input line 1374. +Package xcolor Info: Model `wave' substituted by `hsb' on input line 1375. +) +(./sphinxoptionshyperref.sty +File: sphinxoptionshyperref.sty 2021/01/27 hyperref +) (./sphinxoptionsgeometry.sty +File: sphinxoptionsgeometry.sty 2021/01/27 geometry +) +(/usr/share/texlive/texmf-dist/tex/latex/base/textcomp.sty +Package: textcomp 2020/02/02 v2.0n Standard LaTeX package +) +(/usr/share/texlive/texmf-dist/tex/latex/float/float.sty +Package: float 2001/11/08 v1.3d Float enhancements (AL) +\c@float@type=\count276 +\float@exts=\toks24 +\float@box=\box52 +\@float@everytoks=\toks25 +\@floatcapt=\box53 ) -Package color Info: Driver file: pdftex.def on input line 130. +(/usr/share/texlive/texmf-dist/tex/latex/wrapfig/wrapfig.sty +\wrapoverhang=\dimen149 +\WF@size=\dimen150 +\c@WF@wrappedlines=\count277 +\WF@box=\box54 +\WF@everypar=\toks26 +Package: wrapfig 2003/01/31 v 3.6 +) +(/usr/share/texlive/texmf-dist/tex/latex/capt-of/capt-of.sty +Package: capt-of 2009/12/29 v0.2 standard captions outside of floats +) +(/usr/share/texlive/texmf-dist/tex/latex/tools/multicol.sty +Package: multicol 2021/10/28 v1.9b multicolumn formatting (FMi) +\c@tracingmulticols=\count278 +\mult@box=\box55 +\multicol@leftmargin=\dimen151 +\c@unbalance=\count279 +\c@collectmore=\count280 +\doublecol@number=\count281 +\multicoltolerance=\count282 +\multicolpretolerance=\count283 +\full@width=\dimen152 +\page@free=\dimen153 +\premulticols=\dimen154 +\postmulticols=\dimen155 +\multicolsep=\skip59 +\multicolbaselineskip=\skip60 +\partial@page=\box56 +\last@line=\box57 +\maxbalancingoverflow=\dimen156 +\mult@rightbox=\box58 +\mult@grightbox=\box59 +\mult@firstbox=\box60 +\mult@gfirstbox=\box61 +\@tempa=\box62 +\@tempa=\box63 +\@tempa=\box64 +\@tempa=\box65 +\@tempa=\box66 +\@tempa=\box67 +\@tempa=\box68 +\@tempa=\box69 +\@tempa=\box70 +\@tempa=\box71 +\@tempa=\box72 +\@tempa=\box73 +\@tempa=\box74 +\@tempa=\box75 +\@tempa=\box76 +\@tempa=\box77 +\@tempa=\box78 +\@tempa=\box79 +\@tempa=\box80 +\@tempa=\box81 +\@tempa=\box82 +\@tempa=\box83 +\@tempa=\box84 +\@tempa=\box85 +\@tempa=\box86 +\@tempa=\box87 +\@tempa=\box88 +\@tempa=\box89 +\@tempa=\box90 +\@tempa=\box91 +\@tempa=\box92 +\@tempa=\box93 +\@tempa=\box94 +\@tempa=\box95 +\@tempa=\box96 +\@tempa=\box97 +\c@minrows=\count284 +\c@columnbadness=\count285 +\c@finalcolumnbadness=\count286 +\last@try=\dimen157 +\multicolovershoot=\dimen158 +\multicolundershoot=\dimen159 +\mult@nat@firstbox=\box98 +\colbreak@box=\box99 +\mc@col@check@num=\count287 +) +(/usr/share/texlive/texmf-dist/tex/latex/graphics/graphicx.sty +Package: graphicx 2021/09/16 v1.2d Enhanced LaTeX Graphics (DPC,SPQR) + +(/usr/share/texlive/texmf-dist/tex/latex/graphics/graphics.sty +Package: graphics 2021/03/04 v1.4d Standard LaTeX Graphics (DPC,SPQR) + +(/usr/share/texlive/texmf-dist/tex/latex/graphics/trig.sty +Package: trig 2021/08/11 v1.11 sin cos tan (DPC) +) +(/usr/share/texlive/texmf-dist/tex/latex/graphics-cfg/graphics.cfg +File: graphics.cfg 2016/06/04 v1.11 sample graphics configuration +) +Package graphics Info: Driver file: pdftex.def on input line 107. +) +\Gin@req@height=\dimen160 +\Gin@req@width=\dimen161 +) +(./sphinxlatexgraphics.sty +File: sphinxlatexgraphics.sty 2021/01/27 graphics +\spx@image@maxheight=\dimen162 +\spx@image@box=\box100 +) (./sphinxpackageboxes.sty +Package: sphinxpackageboxes 2023/03/19 v6.2.0 advanced colored boxes + +(/usr/share/texlive/texmf-dist/tex/latex/pict2e/pict2e.sty +Package: pict2e 2020/09/30 v0.4b Improved picture commands (HjG,RN,JT) + +(/usr/share/texlive/texmf-dist/tex/latex/pict2e/pict2e.cfg +File: pict2e.cfg 2016/02/05 v0.1u pict2e configuration for teTeX/TeXLive +) +Package pict2e Info: Driver file: pdftex.def on input line 112. +Package pict2e Info: Driver file for pict2e: p2e-pdftex.def on input line 114. -(/usr/local/texlive/2012/texmf-dist/tex/latex/pdftex-def/pdftex.def -File: pdftex.def 2011/05/27 v0.06d Graphics/color for pdfTeX +(/usr/share/texlive/texmf-dist/tex/latex/pict2e/p2e-pdftex.def +File: p2e-pdftex.def 2016/02/05 v0.1u Driver-dependant file (RN,HjG,JT) +) +\pIIe@GRAPH=\toks27 +\@arclen=\dimen163 +\@arcrad=\dimen164 +\pIIe@tempdima=\dimen165 +\pIIe@tempdimb=\dimen166 +\pIIe@tempdimc=\dimen167 +\pIIe@tempdimd=\dimen168 +\pIIe@tempdime=\dimen169 +\pIIe@tempdimf=\dimen170 +) +(/usr/share/texlive/texmf-dist/tex/latex/ellipse/ellipse.sty +Package: ellipse 2004/11/05 v1.0 .dtx ellipse file +) +\@tempdimd=\dimen171 +\spx@tempboxa=\box101 +\spx@tempboxb=\box102 +\spx@boxes@border=\dimen172 +\spx@boxes@border@top=\dimen173 +\spx@boxes@border@right=\dimen174 +\spx@boxes@border@bottom=\dimen175 +\spx@boxes@border@left=\dimen176 +\spx@boxes@padding@top=\dimen177 +\spx@boxes@padding@right=\dimen178 +\spx@boxes@padding@bottom=\dimen179 +\spx@boxes@padding@left=\dimen180 +\spx@boxes@shadow@xoffset=\dimen181 +\spx@boxes@shadow@yoffset=\dimen182 +\spx@boxes@radius@topleft@x=\dimen183 +\spx@boxes@radius@topright@x=\dimen184 +\spx@boxes@radius@bottomright@x=\dimen185 +\spx@boxes@radius@bottomleft@x=\dimen186 +\spx@boxes@radius@topleft@y=\dimen187 +\spx@boxes@radius@topright@y=\dimen188 +\spx@boxes@radius@bottomright@y=\dimen189 +\spx@boxes@radius@bottomleft@y=\dimen190 +) +(./sphinxlatexadmonitions.sty +File: sphinxlatexadmonitions.sty 2023/03/19 admonitions -(/usr/local/texlive/2012/texmf-dist/tex/generic/oberdiek/infwarerr.sty -Package: infwarerr 2010/04/08 v1.3 Providing info/warning/error messages (HO) +(/usr/share/texlive/texmf-dist/tex/latex/framed/framed.sty +Package: framed 2011/10/22 v 0.96: framed or shaded text with page breaks +\OuterFrameSep=\skip61 +\fb@frw=\dimen191 +\fb@frh=\dimen192 +\FrameRule=\dimen193 +\FrameSep=\dimen194 +) +\spx@notice@border=\dimen195 +) +(./sphinxlatexliterals.sty +File: sphinxlatexliterals.sty 2023/04/01 code-blocks and parsed literals + +(/usr/share/texlive/texmf-dist/tex/latex/fancyvrb/fancyvrb.sty +Package: fancyvrb 2021/12/21 4.1b verbatim text (tvz,hv) +\FV@CodeLineNo=\count288 +\FV@InFile=\read3 +\FV@TabBox=\box103 +\c@FancyVerbLine=\count289 +\FV@StepNumber=\count290 +\FV@OutFile=\write3 +) +(/usr/share/texlive/texmf-dist/tex/latex/base/alltt.sty +Package: alltt 2021/01/29 v2.0g defines alltt environment +) +(/usr/share/texlive/texmf-dist/tex/latex/upquote/upquote.sty +Package: upquote 2012/04/19 v1.3 upright-quote and grave-accent glyphs in verba +tim +) +(/usr/share/texlive/texmf-dist/tex/latex/needspace/needspace.sty +Package: needspace 2010/09/12 v1.3d reserve vertical space +) +\sphinxcontinuationbox=\box104 +\sphinxvisiblespacebox=\box105 +\sphinxVerbatim@TitleBox=\box106 +\sphinxVerbatim@ContentsBox=\box107 ) -(/usr/local/texlive/2012/texmf-dist/tex/generic/oberdiek/ltxcmds.sty -Package: ltxcmds 2011/11/09 v1.22 LaTeX kernel commands for general use (HO) +(./sphinxlatexshadowbox.sty +File: sphinxlatexshadowbox.sty 2023/03/19 sphinxShadowBox +) (./sphinxlatexcontainers.sty +File: sphinxlatexcontainers.sty 2021/05/03 containers ) -\Gread@gobject=\count109 +(./sphinxhighlight.sty +Package: sphinxhighlight 2022/06/30 stylesheet for highlighting with pygments +) (./sphinxlatextables.sty +File: sphinxlatextables.sty 2022/08/15 tables + +(/usr/share/texlive/texmf-dist/tex/latex/tabulary/tabulary.sty +Package: tabulary 2014/06/11 v0.10 tabulary package (DPC) + +(/usr/share/texlive/texmf-dist/tex/latex/tools/array.sty +Package: array 2021/10/04 v2.5f Tabular extension package (FMi) +\col@sep=\dimen196 +\ar@mcellbox=\box108 +\extrarowheight=\dimen197 +\NC@list=\toks28 +\extratabsurround=\skip62 +\backup@length=\skip63 +\ar@cellbox=\box109 +) +\TY@count=\count291 +\TY@linewidth=\dimen198 +\tymin=\dimen199 +\tymax=\dimen256 +\TY@tablewidth=\dimen257 +) +(/usr/share/texlive/texmf-dist/tex/latex/tools/longtable.sty +Package: longtable 2021-09-01 v4.17 Multi-page Table package (DPC) +\LTleft=\skip64 +\LTright=\skip65 +\LTpre=\skip66 +\LTpost=\skip67 +\LTchunksize=\count292 +\LTcapwidth=\dimen258 +\LT@head=\box110 +\LT@firsthead=\box111 +\LT@foot=\box112 +\LT@lastfoot=\box113 +\LT@gbox=\box114 +\LT@cols=\count293 +\LT@rows=\count294 +\c@LT@tables=\count295 +\c@LT@chunks=\count296 +\LT@p@ftn=\toks29 +) +(/usr/share/texlive/texmf-dist/tex/latex/varwidth/varwidth.sty +Package: varwidth 2009/03/30 ver 0.92; Variable-width minipages +\@vwid@box=\box115 +\sift@deathcycles=\count297 +\@vwid@loff=\dimen259 +\@vwid@roff=\dimen260 +) +\sphinx@TY@tablewidth=\dimen261 + +(/usr/share/texlive/texmf-dist/tex/latex/colortbl/colortbl.sty +Package: colortbl 2020/01/04 v1.0e Color table columns (DPC) +\everycr=\toks30 +\minrowclearance=\skip68 +) +\rownum=\count298 + +(/usr/share/texlive/texmf-dist/tex/latex/booktabs/booktabs.sty +Package: booktabs 2020/01/12 v1.61803398 Publication quality tables +\heavyrulewidth=\dimen262 +\lightrulewidth=\dimen263 +\cmidrulewidth=\dimen264 +\belowrulesep=\dimen265 +\belowbottomsep=\dimen266 +\aboverulesep=\dimen267 +\abovetopsep=\dimen268 +\cmidrulesep=\dimen269 +\cmidrulekern=\dimen270 +\defaultaddspace=\dimen271 +\@cmidla=\count299 +\@cmidlb=\count300 +\@aboverulesep=\dimen272 +\@belowrulesep=\dimen273 +\@thisruleclass=\count301 +\@lastruleclass=\count302 +\@thisrulewidth=\dimen274 )) -(/usr/local/texlive/2012/texmf-dist/tex/latex/fancyvrb/fancyvrb.sty -Package: fancyvrb 2008/02/07 - -Style option: `fancyvrb' v2.7a, with DG/SPQR fixes, and firstline=lastline fix -<2008/02/07> (tvz) -(/usr/local/texlive/2012/texmf-dist/tex/latex/graphics/keyval.sty -Package: keyval 1999/03/16 v1.13 key=value parser (DPC) -\KV@toks@=\toks28 -) -\FV@CodeLineNo=\count110 -\FV@InFile=\read2 -\FV@TabBox=\box35 -\c@FancyVerbLine=\count111 -\FV@StepNumber=\count112 -\FV@OutFile=\write4 -) -(/usr/local/texlive/2012/texmf-dist/tex/latex/threeparttable/threeparttable.sty -Package: threeparttable 2003/06/13 v 3.0 -\@tempboxb=\box36 -) (/usr/local/texlive/2012/texmf-dist/tex/latex/mdwtools/footnote.sty -Package: footnote 1997/01/28 1.13 Save footnotes around boxes -\fn@notes=\box37 -\fn@width=\dimen130 -) -(/usr/local/texlive/2012/texmf-dist/tex/latex/wrapfig/wrapfig.sty -\wrapoverhang=\dimen131 -\WF@size=\dimen132 -\c@WF@wrappedlines=\count113 -\WF@box=\box38 -\WF@everypar=\toks29 -Package: wrapfig 2003/01/31 v 3.6 +(./sphinxlatexnumfig.sty +File: sphinxlatexnumfig.sty 2021/01/27 numbering +) (./sphinxlatexlists.sty +File: sphinxlatexlists.sty 2021/12/20 lists +\spx@lineitemlabel=\toks31 ) -(/usr/local/texlive/2012/texmf-dist/tex/latex/parskip/parskip.sty +\c@sphinxscope=\count303 + (./sphinxpackagefootnote.sty +Package: sphinxpackagefootnote 2022/08/15 v5.3.0 Sphinx custom footnotehyper pa +ckage (Sphinx team) +\FNH@notes=\box116 +\FNH@toks=\toks32 +\FNH@width=\dimen275 +\c@sphinxfootnotemark=\count304 +) (./sphinxlatexindbibtoc.sty +File: sphinxlatexindbibtoc.sty 2021/01/27 index, bib., toc + +(/usr/share/texlive/texmf-dist/tex/latex/base/makeidx.sty +Package: makeidx 2021/10/04 v1.0m Standard LaTeX package +)) +(./sphinxlatexstylepage.sty +File: sphinxlatexstylepage.sty 2021/01/27 page styling + +(/usr/share/texlive/texmf-dist/tex/latex/parskip/parskip.sty +Rollback for package 'parskip' requested -> version 'v1'. + This corresponds to the release introduced on 2001-04-09. + +(/usr/share/texlive/texmf-dist/tex/latex/parskip/parskip-2001-04-09.sty Package: parskip 2001/04/09 non-zero parskip adjustments +)) +(/usr/share/texlive/texmf-dist/tex/latex/fancyhdr/fancyhdr.sty +Package: fancyhdr 2021/01/28 v4.0.1 Extensive control of page headers and foote +rs +\f@nch@headwidth=\skip69 +\f@nch@O@elh=\skip70 +\f@nch@O@erh=\skip71 +\f@nch@O@olh=\skip72 +\f@nch@O@orh=\skip73 +\f@nch@O@elf=\skip74 +\f@nch@O@erf=\skip75 +\f@nch@O@olf=\skip76 +\f@nch@O@orf=\skip77 +)) +(./sphinxlatexstyleheadings.sty +File: sphinxlatexstyleheadings.sty 2023/02/11 headings + +(/usr/share/texlive/texmf-dist/tex/latex/titlesec/titlesec.sty +Package: titlesec 2021/07/05 v2.14 Sectioning titles +\ttl@box=\box117 +\beforetitleunit=\skip78 +\aftertitleunit=\skip79 +\ttl@plus=\dimen276 +\ttl@minus=\dimen277 +\ttl@toksa=\toks33 +\titlewidth=\dimen278 +\titlewidthlast=\dimen279 +\titlewidthfirst=\dimen280 +)) +(./sphinxlatexstyletext.sty +File: sphinxlatexstyletext.sty 2023/07/23 text styling +) (./sphinxlatexobjects.sty +File: sphinxlatexobjects.sty 2023/07/23 documentation environments +\sphinxsignaturesep=\skip80 +\sphinxsignaturelistskip=\skip81 +\py@argswidth=\skip82 +\lineblockindentation=\skip83 +\DUlineblockindent=\skip84 +)) +(/usr/share/texlive/texmf-dist/tex/latex/geometry/geometry.sty +Package: geometry 2020/01/02 v5.9 Page Geometry + +(/usr/share/texlive/texmf-dist/tex/generic/iftex/ifvtex.sty +Package: ifvtex 2019/10/25 v1.7 ifvtex legacy package. Use iftex instead. + +(/usr/share/texlive/texmf-dist/tex/generic/iftex/iftex.sty +Package: iftex 2020/03/06 v1.0d TeX engine tests +)) +\Gm@cnth=\count305 +\Gm@cntv=\count306 +\c@Gm@tempcnt=\count307 +\Gm@bindingoffset=\dimen281 +\Gm@wd@mp=\dimen282 +\Gm@odd@mp=\dimen283 +\Gm@even@mp=\dimen284 +\Gm@layoutwidth=\dimen285 +\Gm@layoutheight=\dimen286 +\Gm@layouthoffset=\dimen287 +\Gm@layoutvoffset=\dimen288 +\Gm@dimlist=\toks34 +) +(/usr/share/texlive/texmf-dist/tex/latex/hyperref/hyperref.sty +Package: hyperref 2021-06-07 v7.00m Hypertext links for LaTeX + +(/usr/share/texlive/texmf-dist/tex/generic/pdftexcmds/pdftexcmds.sty +Package: pdftexcmds 2020-06-27 v0.33 Utility functions of pdfTeX for LuaTeX (HO +) + +(/usr/share/texlive/texmf-dist/tex/generic/infwarerr/infwarerr.sty +Package: infwarerr 2019/12/03 v1.5 Providing info/warning/error messages (HO) ) -(/usr/local/texlive/2012/texmf-dist/tex/latex/graphics/graphicx.sty -Package: graphicx 1999/02/16 v1.0f Enhanced LaTeX Graphics (DPC,SPQR) - -(/usr/local/texlive/2012/texmf-dist/tex/latex/graphics/graphics.sty -Package: graphics 2009/02/05 v1.0o Standard LaTeX Graphics (DPC,SPQR) - -(/usr/local/texlive/2012/texmf-dist/tex/latex/graphics/trig.sty -Package: trig 1999/03/16 v1.09 sin cos tan (DPC) -) -(/usr/local/texlive/2012/texmf-dist/tex/latex/latexconfig/graphics.cfg -File: graphics.cfg 2010/04/23 v1.9 graphics configuration of TeX Live -) -Package graphics Info: Driver file: pdftex.def on input line 91. -) -\Gin@req@height=\dimen133 -\Gin@req@width=\dimen134 -) -(/usr/local/texlive/2012/texmf-dist/tex/plain/misc/pdfcolor.tex) -\distancetoright=\skip71 -\py@argswidth=\skip72 -\py@noticelength=\skip73 -\lineblockindentation=\skip74 -\image@box=\box39 -\image@width=\dimen135 - -(/usr/local/texlive/2012/texmf-dist/tex/latex/hyperref/hyperref.sty -Package: hyperref 2012/08/11 v6.82z Hypertext links for LaTeX - -(/usr/local/texlive/2012/texmf-dist/tex/generic/oberdiek/hobsub-hyperref.sty -Package: hobsub-hyperref 2012/05/28 v1.13 Bundle oberdiek, subset hyperref (HO) - - -(/usr/local/texlive/2012/texmf-dist/tex/generic/oberdiek/hobsub-generic.sty -Package: hobsub-generic 2012/05/28 v1.13 Bundle oberdiek, subset generic (HO) -Package: hobsub 2012/05/28 v1.13 Construct package bundles (HO) -Package hobsub Info: Skipping package `infwarerr' (already loaded). -Package hobsub Info: Skipping package `ltxcmds' (already loaded). -Package: ifluatex 2010/03/01 v1.3 Provides the ifluatex switch (HO) -Package ifluatex Info: LuaTeX not detected. -Package: ifvtex 2010/03/01 v1.5 Detect VTeX and its facilities (HO) -Package ifvtex Info: VTeX not detected. -Package: intcalc 2007/09/27 v1.1 Expandable calculations with integers (HO) -Package: ifpdf 2011/01/30 v2.3 Provides the ifpdf switch (HO) -Package ifpdf Info: pdfTeX in PDF mode is detected. -Package: etexcmds 2011/02/16 v1.5 Avoid name clashes with e-TeX commands (HO) -Package etexcmds Info: Could not find \expanded. -(etexcmds) That can mean that you are not using pdfTeX 1.50 or -(etexcmds) that some package has redefined \expanded. -(etexcmds) In the latter case, load this package earlier. -Package: kvsetkeys 2012/04/25 v1.16 Key value parser (HO) -Package: kvdefinekeys 2011/04/07 v1.3 Define keys (HO) -Package: pdftexcmds 2011/11/29 v0.20 Utility functions of pdfTeX for LuaTeX (HO -) -Package pdftexcmds Info: LuaTeX not detected. Package pdftexcmds Info: \pdf@primitive is available. Package pdftexcmds Info: \pdf@ifprimitive is available. Package pdftexcmds Info: \pdfdraftmode found. -Package: pdfescape 2011/11/25 v1.13 Implements pdfTeX's escape features (HO) -Package: bigintcalc 2012/04/08 v1.3 Expandable calculations on big integers (HO ) -Package: bitset 2011/01/30 v1.1 Handle bit-vector datatype (HO) -Package: uniquecounter 2011/01/30 v1.2 Provide unlimited unique counter (HO) +(/usr/share/texlive/texmf-dist/tex/generic/kvdefinekeys/kvdefinekeys.sty +Package: kvdefinekeys 2019-12-19 v1.6 Define keys (HO) ) -Package hobsub Info: Skipping package `hobsub' (already loaded). -Package: letltxmacro 2010/09/02 v1.4 Let assignment for LaTeX macros (HO) -Package: hopatch 2012/05/28 v1.2 Wrapper for package hooks (HO) -Package: xcolor-patch 2011/01/30 xcolor patch -Package: atveryend 2011/06/30 v1.8 Hooks at the very end of document (HO) -Package atveryend Info: \enddocument detected (standard20110627). -Package: atbegshi 2011/10/05 v1.16 At begin shipout hook (HO) -Package: refcount 2011/10/16 v3.4 Data extraction from label references (HO) -Package: hycolor 2011/01/30 v1.7 Color options for hyperref/bookmark (HO) +(/usr/share/texlive/texmf-dist/tex/generic/pdfescape/pdfescape.sty +Package: pdfescape 2019/12/09 v1.15 Implements pdfTeX's escape features (HO) ) -(/usr/local/texlive/2012/texmf-dist/tex/generic/ifxetex/ifxetex.sty -Package: ifxetex 2010/09/12 v0.6 Provides ifxetex conditional +(/usr/share/texlive/texmf-dist/tex/latex/hycolor/hycolor.sty +Package: hycolor 2020-01-27 v1.10 Color options for hyperref/bookmark (HO) ) -(/usr/local/texlive/2012/texmf-dist/tex/latex/oberdiek/auxhook.sty -Package: auxhook 2011/03/04 v1.3 Hooks for auxiliary files (HO) +(/usr/share/texlive/texmf-dist/tex/latex/letltxmacro/letltxmacro.sty +Package: letltxmacro 2019/12/03 v1.6 Let assignment for LaTeX macros (HO) ) -(/usr/local/texlive/2012/texmf-dist/tex/latex/oberdiek/kvoptions.sty -Package: kvoptions 2011/06/30 v3.11 Key value format for package options (HO) +(/usr/share/texlive/texmf-dist/tex/latex/auxhook/auxhook.sty +Package: auxhook 2019-12-17 v1.6 Hooks for auxiliary files (HO) ) -\@linkdim=\dimen136 -\Hy@linkcounter=\count114 -\Hy@pagecounter=\count115 +\@linkdim=\dimen289 +\Hy@linkcounter=\count308 +\Hy@pagecounter=\count309 -(/usr/local/texlive/2012/texmf-dist/tex/latex/hyperref/pd1enc.def -File: pd1enc.def 2012/08/11 v6.82z Hyperref: PDFDocEncoding definition (HO) +(/usr/share/texlive/texmf-dist/tex/latex/hyperref/pd1enc.def +File: pd1enc.def 2021-06-07 v7.00m Hyperref: PDFDocEncoding definition (HO) Now handling font encoding PD1 ... ... no UTF-8 mapping file for font encoding PD1 ) -\Hy@SavedSpaceFactor=\count116 +(/usr/share/texlive/texmf-dist/tex/latex/hyperref/hyperref-langpatches.def +File: hyperref-langpatches.def 2021-06-07 v7.00m Hyperref: patches for babel la +nguages +) +(/usr/share/texlive/texmf-dist/tex/generic/intcalc/intcalc.sty +Package: intcalc 2019/12/15 v1.3 Expandable calculations with integers (HO) +) +(/usr/share/texlive/texmf-dist/tex/generic/etexcmds/etexcmds.sty +Package: etexcmds 2019/12/15 v1.7 Avoid name clashes with e-TeX commands (HO) +) +\Hy@SavedSpaceFactor=\count310 -(/usr/local/texlive/2012/texmf-dist/tex/latex/latexconfig/hyperref.cfg -File: hyperref.cfg 2002/06/06 v1.2 hyperref configuration of TeXLive +(/usr/share/texlive/texmf-dist/tex/latex/hyperref/puenc.def +File: puenc.def 2021-06-07 v7.00m Hyperref: PDF Unicode definition (HO) +Now handling font encoding PU ... +... no UTF-8 mapping file for font encoding PU ) -Package hyperref Info: Option `colorlinks' set `true' on input line 4080. -Package hyperref Info: Option `breaklinks' set `true' on input line 4080. -Package hyperref Info: Hyper figures OFF on input line 4204. -Package hyperref Info: Link nesting OFF on input line 4209. -Package hyperref Info: Hyper index ON on input line 4212. -Package hyperref Info: Plain pages OFF on input line 4219. -Package hyperref Info: Backreferencing OFF on input line 4224. +Package hyperref Info: Option `unicode' set `true' on input line 4073. +Package hyperref Info: Option `colorlinks' set `true' on input line 4073. +Package hyperref Info: Option `breaklinks' set `true' on input line 4073. +Package hyperref Info: Hyper figures OFF on input line 4192. +Package hyperref Info: Link nesting OFF on input line 4197. +Package hyperref Info: Hyper index ON on input line 4200. +Package hyperref Info: Plain pages OFF on input line 4207. +Package hyperref Info: Backreferencing OFF on input line 4212. Package hyperref Info: Implicit mode ON; LaTeX internals redefined. -Package hyperref Info: Bookmarks ON on input line 4442. -\c@Hy@tempcnt=\count117 - -(/usr/local/texlive/2012/texmf-dist/tex/latex/url/url.sty -\Urlmuskip=\muskip11 -Package: url 2006/04/12 ver 3.3 Verb mode for urls, etc. -) -LaTeX Info: Redefining \url on input line 4795. -\Fld@menulength=\count118 -\Field@Width=\dimen137 -\Fld@charsize=\dimen138 -Package hyperref Info: Hyper figures OFF on input line 5985. -Package hyperref Info: Link nesting OFF on input line 5990. -Package hyperref Info: Hyper index ON on input line 5993. -Package hyperref Info: backreferencing OFF on input line 6000. -Package hyperref Info: Link coloring ON on input line 6003. -Package hyperref Info: Link coloring with OCG OFF on input line 6010. -Package hyperref Info: PDF/A mode OFF on input line 6015. -LaTeX Info: Redefining \ref on input line 6055. -LaTeX Info: Redefining \pageref on input line 6059. -\Hy@abspage=\count119 -\c@Item=\count120 -\c@Hfootnote=\count121 -) - -Package hyperref Message: Driver (autodetected): hpdftex. - -(/usr/local/texlive/2012/texmf-dist/tex/latex/hyperref/hpdftex.def -File: hpdftex.def 2012/08/11 v6.82z Hyperref driver for pdfTeX -\Fld@listcount=\count122 -\c@bookmark@seq@number=\count123 - -(/usr/local/texlive/2012/texmf-dist/tex/latex/oberdiek/rerunfilecheck.sty -Package: rerunfilecheck 2011/04/15 v1.7 Rerun checks for auxiliary files (HO) -Package uniquecounter Info: New unique counter `rerunfilecheck' on input line 2 -82. +Package hyperref Info: Bookmarks ON on input line 4445. +\c@Hy@tempcnt=\count311 + +(/usr/share/texlive/texmf-dist/tex/latex/url/url.sty +\Urlmuskip=\muskip17 +Package: url 2013/09/16 ver 3.4 Verb mode for urls, etc. +) +LaTeX Info: Redefining \url on input line 4804. +\XeTeXLinkMargin=\dimen290 + +(/usr/share/texlive/texmf-dist/tex/generic/bitset/bitset.sty +Package: bitset 2019/12/09 v1.3 Handle bit-vector datatype (HO) + +(/usr/share/texlive/texmf-dist/tex/generic/bigintcalc/bigintcalc.sty +Package: bigintcalc 2019/12/15 v1.5 Expandable calculations on big integers (HO +) +)) +\Fld@menulength=\count312 +\Field@Width=\dimen291 +\Fld@charsize=\dimen292 +Package hyperref Info: Hyper figures OFF on input line 6076. +Package hyperref Info: Link nesting OFF on input line 6081. +Package hyperref Info: Hyper index ON on input line 6084. +Package hyperref Info: backreferencing OFF on input line 6091. +Package hyperref Info: Link coloring ON on input line 6094. +Package hyperref Info: Link coloring with OCG OFF on input line 6101. +Package hyperref Info: PDF/A mode OFF on input line 6106. +LaTeX Info: Redefining \ref on input line 6146. +LaTeX Info: Redefining \pageref on input line 6150. + +(/usr/share/texlive/texmf-dist/tex/latex/base/atbegshi-ltx.sty +Package: atbegshi-ltx 2021/01/10 v1.0c Emulation of the original atbegshi +package with kernel methods +) +\Hy@abspage=\count313 +\c@Item=\count314 +\c@Hfootnote=\count315 +) +Package hyperref Info: Driver (autodetected): hpdftex. + +(/usr/share/texlive/texmf-dist/tex/latex/hyperref/hpdftex.def +File: hpdftex.def 2021-06-07 v7.00m Hyperref driver for pdfTeX + +(/usr/share/texlive/texmf-dist/tex/latex/base/atveryend-ltx.sty +Package: atveryend-ltx 2020/08/19 v1.0a Emulation of the original atveryend pac +kage +with kernel methods +) +\Fld@listcount=\count316 +\c@bookmark@seq@number=\count317 + +(/usr/share/texlive/texmf-dist/tex/latex/rerunfilecheck/rerunfilecheck.sty +Package: rerunfilecheck 2019/12/05 v1.9 Rerun checks for auxiliary files (HO) + +(/usr/share/texlive/texmf-dist/tex/generic/uniquecounter/uniquecounter.sty +Package: uniquecounter 2019/12/15 v1.4 Provide unlimited unique counter (HO) ) -\Hy@SectionHShift=\skip75 +Package uniquecounter Info: New unique counter `rerunfilecheck' on input line 2 +86. ) -(/usr/local/texlive/2012/texmf-dist/tex/latex/oberdiek/hypcap.sty -Package: hypcap 2011/02/16 v1.11 Adjusting the anchors of captions (HO) +\Hy@SectionHShift=\skip85 ) -\DUlineblockindent=\skip76 +(/usr/share/texlive/texmf-dist/tex/latex/oberdiek/hypcap.sty +Package: hypcap 2016/05/16 v1.12 Adjusting the anchors of captions (HO) ) -(/usr/local/texlive/2012/texmf-dist/tex/latex/multirow/multirow.sty -\bigstrutjot=\dimen139 +(./sphinxmessages.sty +Package: sphinxmessages 2019/01/04 v2.0 Localized LaTeX macros (Sphinx team) ) -\@indexfile=\write5 -\openout5 = `rHEALPixDGGS.idx'. +\@indexfile=\write4 +\openout4 = `rHEALPixDGGS.idx'. Writing index file rHEALPixDGGS.idx +LaTeX Font Info: Trying to load font information for T1+qtm on input line 72 +. +(/usr/share/texmf/tex/latex/tex-gyre/t1qtm.fd +File: t1qtm.fd 2009/09/25 v1.2 font definition file for T1/qtm +) +(/usr/share/texlive/texmf-dist/tex/latex/l3backend/l3backend-pdftex.def +File: l3backend-pdftex.def 2022-01-12 L3 backend support: PDF output (pdfTeX) +\l__color_backend_stack_int=\count318 +\l__pdf_internal_box=\box118 +) LaTeX Warning: Unused global option(s): [12ptopenany]. @@ -805,602 +727,581 @@ LaTeX Warning: Unused global option(s): (./rHEALPixDGGS.aux) \openout1 = `rHEALPixDGGS.aux'. -LaTeX Font Info: Checking defaults for OML/cmm/m/it on input line 116. -LaTeX Font Info: ... okay on input line 116. -LaTeX Font Info: Checking defaults for T1/cmr/m/n on input line 116. -LaTeX Font Info: ... okay on input line 116. -LaTeX Font Info: Checking defaults for OT1/cmr/m/n on input line 116. -LaTeX Font Info: ... okay on input line 116. -LaTeX Font Info: Checking defaults for OMS/cmsy/m/n on input line 116. -LaTeX Font Info: ... okay on input line 116. -LaTeX Font Info: Checking defaults for OMX/cmex/m/n on input line 116. -LaTeX Font Info: ... okay on input line 116. -LaTeX Font Info: Checking defaults for U/cmr/m/n on input line 116. -LaTeX Font Info: ... okay on input line 116. -LaTeX Font Info: Checking defaults for TS1/cmr/m/n on input line 116. -LaTeX Font Info: Try loading font information for TS1+cmr on input line 116. - - -(/usr/local/texlive/2012/texmf-dist/tex/latex/base/ts1cmr.fd -File: ts1cmr.fd 1999/05/25 v2.5h Standard LaTeX font definitions -) -LaTeX Font Info: ... okay on input line 116. -LaTeX Font Info: Checking defaults for PD1/pdf/m/n on input line 116. -LaTeX Font Info: ... okay on input line 116. -LaTeX Font Info: Try loading font information for T1+ptm on input line 116. - -(/usr/local/texlive/2012/texmf-dist/tex/latex/psnfss/t1ptm.fd -File: t1ptm.fd 2001/06/04 font definitions for T1/ptm. -) -(/usr/local/texlive/2012/texmf-dist/tex/context/base/supp-pdf.mkii +LaTeX Font Info: Checking defaults for OML/cmm/m/it on input line 72. +LaTeX Font Info: ... okay on input line 72. +LaTeX Font Info: Checking defaults for OMS/cmsy/m/n on input line 72. +LaTeX Font Info: ... okay on input line 72. +LaTeX Font Info: Checking defaults for OT1/cmr/m/n on input line 72. +LaTeX Font Info: ... okay on input line 72. +LaTeX Font Info: Checking defaults for T1/cmr/m/n on input line 72. +LaTeX Font Info: ... okay on input line 72. +LaTeX Font Info: Checking defaults for TS1/cmr/m/n on input line 72. +LaTeX Font Info: ... okay on input line 72. +LaTeX Font Info: Checking defaults for OMX/cmex/m/n on input line 72. +LaTeX Font Info: ... okay on input line 72. +LaTeX Font Info: Checking defaults for U/cmr/m/n on input line 72. +LaTeX Font Info: ... okay on input line 72. +LaTeX Font Info: Checking defaults for PD1/pdf/m/n on input line 72. +LaTeX Font Info: ... okay on input line 72. +LaTeX Font Info: Checking defaults for PU/pdf/m/n on input line 72. +LaTeX Font Info: ... okay on input line 72. + +(/usr/share/texlive/texmf-dist/tex/context/base/mkii/supp-pdf.mkii [Loading MPS to PDF converter (version 2006.09.02).] -\scratchcounter=\count124 -\scratchdimen=\dimen140 -\scratchbox=\box40 -\nofMPsegments=\count125 -\nofMParguments=\count126 -\everyMPshowfont=\toks30 -\MPscratchCnt=\count127 -\MPscratchDim=\dimen141 -\MPnumerator=\count128 -\makeMPintoPDFobject=\count129 -\everyMPtoPDFconversion=\toks31 -) (/usr/local/texlive/2012/texmf-dist/tex/latex/oberdiek/epstopdf-base.sty -Package: epstopdf-base 2010/02/09 v2.5 Base part for package epstopdf - -(/usr/local/texlive/2012/texmf-dist/tex/latex/oberdiek/grfext.sty -Package: grfext 2010/08/19 v1.1 Manage graphics extensions (HO) -) -Package grfext Info: Graphics extension search list: -(grfext) [.png,.pdf,.jpg,.mps,.jpeg,.jbig2,.jb2,.PNG,.PDF,.JPG,.JPE -G,.JBIG2,.JB2,.eps] -(grfext) \AppendGraphicsExtensions on input line 452. - -(/usr/local/texlive/2012/texmf-dist/tex/latex/latexconfig/epstopdf-sys.cfg +\scratchcounter=\count319 +\scratchdimen=\dimen293 +\scratchbox=\box119 +\nofMPsegments=\count320 +\nofMParguments=\count321 +\everyMPshowfont=\toks35 +\MPscratchCnt=\count322 +\MPscratchDim=\dimen294 +\MPnumerator=\count323 +\makeMPintoPDFobject=\count324 +\everyMPtoPDFconversion=\toks36 +) (/usr/share/texlive/texmf-dist/tex/latex/epstopdf-pkg/epstopdf-base.sty +Package: epstopdf-base 2020-01-24 v2.11 Base part for package epstopdf +Package epstopdf-base Info: Redefining graphics rule for `.eps' on input line 4 +85. + +(/usr/share/texlive/texmf-dist/tex/latex/latexconfig/epstopdf-sys.cfg File: epstopdf-sys.cfg 2010/07/13 v1.3 Configuration of (r)epstopdf for TeX Liv e )) -\AtBeginShipoutBox=\box41 -Package hyperref Info: Link coloring ON on input line 116. - -(/usr/local/texlive/2012/texmf-dist/tex/latex/hyperref/nameref.sty -Package: nameref 2012/07/31 v2.42 Cross-referencing by name of section - -(/usr/local/texlive/2012/texmf-dist/tex/generic/oberdiek/gettitlestring.sty -Package: gettitlestring 2010/12/03 v1.4 Cleanup title references (HO) +\c@literalblock=\count325 + +*geometry* driver: auto-detecting +*geometry* detected driver: pdftex +*geometry* verbose mode - [ preamble ] result: +* driver: pdftex +* paper: a4paper +* layout: +* layoutoffset:(h,v)=(0.0pt,0.0pt) +* modes: +* h-part:(L,W,R)=(72.26999pt, 452.9679pt, 72.26999pt) +* v-part:(T,H,B)=(72.26999pt, 700.50687pt, 72.26999pt) +* \paperwidth=597.50787pt +* \paperheight=845.04684pt +* \textwidth=452.9679pt +* \textheight=700.50687pt +* \oddsidemargin=0.0pt +* \evensidemargin=0.0pt +* \topmargin=-37.0pt +* \headheight=12.0pt +* \headsep=25.0pt +* \topskip=10.0pt +* \footskip=30.0pt +* \marginparwidth=36.135pt +* \marginparsep=11.0pt +* \columnsep=10.0pt +* \skip\footins=9.0pt plus 4.0pt minus 2.0pt +* \hoffset=0.0pt +* \voffset=0.0pt +* \mag=1000 +* \@twocolumnfalse +* \@twosidefalse +* \@mparswitchfalse +* \@reversemarginfalse +* (1in=72.27pt=25.4mm, 1cm=28.453pt) + +Package hyperref Info: Link coloring ON on input line 72. +(/usr/share/texlive/texmf-dist/tex/latex/hyperref/nameref.sty +Package: nameref 2021-04-02 v2.47 Cross-referencing by name of section + +(/usr/share/texlive/texmf-dist/tex/latex/refcount/refcount.sty +Package: refcount 2019/12/15 v3.6 Data extraction from label references (HO) +) +(/usr/share/texlive/texmf-dist/tex/generic/gettitlestring/gettitlestring.sty +Package: gettitlestring 2019/12/15 v1.6 Cleanup title references (HO) ) -\c@section@level=\count130 +\c@section@level=\count326 ) -LaTeX Info: Redefining \ref on input line 116. -LaTeX Info: Redefining \pageref on input line 116. -LaTeX Info: Redefining \nameref on input line 116. +LaTeX Info: Redefining \ref on input line 72. +LaTeX Info: Redefining \pageref on input line 72. +LaTeX Info: Redefining \nameref on input line 72. (./rHEALPixDGGS.out) (./rHEALPixDGGS.out) -\@outlinefile=\write6 -\openout6 = `rHEALPixDGGS.out'. +\@outlinefile=\write5 +\openout5 = `rHEALPixDGGS.out'. +Package hyperref Info: Option `pageanchor' set `false' on input line 80. +LaTeX Font Info: Trying to load font information for T1+qhv on input line 80 +. -Underfull \hbox (badness 10000) in paragraph at lines 119--119 +(/usr/share/texmf/tex/latex/tex-gyre/t1qhv.fd +File: t1qhv.fd 2009/09/25 v1.2 font definition file for T1/qhv +)<><><><> +LaTeX Font Info: Trying to load font information for U+msa on input line 80. - [] - -LaTeX Font Info: Try loading font information for T1+phv on input line 119. -(/usr/local/texlive/2012/texmf-dist/tex/latex/psnfss/t1phv.fd -File: t1phv.fd 2001/06/04 scalable font definitions for T1/phv. -) -LaTeX Font Info: Font shape `T1/phv/bx/n' in size <24.88> not available -(Font) Font shape `T1/phv/b/n' tried instead on input line 119. -LaTeX Font Info: Font shape `T1/phv/m/it' in size <17.28> not available -(Font) Font shape `T1/phv/m/sl' tried instead on input line 119. -LaTeX Font Info: Font shape `T1/phv/bx/it' in size <17.28> not available -(Font) Font shape `T1/phv/b/it' tried instead on input line 119. -LaTeX Font Info: Font shape `T1/phv/b/it' in size <17.28> not available -(Font) Font shape `T1/phv/b/sl' tried instead on input line 119. -LaTeX Font Info: Font shape `T1/phv/bx/n' in size <17.28> not available -(Font) Font shape `T1/phv/b/n' tried instead on input line 119. - [1 - -{/usr/local/texlive/2012/texmf-var/fonts/map/pdftex/updmap/pdftex.map}] - -Package Fancyhdr Warning: \fancyfoot's `E' option without twoside option is use -less on input line 119. - -(./rHEALPixDGGS.toc -LaTeX Font Info: Font shape `T1/ptm/bx/n' in size <10> not available -(Font) Font shape `T1/ptm/b/n' tried instead on input line 2. + (/usr/share/texlive/texmf-dist/tex/latex/amsfonts/umsa.fd +File: umsa.fd 2013/01/14 v3.01 AMS symbols A ) -\tf@toc=\write7 -\openout7 = `rHEALPixDGGS.toc'. +LaTeX Font Info: Trying to load font information for U+msb on input line 80. -Adding blank page after the table of contents. +(/usr/share/texlive/texmf-dist/tex/latex/amsfonts/umsb.fd +File: umsb.fd 2013/01/14 v3.01 AMS symbols B +) [1 -Package Fancyhdr Warning: \fancyfoot's `E' option without twoside option is use -less on input line 119. +{/var/lib/texmf/fonts/map/pdftex/updmap/pdftex.map}] (./rHEALPixDGGS.toc) +\tf@toc=\write6 +\openout6 = `rHEALPixDGGS.toc'. -LaTeX Font Info: Font shape `T1/phv/bx/n' in size <10> not available -(Font) Font shape `T1/phv/b/n' tried instead on input line 119. -pdfTeX warning (ext4): destination with the same identifier (name{page.i}) has -been already used, duplicate ignored - - \relax -l.119 \tableofcontents - [1 - - -] [2] - -Package Fancyhdr Warning: \fancyfoot's `E' option without twoside option is use -less on input line 119. - - -Package Fancyhdr Warning: \fancyfoot's `E' option without twoside option is use -less on input line 119. + [1 -Package Fancyhdr Warning: \fancyhead's `E' option without twoside option is use -less on input line 119. +] Chapter 1. -LaTeX Font Info: Font shape `T1/phv/bx/n' in size <14.4> not available -(Font) Font shape `T1/phv/b/n' tried instead on input line 124. -LaTeX Font Info: Try loading font information for TS1+ptm on input line 132. - -(/usr/local/texlive/2012/texmf-dist/tex/latex/psnfss/ts1ptm.fd -File: ts1ptm.fd 2001/06/04 font definitions for TS1/ptm. +LaTeX Font Info: Trying to load font information for TS1+qtm on input line 9 +9. +(/usr/share/texmf/tex/latex/tex-gyre/ts1qtm.fd +File: ts1qtm.fd 2009/09/25 v1.2 font definition file for TS1/qtm ) -LaTeX Font Info: Try loading font information for T1+pcr on input line 153. +LaTeX Font Info: Trying to load font information for T1+txtt on input line 1 +43. -(/usr/local/texlive/2012/texmf-dist/tex/latex/psnfss/t1pcr.fd -File: t1pcr.fd 2001/06/04 font definitions for T1/pcr. +(/usr/share/texlive/texmf-dist/tex/latex/txfonts/t1txtt.fd +File: t1txtt.fd 2000/12/15 v3.1 ) -Underfull \hbox (badness 10000) in paragraph at lines 160--161 -\T1/ptm/m/n/10 rHEALPixDGGS is avail-able for down-load at Land-care Re-search' -s git repos-i-tory - [] - -LaTeX Font Info: Font shape `T1/phv/bx/n' in size <12> not available -(Font) Font shape `T1/phv/b/n' tried instead on input line 174. -LaTeX Font Info: Font shape `T1/pcr/bx/n' in size <12> not available -(Font) Font shape `T1/pcr/b/n' tried instead on input line 174. - -Package Fancyhdr Warning: \fancyfoot's `E' option without twoside option is use -less on input line 179. - -[1 +LaTeX Font Info: Font shape `T1/txtt/b/n' in size <12> not available +(Font) Font shape `T1/txtt/bx/n' tried instead on input line 143. + [1 ] -LaTeX Font Info: Font shape `T1/pcr/bx/n' in size <9> not available -(Font) Font shape `T1/pcr/b/n' tried instead on input line 189. - [2] [3] [4] -LaTeX Font Info: Font shape `T1/pcr/m/it' in size <9> not available -(Font) Font shape `T1/pcr/m/sl' tried instead on input line 447. - [5] [6] -Chapter 2. -LaTeX Font Info: Font shape `T1/pcr/bx/n' in size <10> not available -(Font) Font shape `T1/pcr/b/n' tried instead on input line 537. - -Package Fancyhdr Warning: \fancyfoot's `E' option without twoside option is use -less on input line 599. +LaTeX Font Info: Font shape `T1/txtt/b/n' in size <10> not available +(Font) Font shape `T1/txtt/bx/n' tried instead on input line 162. + [2] +LaTeX Font Info: Trying to load font information for TS1+txtt on input line +254. + +(/usr/share/texlive/texmf-dist/tex/latex/txfonts/ts1txtt.fd +File: ts1txtt.fd 2000/12/15 v3.1 +) [3] +Underfull \vbox (badness 2698) detected at line 362 + [] +[4] [5] +LaTeX Font Info: Font shape `T1/txtt/m/it' in size <10> not available +(Font) Font shape `T1/txtt/m/sl' tried instead on input line 436. + [6] +Chapter 2. [7 -] [8] -Chapter 3. - -Package Fancyhdr Warning: \fancyfoot's `E' option without twoside option is use -less on input line 755. - -[9 - -] [10] [11] -Chapter 4. - -Package Fancyhdr Warning: \fancyfoot's `E' option without twoside option is use -less on input line 979. - -[12 - ] -Underfull \hbox (badness 10000) in paragraph at lines 1018--1018 -[]\T1/ptm/m/it/10 a=1\T1/ptm/m/n/10 , \T1/ptm/m/it/10 e=0\T1/ptm/m/n/10 , \T1/p -tm/m/it/10 north_square=0\T1/ptm/m/n/10 , +Underfull \hbox (badness 10000) in paragraph at lines 577--587 +\T1/qtm/m/n/10 (0.25, 0.98939325967009495) * (0.111111111111111, 0.997935147429 +94305) * [] -Underfull \hbox (badness 10000) in paragraph at lines 1018--1018 -\T1/ptm/m/it/10 south_square=0\T1/ptm/m/n/10 , +Underfull \hbox (badness 10000) in paragraph at lines 577--587 +\T1/qtm/m/n/10 (0.0625, 0.99934823645582505) * (0.04, 0.99973321235361001) * (0 +.027777777777778, [] -Underfull \hbox (badness 10000) in paragraph at lines 1030--1030 -[]\T1/ptm/m/it/10 lam\T1/ptm/m/n/10 , \T1/ptm/m/it/10 phi\T1/ptm/m/n/10 , \T1/p -tm/m/it/10 e=0\T1/ptm/m/n/10 , \T1/ptm/m/it/10 north_square=0\T1/ptm/m/n/10 , +Underfull \hbox (badness 10000) in paragraph at lines 577--587 +\T1/qtm/m/n/10 0.99987137105187995) * (0.020408163265306, 0.99993057628561399) +* (0.015625, [] -[13] -Underfull \hbox (badness 10000) in paragraph at lines 1087--1087 -[]\T1/ptm/m/it/10 lam\T1/ptm/m/n/10 , \T1/ptm/m/it/10 phi\T1/ptm/m/n/10 , \T1/p -tm/m/it/10 north_square=0\T1/ptm/m/n/10 , - [] - -Underfull \hbox (badness 10000) in paragraph at lines 1133--1133 -[]\T1/ptm/m/it/10 x\T1/ptm/m/n/10 , \T1/ptm/m/it/10 y\T1/ptm/m/n/10 , \T1/ptm/m -/it/10 north_square=0\T1/ptm/m/n/10 , +Underfull \hbox (badness 10000) in paragraph at lines 577--587 +\T1/qtm/m/n/10 0.99995930708084702) * (0.012345679012346, 0.99997459627121099) +* (0.01, [] +[8] [9] +Chapter 3. +[10 -Underfull \hbox (badness 10000) in paragraph at lines 1161--1161 -[]\T1/ptm/m/it/10 x\T1/ptm/m/n/10 , \T1/ptm/m/it/10 y\T1/ptm/m/n/10 , \T1/ptm/m -/it/10 north_square=0\T1/ptm/m/n/10 , \T1/ptm/m/it/10 south_square=0\T1/ptm/m/n -/10 , \T1/ptm/m/it/10 in- - [] +] [11] [12] +Chapter 4. +[13 -[14] [15] +] [14] [15] [16] [17] Chapter 5. +[18 -Underfull \hbox (badness 10000) in paragraph at lines 1272--1272 -[]\T1/ptm/m/it/10 R=None\T1/ptm/m/n/10 , \T1/ptm/m/it/10 a=6378137.0\T1/ptm/m/n -/10 , \T1/ptm/m/it/10 b=None\T1/ptm/m/n/10 , \T1/ptm/m/it/10 e=None\T1/ptm/m/n/ -10 , - [] - +] [19] [20] +Chapter 6. +[21 -Package Fancyhdr Warning: \fancyfoot's `E' option without twoside option is use -less on input line 1343. +] [22] +Chapter 7. -[16 +Underfull \hbox (badness 10000) in paragraph at lines 1819--1821 +[]\T1/qtm/m/n/10 AR, 2013-01-14: Added in-ter-sects_meridian(), cell_latitudes( +), cells_from_meridian(), + [] -] [17] [18] -Chapter 6. +[23 -Overfull \hbox (7.05937pt too wide) in paragraph at lines 1479--1479 -[]\T1/ptm/m/it/10 ellipsoid=\T1/ptm/m/n/10 , \T1/ptm/m/it/10 proj=No -ne\T1/ptm/m/n/10 , +Underfull \hbox (badness 10000) in paragraph at lines 1988--2000 +\T1/qtm/m/n/10 (90.000000000000028, 58.470677829627355) * Q0 (14.99999999999999 +8, 26.438744923100096) [] -Package Fancyhdr Warning: \fancyfoot's `E' option without twoside option is use -less on input line 1526. +Underfull \hbox (badness 10000) in paragraph at lines 1988--2000 +\T1/qtm/m/n/10 Q1 (45.0, 26.438744923100096) Q2 (74.999999999999986, 26.4387449 +23100096) R0 + [] -[19 -] -Chapter 7. +Underfull \hbox (badness 10000) in paragraph at lines 1988--2000 +\T1/qtm/m/n/10 (105.00000000000001, 26.438744923100096) Q3 (14.999999999999998, + 3.560649871414923e- + [] -Underfull \hbox (badness 10000) in paragraph at lines 1545--1546 -[]\T1/ptm/m/n/10 AR, 2013-01-14: Added in-ter-sects_meridian(), cell_latitudes( -), cells_from_meridian(), +[25] [26] +Underfull \hbox (badness 10000) in paragraph at lines 2180--2189 +\T1/qtm/m/n/10 (-180.0, 74.35752898700072) (-157.50000000000003, 58.41366190347 +2082) * (- [] -Package Fancyhdr Warning: \fancyfoot's `E' option without twoside option is use -less on input line 1603. +Underfull \hbox (badness 10000) in paragraph at lines 2180--2189 +\T1/qtm/m/n/10 150.0, 41.810314895778603) * (-165.00000000000003, 41.8103148957 +78603) * (- + [] -[20 -] [21] -Underfull \hbox (badness 10000) in paragraph at lines 1698--1698 -[]\T1/ptm/m/it/10 rdggs=\T1/ptm/m/n/10 , \T1/ptm/m/it/10 suid=None\T1/ptm/m -/n/10 , \T1/ptm/m/it/10 level_order_index=None\T1/ptm/m/n/10 , +[27] [28] [29] [30] [31] [32] [33] +Underfull \hbox (badness 10000) in paragraph at lines 3024--3028 +\T1/qtm/m/n/10 (89.999999999999929, 74.39069094879062) * for both of the above + [] -[22] [23] [24] [25] [26] [27] [28] -Underfull \hbox (badness 10000) in paragraph at lines 2473--2473 -\T1/ptm/m/it/10 at 0x10354a8d0>\T1/ptm/m/n/10 , \T1/ptm/m/it/10 N_side=3\T1/ptm -/m/n/10 , \T1/ptm/m/it/10 north_square=0\T1/ptm/m/n/10 , +[34] [35] [36] +Underfull \hbox (badness 10000) in paragraph at lines 3372--3379 +\T1/qtm/m/n/10 -1.29836248989 -0.730836688113 -0.224577156195 0.224577156195 0. +730836688113 [] -[29] [30] [31] [32] [33] [34] [35] [36] +LaTeX Font Info: Font shape `TS1/txtt/b/n' in size <10> not available +(Font) Font shape `TS1/txtt/bx/n' tried instead on input line 1. +[37] [38] [39] [40] [41] [42] Chapter 8. +[43 -Package Fancyhdr Warning: \fancyfoot's `E' option without twoside option is use -less on input line 3248. - -[37 - -] [38] -Chapter 9. - -Package Fancyhdr Warning: \fancyfoot's `E' option without twoside option is use -less on input line 3327. - -[39 - -] - -Package Fancyhdr Warning: \fancyfoot's `E' option without twoside option is use -less on input line 3338. - -[40 - +] [44 -] - -Package Fancyhdr Warning: \fancyfoot's `E' option without twoside option is use -less on input line 3348. -[41 +] [45 ] (./rHEALPixDGGS.ind -Underfull \hbox (badness 10000) in paragraph at lines 16--17 -[]\T1/ptm/m/n/10 Cell.ellipsoidal_shape() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 20--21 +[]\T1/txtt/m/n/10 cell_area() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs.dggs +.RHEALPixDGGS [] -Underfull \hbox (badness 10000) in paragraph at lines 19--20 -[]\T1/ptm/m/n/10 Cell.intersects_meridian() (in mod-ule +Overfull \hbox (19.8258pt too wide) in paragraph at lines 21--23 +[]\T1/txtt/m/n/10 cell_from_point() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdgg +s.dggs.RHEALPixDGGS [] -Underfull \hbox (badness 10000) in paragraph at lines 20--21 -[]\T1/ptm/m/n/10 Cell.intersects_parallel() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 23--25 +[]\T1/txtt/m/n/10 cell_from_region() [] -Underfull \hbox (badness 10000) in paragraph at lines 33--34 -[]\T1/ptm/m/n/10 Cell.suid_from_index() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 23--25 +\T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs.dggs.RHEALPixDGGS [] -Underfull \hbox (badness 10000) in paragraph at lines 39--40 -[]\T1/ptm/m/n/10 cells0 (rhealpix_dggs.dggs.RHEALPixDGGS at- +Overfull \hbox (14.57582pt too wide) in paragraph at lines 25--27 +[]\T1/txtt/m/n/10 cell_latitudes() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs +.dggs.RHEALPixDGGS [] -Underfull \hbox (badness 10000) in paragraph at lines 40--41 -[]\T1/ptm/m/n/10 combine_triangles() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 27--28 +[]\T1/txtt/m/n/10 cell_width() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs.dgg +s.RHEALPixDGGS [] -Underfull \hbox (badness 10000) in paragraph at lines 50--51 -[]\T1/ptm/m/n/10 Ellipsoid.get_points() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 28--29 +[]\T1/txtt/m/n/10 cells0 \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs.dggs.RHEA +LPixDGGS at- [] -Underfull \hbox (badness 10000) in paragraph at lines 51--52 -[]\T1/ptm/m/n/10 Ellipsoid.graticule() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 29--31 +[]\T1/txtt/m/n/10 cells_from_meridian() [] -Underfull \hbox (badness 10000) in paragraph at lines 53--54 -[]\T1/ptm/m/n/10 Ellipsoid.meridian() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 29--31 +\T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs.dggs.RHEALPixDGGS [] -Underfull \hbox (badness 10000) in paragraph at lines 54--55 -[]\T1/ptm/m/n/10 Ellipsoid.parallel() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 31--33 +[]\T1/txtt/m/n/10 cells_from_parallel() [] -Underfull \hbox (badness 10000) in paragraph at lines 56--57 -[]\T1/ptm/m/n/10 Ellipsoid.random_point() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 31--33 +\T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs.dggs.RHEALPixDGGS [] -Underfull \hbox (badness 10000) in paragraph at lines 66--67 -[]\T1/ptm/m/n/10 healpix_diagram() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 33--35 +[]\T1/txtt/m/n/10 cells_from_region() [] -Underfull \hbox (badness 10000) in paragraph at lines 67--68 -[]\T1/ptm/m/n/10 healpix_ellipsoid() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 33--35 +\T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs.dggs.RHEALPixDGGS [] -Underfull \hbox (badness 10000) in paragraph at lines 68--69 -[]\T1/ptm/m/n/10 healpix_ellipsoid_inverse() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 37--39 +[]\T1/txtt/m/n/10 combine_triangles() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 in mod-ul +e [] -Underfull \hbox (badness 10000) in paragraph at lines 70--71 -[]\T1/ptm/m/n/10 healpix_sphere_inverse() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 39--41 +[]\T1/txtt/m/n/10 combine_triangles() [] -Underfull \hbox (badness 10000) in paragraph at lines 71--72 -[]\T1/ptm/m/n/10 healpix_vertices() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 39--41 +\T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs.dggs.RHEALPixDGGS [] -Underfull \hbox (badness 10000) in paragraph at lines 75--76 -[]\T1/ptm/m/n/10 in_healpix_image() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 46--47 +[]\T1/txtt/m/n/10 ellipsoidal_shape() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixd +ggs.dggs.Cell [] -Underfull \hbox (badness 10000) in paragraph at lines 76--77 -[]\T1/ptm/m/n/10 in_rhealpix_image() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 50--51 +[]\T1/txtt/m/n/10 get_points() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs.ell +ipsoids.Ellipsoid [] -Package Fancyhdr Warning: \fancyfoot's `E' option without twoside option is use -less on input line 83. +Underfull \hbox (badness 10000) in paragraph at lines 51--52 +[]\T1/txtt/m/n/10 graticule() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs.elli +psoids.Ellipsoid + [] -[42 +Underfull \hbox (badness 10000) in paragraph at lines 57--58 +[]\T1/txtt/m/n/10 healpix() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs.dggs.R +HEALPixDGGS + [] -] -Underfull \hbox (badness 10000) in paragraph at lines 96--97 -[]\T1/ptm/m/n/10 rhealpix_diagram() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 58--60 +[]\T1/txtt/m/n/10 healpix_ellipsoid() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 in mod-ul +e [] -Underfull \hbox (badness 10000) in paragraph at lines 97--98 -[]\T1/ptm/m/n/10 rhealpix_ellipsoid() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 60--62 +[]\T1/txtt/m/n/10 healpix_ellipsoid_inverse() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 i +n mod-ule [] -Underfull \hbox (badness 10000) in paragraph at lines 98--99 -[]\T1/ptm/m/n/10 rhealpix_ellipsoid_inverse() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 62--63 +[]\T1/txtt/m/n/10 healpix_sphere() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 in mod-ule [] -Underfull \hbox (badness 10000) in paragraph at lines 99--100 -[]\T1/ptm/m/n/10 rhealpix_sphere() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 63--65 +[]\T1/txtt/m/n/10 healpix_sphere_inverse() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 in m +od-ule [] -Underfull \hbox (badness 10000) in paragraph at lines 100--101 -[]\T1/ptm/m/n/10 rhealpix_sphere_inverse() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 65--66 +[]\T1/txtt/m/n/10 healpix_vertices() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 in mod-ule + [] -Underfull \hbox (badness 10000) in paragraph at lines 101--102 -[]\T1/ptm/m/n/10 rhealpix_vertices() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 69--71 +[]\T1/txtt/m/n/10 in_healpix_image() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 in mod-ule + [] -Underfull \hbox (badness 10000) in paragraph at lines 103--104 -[]\T1/ptm/m/n/10 RHEALPixDGGS.cell() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 71--73 +[]\T1/txtt/m/n/10 in_rhealpix_image() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 in mod-ul +e [] -Underfull \hbox (badness 10000) in paragraph at lines 104--105 -[]\T1/ptm/m/n/10 RHEALPixDGGS.cell_area() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 75--76 +[]\T1/txtt/m/n/10 intersects_meridian() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpi +xdggs.dggs.Cell [] -Underfull \hbox (badness 10000) in paragraph at lines 105--106 -[]\T1/ptm/m/n/10 RHEALPixDGGS.cell_from_point() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 76--77 +[]\T1/txtt/m/n/10 intersects_parallel() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpi +xdggs.dggs.Cell [] -Underfull \hbox (badness 10000) in paragraph at lines 106--107 -[]\T1/ptm/m/n/10 RHEALPixDGGS.cell_from_region() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 77--78 +[]\T1/txtt/m/n/10 interval() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs.dggs. +RHEALPixDGGS [] -Underfull \hbox (badness 10000) in paragraph at lines 107--108 -[]\T1/ptm/m/n/10 RHEALPixDGGS.cell_latitudes() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 85--86 +[]\T1/txtt/m/n/10 meridian() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs.ellip +soids.Ellipsoid [] -Underfull \hbox (badness 10000) in paragraph at lines 108--109 -[]\T1/ptm/m/n/10 RHEALPixDGGS.cell_width() (in mod-ule +Overfull \hbox (9.32584pt too wide) in paragraph at lines 86--87 +[]\T1/txtt/m/n/10 minimal_cover() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs. +dggs.RHEALPixDGGS [] +[46 -Underfull \hbox (badness 10000) in paragraph at lines 110--111 -[]\T1/ptm/m/n/10 RHEALPixDGGS.cells_from_parallel() (in mod-ule - [] -Underfull \hbox (badness 10000) in paragraph at lines 111--112 -[]\T1/ptm/m/n/10 RHEALPixDGGS.cells_from_region() (in mod-ule +] +Underfull \hbox (badness 10000) in paragraph at lines 101--102 +[]\T1/txtt/m/n/10 num_cells() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs.dggs +.RHEALPixDGGS [] -Underfull \hbox (badness 10000) in paragraph at lines 112--113 -[]\T1/ptm/m/n/10 RHEALPixDGGS.combine_triangles() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 110--111 +[]\T1/txtt/m/n/10 parallel() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs.ellip +soids.Ellipsoid [] -Underfull \hbox (badness 10000) in paragraph at lines 113--114 -[]\T1/ptm/m/n/10 RHEALPixDGGS.grid() (in mod-ule +Overfull \hbox (4.07585pt too wide) in paragraph at lines 119--120 +[]\T1/txtt/m/n/10 random_point() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs.d +ggs.RHEALPixDGGS [] -Underfull \hbox (badness 10000) in paragraph at lines 114--115 -[]\T1/ptm/m/n/10 RHEALPixDGGS.healpix() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 120--122 +[]\T1/txtt/m/n/10 random_point() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs.e +llipsoids.Ellipsoid [] -Underfull \hbox (badness 10000) in paragraph at lines 115--116 -[]\T1/ptm/m/n/10 RHEALPixDGGS.interval() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 123--124 +[]\T1/txtt/m/n/10 region_overlaps() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdgg +s.dggs.Cell [] -Underfull \hbox (badness 10000) in paragraph at lines 116--117 -[]\T1/ptm/m/n/10 RHEALPixDGGS.minimal_cover() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 125--126 +[]\T1/txtt/m/n/10 rhealpix() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs.dggs. +RHEALPixDGGS [] -Underfull \hbox (badness 10000) in paragraph at lines 117--118 -[]\T1/ptm/m/n/10 RHEALPixDGGS.num_cells() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 126--128 +[]\T1/txtt/m/n/10 rhealpix_ellipsoid() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 in mod-u +le [] -Underfull \hbox (badness 10000) in paragraph at lines 118--119 -[]\T1/ptm/m/n/10 RHEALPixDGGS.plot_cells() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 128--130 +[]\T1/txtt/m/n/10 rhealpix_ellipsoid_inverse() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 +in mod-ule [] -Underfull \hbox (badness 10000) in paragraph at lines 119--120 -[]\T1/ptm/m/n/10 RHEALPixDGGS.random_cell() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 130--131 +[]\T1/txtt/m/n/10 rhealpix_sphere() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 in mod-ule [] -Underfull \hbox (badness 10000) in paragraph at lines 120--121 -[]\T1/ptm/m/n/10 RHEALPixDGGS.random_point() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 131--133 +[]\T1/txtt/m/n/10 rhealpix_sphere_inverse() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 in +mod-ule [] -Underfull \hbox (badness 10000) in paragraph at lines 121--122 -[]\T1/ptm/m/n/10 RHEALPixDGGS.rhealpix() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 133--135 +[]\T1/txtt/m/n/10 rhealpix_vertices() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 in mod-ul +e [] -Underfull \hbox (badness 10000) in paragraph at lines 122--123 -[]\T1/ptm/m/n/10 RHEALPixDGGS.triangle() (in mod-ule +Underfull \hbox (badness 5832) in paragraph at lines 157--159 +[]\T1/txtt/m/n/10 suid_from_index() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdgg +s.dggs.Cell static [] -Underfull \hbox (badness 10000) in paragraph at lines 123--124 -[]\T1/ptm/m/n/10 RHEALPixDGGS.xyz() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 164--165 +[]\T1/txtt/m/n/10 triangle() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs.dggs. +RHEALPixDGGS [] -Underfull \hbox (badness 10000) in paragraph at lines 124--125 -[]\T1/ptm/m/n/10 RHEALPixDGGS.xyz_cube() (in mod-ule +Underfull \hbox (badness 10000) in paragraph at lines 185--186 +[]\T1/txtt/m/n/10 xyz_cube() \T1/qtm/m/n/10 (\T1/qtm/m/it/10 rhealpixdggs.dggs. +RHEALPixDGGS [] -[43]) -Package atveryend Info: Empty hook `BeforeClearDocument' on input line 3352. -Package atveryend Info: Empty hook `AfterLastShipout' on input line 3352. - (./rHEALPixDGGS.aux) -Package atveryend Info: Executing hook `AtVeryEndDocument' on input line 3352. -Package atveryend Info: Executing hook `AtEndAfterFileList' on input line 3352. - +[47]) (./rHEALPixDGGS.aux) Package rerunfilecheck Info: File `rHEALPixDGGS.out' has not changed. -(rerunfilecheck) Checksum: 6E3AA318B3002ED25202A4F02F6E1EB9;819. -Package atveryend Info: Empty hook `AtVeryVeryEnd' on input line 3352. +(rerunfilecheck) Checksum: 625DC041C1B0D52D08A2296C25EB0C2F;2309. ) Here is how much of TeX's memory you used: - 9153 strings out of 493488 - 130261 string characters out of 3141326 - 224067 words of memory out of 3000000 - 12110 multiletter control sequences out of 15000+200000 - 58810 words of font info for 70 fonts, out of 3000000 for 9000 - 958 hyphenation exceptions out of 8191 - 36i,12n,45p,468b,565s stack positions out of 5000i,500n,10000p,200000b,50000s -{/usr/local/texlive/2012/texmf-dist/fonts/enc/dvips/base/8r.enc} -Output written on rHEALPixDGGS.pdf (46 pages, 216938 bytes). + 16273 strings out of 480247 + 273513 string characters out of 5896151 + 653365 words of memory out of 5000000 + 33667 multiletter control sequences out of 15000+600000 + 524741 words of font info for 74 fonts, out of 8000000 for 9000 + 15 hyphenation exceptions out of 8191 + 70i,12n,76p,925b,782s stack positions out of 5000i,500n,10000p,200000b,80000s +{/usr/share/texmf/fonts/enc/dvips/tex-gyre/q-ec.enc}{/usr/share/texmf/fonts/e +nc/dvips/tex-gyre/q-ts1.enc} +Output written on rHEALPixDGGS.pdf (49 pages, 310061 bytes). PDF statistics: - 575 PDF objects out of 1000 (max. 8388607) - 512 compressed objects within 6 object streams - 162 named destinations out of 1000 (max. 500000) - 121 words of extra memory for PDF output out of 10000 (max. 10000000) + 605 PDF objects out of 1000 (max. 8388607) + 526 compressed objects within 6 object streams + 155 named destinations out of 1000 (max. 500000) + 149 words of extra memory for PDF output out of 10000 (max. 10000000) diff --git a/docs/build/latex/rHEALPixDGGS.out b/docs/build/latex/rHEALPixDGGS.out index f3af6be..4d47a4f 100644 --- a/docs/build/latex/rHEALPixDGGS.out +++ b/docs/build/latex/rHEALPixDGGS.out @@ -1,15 +1,16 @@ -\BOOKMARK [0][-]{chapter.1}{Introduction}{}% 1 -\BOOKMARK [1][-]{section.1.1}{Requirements}{chapter.1}% 2 -\BOOKMARK [1][-]{section.1.2}{Installation}{chapter.1}% 3 -\BOOKMARK [1][-]{section.1.3}{Usage}{chapter.1}% 4 -\BOOKMARK [0][-]{chapter.2}{The utils Module}{}% 5 -\BOOKMARK [0][-]{chapter.3}{The pj\137healpix Module}{}% 6 -\BOOKMARK [0][-]{chapter.4}{The pj\137rhealpix Module}{}% 7 -\BOOKMARK [0][-]{chapter.5}{The ellipsoids Module}{}% 8 -\BOOKMARK [0][-]{chapter.6}{The projection\137wrapper Module}{}% 9 -\BOOKMARK [0][-]{chapter.7}{The dggs Module}{}% 10 -\BOOKMARK [0][-]{chapter.8}{The distortion Module}{}% 11 -\BOOKMARK [0][-]{chapter.9}{Indices and tables}{}% 12 -\BOOKMARK [0][-]{chapter*.95}{Bibliography}{}% 13 -\BOOKMARK [0][-]{section*.98}{Python Module Index}{}% 14 -\BOOKMARK [0][-]{section*.99}{Index}{}% 15 +\BOOKMARK [0][-]{chapter.1}{\376\377\000I\000n\000t\000r\000o\000d\000u\000c\000t\000i\000o\000n}{}% 1 +\BOOKMARK [1][-]{section.1.1}{\376\377\000R\000e\000q\000u\000i\000r\000e\000m\000e\000n\000t\000s}{chapter.1}% 2 +\BOOKMARK [1][-]{section.1.2}{\376\377\000I\000n\000s\000t\000a\000l\000l\000a\000t\000i\000o\000n}{chapter.1}% 3 +\BOOKMARK [1][-]{section.1.3}{\376\377\000U\000s\000a\000g\000e}{chapter.1}% 4 +\BOOKMARK [2][-]{subsection.1.3.1}{\376\377\000U\000s\000i\000n\000g\000\040\000t\000h\000e\000\040\000e\000l\000l\000i\000p\000s\000o\000i\000d\000s\000\040\000a\000n\000d\000\040\000p\000r\000o\000j\000e\000c\000t\000i\000o\000n\000\137\000w\000r\000a\000p\000p\000e\000r\000\040\000M\000o\000d\000u\000l\000e\000s}{section.1.3}% 5 +\BOOKMARK [2][-]{subsection.1.3.2}{\376\377\000U\000s\000i\000n\000g\000\040\000t\000h\000e\000\040\000d\000g\000g\000s\000\040\000M\000o\000d\000u\000l\000e}{section.1.3}% 6 +\BOOKMARK [0][-]{chapter.2}{\376\377\000T\000h\000e\000\040\000u\000t\000i\000l\000s\000\040\000M\000o\000d\000u\000l\000e}{}% 7 +\BOOKMARK [0][-]{chapter.3}{\376\377\000T\000h\000e\000\040\000p\000j\000\137\000h\000e\000a\000l\000p\000i\000x\000\040\000M\000o\000d\000u\000l\000e}{}% 8 +\BOOKMARK [0][-]{chapter.4}{\376\377\000T\000h\000e\000\040\000p\000j\000\137\000r\000h\000e\000a\000l\000p\000i\000x\000\040\000M\000o\000d\000u\000l\000e}{}% 9 +\BOOKMARK [0][-]{chapter.5}{\376\377\000T\000h\000e\000\040\000e\000l\000l\000i\000p\000s\000o\000i\000d\000s\000\040\000M\000o\000d\000u\000l\000e}{}% 10 +\BOOKMARK [0][-]{chapter.6}{\376\377\000T\000h\000e\000\040\000p\000r\000o\000j\000e\000c\000t\000i\000o\000n\000\137\000w\000r\000a\000p\000p\000e\000r\000\040\000M\000o\000d\000u\000l\000e}{}% 11 +\BOOKMARK [0][-]{chapter.7}{\376\377\000T\000h\000e\000\040\000d\000g\000g\000s\000\040\000M\000o\000d\000u\000l\000e}{}% 12 +\BOOKMARK [0][-]{chapter.8}{\376\377\000I\000n\000d\000i\000c\000e\000s\000\040\000a\000n\000d\000\040\000t\000a\000b\000l\000e\000s}{}% 13 +\BOOKMARK [0][-]{chapter*.89}{\376\377\000B\000i\000b\000l\000i\000o\000g\000r\000a\000p\000h\000y}{}% 14 +\BOOKMARK [0][-]{section*.90}{\376\377\000P\000y\000t\000h\000o\000n\000\040\000M\000o\000d\000u\000l\000e\000\040\000I\000n\000d\000e\000x}{}% 15 +\BOOKMARK [0][-]{section*.91}{\376\377\000I\000n\000d\000e\000x}{}% 16 diff --git a/docs/build/latex/rHEALPixDGGS.pdf b/docs/build/latex/rHEALPixDGGS.pdf index 5aa04fe..13f467a 100644 Binary files a/docs/build/latex/rHEALPixDGGS.pdf and b/docs/build/latex/rHEALPixDGGS.pdf differ diff --git a/docs/build/latex/rHEALPixDGGS.tex b/docs/build/latex/rHEALPixDGGS.tex index dcb9caa..b815d8e 100644 --- a/docs/build/latex/rHEALPixDGGS.tex +++ b/docs/build/latex/rHEALPixDGGS.tex @@ -1,237 +1,211 @@ -% Generated by Sphinx. +%% Generated by Sphinx. \def\sphinxdocclass{report} -\documentclass[a4paper,12ptopenany,oneside]{sphinxmanual} +\documentclass[a4paper,12ptopenany,oneside,english]{sphinxmanual} +\ifdefined\pdfpxdimen + \let\sphinxpxdimen\pdfpxdimen\else\newdimen\sphinxpxdimen +\fi \sphinxpxdimen=.75bp\relax +\ifdefined\pdfimageresolution + \pdfimageresolution= \numexpr \dimexpr1in\relax/\sphinxpxdimen\relax +\fi +%% let collapsible pdf bookmarks panel have high depth per default +\PassOptionsToPackage{bookmarksdepth=5}{hyperref} + +\PassOptionsToPackage{warn}{textcomp} \usepackage[utf8]{inputenc} -\DeclareUnicodeCharacter{00A0}{\nobreakspace} +\ifdefined\DeclareUnicodeCharacter +% support both utf8 and utf8x syntaxes + \ifdefined\DeclareUnicodeCharacterAsOptional + \def\sphinxDUC#1{\DeclareUnicodeCharacter{"#1}} + \else + \let\sphinxDUC\DeclareUnicodeCharacter + \fi + \sphinxDUC{00A0}{\nobreakspace} + \sphinxDUC{2500}{\sphinxunichar{2500}} + \sphinxDUC{2502}{\sphinxunichar{2502}} + \sphinxDUC{2514}{\sphinxunichar{2514}} + \sphinxDUC{251C}{\sphinxunichar{251C}} + \sphinxDUC{2572}{\textbackslash} +\fi +\usepackage{cmap} \usepackage[T1]{fontenc} +\usepackage{amsmath,amssymb,amstext} \usepackage[english]{babel} -\usepackage{times} + + + +\usepackage{tgtermes} +\usepackage{tgheros} +\renewcommand{\ttdefault}{txtt} + + + \usepackage[Bjarne]{fncychap} -\usepackage{longtable} \usepackage{sphinx} -\usepackage{multirow} + +\fvset{fontsize=auto} +\usepackage{geometry} + + +% Include hyperref last. +\usepackage{hyperref} +% Fix anchor placement for figures with captions. +\usepackage{hypcap}% it must be loaded after hyperref. +% Set up styles of URL: it should be placed after hyperref. +\urlstyle{same} + + +\usepackage{sphinxmessages} +\setcounter{tocdepth}{1} + \title{rHEALPixDGGS Documentation} -\date{August 12, 2013} -\release{0.5.1} +\date{Dec 18, 2023} +\release{0.5.4} \author{Alexander Raichev} -\newcommand{\sphinxlogo}{} +\newcommand{\sphinxlogo}{\vbox{}} \renewcommand{\releasename}{Release} \makeindex +\begin{document} -\makeatletter -\def\PYG@reset{\let\PYG@it=\relax \let\PYG@bf=\relax% - \let\PYG@ul=\relax \let\PYG@tc=\relax% - \let\PYG@bc=\relax \let\PYG@ff=\relax} -\def\PYG@tok#1{\csname PYG@tok@#1\endcsname} -\def\PYG@toks#1+{\ifx\relax#1\empty\else% - \PYG@tok{#1}\expandafter\PYG@toks\fi} -\def\PYG@do#1{\PYG@bc{\PYG@tc{\PYG@ul{% - \PYG@it{\PYG@bf{\PYG@ff{#1}}}}}}} -\def\PYG#1#2{\PYG@reset\PYG@toks#1+\relax+\PYG@do{#2}} - -\expandafter\def\csname PYG@tok@bp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@sc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} -\expandafter\def\csname PYG@tok@kp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@c1\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}} -\expandafter\def\csname PYG@tok@sr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.14,0.33,0.53}{##1}}} -\expandafter\def\csname PYG@tok@kd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@nt\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.45}{##1}}} -\expandafter\def\csname PYG@tok@nv\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} -\expandafter\def\csname PYG@tok@vg\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} -\expandafter\def\csname PYG@tok@nd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.33,0.33,0.33}{##1}}} -\expandafter\def\csname PYG@tok@ne\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@nf\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.49}{##1}}} -\expandafter\def\csname PYG@tok@na\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} -\expandafter\def\csname PYG@tok@nb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@nc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}} -\expandafter\def\csname PYG@tok@nl\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.13,0.44}{##1}}} -\expandafter\def\csname PYG@tok@nn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}} -\expandafter\def\csname PYG@tok@no\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.38,0.68,0.84}{##1}}} -\expandafter\def\csname PYG@tok@ni\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.84,0.33,0.22}{##1}}} -\expandafter\def\csname PYG@tok@s1\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} -\expandafter\def\csname PYG@tok@gs\endcsname{\let\PYG@bf=\textbf} -\expandafter\def\csname PYG@tok@gr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{1.00,0.00,0.00}{##1}}} -\expandafter\def\csname PYG@tok@gp\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}} -\expandafter\def\csname PYG@tok@kc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@gu\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.50,0.00,0.50}{##1}}} -\expandafter\def\csname PYG@tok@gt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.27,0.87}{##1}}} -\expandafter\def\csname PYG@tok@kn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@sx\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}} -\expandafter\def\csname PYG@tok@cs\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}} -\expandafter\def\csname PYG@tok@cp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@cm\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}} -\expandafter\def\csname PYG@tok@kt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.56,0.13,0.00}{##1}}} -\expandafter\def\csname PYG@tok@kr\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@ge\endcsname{\let\PYG@it=\textit} -\expandafter\def\csname PYG@tok@gd\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.63,0.00,0.00}{##1}}} -\expandafter\def\csname PYG@tok@gi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.63,0.00}{##1}}} -\expandafter\def\csname PYG@tok@gh\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.50}{##1}}} -\expandafter\def\csname PYG@tok@go\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.20,0.20,0.20}{##1}}} -\expandafter\def\csname PYG@tok@err\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\fcolorbox[rgb]{1.00,0.00,0.00}{1,1,1}{\strut ##1}}} -\expandafter\def\csname PYG@tok@vc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} -\expandafter\def\csname PYG@tok@si\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.44,0.63,0.82}{##1}}} -\expandafter\def\csname PYG@tok@sh\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} -\expandafter\def\csname PYG@tok@w\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.73,0.73}{##1}}} -\expandafter\def\csname PYG@tok@sd\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} -\expandafter\def\csname PYG@tok@ow\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@sb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} -\expandafter\def\csname PYG@tok@s\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} -\expandafter\def\csname PYG@tok@s2\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} -\expandafter\def\csname PYG@tok@m\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} -\expandafter\def\csname PYG@tok@il\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} -\expandafter\def\csname PYG@tok@o\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.40,0.40,0.40}{##1}}} -\expandafter\def\csname PYG@tok@mo\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} -\expandafter\def\csname PYG@tok@k\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@mf\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} -\expandafter\def\csname PYG@tok@mi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} -\expandafter\def\csname PYG@tok@mh\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} -\expandafter\def\csname PYG@tok@ss\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.32,0.47,0.09}{##1}}} -\expandafter\def\csname PYG@tok@se\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} -\expandafter\def\csname PYG@tok@c\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}} -\expandafter\def\csname PYG@tok@vi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} - -\def\PYGZbs{\char`\\} -\def\PYGZus{\char`\_} -\def\PYGZob{\char`\{} -\def\PYGZcb{\char`\}} -\def\PYGZca{\char`\^} -\def\PYGZam{\char`\&} -\def\PYGZlt{\char`\<} -\def\PYGZgt{\char`\>} -\def\PYGZsh{\char`\#} -\def\PYGZpc{\char`\%} -\def\PYGZdl{\char`\$} -\def\PYGZhy{\char`\-} -\def\PYGZsq{\char`\'} -\def\PYGZdq{\char`\"} -\def\PYGZti{\char`\~} -% for compatibility with earlier versions -\def\PYGZat{@} -\def\PYGZlb{[} -\def\PYGZrb{]} -\makeatother +\ifdefined\shorthandoff + \ifnum\catcode`\=\string=\active\shorthandoff{=}\fi + \ifnum\catcode`\"=\active\shorthandoff{"}\fi +\fi -\begin{document} +\pagestyle{empty} +\sphinxmaketitle +\pagestyle{plain} +\sphinxtableofcontents +\pagestyle{normal} +\phantomsection\label{\detokenize{index::doc}} -\maketitle -\tableofcontents -\phantomsection\label{index::doc} +\sphinxstepscope \chapter{Introduction} -\label{introduction::doc}\label{introduction:welcome-the-rhealpixdggs-documentation}\label{introduction:introduction} -rHEALPixDGGS is a Python 3.3 package that implements the rHEALPix discrete global grid system (DGGS). -This documentation assumes you are familiar with the rHEALPix DGGS as described in {\hyperref[introduction:grs2013]{{[}GRS2013{]}}} and familiar with basic Python 3.3 usage as described in \href{http://docs.python.org/3/tutorial/}{The Python Tutorial}. +\label{\detokenize{introduction:introduction}}\label{\detokenize{introduction::doc}} +\sphinxAtStartPar +rHEALPixDGGS is a Python 3 package that implements the rHEALPix discrete global grid system (DGGS). +This documentation assumes you are familiar with the rHEALPix DGGS as described in \sphinxcite{introduction:grs2013} and familiar with basic Python 3.3 usage as described in \sphinxhref{http://docs.python.org/3/tutorial/}{The Python Tutorial}. \section{Requirements} -\label{introduction:requirements}\begin{itemize} +\label{\detokenize{introduction:requirements}}\begin{itemize} \item {} -\href{http://python.org/}{Python \textgreater{}=3.3} +\sphinxAtStartPar +\sphinxhref{http://python.org/}{Python \textgreater{}=3.11} \item {} -\href{http://www.numpy.org/}{NumPy \textgreater{}=1.7} Base N-dimensional array package +\sphinxAtStartPar +\sphinxhref{http://www.numpy.org/}{NumPy \textgreater{}=1.25.2} Base N\sphinxhyphen{}dimensional array package \item {} -\href{http://www.scipy.org/}{SciPy \textgreater{}=0.12} Fundamental library for scientific computing +\sphinxAtStartPar +\sphinxhref{http://www.scipy.org/}{SciPy \textgreater{}=1.11.2} Fundamental library for scientific computing \item {} -\href{http://matplotlib.org/}{Matplotlib \textgreater{}=1.2.1} Comprehensive 2D Plotting +\sphinxAtStartPar +\sphinxhref{http://matplotlib.org/}{Matplotlib \textgreater{}=3.7.2} Comprehensive 2D Plotting \item {} -\href{http://code.google.com/p/pyproj/}{Pyproj \textgreater{}=1.9.3} +\sphinxAtStartPar +\sphinxhref{http://code.google.com/p/pyproj/}{Pyproj \textgreater{}=3.6} Python interface to the PROJ.4 cartographic library -\item {} -\href{http://www.sagemath.org}{Sage \textgreater{}=5.10} -(Optional) Comprehensive mathematics package. -Needed only for a few optional graphics methods. -To use the optional graphics methods, start a Sage notebook session and import/attach the Python module that contains the methods. -For examples, see the Sage worksheet \code{rhealpix\_dggs/tests/test\_dggs.sws}. - \end{itemize} \section{Installation} -\label{introduction:installation} -rHEALPixDGGS is available for download at Landcare Research's git repository \href{http://code.scenzgrid.org/index.php/p/scenzgrid-py/source/tree/master/rHEALPixDGGS-0.5}{http://code.scenzgrid.org/index.php/p/scenzgrid-py/source/tree/master/rHEALPixDGGS-0.5} and can be cloned via the command \code{git clone git@code.scenzgrid.org:scenzgrid-py.git}. +\label{\detokenize{introduction:installation}} +\sphinxAtStartPar +The package is available on PyPI, the Package Index from where it can be installed as follows: -To install Sage, download and install the appropriate binary file from \href{http://www.sagemath.org}{sagemath.org}. -Then install Pyproj within Sage by downloading the Pyproj source, changing to the Pyproj directory, starting a Sage shell via \code{sage -sh}, then typing \code{python setup.py build}, then \code{python setup.py install}. -If that doesn't work, try again but first start in superuser mode via \code{sudo su}. +\sphinxAtStartPar +pip install rhealpixdggs + +\sphinxAtStartPar +rHEALPixDGGS is also available for download from Landcare Research’s github repository \sphinxurl{https://github.com/manaakiwhenua/rhealpixdggs-py} from wher the latest version can be cloned. \section{Usage} -\label{introduction:usage} +\label{\detokenize{introduction:usage}} +\sphinxAtStartPar To use rHEALPixDGGS after installing it, start a Python session in the directory where you downloaded the modules and import the modules. Here are some examples. For a list of all methods available, see the application programming interface (API) in the following chapters. -\subsection{Using the \texttt{ellipsoids} and \texttt{projection\_wrapper} Modules} -\label{introduction:using-the-ellipsoids-and-projection-wrapper-modules} -The \code{ellipsoids} module implements functions and constants dealing with ellipsoids of revolution (which include spheres but not general triaxial ellipsoids). -For brevity hereafter, the word `ellipsoid' abbreviates `ellipsoid of revolution'. +\subsection{Using the \sphinxstyleliteralintitle{\sphinxupquote{ellipsoids}} and \sphinxstyleliteralintitle{\sphinxupquote{projection\_wrapper}} Modules} +\label{\detokenize{introduction:using-the-ellipsoids-and-projection-wrapper-modules}} +\sphinxAtStartPar +The \sphinxcode{\sphinxupquote{ellipsoids}} module implements functions and constants dealing with ellipsoids of revolution (which include spheres but not general triaxial ellipsoids). +For brevity hereafter, the word ‘ellipsoid’ abbreviates ‘ellipsoid of revolution’. -The module \code{projection\_wrapper} implements a wrapper for the map projections of ellipsoids defined in \code{pj\_healpix}, \code{pj\_rhealpix}, and Pyproj. +\sphinxAtStartPar +The module \sphinxcode{\sphinxupquote{projection\_wrapper}} implements a wrapper for the map projections of ellipsoids defined in \sphinxcode{\sphinxupquote{pj\_healpix}}, \sphinxcode{\sphinxupquote{pj\_rhealpix}}, and Pyproj. -Currently \code{projection\_wrapper} uses the HEALPix and rHEALPix projections -defined in \code{pj\_healpix} and \code{pj\_rhealpix} and \emph{not} the buggy versions defined in Pyproj 1.9.3 as \code{PJ\_healpix.c}. -Alternatively, you can download a corrected version of \code{PJ\_healpix.c} from -\href{http://trac.osgeo.org/proj/changeset/2378}{trac.osgeo.org/proj/changeset/2378}, rebuild Pyproj with it, and use it in \code{dggs} by editing the \code{HOMEMADE\_PROJECTIONS} line in \code{projection\_wrapper}. +\sphinxAtStartPar +Currently \sphinxcode{\sphinxupquote{projection\_wrapper}} uses the HEALPix and rHEALPix projections +defined in \sphinxcode{\sphinxupquote{pj\_healpix}} and \sphinxcode{\sphinxupquote{pj\_rhealpix}} and \sphinxstyleemphasis{not} the buggy versions defined in Pyproj 1.9.3 as \sphinxcode{\sphinxupquote{PJ\_healpix.c}}. +Alternatively, you can download a corrected version of \sphinxcode{\sphinxupquote{PJ\_healpix.c}} from +\sphinxhref{http://trac.osgeo.org/proj/changeset/2378}{trac.osgeo.org/proj/changeset/2378}, rebuild Pyproj with it, and use it in \sphinxcode{\sphinxupquote{dggs}} by editing the \sphinxcode{\sphinxupquote{HOMEMADE\_PROJECTIONS}} line in \sphinxcode{\sphinxupquote{projection\_wrapper}}. +\sphinxAtStartPar Import all the classes, methods, and constants from the module: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.projection\PYGZus{}wrapper} \PYG{k+kn}{import} \PYG{o}{*} -\end{Verbatim} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpixdggs}\PYG{n+nn}{.}\PYG{n+nn}{projection\PYGZus{}wrapper} \PYG{k+kn}{import} \PYG{o}{*} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpixdggs}\PYG{n+nn}{.}\PYG{n+nn}{ellipsoids} \PYG{k+kn}{import} \PYG{o}{*} +\end{sphinxVerbatim} +\sphinxAtStartPar Create an ellipsoid, say, one with major radius 5 and eccentricity 0.8: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.ellipsoids} \PYG{k+kn}{import} \PYG{o}{*} +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{ellps\PYGZus{}1} \PYG{o}{=} \PYG{n}{Ellipsoid}\PYG{p}{(}\PYG{n}{a}\PYG{o}{=}\PYG{l+m+mi}{5}\PYG{p}{,} \PYG{n}{e}\PYG{o}{=}\PYG{l+m+mf}{0.8}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{ellps\PYGZus{}1}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{ellps\PYGZus{}1}\PYG{p}{)} \PYG{g+go}{ellipsoid:} -\PYG{g+go}{ R\PYGZus{}A = 4.32200117119} +\PYG{g+go}{ R\PYGZus{}A = 4.322001171188888} \PYG{g+go}{ a = 5} -\PYG{g+go}{ b = 3.0} +\PYG{g+go}{ b = 2.999999999999999} \PYG{g+go}{ e = 0.8} \PYG{g+go}{ f = 0.4} \PYG{g+go}{ lat\PYGZus{}0 = 0} \PYG{g+go}{ lon\PYGZus{}0 = 0} \PYG{g+go}{ radians = False} \PYG{g+go}{ sphere = False} -\end{Verbatim} +\end{sphinxVerbatim} -The names of the ellipsoid attributes agree with the names of the \href{http://trac.osgeo.org/proj/wiki/GenParms}{PROJ.4 ellipsoid parameters}. -For example, \code{R\_A} is the authalic radius of the ellipsoid, the radius of the sphere that has the same area as the ellipsoid. +\sphinxAtStartPar +The names of the ellipsoid attributes agree with the names of the \sphinxhref{http://trac.osgeo.org/proj/wiki/GenParms}{PROJ.4 ellipsoid parameters}. +For example, \sphinxcode{\sphinxupquote{R\_A}} is the authalic radius of the ellipsoid, the radius of the sphere that has the same area as the ellipsoid. +\sphinxAtStartPar By default, angles are measured in degrees. If you prefer radians, then do: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{ellps\PYGZus{}2} \PYG{o}{=} \PYG{n}{Ellipsoid}\PYG{p}{(}\PYG{n}{a}\PYG{o}{=}\PYG{l+m+mi}{5}\PYG{p}{,} \PYG{n}{e}\PYG{o}{=}\PYG{l+m+mf}{0.8}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{ellps\PYGZus{}2}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{ellps\PYGZus{}2} \PYG{o}{=} \PYG{n}{Ellipsoid}\PYG{p}{(}\PYG{n}{a}\PYG{o}{=}\PYG{l+m+mi}{5}\PYG{p}{,} \PYG{n}{e}\PYG{o}{=}\PYG{l+m+mf}{0.8}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{ellps\PYGZus{}2}\PYG{p}{)} \PYG{g+go}{ellipsoid:} -\PYG{g+go}{ R\PYGZus{}A = 4.32200117119} +\PYG{g+go}{ R\PYGZus{}A = 4.322001171188888} \PYG{g+go}{ a = 5} -\PYG{g+go}{ b = 3.0} +\PYG{g+go}{ b = 2.999999999999999} \PYG{g+go}{ e = 0.8} \PYG{g+go}{ f = 0.4} \PYG{g+go}{ lat\PYGZus{}0 = 0} \PYG{g+go}{ lon\PYGZus{}0 = 0} \PYG{g+go}{ radians = True} \PYG{g+go}{ sphere = False} -\end{Verbatim} +\end{sphinxVerbatim} +\sphinxAtStartPar Some common ellipsoids are predefined as constants. -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{UNIT\PYGZus{}SPHERE}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{UNIT\PYGZus{}SPHERE}\PYG{p}{)} \PYG{g+go}{ellipsoid:} \PYG{g+go}{ R = 1} \PYG{g+go}{ R\PYGZus{}A = 1} @@ -243,65 +217,71 @@ \subsection{Using the \texttt{ellipsoids} and \texttt{projection\_wrapper} Modul \PYG{g+go}{ lon\PYGZus{}0 = 0} \PYG{g+go}{ radians = False} \PYG{g+go}{ sphere = True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{WGS84\PYGZus{}ELLIPSOID}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{WGS84\PYGZus{}ELLIPSOID}\PYG{p}{)} \PYG{g+go}{ellipsoid:} -\PYG{g+go}{ R\PYGZus{}A = 6374581.4671} +\PYG{g+go}{ R\PYGZus{}A = 6374581.467096525} \PYG{g+go}{ a = 6378137.0} \PYG{g+go}{ b = 6356752.314140356} -\PYG{g+go}{ e = 0.0578063088401} +\PYG{g+go}{ e = 0.057806308840112} \PYG{g+go}{ f = 0.003352810681182} \PYG{g+go}{ lat\PYGZus{}0 = 0} \PYG{g+go}{ lon\PYGZus{}0 = 0} \PYG{g+go}{ radians = False} \PYG{g+go}{ sphere = False} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{WGS84\PYGZus{}ELLIPSOID\PYGZus{}RADIANS}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{WGS84\PYGZus{}ELLIPSOID\PYGZus{}RADIANS}\PYG{p}{)} \PYG{g+go}{ellipsoid:} -\PYG{g+go}{ R\PYGZus{}A = 6374581.4671} +\PYG{g+go}{ R\PYGZus{}A = 6374581.467096525} \PYG{g+go}{ a = 6378137.0} \PYG{g+go}{ b = 6356752.314140356} -\PYG{g+go}{ e = 0.0578063088401} +\PYG{g+go}{ e = 0.057806308840112} \PYG{g+go}{ f = 0.003352810681182} \PYG{g+go}{ lat\PYGZus{}0 = 0} \PYG{g+go}{ lon\PYGZus{}0 = 0} \PYG{g+go}{ radians = True} \PYG{g+go}{ sphere = False} -\end{Verbatim} +\end{sphinxVerbatim} -Ellipsoid instances are parametrized by geographic longitude and latitude with the central meridian at \code{lon\_0} and the parallel of origin at \code{lat\_0}. +\sphinxAtStartPar +Ellipsoid instances are parametrized by geographic longitude and latitude with the central meridian at \sphinxcode{\sphinxupquote{lon\_0}} and the parallel of origin at \sphinxcode{\sphinxupquote{lat\_0}}. +\sphinxAtStartPar Project some points of the ellipsoid using the HEALPix and rHEALPix projections: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{h} \PYG{o}{=} \PYG{n}{Proj}\PYG{p}{(}\PYG{n}{ellps\PYGZus{}1}\PYG{p}{,} \PYG{l+s}{\PYGZsq{}}\PYG{l+s}{healpix}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rh} \PYG{o}{=} \PYG{n}{Proj}\PYG{p}{(}\PYG{n}{ellps\PYGZus{}1}\PYG{p}{,} \PYG{l+s}{\PYGZsq{}}\PYG{l+s}{rhealpix}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{n}{north\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{south\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{2}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{h}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{60}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.0, 3.351278550178026)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rh}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{60}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.0, 3.351278550178026)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{h}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{70}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.864006732389895, 4.2584985144432679)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rh}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{70}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}0.86400673238989445, 4.2584985144432679)} -\end{Verbatim} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{numpy}\PYG{n+nn}{.}\PYG{n+nn}{testing} \PYG{k+kn}{import} \PYG{n}{assert\PYGZus{}allclose} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{h} \PYG{o}{=} \PYG{n}{Projection}\PYG{p}{(}\PYG{n}{ellps\PYGZus{}1}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{healpix}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rh} \PYG{o}{=} \PYG{n}{Projection}\PYG{p}{(}\PYG{n}{ellps\PYGZus{}1}\PYG{p}{,} \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{rhealpix}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{n}{north\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{south\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{2}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{assert\PYGZus{}allclose}\PYG{p}{(}\PYG{n}{h}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{60}\PYG{p}{)}\PYG{p}{,} \PYG{p}{(}\PYG{l+m+mf}{0.0}\PYG{p}{,} \PYG{l+m+mf}{3.35127855017803}\PYG{p}{)}\PYG{p}{,} \PYG{n}{rtol}\PYG{o}{=}\PYG{l+m+mf}{1e\PYGZhy{}14}\PYG{p}{,} \PYG{n}{atol}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{)} \PYG{o}{==} \PYG{k+kc}{None} +\PYG{g+go}{True} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{assert\PYGZus{}allclose}\PYG{p}{(}\PYG{n}{rh}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{60}\PYG{p}{)}\PYG{p}{,} \PYG{p}{(}\PYG{l+m+mf}{0.0}\PYG{p}{,} \PYG{l+m+mf}{3.35127855017803}\PYG{p}{)}\PYG{p}{,} \PYG{n}{rtol}\PYG{o}{=}\PYG{l+m+mf}{1e\PYGZhy{}14}\PYG{p}{,} \PYG{n}{atol}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{)} \PYG{o}{==} \PYG{k+kc}{None} +\PYG{g+go}{True} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{assert\PYGZus{}allclose}\PYG{p}{(}\PYG{n}{h}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{70}\PYG{p}{)}\PYG{p}{,} \PYG{p}{(}\PYG{l+m+mf}{0.864006732389895}\PYG{p}{,} \PYG{l+m+mf}{4.258498514443268}\PYG{p}{)}\PYG{p}{,} \PYG{n}{rtol}\PYG{o}{=}\PYG{l+m+mf}{1e\PYGZhy{}14}\PYG{p}{,} \PYG{n}{atol}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{)} \PYG{o}{==} \PYG{k+kc}{None} +\PYG{g+go}{True} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{assert\PYGZus{}allclose}\PYG{p}{(}\PYG{n}{rh}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{70}\PYG{p}{)}\PYG{p}{,} \PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mf}{0.864006732389895}\PYG{p}{,} \PYG{l+m+mf}{4.258498514443268}\PYG{p}{)}\PYG{p}{,} \PYG{n}{rtol}\PYG{o}{=}\PYG{l+m+mf}{1e\PYGZhy{}14}\PYG{p}{,} \PYG{n}{atol}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{)} \PYG{o}{==} \PYG{k+kc}{None} +\PYG{g+go}{True} +\end{sphinxVerbatim} -\subsection{Using the \texttt{dggs} Module} -\label{introduction:using-the-dggs-module} -The module \code{dggs} implements the rHEALPix DGGS and various operations thereupon. +\subsection{Using the \sphinxstyleliteralintitle{\sphinxupquote{dggs}} Module} +\label{\detokenize{introduction:using-the-dggs-module}} +\sphinxAtStartPar +The module \sphinxcode{\sphinxupquote{dggs}} implements the rHEALPix DGGS and various operations thereupon. +\sphinxAtStartPar Import all the classes, methods, and constants from the module -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.dggs} \PYG{k+kn}{import} \PYG{o}{*} -\end{Verbatim} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpixdggs}\PYG{n+nn}{.}\PYG{n+nn}{dggs} \PYG{k+kn}{import} \PYG{o}{*} +\end{sphinxVerbatim} -Create the (0, 0)-rHEALPix DGGS with N\_side=3 that is based upon the WGS84 ellipsoid: +\sphinxAtStartPar +Create the (0, 0)\sphinxhyphen{}rHEALPix DGGS with N\_side=3 that is based upon the WGS84 ellipsoid: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.ellipsoids} \PYG{k+kn}{import} \PYG{n}{WGS84\PYGZus{}ELLIPSOID} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpixdggs}\PYG{n+nn}{.}\PYG{n+nn}{ellipsoids} \PYG{k+kn}{import} \PYG{n}{WGS84\PYGZus{}ELLIPSOID} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}ELLIPSOID} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{n}{ellipsoid}\PYG{o}{=}\PYG{n}{E}\PYG{p}{,} \PYG{n}{north\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{south\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{N\PYGZus{}side}\PYG{o}{=}\PYG{l+m+mi}{3}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{)} \PYG{g+go}{rHEALPix DGGS:} \PYG{g+go}{ N\PYGZus{}side = 3} \PYG{g+go}{ north\PYGZus{}square = 0} @@ -309,21 +289,22 @@ \subsection{Using the \texttt{dggs} Module} \PYG{g+go}{ max\PYGZus{}areal\PYGZus{}resolution = 1} \PYG{g+go}{ max\PYGZus{}resolution = 15} \PYG{g+go}{ ellipsoid:} -\PYG{g+go}{ R\PYGZus{}A = 6374581.4671} +\PYG{g+go}{ R\PYGZus{}A = 6374581.467096525} \PYG{g+go}{ a = 6378137.0} \PYG{g+go}{ b = 6356752.314140356} -\PYG{g+go}{ e = 0.0578063088401} +\PYG{g+go}{ e = 0.0578063088401125} \PYG{g+go}{ f = 0.003352810681182319} \PYG{g+go}{ lat\PYGZus{}0 = 0} \PYG{g+go}{ lon\PYGZus{}0 = 0} \PYG{g+go}{ radians = False} \PYG{g+go}{ sphere = False} -\end{Verbatim} +\end{sphinxVerbatim} +\sphinxAtStartPar Some common rHEALPix DGGSs are predefined as constants: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{UNIT\PYGZus{}003}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{UNIT\PYGZus{}003}\PYG{p}{)} \PYG{g+go}{rHEALPix DGGS:} \PYG{g+go}{ N\PYGZus{}side = 3} \PYG{g+go}{ north\PYGZus{}square = 0} @@ -341,7 +322,7 @@ \subsection{Using the \texttt{dggs} Module} \PYG{g+go}{ lon\PYGZus{}0 = 0} \PYG{g+go}{ radians = False} \PYG{g+go}{ sphere = True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{WGS84\PYGZus{}003}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{WGS84\PYGZus{}003}\PYG{p}{)} \PYG{g+go}{rHEALPix DGGS:} \PYG{g+go}{ N\PYGZus{}side = 3} \PYG{g+go}{ north\PYGZus{}square = 0} @@ -349,16 +330,16 @@ \subsection{Using the \texttt{dggs} Module} \PYG{g+go}{ max\PYGZus{}areal\PYGZus{}resolution = 1} \PYG{g+go}{ max\PYGZus{}resolution = 15} \PYG{g+go}{ ellipsoid:} -\PYG{g+go}{ R\PYGZus{}A = 6374581.4671} +\PYG{g+go}{ R\PYGZus{}A = 6374581.467096525} \PYG{g+go}{ a = 6378137.0} \PYG{g+go}{ b = 6356752.314140356} -\PYG{g+go}{ e = 0.0578063088401} +\PYG{g+go}{ e = 0.0578063088401125} \PYG{g+go}{ f = 0.003352810681182319} \PYG{g+go}{ lat\PYGZus{}0 = 0} \PYG{g+go}{ lon\PYGZus{}0 = 0} \PYG{g+go}{ radians = False} \PYG{g+go}{ sphere = False} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{UNIT\PYGZus{}003\PYGZus{}RADIANS}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{UNIT\PYGZus{}003\PYGZus{}RADIANS}\PYG{p}{)} \PYG{g+go}{rHEALPix DGGS:} \PYG{g+go}{ N\PYGZus{}side = 3} \PYG{g+go}{ north\PYGZus{}square = 0} @@ -376,79 +357,101 @@ \subsection{Using the \texttt{dggs} Module} \PYG{g+go}{ lon\PYGZus{}0 = 0} \PYG{g+go}{ radians = True} \PYG{g+go}{ sphere = True} -\end{Verbatim} +\end{sphinxVerbatim} -Pick a (longitude-latitude) point on the ellipsoid and find the level 1 cell that contains it +\sphinxAtStartPar +Pick a (longitude\sphinxhyphen{}latitude) point on the ellipsoid and find the level 1 cell that contains it -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}from\PYGZus{}point}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{p}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{;} \PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}from\PYGZus{}point}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{p}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)}\PYG{p}{;} \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} \PYG{g+go}{Q0} -\end{Verbatim} +\end{sphinxVerbatim} +\sphinxAtStartPar Find the ellipsoidal (edge) neighbors of this cell -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} \PYG{o+ow}{in} \PYG{n+nb}{sorted}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{neighbors}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{o}{.}\PYG{n}{items}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} \PYG{o+ow}{in} \PYG{n+nb}{sorted}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{neighbors}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)}\PYG{o}{.}\PYG{n}{items}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)}\PYG{p}{:} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} \PYG{g+go}{east Q1} \PYG{g+go}{north N2} \PYG{g+go}{south Q3} \PYG{g+go}{west P2} -\end{Verbatim} +\end{sphinxVerbatim} +\sphinxAtStartPar Find the planar (edge) neighbors of this cell -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} \PYG{o+ow}{in} \PYG{n+nb}{sorted}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{neighbors}\PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{plane}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)}\PYG{o}{.}\PYG{n}{items}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} \PYG{o+ow}{in} \PYG{n+nb}{sorted}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{neighbors}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{plane}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}\PYG{o}{.}\PYG{n}{items}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)}\PYG{p}{:} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} \PYG{g+go}{down Q3} \PYG{g+go}{left P2} \PYG{g+go}{right Q1} \PYG{g+go}{up N2} -\end{Verbatim} +\end{sphinxVerbatim} -Find all the level 1 cells intersecting the longitude-latitude aligned ellipsoidal quadrangle with given northwest and southeast corners +\sphinxAtStartPar +Find all the level 1 cells intersecting the longitude\sphinxhyphen{}latitude aligned ellipsoidal quadrangle with given northwest and southeast corners -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{nw} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{45}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{se} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{90}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{cells} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}region}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{nw}\PYG{p}{,} \PYG{n}{se}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{cells} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}region}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{nw}\PYG{p}{,} \PYG{n}{se}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{row} \PYG{o+ow}{in} \PYG{n}{cells}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{]}\PYG{p}{)} \PYG{g+go}{[\PYGZsq{}N2\PYGZsq{}, \PYGZsq{}N1\PYGZsq{}, \PYGZsq{}N0\PYGZsq{}]} \PYG{g+go}{[\PYGZsq{}Q0\PYGZsq{}, \PYGZsq{}Q1\PYGZsq{}, \PYGZsq{}Q2\PYGZsq{}, \PYGZsq{}R0\PYGZsq{}]} \PYG{g+go}{[\PYGZsq{}Q3\PYGZsq{}, \PYGZsq{}Q4\PYGZsq{}, \PYGZsq{}Q5\PYGZsq{}, \PYGZsq{}R3\PYGZsq{}]} -\end{Verbatim} +\end{sphinxVerbatim} +\sphinxAtStartPar Compute the ellipsoidal shape and ellipsoidal nuclei of these cells -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{row} \PYG{o+ow}{in} \PYG{n}{cells}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{,} \PYG{n}{cell}\PYG{o}{.}\PYG{n}{ellipsoidal\PYGZus{}shape}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{n}{cell}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{N2 dart (5.0888874903416268e\PYGZhy{}14, 58.470677829627355)} -\PYG{g+go}{N1 skew\PYGZus{}quad (45.000000000000036, 58.470677829627355)} -\PYG{g+go}{N0 dart (89.999999999999957, 58.470677829627363)} -\PYG{g+go}{Q0 quad (14.999999999999998, 26.438744923100096)} -\PYG{g+go}{Q1 quad (45.0, 26.438744923100096)} -\PYG{g+go}{Q2 quad (74.999999999999986, 26.438744923100096)} -\PYG{g+go}{R0 quad (105.00000000000001, 26.438744923100096)} -\PYG{g+go}{Q3 quad (14.999999999999998, 3.560649871414923e\PYGZhy{}15)} -\PYG{g+go}{Q4 quad (45.0, 3.560649871414923e\PYGZhy{}15)} -\PYG{g+go}{Q5 quad (74.999999999999986, 3.560649871414923e\PYGZhy{}15)} -\PYG{g+go}{R3 quad (105.00000000000001, 3.560649871414923e\PYGZhy{}15)} -\end{Verbatim} - -Create the (0, 0)-rHEALPix DGGS with N\_side = 3 that is based on the WGS84 ellipsoid. +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{expected\PYGZus{}results} \PYG{o}{=} \PYG{p}{[} +\PYG{g+gp}{... } \PYG{p}{[} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{5.088887490341627e\PYGZhy{}14}\PYG{p}{,} \PYG{l+m+mf}{58.47067782962734}\PYG{p}{)}\PYG{p}{,} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{45.000000000000036}\PYG{p}{,} \PYG{l+m+mf}{58.47067782962734}\PYG{p}{)}\PYG{p}{,} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{89.99999999999996}\PYG{p}{,} \PYG{l+m+mf}{58.47067782962736}\PYG{p}{)} +\PYG{g+gp}{... } \PYG{p}{]}\PYG{p}{,} \PYG{p}{[} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{14.999999999999998}\PYG{p}{,} \PYG{l+m+mf}{26.438744923100096}\PYG{p}{)}\PYG{p}{,} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{45.0}\PYG{p}{,} \PYG{l+m+mf}{26.438744923100096}\PYG{p}{)}\PYG{p}{,} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{74.99999999999999}\PYG{p}{,} \PYG{l+m+mf}{26.438744923100096}\PYG{p}{)}\PYG{p}{,} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{105.00000000000001}\PYG{p}{,} \PYG{l+m+mf}{26.438744923100096}\PYG{p}{)} +\PYG{g+gp}{... } \PYG{p}{]}\PYG{p}{,} \PYG{p}{[} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{14.999999999999998}\PYG{p}{,} \PYG{l+m+mf}{3.560649871414923e\PYGZhy{}15}\PYG{p}{)}\PYG{p}{,} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{45.0}\PYG{p}{,} \PYG{l+m+mf}{3.560649871414923e\PYGZhy{}15}\PYG{p}{)}\PYG{p}{,} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{74.99999999999999}\PYG{p}{,} \PYG{l+m+mf}{3.560649871414923e\PYGZhy{}15}\PYG{p}{)}\PYG{p}{,} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{105.00000000000001}\PYG{p}{,} \PYG{l+m+mf}{3.560649871414923e\PYGZhy{}15}\PYG{p}{)} +\PYG{g+gp}{... } \PYG{p}{]}\PYG{p}{]} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{i}\PYG{p}{,} \PYG{n}{row} \PYG{o+ow}{in} \PYG{n+nb}{enumerate}\PYG{p}{(}\PYG{n}{cells}\PYG{p}{)}\PYG{p}{:} +\PYG{g+gp}{... } \PYG{k}{for} \PYG{n}{j}\PYG{p}{,} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n+nb}{enumerate}\PYG{p}{(}\PYG{n}{row}\PYG{p}{)}\PYG{p}{:} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{,} \PYG{n}{cell}\PYG{o}{.}\PYG{n}{ellipsoidal\PYGZus{}shape}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{n}{assert\PYGZus{}allclose}\PYG{p}{(}\PYG{n}{cell}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)}\PYG{p}{,} \PYG{n}{expected\PYGZus{}results}\PYG{p}{[}\PYG{n}{i}\PYG{p}{]}\PYG{p}{[}\PYG{n}{j}\PYG{p}{]}\PYG{p}{,} \PYG{n}{rtol}\PYG{o}{=}\PYG{l+m+mf}{1e\PYGZhy{}15}\PYG{p}{,} \PYG{n}{atol}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{)} \PYG{o}{==} \PYG{k+kc}{None}\PYG{p}{)} +\PYG{g+go}{N2 dart True} +\PYG{g+go}{N1 skew\PYGZus{}quad True} +\PYG{g+go}{N0 dart True} +\PYG{g+go}{Q0 quad True} +\PYG{g+go}{Q1 quad True} +\PYG{g+go}{Q2 quad True} +\PYG{g+go}{R0 quad True} +\PYG{g+go}{Q3 quad True} +\PYG{g+go}{Q4 quad True} +\PYG{g+go}{Q5 quad True} +\PYG{g+go}{R3 quad True} +\end{sphinxVerbatim} + +\sphinxAtStartPar +Create the (0, 0)\sphinxhyphen{}rHEALPix DGGS with N\_side = 3 that is based on the WGS84 ellipsoid. Orient the DGGS so that the planar origin (0, 0) is on Auckland, New Zealand: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{174}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{37}\PYG{p}{)} \PYG{c}{\PYGZsh{} Approximate Auckland lon\PYGZhy{}lat coordinates} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.projection\PYGZus{}wrapper} \PYG{k+kn}{import} \PYG{o}{*} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{Ellipsoid}\PYG{p}{(}\PYG{n}{a}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}A}\PYG{p}{,} \PYG{n}{f}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}F}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{,} \PYG{n}{lon\PYGZus{}0}\PYG{o}{=}\PYG{n}{p}\PYG{p}{[}\PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{,} \PYG{n}{lat\PYGZus{}0}\PYG{o}{=}\PYG{n}{p}\PYG{p}{[}\PYG{l+m+mi}{1}\PYG{p}{]}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{174}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{37}\PYG{p}{)} \PYG{c+c1}{\PYGZsh{} Approximate Auckland lon\PYGZhy{}lat coordinates} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpixdggs}\PYG{n+nn}{.}\PYG{n+nn}{projection\PYGZus{}wrapper} \PYG{k+kn}{import} \PYG{o}{*} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{Ellipsoid}\PYG{p}{(}\PYG{n}{a}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}A}\PYG{p}{,} \PYG{n}{f}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}F}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{,} \PYG{n}{lon\PYGZus{}0}\PYG{o}{=}\PYG{n}{p}\PYG{p}{[}\PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{,} \PYG{n}{lat\PYGZus{}0}\PYG{o}{=}\PYG{n}{p}\PYG{p}{[}\PYG{l+m+mi}{1}\PYG{p}{]}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{n}{E}\PYG{p}{,} \PYG{n}{N\PYGZus{}side}\PYG{o}{=}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{n}{north\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{south\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{)} \PYG{g+go}{rHEALPix DGGS:} \PYG{g+go}{ N\PYGZus{}side = 3} \PYG{g+go}{ north\PYGZus{}square = 0} @@ -456,397 +459,450 @@ \subsection{Using the \texttt{dggs} Module} \PYG{g+go}{ max\PYGZus{}areal\PYGZus{}resolution = 1} \PYG{g+go}{ max\PYGZus{}resolution = 15} \PYG{g+go}{ ellipsoid:} -\PYG{g+go}{ R\PYGZus{}A = 6374581.4671} +\PYG{g+go}{ R\PYGZus{}A = 6374581.467096525} \PYG{g+go}{ a = 6378137.0} \PYG{g+go}{ b = 6356752.314140356} -\PYG{g+go}{ e = 0.0578063088401} +\PYG{g+go}{ e = 0.0578063088401125} \PYG{g+go}{ f = 0.003352810681182319} \PYG{g+go}{ lat\PYGZus{}0 = \PYGZhy{}37} \PYG{g+go}{ lon\PYGZus{}0 = 174} \PYG{g+go}{ radians = False} \PYG{g+go}{ sphere = False} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}from\PYGZus{}point}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{p}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}from\PYGZus{}point}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{p}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{Q3} -\end{Verbatim} - - -\subsection{Using the \texttt{distortion} Module} -\label{introduction:using-the-distortion-module} -The module \code{distortion} computes distortions of map projections created via \code{projection\_wrapper} and was used to produce the tables in {\hyperref[introduction:grs2013]{{[}GRS2013{]}}}. -The module is not necessary for manipulating the rHEALPix DGGS. +\end{sphinxVerbatim} -Import all the classes, methods, and constants from the module: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.distortion} \PYG{k+kn}{import} \PYG{o}{*} -\end{Verbatim} - -Import the WGS84 ellipsoid, define the rHEALPix projection on the ellipsoid, and compute linear distortion and areal distortion for the projection at a given point: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.ellipsoids} \PYG{k+kn}{import} \PYG{n}{WGS84\PYGZus{}ELLIPSOID} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}ELLIPSOID} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.projection\PYGZus{}wrapper} \PYG{k+kn}{import} \PYG{n}{Proj} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{f} \PYG{o}{=} \PYG{n}{Proj}\PYG{p}{(}\PYG{n}{ellipsoid}\PYG{o}{=}\PYG{n}{E}\PYG{p}{,} \PYG{n}{proj}\PYG{o}{=}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{rhealpix}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{n}{north\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{south\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{30}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{distortion}\PYG{p}{(}\PYG{n}{f}\PYG{p}{,} \PYG{o}{*}\PYG{n}{p}\PYG{p}{)} \PYG{c}{\PYGZsh{} First entry of output is f(*p)) } -\PYG{g+go}{((0.0, 3748655.115049511), 6.976075406932126, 1.1295629192757011, 1.1780969079183845)} -\end{Verbatim} - -Sample 100 random points from the WGS84 ellipsoid and compute the sample minimum, sample maximum, sample median, sample mean, and sample standard deviation of the linear and area distortion functions of the rHEALPix projection of those points: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{sample} \PYG{o}{=} \PYG{p}{[}\PYG{n}{E}\PYG{o}{.}\PYG{n}{random\PYGZus{}point}\PYG{p}{(}\PYG{p}{)} \PYG{k}{for} \PYG{n}{i} \PYG{o+ow}{in} \PYG{n+nb}{range}\PYG{p}{(}\PYG{l+m+mi}{100}\PYG{p}{)}\PYG{p}{]} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{distortion\PYGZus{}stats}\PYG{p}{(}\PYG{n}{f}\PYG{p}{,} \PYG{n}{sample}\PYG{p}{)}\PYG{p}{[}\PYG{l+m+mi}{1}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{[[14.918, 13.82, 0.124, 48.086, 8.623], [1.345, 0.371, 1.002, 2.375, 1.163], [1.178, 0.0, 1.178, 1.178, 1.178]]} -\end{Verbatim} - -Do the same for 100 points chosen at random from an rHEALPix DGGS dart cell: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.dggs} \PYG{k+kn}{import} \PYG{o}{*} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{cell} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{sample} \PYG{o}{=} \PYG{p}{[}\PYG{n}{cell}\PYG{o}{.}\PYG{n}{random\PYGZus{}point}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} \PYG{k}{for} \PYG{n}{i} \PYG{o+ow}{in} \PYG{n+nb}{range}\PYG{p}{(}\PYG{l+m+mi}{100}\PYG{p}{)}\PYG{p}{]} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{distortion\PYGZus{}stats}\PYG{p}{(}\PYG{n}{f}\PYG{p}{,} \PYG{n}{sample}\PYG{p}{)}\PYG{p}{[}\PYG{l+m+mi}{1}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{[[38.907, 6.044, 28.189, 48.963, 38.701], [2.013, 0.226, 1.644, 2.415, 1.991], [1.178, 0.0, 1.178, 1.178, 1.178]]} -\end{Verbatim} +\sphinxstepscope \chapter{The utils Module} -\label{utils::doc}\label{utils:the-utils-module}\label{utils:module-rhealpix_dggs.utils}\index{rhealpix\_dggs.utils (module)} -This Python 3.3 module implements several helper functions for coding map projections. - -CHANGELOG: +\label{\detokenize{utils:module-rhealpixdggs.utils}}\label{\detokenize{utils:the-utils-module}}\label{\detokenize{utils::doc}}\index{module@\spxentry{module}!rhealpixdggs.utils@\spxentry{rhealpixdggs.utils}}\index{rhealpixdggs.utils@\spxentry{rhealpixdggs.utils}!module@\spxentry{module}} +\sphinxAtStartPar +This Python 3.11 module implements several helper functions for coding map projections. \begin{itemize} \item {} -Alexander Raichev (AR), 2012-01-26: Refactored code from release 0.3. - -\item {} -AR, 2013-07-23: Ported to Python 3.3. +\sphinxAtStartPar +Alexander Raichev (AR), 2012\sphinxhyphen{}01\sphinxhyphen{}26: Refactored code from release 0.3. \end{itemize} +\sphinxAtStartPar NOTE: -All lengths are measured in meters and all angles are measured in radians +\sphinxAtStartPar +All lengths are measured in meters and all angles are measured in radians unless indicated otherwise. -\index{auth\_lat() (in module rhealpix\_dggs.utils)} +\index{auth\_lat() (in module rhealpixdggs.utils)@\spxentry{auth\_lat()}\spxextra{in module rhealpixdggs.utils}} \begin{fulllineitems} -\phantomsection\label{utils:rhealpix_dggs.utils.auth_lat}\pysiglinewithargsret{\code{rhealpix\_dggs.utils.}\bfcode{auth\_lat}}{\emph{phi}, \emph{e}, \emph{inverse=False}, \emph{radians=False}}{} -Given a point of geographic latitude \emph{phi} on an ellipse of -eccentricity \emph{e}, return the authalic latitude of the point. -If \emph{inverse} =True, then compute its inverse approximately. +\phantomsection\label{\detokenize{utils:rhealpixdggs.utils.auth_lat}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.utils.}}\sphinxbfcode{\sphinxupquote{auth\_lat}}}{\emph{\DUrole{n}{phi}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{e}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{inverse}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{bool}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{False}}, \emph{\DUrole{n}{radians}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{bool}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{False}}}{{ $\rightarrow$ float}} +\pysigstopsignatures +\sphinxAtStartPar +Given a point of geographic latitude \sphinxtitleref{phi} on an ellipse of +eccentricity \sphinxtitleref{e}, return the authalic latitude of the point. +If \sphinxtitleref{inverse} =True, then compute its inverse approximately. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{beta} \PYG{o}{=} \PYG{n}{auth\PYGZus{}lat}\PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{l+m+mf}{0.5}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{beta}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{0.689518212435} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{auth\PYGZus{}lat}\PYG{p}{(}\PYG{n}{beta}\PYG{p}{,} \PYG{l+m+mf}{0.5}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{0.785126523581} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{beta} \PYG{o}{=} \PYG{n}{auth\PYGZus{}lat}\PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{l+m+mf}{0.5}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{beta}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{0.68951821243544} +\end{sphinxVerbatim} +\begin{description} +\sphinxlineitem{NOTES:: .. Issue \#1 was ..} +\sphinxAtStartPar +0.689518212435 + +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{auth\PYGZus{}lat}\PYG{p}{(}\PYG{n}{beta}\PYG{p}{,} \PYG{l+m+mf}{0.5}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{0.785126523581272} +\end{sphinxVerbatim} + +\sphinxlineitem{NOTES:: .. Issue \#1 was ..} +\sphinxAtStartPar +0.785126523581 + +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{0.785398163397448} -\end{Verbatim} +\end{sphinxVerbatim} + +\end{description} +\sphinxAtStartPar NOTES: +\sphinxAtStartPar The power series approximation used for the inverse is standard in cartography (PROJ.4 uses it, for instance) and accurate for small eccentricities. \end{fulllineitems} -\index{auth\_rad() (in module rhealpix\_dggs.utils)} +\index{auth\_rad() (in module rhealpixdggs.utils)@\spxentry{auth\_rad()}\spxextra{in module rhealpixdggs.utils}} \begin{fulllineitems} -\phantomsection\label{utils:rhealpix_dggs.utils.auth_rad}\pysiglinewithargsret{\code{rhealpix\_dggs.utils.}\bfcode{auth\_rad}}{\emph{a}, \emph{e}, \emph{inverse=False}}{} +\phantomsection\label{\detokenize{utils:rhealpixdggs.utils.auth_rad}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.utils.}}\sphinxbfcode{\sphinxupquote{auth\_rad}}}{\emph{\DUrole{n}{a}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{e}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{inverse}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{bool}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{False}}}{{ $\rightarrow$ float}} +\pysigstopsignatures +\sphinxAtStartPar Return the radius of the authalic sphere of the ellipsoid with major -radius \emph{a} and eccentricity \emph{e}. -If \emph{inverse} = True, then return the major radius of the ellipsoid -with authalic radius \emph{a} and eccentricity \emph{e}. +radius \sphinxtitleref{a} and eccentricity \sphinxtitleref{e}. +If \sphinxtitleref{inverse} = True, then return the major radius of the ellipsoid +with authalic radius \sphinxtitleref{a} and eccentricity \sphinxtitleref{e}. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{auth\PYGZus{}rad}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)} \PYG{g+go}{1} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{i} \PYG{o+ow}{in} \PYG{n+nb}{range}\PYG{p}{(}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{l+m+mi}{11}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{n}{e} \PYG{o}{=} \PYG{l+m+mf}{1.0}\PYG{o}{/}\PYG{n}{i}\PYG{o}{*}\PYG{o}{*}\PYG{l+m+mi}{2} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{p}{(}\PYG{n}{e}\PYG{p}{,} \PYG{n}{auth\PYGZus{}rad}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{l+m+mf}{1.0}\PYG{o}{/}\PYG{n}{i}\PYG{o}{*}\PYG{o}{*}\PYG{l+m+mi}{2}\PYG{p}{)}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.25, 0.98939325967009495)} -\PYG{g+go}{(0.111111111111111, 0.99793514742994305)} -\PYG{g+go}{(0.0625, 0.99934823645582505)} -\PYG{g+go}{(0.04, 0.99973321235361001)} -\PYG{g+go}{(0.027777777777778, 0.99987137105187995)} -\PYG{g+go}{(0.020408163265306, 0.99993057628561399)} -\PYG{g+go}{(0.015625, 0.99995930708084702)} -\PYG{g+go}{(0.012345679012346, 0.99997459627121099)} -\PYG{g+go}{(0.01, 0.99998333286108898)} -\end{Verbatim} +\PYG{g+gp}{... } \PYG{n}{e} \PYG{o}{=} \PYG{l+m+mf}{1.0}\PYG{o}{/}\PYG{n}{i}\PYG{o}{*}\PYG{o}{*}\PYG{l+m+mi}{2} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{p}{(}\PYG{n}{e}\PYG{p}{,} \PYG{n}{auth\PYGZus{}rad}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{l+m+mf}{1.0}\PYG{o}{/}\PYG{n}{i}\PYG{o}{*}\PYG{o}{*}\PYG{l+m+mi}{2}\PYG{p}{)}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(0.25, 0.989393259670095)} +\PYG{g+go}{(0.111111111111111, 0.997935147429943)} +\PYG{g+go}{(0.0625, 0.999348236455825)} +\PYG{g+go}{(0.04, 0.99973321235361)} +\PYG{g+go}{(0.027777777777778, 0.99987137105188)} +\PYG{g+go}{(0.020408163265306, 0.999930576285614)} +\PYG{g+go}{(0.015625, 0.999959307080847)} +\PYG{g+go}{(0.012345679012346, 0.999974596271211)} +\PYG{g+go}{(0.01, 0.999983332861089)} +\end{sphinxVerbatim} +\begin{description} +\sphinxlineitem{NOTES:: .. Issue \#1 was ..} +\sphinxAtStartPar +(0.25, 0.98939325967009495) * +(0.111111111111111, 0.99793514742994305) * +(0.0625, 0.99934823645582505) * +(0.04, 0.99973321235361001) * +(0.027777777777778, 0.99987137105187995) * +(0.020408163265306, 0.99993057628561399) * +(0.015625, 0.99995930708084702) * +(0.012345679012346, 0.99997459627121099) * +(0.01, 0.99998333286108898) * + +\end{description} \end{fulllineitems} -\index{my\_round() (in module rhealpix\_dggs.utils)} +\index{my\_round() (in module rhealpixdggs.utils)@\spxentry{my\_round()}\spxextra{in module rhealpixdggs.utils}} \begin{fulllineitems} -\phantomsection\label{utils:rhealpix_dggs.utils.my_round}\pysiglinewithargsret{\code{rhealpix\_dggs.utils.}\bfcode{my\_round}}{\emph{x}, \emph{digits=0}}{} +\phantomsection\label{\detokenize{utils:rhealpixdggs.utils.my_round}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.utils.}}\sphinxbfcode{\sphinxupquote{my\_round}}}{\emph{\DUrole{n}{x}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{Any}}, \emph{\DUrole{n}{digits}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{int}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}}{{ $\rightarrow$ Any}} +\pysigstopsignatures +\sphinxAtStartPar Round the floating point number or list/tuple of floating point -numbers to \code{digits} number of digits. -Calls Python's \code{round()} function. +numbers to \sphinxcode{\sphinxupquote{digits}} number of digits. +Calls Python’s \sphinxcode{\sphinxupquote{round()}} function. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{l+m+mf}{1.}\PYG{o}{/}\PYG{l+m+mi}{7}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{)}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{l+m+mf}{1.}\PYG{o}{/}\PYG{l+m+mi}{7}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{0.142857} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{p}{(}\PYG{l+m+mf}{1.}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{l+m+mf}{1.}\PYG{o}{/}\PYG{l+m+mi}{7}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{p}{(}\PYG{l+m+mf}{1.}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{l+m+mf}{1.}\PYG{o}{/}\PYG{l+m+mi}{7}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(0.333333, 0.142857)} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{wrap\_latitude() (in module rhealpix\_dggs.utils)} +\index{wrap\_latitude() (in module rhealpixdggs.utils)@\spxentry{wrap\_latitude()}\spxextra{in module rhealpixdggs.utils}} \begin{fulllineitems} -\phantomsection\label{utils:rhealpix_dggs.utils.wrap_latitude}\pysiglinewithargsret{\code{rhealpix\_dggs.utils.}\bfcode{wrap\_latitude}}{\emph{phi}, \emph{radians=False}}{} -Given a point p on the unit circle at angle \emph{phi} from the positive x-axis, -if p lies in the right half of the circle, then return its angle that lies -in the interval {[}-pi/2, pi/2{]}. -If p lies in the left half of the circle, then reflect it through the -origin, and return the angle of the reflected point that lies in the -interval {[}-pi/2, pi/2{]}. -If \emph{radians} = True, then \emph{phi} and the output are given in radians. +\phantomsection\label{\detokenize{utils:rhealpixdggs.utils.wrap_latitude}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.utils.}}\sphinxbfcode{\sphinxupquote{wrap\_latitude}}}{\emph{\DUrole{n}{phi}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{radians}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{bool}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{False}}}{{ $\rightarrow$ float}} +\pysigstopsignatures +\sphinxAtStartPar +Given a point p on the unit circle at angle \sphinxtitleref{phi} from the positive x\sphinxhyphen{}axis, +if p lies in the right half of the circle, then return its angle that lies +in the interval {[}\sphinxhyphen{}pi/2, pi/2{]}. +If p lies in the left half of the circle, then reflect it through the +origin, and return the angle of the reflected point that lies in the +interval {[}\sphinxhyphen{}pi/2, pi/2{]}. +If \sphinxtitleref{radians} = True, then \sphinxtitleref{phi} and the output are given in radians. Otherwise, they are given in degrees. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}latitude}\PYG{p}{(}\PYG{l+m+mi}{45}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}latitude}\PYG{p}{(}\PYG{l+m+mi}{45}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)} \PYG{g+go}{45.0} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}latitude}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{45}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}latitude}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{45}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)} \PYG{g+go}{\PYGZhy{}45.0} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}latitude}\PYG{p}{(}\PYG{l+m+mi}{90}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}latitude}\PYG{p}{(}\PYG{l+m+mi}{90}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)} \PYG{g+go}{90.0} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}latitude}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{90}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}latitude}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{90}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)} \PYG{g+go}{\PYGZhy{}90.0} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}latitude}\PYG{p}{(}\PYG{l+m+mi}{135}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}latitude}\PYG{p}{(}\PYG{l+m+mi}{135}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)} \PYG{g+go}{\PYGZhy{}45.0} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}latitude}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{135}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}latitude}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{135}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)} \PYG{g+go}{45.0} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{wrap\_longitude() (in module rhealpix\_dggs.utils)} +\index{wrap\_longitude() (in module rhealpixdggs.utils)@\spxentry{wrap\_longitude()}\spxextra{in module rhealpixdggs.utils}} \begin{fulllineitems} -\phantomsection\label{utils:rhealpix_dggs.utils.wrap_longitude}\pysiglinewithargsret{\code{rhealpix\_dggs.utils.}\bfcode{wrap\_longitude}}{\emph{lam}, \emph{radians=False}}{} -Given a point p on the unit circle at angle \emph{lam} from the positive -x-axis, return its angle theta in the range -pi \textless{}= theta \textless{} pi. -If \emph{radians} = True, then \emph{lam} and the output are given in radians. +\phantomsection\label{\detokenize{utils:rhealpixdggs.utils.wrap_longitude}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.utils.}}\sphinxbfcode{\sphinxupquote{wrap\_longitude}}}{\emph{\DUrole{n}{lam}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{radians}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{bool}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{False}}}{{ $\rightarrow$ float}} +\pysigstopsignatures +\sphinxAtStartPar +Given a point p on the unit circle at angle \sphinxtitleref{lam} from the positive +x\sphinxhyphen{}axis, return its angle theta in the range \sphinxhyphen{}pi \textless{}= theta \textless{} pi. +If \sphinxtitleref{radians} = True, then \sphinxtitleref{lam} and the output are given in radians. Otherwise, they are given in degrees. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}longitude}\PYG{p}{(}\PYG{l+m+mi}{2}\PYG{o}{*}\PYG{n}{pi} \PYG{o}{+} \PYG{n}{pi}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)} -\PYG{g+go}{\PYGZhy{}3.1415926535897931} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}longitude}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{185}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}longitude}\PYG{p}{(}\PYG{l+m+mi}{2}\PYG{o}{*}\PYG{n}{pi} \PYG{o}{+} \PYG{n}{pi}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)} +\PYG{g+go}{\PYGZhy{}3.141592653589793} +\end{sphinxVerbatim} +\begin{description} +\sphinxlineitem{NOTES:: .. Issue \#1 was ..} +\sphinxAtStartPar +\sphinxhyphen{}3.1415926535897931 + +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}longitude}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{185}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)} \PYG{g+go}{175.0} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}longitude}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{180}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}longitude}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{180}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)} \PYG{g+go}{\PYGZhy{}180.0} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}longitude}\PYG{p}{(}\PYG{l+m+mi}{185}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}longitude}\PYG{p}{(}\PYG{l+m+mi}{185}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)} \PYG{g+go}{\PYGZhy{}175.0} -\end{Verbatim} +\end{sphinxVerbatim} + +\end{description} \end{fulllineitems} +\sphinxstepscope -\chapter{The pj\_healpix Module} -\label{pj_healpix::doc}\label{pj_healpix:the-pj-healpix-module}\label{pj_healpix:module-rhealpix_dggs.pj_healpix}\index{rhealpix\_dggs.pj\_healpix (module)} -This Python 3.3 module implements the HEALPix map projection as described in {\hyperref[pj_healpix:caro2007]{{[}CaRo2007{]}}}. -CHANGELOG: +\chapter{The pj\_healpix Module} +\label{\detokenize{pj_healpix:module-rhealpixdggs.pj_healpix}}\label{\detokenize{pj_healpix:the-pj-healpix-module}}\label{\detokenize{pj_healpix::doc}}\index{module@\spxentry{module}!rhealpixdggs.pj\_healpix@\spxentry{rhealpixdggs.pj\_healpix}}\index{rhealpixdggs.pj\_healpix@\spxentry{rhealpixdggs.pj\_healpix}!module@\spxentry{module}} +\sphinxAtStartPar +This Python 3.11 module implements the HEALPix map projection as described in \sphinxcite{pj_healpix:caro2007}. \begin{itemize} \item {} -Alexander Raichev (AR), 2013-01-26: Refactored code from release 0.3. - -\item {} -AR, 2013-03-05: In in\_healpix\_image() increased eps to 1e-10 to decrease out-of-bounds errors i was getting when drawing figures. - -\item {} -AR, 2013-07-23: Ported to Python 3.3. +\sphinxAtStartPar +Alexander Raichev (AR), 2013\sphinxhyphen{}01\sphinxhyphen{}26: Refactored code from release 0.3. \end{itemize} +\sphinxAtStartPar NOTE: -All lengths are measured in meters and all angles are measured in radians -unless indicated otherwise. -By `ellipsoid' below, i mean an oblate ellipsoid of revolution. -\index{healpix() (in module rhealpix\_dggs.pj\_healpix)} +\sphinxAtStartPar +All lengths are measured in meters and all angles are measured in radians +unless indicated otherwise. +By ‘ellipsoid’ below, I mean an oblate ellipsoid of revolution. +\index{healpix() (in module rhealpixdggs.pj\_healpix)@\spxentry{healpix()}\spxextra{in module rhealpixdggs.pj\_healpix}} \begin{fulllineitems} -\phantomsection\label{pj_healpix:rhealpix_dggs.pj_healpix.healpix}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_healpix.}\bfcode{healpix}}{\emph{a=1}, \emph{e=0}}{} +\phantomsection\label{\detokenize{pj_healpix:rhealpixdggs.pj_healpix.healpix}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.pj\_healpix.}}\sphinxbfcode{\sphinxupquote{healpix}}}{\emph{\DUrole{n}{a}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{1}}, \emph{\DUrole{n}{e}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}}{{ $\rightarrow$ Callable\DUrole{p}{{[}}\DUrole{p}{{[}}float\DUrole{p}{,}\DUrole{w}{ }float\DUrole{p}{,}\DUrole{w}{ }bool\DUrole{p}{,}\DUrole{w}{ }bool\DUrole{p}{{]}}\DUrole{p}{,}\DUrole{w}{ }tuple\DUrole{p}{{[}}float\DUrole{p}{,}\DUrole{w}{ }float\DUrole{p}{{]}}\DUrole{p}{{]}}}} +\pysigstopsignatures +\sphinxAtStartPar Return a function object that wraps the HEALPix projection and its inverse -of an ellipsoid with major radius \emph{a} and eccentricity \emph{e}. +of an ellipsoid with major radius \sphinxtitleref{a} and eccentricity \sphinxtitleref{e}. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{f} \PYG{o}{=} \PYG{n}{healpix}\PYG{p}{(}\PYG{n}{a}\PYG{o}{=}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{e}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{f}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.57495135977821499, 2.1457476865731109)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{60}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{q} \PYG{o}{=} \PYG{n}{f}\PYG{p}{(}\PYG{o}{*}\PYG{n}{p}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{;} \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{q}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.57495135977821499, 2.1457476865731109)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{f}\PYG{p}{(}\PYG{o}{*}\PYG{n}{q}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(5.9999999999999997e\PYGZhy{}15, 59.999999999999986)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{f}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(0.574951359778215, 2.145747686573111)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{60}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{q} \PYG{o}{=} \PYG{n}{f}\PYG{p}{(}\PYG{o}{*}\PYG{n}{p}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)}\PYG{p}{;} \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{q}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(0.574951359778215, 2.145747686573111)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{f}\PYG{p}{(}\PYG{o}{*}\PYG{n}{q}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(6e\PYGZhy{}15, 59.999999999999986)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(0, 60)} -\end{Verbatim} +\end{sphinxVerbatim} +\sphinxAtStartPar OUTPUT: \begin{itemize} \item {} +\sphinxAtStartPar A function object of the form f(u, v, radians=False, inverse=False). \end{itemize} \end{fulllineitems} -\index{healpix\_diagram() (in module rhealpix\_dggs.pj\_healpix)} - -\begin{fulllineitems} -\phantomsection\label{pj_healpix:rhealpix_dggs.pj_healpix.healpix_diagram}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_healpix.}\bfcode{healpix\_diagram}}{\emph{a=1}, \emph{e=0}, \emph{shade\_polar\_region=True}}{} -Return a Sage Graphics object diagramming the HEALPix projection -boundary and polar triangles for the ellipsoid with major radius \emph{a} -and eccentricity \emph{e}. -Inessential graphics method. -Requires Sage graphics methods. - -\end{fulllineitems} - -\index{healpix\_ellipsoid() (in module rhealpix\_dggs.pj\_healpix)} +\index{healpix\_ellipsoid() (in module rhealpixdggs.pj\_healpix)@\spxentry{healpix\_ellipsoid()}\spxextra{in module rhealpixdggs.pj\_healpix}} \begin{fulllineitems} -\phantomsection\label{pj_healpix:rhealpix_dggs.pj_healpix.healpix_ellipsoid}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_healpix.}\bfcode{healpix\_ellipsoid}}{\emph{lam}, \emph{phi}, \emph{e=0}}{} +\phantomsection\label{\detokenize{pj_healpix:rhealpixdggs.pj_healpix.healpix_ellipsoid}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.pj\_healpix.}}\sphinxbfcode{\sphinxupquote{healpix\_ellipsoid}}}{\emph{\DUrole{n}{lam}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{phi}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{e}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}}{{ $\rightarrow$ tuple\DUrole{p}{{[}}float\DUrole{p}{,}\DUrole{w}{ }float\DUrole{p}{{]}}}} +\pysigstopsignatures +\sphinxAtStartPar Compute the signature functions of the HEALPix projection of an oblate -ellipsoid with eccentricity \emph{e} whose authalic sphere is the unit sphere. -Works when \emph{e} = 0 (spherical case) too. +ellipsoid with eccentricity \sphinxtitleref{e} whose authalic sphere is the unit sphere. +Works when \sphinxtitleref{e} = 0 (spherical case) too. +\sphinxAtStartPar INPUT: \begin{itemize} \item {} -\emph{lam, phi} - Geodetic longitude-latitude coordinates in radians. -Assume -pi \textless{}= \emph{lam} \textless{} pi and -pi/2 \textless{}= \emph{phi} \textless{}= pi/2. +\sphinxAtStartPar +\sphinxtitleref{lam, phi} \sphinxhyphen{} Geodetic longitude\sphinxhyphen{}latitude coordinates in radians. +Assume \sphinxhyphen{}pi \textless{}= \sphinxtitleref{lam} \textless{} pi and \sphinxhyphen{}pi/2 \textless{}= \sphinxtitleref{phi} \textless{}= pi/2. \item {} -\emph{e} - Eccentricity of the oblate ellipsoid. +\sphinxAtStartPar +\sphinxtitleref{e} \sphinxhyphen{} Eccentricity of the oblate ellipsoid. \end{itemize} +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{healpix\PYGZus{}ellipsoid}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{7}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0, 0.51115723774642197)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{healpix\PYGZus{}ellipsoid}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{7}\PYG{p}{,} \PYG{n}{e}\PYG{o}{=}\PYG{l+m+mf}{0.8}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0, 0.26848445085783701)} -\end{Verbatim} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{healpix\PYGZus{}ellipsoid}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{7}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(0, 0.511157237746422)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{healpix\PYGZus{}ellipsoid}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{7}\PYG{p}{,} \PYG{n}{e}\PYG{o}{=}\PYG{l+m+mf}{0.8}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(0, 0.268484450857837)} +\end{sphinxVerbatim} \end{fulllineitems} -\index{healpix\_ellipsoid\_inverse() (in module rhealpix\_dggs.pj\_healpix)} +\index{healpix\_ellipsoid\_inverse() (in module rhealpixdggs.pj\_healpix)@\spxentry{healpix\_ellipsoid\_inverse()}\spxextra{in module rhealpixdggs.pj\_healpix}} \begin{fulllineitems} -\phantomsection\label{pj_healpix:rhealpix_dggs.pj_healpix.healpix_ellipsoid_inverse}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_healpix.}\bfcode{healpix\_ellipsoid\_inverse}}{\emph{x}, \emph{y}, \emph{e=0}}{} +\phantomsection\label{\detokenize{pj_healpix:rhealpixdggs.pj_healpix.healpix_ellipsoid_inverse}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.pj\_healpix.}}\sphinxbfcode{\sphinxupquote{healpix\_ellipsoid\_inverse}}}{\emph{\DUrole{n}{x}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{y}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{e}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}}{{ $\rightarrow$ tuple\DUrole{p}{{[}}float\DUrole{p}{,}\DUrole{w}{ }float\DUrole{p}{{]}}}} +\pysigstopsignatures +\sphinxAtStartPar Compute the inverse of healpix\_ellipsoid(). +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{7}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{q} \PYG{o}{=} \PYG{n}{healpix\PYGZus{}ellipsoid}\PYG{p}{(}\PYG{o}{*}\PYG{n}{p}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{healpix\PYGZus{}ellipsoid\PYGZus{}inverse}\PYG{p}{(}\PYG{o}{*}\PYG{n}{q}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0, 0.44879895051282798)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{healpix\PYGZus{}ellipsoid\PYGZus{}inverse}\PYG{p}{(}\PYG{o}{*}\PYG{n}{q}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(0, 0.448798950512828)} -\end{Verbatim} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(0, 0.448798950512828)} +\end{sphinxVerbatim} \end{fulllineitems} -\index{healpix\_sphere() (in module rhealpix\_dggs.pj\_healpix)} +\index{healpix\_sphere() (in module rhealpixdggs.pj\_healpix)@\spxentry{healpix\_sphere()}\spxextra{in module rhealpixdggs.pj\_healpix}} \begin{fulllineitems} -\phantomsection\label{pj_healpix:rhealpix_dggs.pj_healpix.healpix_sphere}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_healpix.}\bfcode{healpix\_sphere}}{\emph{lam}, \emph{phi}}{} -Compute the signature function of the HEALPix +\phantomsection\label{\detokenize{pj_healpix:rhealpixdggs.pj_healpix.healpix_sphere}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.pj\_healpix.}}\sphinxbfcode{\sphinxupquote{healpix\_sphere}}}{\emph{\DUrole{n}{lam}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{phi}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}}{{ $\rightarrow$ tuple\DUrole{p}{{[}}float\DUrole{p}{,}\DUrole{w}{ }float\DUrole{p}{{]}}}} +\pysigstopsignatures +\sphinxAtStartPar +Compute the signature function of the HEALPix projection of the unit sphere. +\sphinxAtStartPar INPUT: \begin{itemize} \item {} -\emph{lam, phi} - Geodetic longitude-latitude coordinates in radians. -Assume -pi \textless{}= \emph{lam} \textless{} pi and -pi/2 \textless{}= \emph{phi} \textless{}= pi/2. +\sphinxAtStartPar +\sphinxtitleref{lam, phi} \sphinxhyphen{} Geodetic longitude\sphinxhyphen{}latitude coordinates in radians. +Assume \sphinxhyphen{}pi \textless{}= \sphinxtitleref{lam} \textless{} pi and \sphinxhyphen{}pi/2 \textless{}= \sphinxtitleref{phi} \textless{}= pi/2. \end{itemize} +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{healpix\PYGZus{}sphere}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{arcsin}\PYG{p}{(}\PYG{l+m+mf}{2.0}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{)}\PYG{p}{)} \PYG{o}{==} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{healpix\PYGZus{}sphere}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{arcsin}\PYG{p}{(}\PYG{l+m+mf}{2.0}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{)}\PYG{p}{)} \PYG{o}{==} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{True} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{healpix\_sphere\_inverse() (in module rhealpix\_dggs.pj\_healpix)} +\index{healpix\_sphere\_inverse() (in module rhealpixdggs.pj\_healpix)@\spxentry{healpix\_sphere\_inverse()}\spxextra{in module rhealpixdggs.pj\_healpix}} \begin{fulllineitems} -\phantomsection\label{pj_healpix:rhealpix_dggs.pj_healpix.healpix_sphere_inverse}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_healpix.}\bfcode{healpix\_sphere\_inverse}}{\emph{x}, \emph{y}}{} +\phantomsection\label{\detokenize{pj_healpix:rhealpixdggs.pj_healpix.healpix_sphere_inverse}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.pj\_healpix.}}\sphinxbfcode{\sphinxupquote{healpix\_sphere\_inverse}}}{\emph{\DUrole{n}{x}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{y}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}}{{ $\rightarrow$ tuple\DUrole{p}{{[}}float\DUrole{p}{,}\DUrole{w}{ }float\DUrole{p}{{]}}}} +\pysigstopsignatures +\sphinxAtStartPar Compute the inverse of the healpix\_sphere(). +\sphinxAtStartPar INPUT: \begin{itemize} \item {} -\emph{x, y} - Planar coordinates in meters in the image of the +\sphinxAtStartPar +\sphinxtitleref{x, y} \sphinxhyphen{} Planar coordinates in meters in the image of the HEALPix projection of the unit sphere. \end{itemize} +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{healpix\PYGZus{}sphere\PYGZus{}inverse}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)} \PYG{o}{==} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{arcsin}\PYG{p}{(}\PYG{l+m+mf}{2.0}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{)}\PYG{p}{)}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{healpix\PYGZus{}sphere\PYGZus{}inverse}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)} \PYG{o}{==} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{arcsin}\PYG{p}{(}\PYG{l+m+mf}{2.0}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{)}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{True} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{healpix\_vertices() (in module rhealpix\_dggs.pj\_healpix)} +\index{healpix\_vertices() (in module rhealpixdggs.pj\_healpix)@\spxentry{healpix\_vertices()}\spxextra{in module rhealpixdggs.pj\_healpix}} \begin{fulllineitems} -\phantomsection\label{pj_healpix:rhealpix_dggs.pj_healpix.healpix_vertices}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_healpix.}\bfcode{healpix\_vertices}}{}{} -Return a list of the planar vertices of the HEALPix projection of +\phantomsection\label{\detokenize{pj_healpix:rhealpixdggs.pj_healpix.healpix_vertices}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.pj\_healpix.}}\sphinxbfcode{\sphinxupquote{healpix\_vertices}}}{}{{ $\rightarrow$ list\DUrole{p}{{[}}tuple\DUrole{p}{{[}}float\DUrole{p}{,}\DUrole{w}{ }float\DUrole{p}{,}\DUrole{w}{ }float\DUrole{p}{{]}}\DUrole{p}{{]}}}} +\pysigstopsignatures +\sphinxAtStartPar +Return a list of the planar vertices of the HEALPix projection of the unit sphere. \end{fulllineitems} -\index{in\_healpix\_image() (in module rhealpix\_dggs.pj\_healpix)} +\index{in\_healpix\_image() (in module rhealpixdggs.pj\_healpix)@\spxentry{in\_healpix\_image()}\spxextra{in module rhealpixdggs.pj\_healpix}} \begin{fulllineitems} -\phantomsection\label{pj_healpix:rhealpix_dggs.pj_healpix.in_healpix_image}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_healpix.}\bfcode{in\_healpix\_image}}{\emph{x}, \emph{y}}{} -Return True if and only if \emph{(x, y)} lies in the image of the HEALPix +\phantomsection\label{\detokenize{pj_healpix:rhealpixdggs.pj_healpix.in_healpix_image}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.pj\_healpix.}}\sphinxbfcode{\sphinxupquote{in\_healpix\_image}}}{\emph{\DUrole{n}{x}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{y}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}}{{ $\rightarrow$ bool}} +\pysigstopsignatures +\sphinxAtStartPar +Return True if and only if \sphinxtitleref{(x, y)} lies in the image of the HEALPix projection of the unit sphere. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{eps} \PYG{o}{=} \PYG{l+m+mi}{0} \PYG{c}{\PYGZsh{} Test boundary points.} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{eps} \PYG{o}{=} \PYG{l+m+mi}{0} \PYG{c+c1}{\PYGZsh{} Test boundary points.} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{hp} \PYG{o}{=} \PYG{p}{[} \PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{,} \PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{3}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} @@ -869,90 +925,105 @@ \chapter{The pj\_healpix Module} \PYG{g+gp}{... }\PYG{p}{]} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{hp}\PYG{p}{:} \PYG{g+gp}{... } \PYG{k}{if} \PYG{o+ow}{not} \PYG{n}{in\PYGZus{}healpix\PYGZus{}image}\PYG{p}{(}\PYG{o}{*}\PYG{n}{p}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{Fail}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)} -\PYG{g+gp}{... } +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{Fail}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} +\PYG{g+gp}{...} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{in\PYGZus{}healpix\PYGZus{}image}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)} \PYG{g+go}{True} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{in\PYGZus{}healpix\PYGZus{}image}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{+} \PYG{l+m+mf}{0.1}\PYG{p}{)} \PYG{g+go}{False} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} +\sphinxstepscope -\chapter{The pj\_rhealpix Module} -\label{pj_rhealpix::doc}\label{pj_rhealpix:module-rhealpix_dggs.pj_rhealpix}\label{pj_rhealpix:the-pj-rhealpix-module}\index{rhealpix\_dggs.pj\_rhealpix (module)} -This Python 3.3 module implements the rHEALPix map projection. -CHANGELOG: +\chapter{The pj\_rhealpix Module} +\label{\detokenize{pj_rhealpix:module-rhealpixdggs.pj_rhealpix}}\label{\detokenize{pj_rhealpix:the-pj-rhealpix-module}}\label{\detokenize{pj_rhealpix::doc}}\index{module@\spxentry{module}!rhealpixdggs.pj\_rhealpix@\spxentry{rhealpixdggs.pj\_rhealpix}}\index{rhealpixdggs.pj\_rhealpix@\spxentry{rhealpixdggs.pj\_rhealpix}!module@\spxentry{module}} +\sphinxAtStartPar +This Python 3.11 module implements the rHEALPix map projection. \begin{itemize} \item {} -Alexander Raichev (AR), 2013-01-26: Refactored code from release 0.3. - -\item {} -AR, 2013-07-23: Ported to Python 3.3. +\sphinxAtStartPar +Alexander Raichev (AR), 2013\sphinxhyphen{}01\sphinxhyphen{}26: Refactored code from release 0.3. \end{itemize} +\sphinxAtStartPar NOTE: -All lengths are measured in meters and all angles are measured in radians -unless indicated otherwise. -By `ellipsoid' below, i mean an oblate ellipsoid of revolution. -\index{combine\_triangles() (in module rhealpix\_dggs.pj\_rhealpix)} +\sphinxAtStartPar +All lengths are measured in meters and all angles are measured in radians +unless indicated otherwise. +By ‘ellipsoid’ below, I mean an oblate ellipsoid of revolution. +\index{combine\_triangles() (in module rhealpixdggs.pj\_rhealpix)@\spxentry{combine\_triangles()}\spxextra{in module rhealpixdggs.pj\_rhealpix}} \begin{fulllineitems} -\phantomsection\label{pj_rhealpix:rhealpix_dggs.pj_rhealpix.combine_triangles}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_rhealpix.}\bfcode{combine\_triangles}}{\emph{x}, \emph{y}, \emph{north\_square=0}, \emph{south\_square=0}, \emph{inverse=False}}{} -Rearrange point \emph{(x, y)} in the HEALPix projection by +\phantomsection\label{\detokenize{pj_rhealpix:rhealpixdggs.pj_rhealpix.combine_triangles}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.pj\_rhealpix.}}\sphinxbfcode{\sphinxupquote{combine\_triangles}}}{\emph{\DUrole{n}{x}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{y}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{north\_square}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{int}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}, \emph{\DUrole{n}{south\_square}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{int}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}, \emph{\DUrole{n}{inverse}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{bool}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{False}}}{{ $\rightarrow$ tuple\DUrole{p}{{[}}float\DUrole{p}{,}\DUrole{w}{ }float\DUrole{p}{{]}}}} +\pysigstopsignatures +\sphinxAtStartPar +Rearrange point \sphinxtitleref{(x, y)} in the HEALPix projection by combining the polar triangles into two polar squares. -Put the north polar square in position \emph{north\_square} and -the south polar square in position \emph{south\_square}. -If \emph{inverse} = True, uncombine the polar triangles. +Put the north polar square in position \sphinxtitleref{north\_square} and +the south polar square in position \sphinxtitleref{south\_square}. +If \sphinxtitleref{inverse} = True, uncombine the polar triangles. +\sphinxAtStartPar INPUT: \begin{itemize} \item {} -\emph{x, y} - Coordinates in the HEALPix projection of the unit sphere. +\sphinxAtStartPar +\sphinxtitleref{x, y} \sphinxhyphen{} Coordinates in the HEALPix projection of the unit sphere. \item {} -\emph{north\_square, south\_square} - Integers between 0 and 3 indicating -the positions of the north\_square polar square and south\_square polar +\sphinxAtStartPar +\sphinxtitleref{north\_square, south\_square} \sphinxhyphen{} Integers between 0 and 3 indicating +the positions of the north\_square polar square and south\_square polar square respectively. See rhealpix\_sphere() docstring for a diagram. \item {} -\emph{inverse} - (Optional; default = False) Boolean. If False, then compute +\sphinxAtStartPar +\sphinxtitleref{inverse} \sphinxhyphen{} (Optional; default = False) Boolean. If False, then compute forward function. If True, then compute inverse function. \end{itemize} +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{u}\PYG{p}{,} \PYG{n}{v} \PYG{o}{=} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{3} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{x}\PYG{p}{,} \PYG{n}{y} \PYG{o}{=} \PYG{n}{combine\PYGZus{}triangles}\PYG{p}{(}\PYG{n}{u}\PYG{p}{,} \PYG{n}{v}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{p}{(}\PYG{n}{x}\PYG{p}{,} \PYG{n}{y}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}1.8325957145940459, 1.5707963267948959)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{combine\PYGZus{}triangles}\PYG{p}{(}\PYG{n}{x}\PYG{p}{,} \PYG{n}{y}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}0.78539816339744795, 1.0471975511965981)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{p}{(}\PYG{n}{u}\PYG{p}{,} \PYG{n}{v}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{p}{(}\PYG{n}{x}\PYG{p}{,} \PYG{n}{y}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(\PYGZhy{}1.832595714594046, 1.570796326794896)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{combine\PYGZus{}triangles}\PYG{p}{(}\PYG{n}{x}\PYG{p}{,} \PYG{n}{y}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(\PYGZhy{}0.785398163397448, 1.047197551196598)} -\end{Verbatim} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{p}{(}\PYG{n}{u}\PYG{p}{,} \PYG{n}{v}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(\PYGZhy{}0.785398163397448, 1.047197551196598)} +\end{sphinxVerbatim} \end{fulllineitems} -\index{in\_rhealpix\_image() (in module rhealpix\_dggs.pj\_rhealpix)} +\index{in\_rhealpix\_image() (in module rhealpixdggs.pj\_rhealpix)@\spxentry{in\_rhealpix\_image()}\spxextra{in module rhealpixdggs.pj\_rhealpix}} \begin{fulllineitems} -\phantomsection\label{pj_rhealpix:rhealpix_dggs.pj_rhealpix.in_rhealpix_image}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_rhealpix.}\bfcode{in\_rhealpix\_image}}{\emph{x}, \emph{y}, \emph{north\_square=0}, \emph{south\_square=0}}{} -Return True if and only if the point \emph{(x, y)} lies in the image of +\phantomsection\label{\detokenize{pj_rhealpix:rhealpixdggs.pj_rhealpix.in_rhealpix_image}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.pj\_rhealpix.}}\sphinxbfcode{\sphinxupquote{in\_rhealpix\_image}}}{\emph{\DUrole{n}{x}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{y}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{north\_square}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{int}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}, \emph{\DUrole{n}{south\_square}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{int}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}}{{ $\rightarrow$ bool}} +\pysigstopsignatures +\sphinxAtStartPar +Return True if and only if the point \sphinxtitleref{(x, y)} lies in the image of the rHEALPix projection of the unit sphere. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{eps} \PYG{o}{=} \PYG{l+m+mi}{0} \PYG{c}{\PYGZsh{} Test boundary points.} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{eps} \PYG{o}{=} \PYG{l+m+mi}{0} \PYG{c+c1}{\PYGZsh{} Test boundary points.} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{north\PYGZus{}square}\PYG{p}{,} \PYG{n}{south\PYGZus{}square} \PYG{o}{=} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{0} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rhp} \PYG{o}{=} \PYG{p}{[} \PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} @@ -970,399 +1041,475 @@ \chapter{The pj\_rhealpix Module} \PYG{g+gp}{... }\PYG{p}{]} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{rhp}\PYG{p}{:} \PYG{g+gp}{... } \PYG{k}{if} \PYG{o+ow}{not} \PYG{n}{in\PYGZus{}rhealpix\PYGZus{}image}\PYG{p}{(}\PYG{o}{*}\PYG{n}{p}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{Fail}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)} -\PYG{g+gp}{... } -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{in\PYGZus{}rhealpix\PYGZus{}image}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{Fail}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} +\PYG{g+gp}{...} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{in\PYGZus{}rhealpix\PYGZus{}image}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{in\PYGZus{}rhealpix\PYGZus{}image}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{+} \PYG{l+m+mf}{0.1}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{in\PYGZus{}rhealpix\PYGZus{}image}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{+} \PYG{l+m+mf}{0.1}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{False} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{rhealpix() (in module rhealpix\_dggs.pj\_rhealpix)} +\index{rhealpix() (in module rhealpixdggs.pj\_rhealpix)@\spxentry{rhealpix()}\spxextra{in module rhealpixdggs.pj\_rhealpix}} \begin{fulllineitems} -\phantomsection\label{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_rhealpix.}\bfcode{rhealpix}}{\emph{a=1}, \emph{e=0}, \emph{north\_square=0}, \emph{south\_square=0}}{} +\phantomsection\label{\detokenize{pj_rhealpix:rhealpixdggs.pj_rhealpix.rhealpix}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.pj\_rhealpix.}}\sphinxbfcode{\sphinxupquote{rhealpix}}}{\emph{\DUrole{n}{a}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{1}}, \emph{\DUrole{n}{e}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}, \emph{\DUrole{n}{north\_square}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{int}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}, \emph{\DUrole{n}{south\_square}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{int}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}, \emph{\DUrole{n}{region}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{str}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{\textquotesingle{}none\textquotesingle{}}}}{{ $\rightarrow$ Callable\DUrole{p}{{[}}\DUrole{p}{{[}}float\DUrole{p}{,}\DUrole{w}{ }float\DUrole{p}{,}\DUrole{w}{ }bool\DUrole{p}{,}\DUrole{w}{ }bool\DUrole{p}{{]}}\DUrole{p}{,}\DUrole{w}{ }tuple\DUrole{p}{{[}}float\DUrole{p}{,}\DUrole{w}{ }float\DUrole{p}{{]}}\DUrole{p}{{]}}}} +\pysigstopsignatures +\sphinxAtStartPar Return a function object that wraps the rHEALPix projection and its inverse -of an ellipsoid with major radius \emph{a} and eccentricity \emph{e}. +of an ellipsoid with major radius \sphinxtitleref{a} and eccentricity \sphinxtitleref{e}. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{f} \PYG{o}{=} \PYG{n}{rhealpix}\PYG{p}{(}\PYG{n}{a}\PYG{o}{=}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{e}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{north\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{south\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{2}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{f}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}0.57495135977821499, 2.1457476865731109)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{60}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{q} \PYG{o}{=} \PYG{n}{f}\PYG{p}{(}\PYG{o}{*}\PYG{n}{p}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{q}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}0.57495135977821499, 2.1457476865731109)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{f}\PYG{p}{(}\PYG{o}{*}\PYG{n}{q}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(5.9999999999999997e\PYGZhy{}15, 59.999999999999986)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{f}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(\PYGZhy{}0.574951359778215, 2.145747686573111)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{60}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{q} \PYG{o}{=} \PYG{n}{f}\PYG{p}{(}\PYG{o}{*}\PYG{n}{p}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{q}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(\PYGZhy{}0.574951359778215, 2.145747686573111)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{f}\PYG{p}{(}\PYG{o}{*}\PYG{n}{q}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(6e\PYGZhy{}15, 59.999999999999986)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(0, 60)} -\end{Verbatim} +\end{sphinxVerbatim} +\sphinxAtStartPar OUTPUT: \begin{itemize} \item {} +\sphinxAtStartPar A function object of the form f(u, v, radians=False, inverse=False). \end{itemize} \end{fulllineitems} -\index{rhealpix\_diagram() (in module rhealpix\_dggs.pj\_rhealpix)} - -\begin{fulllineitems} -\phantomsection\label{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix_diagram}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_rhealpix.}\bfcode{rhealpix\_diagram}}{\emph{a=1}, \emph{e=0}, \emph{north\_square=0}, \emph{south\_square=0}, \emph{shade\_polar\_region=True}}{} -Return a Sage Graphics object diagramming the rHEALPix projection -boundary and polar triangles for the ellipsoid with major radius \emph{a} -and eccentricity \emph{e}. -Inessential graphics method. -Requires Sage graphics methods. - -\end{fulllineitems} - -\index{rhealpix\_ellipsoid() (in module rhealpix\_dggs.pj\_rhealpix)} +\index{rhealpix\_ellipsoid() (in module rhealpixdggs.pj\_rhealpix)@\spxentry{rhealpix\_ellipsoid()}\spxextra{in module rhealpixdggs.pj\_rhealpix}} \begin{fulllineitems} -\phantomsection\label{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix_ellipsoid}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_rhealpix.}\bfcode{rhealpix\_ellipsoid}}{\emph{lam}, \emph{phi}, \emph{e=0}, \emph{north\_square=0}, \emph{south\_square=0}}{} -Compute the signature functions of the rHEALPix map -projection of an oblate ellipsoid with eccentricity \emph{e} whose -authalic sphere is the unit sphere. -The north polar square is put in position \emph{north\_square}, -and the south polar square is put in position \emph{south\_square}. -Works when \emph{e} = 0 (spherical case) too. +\phantomsection\label{\detokenize{pj_rhealpix:rhealpixdggs.pj_rhealpix.rhealpix_ellipsoid}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.pj\_rhealpix.}}\sphinxbfcode{\sphinxupquote{rhealpix\_ellipsoid}}}{\emph{\DUrole{n}{lam}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{phi}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{e}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}, \emph{\DUrole{n}{north\_square}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{int}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}, \emph{\DUrole{n}{south\_square}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{int}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}, \emph{\DUrole{n}{region}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{str}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{\textquotesingle{}none\textquotesingle{}}}}{{ $\rightarrow$ tuple\DUrole{p}{{[}}float\DUrole{p}{,}\DUrole{w}{ }float\DUrole{p}{{]}}}} +\pysigstopsignatures +\sphinxAtStartPar +Compute the signature functions of the rHEALPix map +projection of an oblate ellipsoid with eccentricity \sphinxtitleref{e} whose +authalic sphere is the unit sphere. +The north polar square is put in position \sphinxtitleref{north\_square}, +and the south polar square is put in position \sphinxtitleref{south\_square}. +Works when \sphinxtitleref{e} = 0 (spherical case) too. +\sphinxAtStartPar INPUT: \begin{itemize} \item {} -\emph{lam, phi} - Geographic longitude-latitude coordinates in radian. -Assume -pi \textless{}= \emph{lam} \textless{} pi and -pi/2 \textless{}= \emph{phi} \textless{}= pi/2. +\sphinxAtStartPar +\sphinxtitleref{lam, phi} \sphinxhyphen{} Geographic longitude\sphinxhyphen{}latitude coordinates in radian. +Assume \sphinxhyphen{}pi \textless{}= \sphinxtitleref{lam} \textless{} pi and \sphinxhyphen{}pi/2 \textless{}= \sphinxtitleref{phi} \textless{}= pi/2. \item {} -\emph{e} - Eccentricity of the ellipsoid. +\sphinxAtStartPar +\sphinxtitleref{e} \sphinxhyphen{} Eccentricity of the ellipsoid. \item {} -\emph{north\_square, south\_square} - (Optional; defaults = 0, 0) Integers -between 0 and 3 indicating positions of north polar and +\sphinxAtStartPar +\sphinxtitleref{north\_square, south\_square} \sphinxhyphen{} (Optional; defaults = 0, 0) Integers +between 0 and 3 indicating positions of north polar and south polar squares, respectively. See rhealpix\_sphere() docstring for a diagram. \end{itemize} +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{numpy} \PYG{k+kn}{import} \PYG{n}{arcsin} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rhealpix\PYGZus{}ellipsoid}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{arcsin}\PYG{p}{(}\PYG{l+m+mf}{2.0}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{)}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0, 0.78539816339744795)} -\end{Verbatim} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rhealpix\PYGZus{}ellipsoid}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{arcsin}\PYG{p}{(}\PYG{l+m+mf}{2.0}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{)}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(0, 0.785398163397448)} +\end{sphinxVerbatim} \end{fulllineitems} -\index{rhealpix\_ellipsoid\_inverse() (in module rhealpix\_dggs.pj\_rhealpix)} +\index{rhealpix\_ellipsoid\_inverse() (in module rhealpixdggs.pj\_rhealpix)@\spxentry{rhealpix\_ellipsoid\_inverse()}\spxextra{in module rhealpixdggs.pj\_rhealpix}} \begin{fulllineitems} -\phantomsection\label{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix_ellipsoid_inverse}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_rhealpix.}\bfcode{rhealpix\_ellipsoid\_inverse}}{\emph{x}, \emph{y}, \emph{e=0}, \emph{north\_square=0}, \emph{south\_square=0}}{} -Compute the inverse of rhealpix\_ellipsoid. +\phantomsection\label{\detokenize{pj_rhealpix:rhealpixdggs.pj_rhealpix.rhealpix_ellipsoid_inverse}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.pj\_rhealpix.}}\sphinxbfcode{\sphinxupquote{rhealpix\_ellipsoid\_inverse}}}{\emph{\DUrole{n}{x}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{y}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{e}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}, \emph{\DUrole{n}{north\_square}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{int}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}, \emph{\DUrole{n}{south\_square}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{int}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}, \emph{\DUrole{n}{region}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{str}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{\textquotesingle{}none\textquotesingle{}}}}{{ $\rightarrow$ tuple\DUrole{p}{{[}}float\DUrole{p}{,}\DUrole{w}{ }float\DUrole{p}{{]}}}} +\pysigstopsignatures +\sphinxAtStartPar +Compute the inverse of rhealpix\_ellipsoid(). +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{q} \PYG{o}{=} \PYG{n}{rhealpix\PYGZus{}ellipsoid}\PYG{p}{(}\PYG{o}{*}\PYG{n}{p}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rhealpix\PYGZus{}ellipsoid\PYGZus{}inverse}\PYG{p}{(}\PYG{o}{*}\PYG{n}{q}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.0, 0.78539816339744795)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rhealpix\PYGZus{}ellipsoid\PYGZus{}inverse}\PYG{p}{(}\PYG{o}{*}\PYG{n}{q}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(0.0, 0.785398163397448)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(0, 0.785398163397448)} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{rhealpix\_sphere() (in module rhealpix\_dggs.pj\_rhealpix)} +\index{rhealpix\_sphere() (in module rhealpixdggs.pj\_rhealpix)@\spxentry{rhealpix\_sphere()}\spxextra{in module rhealpixdggs.pj\_rhealpix}} \begin{fulllineitems} -\phantomsection\label{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix_sphere}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_rhealpix.}\bfcode{rhealpix\_sphere}}{\emph{lam}, \emph{phi}, \emph{north\_square=0}, \emph{south\_square=0}}{} -Compute the signature functions of the rHEALPix map projection of -the unit sphere. -The north polar square is put in position \emph{north\_square}, and the -south polar square is put in position \emph{south\_square}. +\phantomsection\label{\detokenize{pj_rhealpix:rhealpixdggs.pj_rhealpix.rhealpix_sphere}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.pj\_rhealpix.}}\sphinxbfcode{\sphinxupquote{rhealpix\_sphere}}}{\emph{\DUrole{n}{lam}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{phi}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{north\_square}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{int}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}, \emph{\DUrole{n}{south\_square}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{int}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}, \emph{\DUrole{n}{region}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{str}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{\textquotesingle{}none\textquotesingle{}}}}{{ $\rightarrow$ tuple\DUrole{p}{{[}}float\DUrole{p}{,}\DUrole{w}{ }float\DUrole{p}{{]}}}} +\pysigstopsignatures +\sphinxAtStartPar +Compute the signature functions of the rHEALPix map projection of +the unit sphere. +The north polar square is put in position \sphinxtitleref{north\_square}, and the +south polar square is put in position \sphinxtitleref{south\_square}. +\sphinxAtStartPar INPUT: \begin{itemize} \item {} -\emph{lam, phi} -Geographic longitude-latitude coordinates in radians. -Assume -pi \textless{}= \emph{lam} \textless{} pi and -pi/2 \textless{}= \emph{phi} \textless{}= pi/2. +\sphinxAtStartPar +\sphinxtitleref{lam, phi} \sphinxhyphen{}Geographic longitude\sphinxhyphen{}latitude coordinates in radians. +Assume \sphinxhyphen{}pi \textless{}= \sphinxtitleref{lam} \textless{} pi and \sphinxhyphen{}pi/2 \textless{}= \sphinxtitleref{phi} \textless{}= pi/2. \item {} -\emph{north\_square, south\_square} - (Optional; defaults = 0, 0) Integers -between 0 and 3 indicating positions of north polar and +\sphinxAtStartPar +\sphinxtitleref{north\_square, south\_square} \sphinxhyphen{} (Optional; defaults = 0, 0) Integers +between 0 and 3 indicating positions of north polar and south polar squares, respectively. \end{itemize} +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rhealpix\PYGZus{}sphere}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rhealpix\PYGZus{}sphere}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(\PYGZhy{}1.619978633413937, 2.307012183573304)} -\end{Verbatim} +\end{sphinxVerbatim} +\sphinxAtStartPar NOTE: +\sphinxAtStartPar The polar squares are labeled 0, 1, 2, 3 from east to west like this: -\begin{Verbatim}[commandchars=\\\{\}] -east west -*---*---*---*---* -\textbar{} 0 \textbar{} 1 \textbar{} 2 \textbar{} 3 \textbar{} -*---*---*---*---* -\textbar{} \textbar{} \textbar{} \textbar{} \textbar{} -*---*---*---*---* -\textbar{} 0 \textbar{} 1 \textbar{} 2 \textbar{} 3 \textbar{} -*---*---*---*---* -\end{Verbatim} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{east} \PYG{n}{west} +\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*} +\PYG{o}{|} \PYG{l+m+mi}{0} \PYG{o}{|} \PYG{l+m+mi}{1} \PYG{o}{|} \PYG{l+m+mi}{2} \PYG{o}{|} \PYG{l+m+mi}{3} \PYG{o}{|} +\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*} +\PYG{o}{|} \PYG{o}{|} \PYG{o}{|} \PYG{o}{|} \PYG{o}{|} +\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*} +\PYG{o}{|} \PYG{l+m+mi}{0} \PYG{o}{|} \PYG{l+m+mi}{1} \PYG{o}{|} \PYG{l+m+mi}{2} \PYG{o}{|} \PYG{l+m+mi}{3} \PYG{o}{|} +\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*} +\end{sphinxVerbatim} \end{fulllineitems} -\index{rhealpix\_sphere\_inverse() (in module rhealpix\_dggs.pj\_rhealpix)} +\index{rhealpix\_sphere\_inverse() (in module rhealpixdggs.pj\_rhealpix)@\spxentry{rhealpix\_sphere\_inverse()}\spxextra{in module rhealpixdggs.pj\_rhealpix}} \begin{fulllineitems} -\phantomsection\label{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix_sphere_inverse}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_rhealpix.}\bfcode{rhealpix\_sphere\_inverse}}{\emph{x}, \emph{y}, \emph{north\_square=0}, \emph{south\_square=0}}{} +\phantomsection\label{\detokenize{pj_rhealpix:rhealpixdggs.pj_rhealpix.rhealpix_sphere_inverse}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.pj\_rhealpix.}}\sphinxbfcode{\sphinxupquote{rhealpix\_sphere\_inverse}}}{\emph{\DUrole{n}{x}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{y}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{north\_square}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{int}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}, \emph{\DUrole{n}{south\_square}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{int}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}, \emph{\DUrole{n}{region}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{str}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{\textquotesingle{}none\textquotesingle{}}}}{{ $\rightarrow$ tuple\DUrole{p}{{[}}float\DUrole{p}{,}\DUrole{w}{ }float\DUrole{p}{{]}}}} +\pysigstopsignatures +\sphinxAtStartPar Compute the inverse of rhealpix\_sphere(). +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{q} \PYG{o}{=} \PYG{n}{rhealpix\PYGZus{}sphere}\PYG{p}{(}\PYG{o}{*}\PYG{n}{p}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rhealpix\PYGZus{}sphere\PYGZus{}inverse}\PYG{p}{(}\PYG{o}{*}\PYG{n}{q}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.0, 0.78539816339744795)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rhealpix\PYGZus{}sphere\PYGZus{}inverse}\PYG{p}{(}\PYG{o}{*}\PYG{n}{q}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(0.0, 0.785398163397448)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(0, 0.785398163397448)} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{rhealpix\_vertices() (in module rhealpix\_dggs.pj\_rhealpix)} +\index{rhealpix\_vertices() (in module rhealpixdggs.pj\_rhealpix)@\spxentry{rhealpix\_vertices()}\spxextra{in module rhealpixdggs.pj\_rhealpix}} \begin{fulllineitems} -\phantomsection\label{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix_vertices}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_rhealpix.}\bfcode{rhealpix\_vertices}}{\emph{north\_square=0}, \emph{south\_square=0}}{} -Return a list of the planar vertices of the rHEALPix projection of +\phantomsection\label{\detokenize{pj_rhealpix:rhealpixdggs.pj_rhealpix.rhealpix_vertices}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.pj\_rhealpix.}}\sphinxbfcode{\sphinxupquote{rhealpix\_vertices}}}{\emph{\DUrole{n}{north\_square}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{int}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}, \emph{\DUrole{n}{south\_square}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{int}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}}{{ $\rightarrow$ list\DUrole{p}{{[}}tuple\DUrole{p}{{[}}float\DUrole{p}{,}\DUrole{w}{ }float\DUrole{p}{{]}}\DUrole{p}{{]}}}} +\pysigstopsignatures +\sphinxAtStartPar +Return a list of the planar vertices of the rHEALPix projection of the unit sphere. \end{fulllineitems} -\index{triangle() (in module rhealpix\_dggs.pj\_rhealpix)} +\index{triangle() (in module rhealpixdggs.pj\_rhealpix)@\spxentry{triangle()}\spxextra{in module rhealpixdggs.pj\_rhealpix}} \begin{fulllineitems} -\phantomsection\label{pj_rhealpix:rhealpix_dggs.pj_rhealpix.triangle}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_rhealpix.}\bfcode{triangle}}{\emph{x}, \emph{y}, \emph{north\_square=0}, \emph{south\_square=0}, \emph{inverse=False}}{} -Return the number of the polar triangle and region that \emph{(x, y)} lies in. -If \emph{inverse} = False, then assume \emph{(x,y)} lies in the image of the HEALPix +\phantomsection\label{\detokenize{pj_rhealpix:rhealpixdggs.pj_rhealpix.triangle}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxcode{\sphinxupquote{rhealpixdggs.pj\_rhealpix.}}\sphinxbfcode{\sphinxupquote{triangle}}}{\emph{\DUrole{n}{x}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{y}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{float}}, \emph{\DUrole{n}{north\_square}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{int}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}, \emph{\DUrole{n}{south\_square}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{int}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{0}}, \emph{\DUrole{n}{inverse}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{bool}\DUrole{w}{ }\DUrole{o}{=}\DUrole{w}{ }\DUrole{default_value}{False}}}{{ $\rightarrow$ tuple\DUrole{p}{{[}}int\DUrole{p}{,}\DUrole{w}{ }str\DUrole{p}{{]}}}} +\pysigstopsignatures +\sphinxAtStartPar +Return the number of the polar triangle and region that \sphinxtitleref{(x, y)} lies in. +If \sphinxtitleref{inverse} = False, then assume \sphinxtitleref{(x,y)} lies in the image of the HEALPix projection of the unit sphere. -If \emph{inverse} = True, then assume \emph{(x,y)} lies in the image of the -\emph{(north\_square, south\_square)}-rHEALPix projection of the unit sphere. +If \sphinxtitleref{inverse} = True, then assume \sphinxtitleref{(x,y)} lies in the image of the +\sphinxtitleref{(north\_square, south\_square)}\sphinxhyphen{}rHEALPix projection of the unit sphere. +\sphinxAtStartPar INPUT: \begin{itemize} \item {} -\emph{x, y} - Coordinates in the HEALPix or rHEALPix (if \emph{inverse} = True) +\sphinxAtStartPar +\sphinxtitleref{x, y} \sphinxhyphen{} Coordinates in the HEALPix or rHEALPix (if \sphinxtitleref{inverse} = True) projection of the unit sphere. \item {} -\emph{north\_square, south\_square} - Integers between 0 and 3 indicating the -positions of the north\_square pole square and south\_square pole square +\sphinxAtStartPar +\sphinxtitleref{north\_square, south\_square} \sphinxhyphen{} Integers between 0 and 3 indicating the +positions of the north\_square pole square and south\_square pole square respectively. See rhealpix\_sphere() docstring for a diagram. \item {} -\emph{inverse} - (Optional; default = False) Boolean. If False, then compute +\sphinxAtStartPar +\sphinxtitleref{inverse} \sphinxhyphen{} (Optional; default = False) Boolean. If False, then compute forward function. If True, then compute inverse function. \end{itemize} +\sphinxAtStartPar OUTPUT: +\sphinxAtStartPar The pair (triangle\_number, region). -Here region equals `north\_polar' (polar), `south\_polar' (polar), or -`equatorial', indicating where \emph{(x, y)} lies. -If region = `equatorial', then triangle\_number = None. -Suppose now that region != `equatorial'. -If \emph{inverse} = False, then triangle\_number is the number (0, 1, 2, or 3) of -the HEALPix polar triangle Z that \emph{(x, y)} lies in. -If \emph{inverse} = True, then triangle\_number is the number (0, 1, 2, or 3) of -the HEALPix polar triangle that \emph{(x, y)} will get moved into. +Here region equals ‘north\_polar’ (polar), ‘south\_polar’ (polar), or +‘equatorial’, indicating where \sphinxtitleref{(x, y)} lies. +If region = ‘equatorial’, then triangle\_number = None. +Suppose now that region != ‘equatorial’. +If \sphinxtitleref{inverse} = False, then triangle\_number is the number (0, 1, 2, or 3) of +the HEALPix polar triangle Z that \sphinxtitleref{(x, y)} lies in. +If \sphinxtitleref{inverse} = True, then triangle\_number is the number (0, 1, 2, or 3) of +the HEALPix polar triangle that \sphinxtitleref{(x, y)} will get moved into. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{triangle}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{+} \PYG{l+m+mf}{0.1}\PYG{p}{)} \PYG{g+go}{(1, \PYGZsq{}north\PYGZus{}polar\PYGZsq{})} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{triangle}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{3}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{+} \PYG{l+m+mf}{0.1}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{triangle}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{3}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{+} \PYG{l+m+mf}{0.1}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)} \PYG{g+go}{(1, \PYGZsq{}north\PYGZus{}polar\PYGZsq{})} -\end{Verbatim} +\end{sphinxVerbatim} +\sphinxAtStartPar NOTES: -In the HEALPix projection, the polar triangles are labeled 0--3 from +\sphinxAtStartPar +In the HEALPix projection, the polar triangles are labeled 0\textendash{}3 from east to west like this: -\begin{Verbatim}[commandchars=\\\{\}] - * * * * - * 0 * * 1 * * 2 * * 3 * -*-------*-------*-------*-------* -\textbar{} \textbar{} \textbar{} \textbar{} \textbar{} -\textbar{} \textbar{} \textbar{} \textbar{} \textbar{} -\textbar{} \textbar{} \textbar{} \textbar{} \textbar{} -*-------*-------*-------*-------* - * 0 * * 1 * * 2 * * 3 * - * * * * -\end{Verbatim} - +\begin{sphinxVerbatim}[commandchars=\\\{\}] + \PYG{o}{*} \PYG{o}{*} \PYG{o}{*} \PYG{o}{*} + \PYG{o}{*} \PYG{l+m+mi}{0} \PYG{o}{*} \PYG{o}{*} \PYG{l+m+mi}{1} \PYG{o}{*} \PYG{o}{*} \PYG{l+m+mi}{2} \PYG{o}{*} \PYG{o}{*} \PYG{l+m+mi}{3} \PYG{o}{*} +\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*} +\PYG{o}{|} \PYG{o}{|} \PYG{o}{|} \PYG{o}{|} \PYG{o}{|} +\PYG{o}{|} \PYG{o}{|} \PYG{o}{|} \PYG{o}{|} \PYG{o}{|} +\PYG{o}{|} \PYG{o}{|} \PYG{o}{|} \PYG{o}{|} \PYG{o}{|} +\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*} + \PYG{o}{*} \PYG{l+m+mi}{0} \PYG{o}{*} \PYG{o}{*} \PYG{l+m+mi}{1} \PYG{o}{*} \PYG{o}{*} \PYG{l+m+mi}{2} \PYG{o}{*} \PYG{o}{*} \PYG{l+m+mi}{3} \PYG{o}{*} + \PYG{o}{*} \PYG{o}{*} \PYG{o}{*} \PYG{o}{*} +\end{sphinxVerbatim} + +\sphinxAtStartPar In the rHEALPix projection these polar triangles get rearranged -into a square with the triangles numbered \emph{north\_square} and \emph{south\_square} +into a square with the triangles numbered \sphinxtitleref{north\_square} and \sphinxtitleref{south\_square} remaining fixed. -For example, if \emph{north\_square} = 1 and \emph{south\_square} = 3, +For example, if \sphinxtitleref{north\_square} = 1 and \sphinxtitleref{south\_square} = 3, then the triangles get rearranged this way: -\begin{Verbatim}[commandchars=\\\{\}] -North polar square: *-------* - \textbar{} * 3 * \textbar{} - \textbar{} 0 * 2 \textbar{} - \textbar{} * 1 * \textbar{} - ----*-------*---- - -South polar square: ----*-------*---- - \textbar{} * 3 * \textbar{} - \textbar{} 2 * 0 \textbar{} - \textbar{} * 1 * \textbar{} - *-------* -\end{Verbatim} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{n}{North} \PYG{n}{polar} \PYG{n}{square}\PYG{p}{:} \PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*} + \PYG{o}{|} \PYG{o}{*} \PYG{l+m+mi}{3} \PYG{o}{*} \PYG{o}{|} + \PYG{o}{|} \PYG{l+m+mi}{0} \PYG{o}{*} \PYG{l+m+mi}{2} \PYG{o}{|} + \PYG{o}{|} \PYG{o}{*} \PYG{l+m+mi}{1} \PYG{o}{*} \PYG{o}{|} + \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}} + +\PYG{n}{South} \PYG{n}{polar} \PYG{n}{square}\PYG{p}{:} \PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}} + \PYG{o}{|} \PYG{o}{*} \PYG{l+m+mi}{3} \PYG{o}{*} \PYG{o}{|} + \PYG{o}{|} \PYG{l+m+mi}{2} \PYG{o}{*} \PYG{l+m+mi}{0} \PYG{o}{|} + \PYG{o}{|} \PYG{o}{*} \PYG{l+m+mi}{1} \PYG{o}{*} \PYG{o}{|} + \PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*} +\end{sphinxVerbatim} \end{fulllineitems} +\sphinxstepscope -\chapter{The ellipsoids Module} -\label{ellipsoids::doc}\label{ellipsoids:the-ellipsoids-module}\label{ellipsoids:module-rhealpix_dggs.ellipsoids}\index{rhealpix\_dggs.ellipsoids (module)} -This Python 3.3 code implements ellipsoids of revolution. -CHANGELOG: +\chapter{The ellipsoids Module} +\label{\detokenize{ellipsoids:module-rhealpixdggs.ellipsoids}}\label{\detokenize{ellipsoids:the-ellipsoids-module}}\label{\detokenize{ellipsoids::doc}}\index{module@\spxentry{module}!rhealpixdggs.ellipsoids@\spxentry{rhealpixdggs.ellipsoids}}\index{rhealpixdggs.ellipsoids@\spxentry{rhealpixdggs.ellipsoids}!module@\spxentry{module}} +\sphinxAtStartPar +This Python 3.11 code implements ellipsoids of revolution. \begin{itemize} \item {} -Alexander Raichev (AR), 2012-01-26: Refactored code from release 0.3. - -\item {} -AR, 2013-07-23: Ported to Python 3.3. +\sphinxAtStartPar +Alexander Raichev (AR), 2012\sphinxhyphen{}01\sphinxhyphen{}26: Refactored code from release 0.3. \end{itemize} +\sphinxAtStartPar NOTE: -All lengths are measured in meters and all angles are measured in radians +\sphinxAtStartPar +All lengths are measured in meters and all angles are measured in radians unless indicated otherwise. -By `ellipsoid' throughout, i mean an ellipsoid of revolution and \emph{not} a general (triaxial) ellipsoid. +\sphinxAtStartPar +By ‘ellipsoid’ throughout, I mean an ellipsoid of revolution and \sphinxstyleemphasis{not} a general (triaxial) ellipsoid. Points lying on an ellipsoid are given in geodetic (longitude, latitude) coordinates. -\index{Ellipsoid (class in rhealpix\_dggs.ellipsoids)} +\index{Ellipsoid (class in rhealpixdggs.ellipsoids)@\spxentry{Ellipsoid}\spxextra{class in rhealpixdggs.ellipsoids}} \begin{fulllineitems} -\phantomsection\label{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid}\pysiglinewithargsret{\strong{class }\code{rhealpix\_dggs.ellipsoids.}\bfcode{Ellipsoid}}{\emph{R=None}, \emph{a=6378137.0}, \emph{b=None}, \emph{e=None}, \emph{f=0.003352810681182319}, \emph{lon\_0=0}, \emph{lat\_0=0}, \emph{radians=False}}{} -Bases: \code{builtins.object} +\phantomsection\label{\detokenize{ellipsoids:rhealpixdggs.ellipsoids.Ellipsoid}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class\DUrole{w}{ }}}\sphinxcode{\sphinxupquote{rhealpixdggs.ellipsoids.}}\sphinxbfcode{\sphinxupquote{Ellipsoid}}}{\emph{\DUrole{n}{R}\DUrole{o}{=}\DUrole{default_value}{None}}, \emph{\DUrole{n}{a}\DUrole{o}{=}\DUrole{default_value}{6378137.0}}, \emph{\DUrole{n}{b}\DUrole{o}{=}\DUrole{default_value}{None}}, \emph{\DUrole{n}{e}\DUrole{o}{=}\DUrole{default_value}{None}}, \emph{\DUrole{n}{f}\DUrole{o}{=}\DUrole{default_value}{0.003352810681182319}}, \emph{\DUrole{n}{lon\_0}\DUrole{o}{=}\DUrole{default_value}{0}}, \emph{\DUrole{n}{lat\_0}\DUrole{o}{=}\DUrole{default_value}{0}}, \emph{\DUrole{n}{radians}\DUrole{o}{=}\DUrole{default_value}{False}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Bases: \sphinxcode{\sphinxupquote{object}} -Represents an ellipsoid of revolution (possibly a sphere) with a -geodetic longitude-latitude coordinate frame. +\sphinxAtStartPar +Represents an ellipsoid of revolution (possibly a sphere) with a +geodetic longitude\sphinxhyphen{}latitude coordinate frame. +\sphinxAtStartPar INSTANCE ATTRIBUTES: \begin{itemize} \item {} -\emph{sphere} - True if the ellipsoid is a sphere, and False otherwise. +\sphinxAtStartPar +\sphinxtitleref{sphere} \sphinxhyphen{} True if the ellipsoid is a sphere, and False otherwise. \item {} -\emph{R} - The radius of the ellipsoid in meters, implying that it is a +\sphinxAtStartPar +\sphinxtitleref{R} \sphinxhyphen{} The radius of the ellipsoid in meters, implying that it is a sphere. \item {} -\emph{a} - Major radius of the ellipsoid in meters. +\sphinxAtStartPar +\sphinxtitleref{a} \sphinxhyphen{} Major radius of the ellipsoid in meters. \item {} -\emph{b} - Minor radius of the ellipsoid in meters. +\sphinxAtStartPar +\sphinxtitleref{b} \sphinxhyphen{} Minor radius of the ellipsoid in meters. \item {} -\emph{e} - Eccentricity of the ellipsoid. +\sphinxAtStartPar +\sphinxtitleref{e} \sphinxhyphen{} Eccentricity of the ellipsoid. \item {} -\emph{f} - Flattening of the ellipsoid. +\sphinxAtStartPar +\sphinxtitleref{f} \sphinxhyphen{} Flattening of the ellipsoid. \item {} -\emph{R\_A} - Authalic radius of the ellipsoid in meters. +\sphinxAtStartPar +\sphinxtitleref{R\_A} \sphinxhyphen{} Authalic radius of the ellipsoid in meters. \item {} -\emph{lon\_0} - Central meridian. +\sphinxAtStartPar +\sphinxtitleref{lon\_0} \sphinxhyphen{} Central meridian. \item {} -\emph{lat\_0} - Latitude of origin. +\sphinxAtStartPar +\sphinxtitleref{lat\_0} \sphinxhyphen{} Latitude of origin. \item {} -\emph{radians} - If True, use angles measured in radians for all calculations. +\sphinxAtStartPar +\sphinxtitleref{radians} \sphinxhyphen{} If True, use angles measured in radians for all calculations. Use degrees otherwise. \item {} -\emph{phi\_0} - The latitude separating the equatorial region and +\sphinxAtStartPar +\sphinxtitleref{phi\_0} \sphinxhyphen{} The latitude separating the equatorial region and the north polar region in the context of the (r)HEALPix projection. \end{itemize} -Except for phi\_0, these attribute names match the names of the -\href{http://trac.osgeo.org/proj/wiki/GenParms}{PROJ.4 ellipsoid parameters}. -\index{Ellipsoid.get\_points() (in module rhealpix\_dggs.ellipsoids)} - -\begin{fulllineitems} -\phantomsection\label{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.get_points}\pysiglinewithargsret{\bfcode{get\_points}}{\emph{self}, \emph{filename}}{} -Return a list of longitude-latitude points contained in -the file with filename \emph{filename}. -Assume the file is a text file containing at most one -longitude-latitude point per line with the coordinates separated by +\sphinxAtStartPar +Except for phi\_0, these attribute names match the names of the +\sphinxhref{http://trac.osgeo.org/proj/wiki/GenParms}{PROJ.4 ellipsoid parameters}. +\index{get\_points() (rhealpixdggs.ellipsoids.Ellipsoid method)@\spxentry{get\_points()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{ellipsoids:rhealpixdggs.ellipsoids.Ellipsoid.get_points}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{get\_points}}}{\emph{\DUrole{n}{filename}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return a list of longitude\sphinxhyphen{}latitude points contained in +the file with filename \sphinxtitleref{filename}. +Assume the file is a text file containing at most one +longitude\sphinxhyphen{}latitude point per line with the coordinates separated by whitespace and angles given in degrees. \end{fulllineitems} -\index{Ellipsoid.graticule() (in module rhealpix\_dggs.ellipsoids)} +\index{graticule() (rhealpixdggs.ellipsoids.Ellipsoid method)@\spxentry{graticule()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}} \begin{fulllineitems} -\phantomsection\label{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.graticule}\pysiglinewithargsret{\bfcode{graticule}}{\emph{self}, \emph{n=400}, \emph{spacing=None}}{} -Return a list of longitude-latitude points sampled from a -longitude-latitude graticule on this ellipsoid with the given +\phantomsection\label{\detokenize{ellipsoids:rhealpixdggs.ellipsoids.Ellipsoid.graticule}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{graticule}}}{\emph{\DUrole{n}{n}\DUrole{o}{=}\DUrole{default_value}{400}}, \emph{\DUrole{n}{spacing}\DUrole{o}{=}\DUrole{default_value}{None}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return a list of longitude\sphinxhyphen{}latitude points sampled from a +longitude\sphinxhyphen{}latitude graticule on this ellipsoid with the given spacing between meridians and between parallels. -The number of points on longitude and latitude per pi radians is \emph{n}. +The number of points on longitude and latitude per pi radians is \sphinxtitleref{n}. The spacing should be specified in the angle units used for this ellipsoid. -If \emph{spacing=None}, then a default spacing of pi/16 radians will be set. +If \sphinxtitleref{spacing=None}, then a default spacing of pi/16 radians will be set. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}SPHERE} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n+nb}{len}\PYG{p}{(}\PYG{n}{E}\PYG{o}{.}\PYG{n}{graticule}\PYG{p}{(}\PYG{n}{n}\PYG{o}{=}\PYG{l+m+mi}{400}\PYG{p}{)}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n+nb}{len}\PYG{p}{(}\PYG{n}{E}\PYG{o}{.}\PYG{n}{graticule}\PYG{p}{(}\PYG{n}{n}\PYG{o}{=}\PYG{l+m+mi}{400}\PYG{p}{)}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{25600} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{Ellipsoid.lattice() (in module rhealpix\_dggs.ellipsoids)} +\index{lattice() (rhealpixdggs.ellipsoids.Ellipsoid method)@\spxentry{lattice()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}} \begin{fulllineitems} -\phantomsection\label{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.lattice}\pysiglinewithargsret{\bfcode{lattice}}{\emph{self}, \emph{n=90}}{} -Return a 2n x n square lattice of longitude-latitude points. +\phantomsection\label{\detokenize{ellipsoids:rhealpixdggs.ellipsoids.Ellipsoid.lattice}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{lattice}}}{\emph{\DUrole{n}{n}\DUrole{o}{=}\DUrole{default_value}{90}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return a 2n x n square lattice of longitude\sphinxhyphen{}latitude points. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}SPHERE} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{E}\PYG{o}{.}\PYG{n}{lattice}\PYG{p}{(}\PYG{n}{n}\PYG{o}{=}\PYG{l+m+mi}{3}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{p}\PYG{p}{)} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{p}\PYG{p}{)} \PYG{g+go}{(\PYGZhy{}150.0, \PYGZhy{}60.0)} \PYG{g+go}{(\PYGZhy{}150.0, 0.0)} \PYG{g+go}{(\PYGZhy{}150.0, 60.0)} @@ -1381,71 +1528,99 @@ \chapter{The ellipsoids Module} \PYG{g+go}{(150.0, \PYGZhy{}60.0)} \PYG{g+go}{(150.0, 0.0)} \PYG{g+go}{(150.0, 60.0)} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{Ellipsoid.meridian() (in module rhealpix\_dggs.ellipsoids)} +\index{meridian() (rhealpixdggs.ellipsoids.Ellipsoid method)@\spxentry{meridian()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}} \begin{fulllineitems} -\phantomsection\label{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.meridian}\pysiglinewithargsret{\bfcode{meridian}}{\emph{self}, \emph{lam}, \emph{n=200}}{} -Return a list of \emph{n} equispaced longitude-latitude -points lying along the meridian of longitude \emph{lam}. +\phantomsection\label{\detokenize{ellipsoids:rhealpixdggs.ellipsoids.Ellipsoid.meridian}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{meridian}}}{\emph{\DUrole{n}{lam}}, \emph{\DUrole{n}{n}\DUrole{o}{=}\DUrole{default_value}{200}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return a list of \sphinxtitleref{n} equispaced longitude\sphinxhyphen{}latitude +points lying along the meridian of longitude \sphinxtitleref{lam}. Avoid the poles. \end{fulllineitems} -\index{Ellipsoid.parallel() (in module rhealpix\_dggs.ellipsoids)} +\index{parallel() (rhealpixdggs.ellipsoids.Ellipsoid method)@\spxentry{parallel()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}} \begin{fulllineitems} -\phantomsection\label{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.parallel}\pysiglinewithargsret{\bfcode{parallel}}{\emph{self}, \emph{phi}, \emph{n=200}}{} -Return a list of \emph{2*n} equispaced longitude-latitude -points lying along the parallel of latitude \emph{phi}. +\phantomsection\label{\detokenize{ellipsoids:rhealpixdggs.ellipsoids.Ellipsoid.parallel}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{parallel}}}{\emph{\DUrole{n}{phi}}, \emph{\DUrole{n}{n}\DUrole{o}{=}\DUrole{default_value}{200}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return a list of \sphinxtitleref{2*n} equispaced longitude\sphinxhyphen{}latitude +points lying along the parallel of latitude \sphinxtitleref{phi}. \end{fulllineitems} -\index{Ellipsoid.pi() (in module rhealpix\_dggs.ellipsoids)} +\index{pi() (rhealpixdggs.ellipsoids.Ellipsoid method)@\spxentry{pi()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}} \begin{fulllineitems} -\phantomsection\label{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.pi}\pysiglinewithargsret{\bfcode{pi}}{\emph{self}}{} -Return pi if \emph{self.radians} = True and 180 otherwise. +\phantomsection\label{\detokenize{ellipsoids:rhealpixdggs.ellipsoids.Ellipsoid.pi}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{pi}}}{}{} +\pysigstopsignatures +\sphinxAtStartPar +Return pi if \sphinxtitleref{self.radians} = True and 180 otherwise. \end{fulllineitems} -\index{Ellipsoid.random\_point() (in module rhealpix\_dggs.ellipsoids)} +\index{random\_point() (rhealpixdggs.ellipsoids.Ellipsoid method)@\spxentry{random\_point()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}} \begin{fulllineitems} -\phantomsection\label{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.random_point}\pysiglinewithargsret{\bfcode{random\_point}}{\emph{self}, \emph{lam\_min=None}, \emph{lam\_max=None}, \emph{phi\_min=None}, \emph{phi\_max=None}}{} +\phantomsection\label{\detokenize{ellipsoids:rhealpixdggs.ellipsoids.Ellipsoid.random_point}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{random\_point}}}{\emph{\DUrole{n}{lam\_min}\DUrole{o}{=}\DUrole{default_value}{None}}, \emph{\DUrole{n}{lam\_max}\DUrole{o}{=}\DUrole{default_value}{None}}, \emph{\DUrole{n}{phi\_min}\DUrole{o}{=}\DUrole{default_value}{None}}, \emph{\DUrole{n}{phi\_max}\DUrole{o}{=}\DUrole{default_value}{None}}}{} +\pysigstopsignatures +\sphinxAtStartPar Return a point (given in geodetic coordinates) sampled uniformly at random from the section of this ellipsoid with longitude in the range -\emph{lam\_min \textless{}= lam \textless{} lam\_max} and latitude in the range -\emph{phi\_min \textless{}= phi \textless{} phi\_max}. +\sphinxtitleref{lam\_min \textless{}= lam \textless{} lam\_max} and latitude in the range +\sphinxtitleref{phi\_min \textless{}= phi \textless{} phi\_max}. But avoid the poles. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}SPHERE} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{E}\PYG{o}{.}\PYG{n}{random\PYGZus{}point}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{E}\PYG{o}{.}\PYG{n}{random\PYGZus{}point}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(\PYGZhy{}1.0999574573422948, 0.21029104897701129)} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{Ellipsoid.xyz() (in module rhealpix\_dggs.ellipsoids)} +\index{xyz() (rhealpixdggs.ellipsoids.Ellipsoid method)@\spxentry{xyz()}\spxextra{rhealpixdggs.ellipsoids.Ellipsoid method}} \begin{fulllineitems} -\phantomsection\label{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.xyz}\pysiglinewithargsret{\bfcode{xyz}}{\emph{self}, \emph{lam}, \emph{phi}}{} -Given a point on this ellipsoid with longitude-latitude coordinates -\emph{(lam, phi)}, return the point's 3D rectangular coordinates. +\phantomsection\label{\detokenize{ellipsoids:rhealpixdggs.ellipsoids.Ellipsoid.xyz}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{xyz}}}{\emph{\DUrole{n}{lam}}, \emph{\DUrole{n}{phi}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Given a point on this ellipsoid with longitude\sphinxhyphen{}latitude coordinates +\sphinxtitleref{(lam, phi)}, return the point’s 3D rectangular coordinates. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}SPHERE} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{E}\PYG{o}{.}\PYG{n}{xyz}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{45}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.70710678118654802, 0.0, 0.70710678118654802)} -\end{Verbatim} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{E}\PYG{o}{.}\PYG{n}{xyz}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{45}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(0.707106781186548, 0.0, 0.707106781186548)} +\end{sphinxVerbatim} +\begin{description} +\sphinxlineitem{NOTES:: .. Issue \#1 was ..} +\sphinxAtStartPar +(0.70710678118654802, 0.0, 0.70710678118654802) + +\end{description} \end{fulllineitems} @@ -1453,137 +1628,142 @@ \chapter{The ellipsoids Module} \end{fulllineitems} +\sphinxstepscope -\chapter{The projection\_wrapper Module} -\label{projection_wrapper::doc}\label{projection_wrapper:module-rhealpix_dggs.projection_wrapper}\label{projection_wrapper:the-projection-wrapper-module}\index{rhealpix\_dggs.projection\_wrapper (module)} -This Python 3.3 module implements a wrapper for map projections. -CHANGELOG: +\chapter{The projection\_wrapper Module} +\label{\detokenize{projection_wrapper:module-rhealpixdggs.projection_wrapper}}\label{\detokenize{projection_wrapper:the-projection-wrapper-module}}\label{\detokenize{projection_wrapper::doc}}\index{module@\spxentry{module}!rhealpixdggs.projection\_wrapper@\spxentry{rhealpixdggs.projection\_wrapper}}\index{rhealpixdggs.projection\_wrapper@\spxentry{rhealpixdggs.projection\_wrapper}!module@\spxentry{module}} +\sphinxAtStartPar +This Python 3.11 module implements a wrapper for map projections. \begin{itemize} \item {} -Alexander Raichev (AR), 2013-01-25: Refactored code from release 0.3. - -\item {} -AR, 2013-07-23: Ported to Python 3.3. +\sphinxAtStartPar +Alexander Raichev (AR), 2013\sphinxhyphen{}01\sphinxhyphen{}25: Refactored code from release 0.3. \end{itemize} +\sphinxAtStartPar NOTE: -All lengths are measured in meters and all angles are measured in radians -unless indicated otherwise. -By `ellipsoid' below, i mean an oblate ellipsoid of revolution. -\index{Proj (class in rhealpix\_dggs.projection\_wrapper)} +\sphinxAtStartPar +All lengths are measured in meters and all angles are measured in radians +unless indicated otherwise. +By ‘ellipsoid’ below, I mean an oblate ellipsoid of revolution. +\index{Projection (class in rhealpixdggs.projection\_wrapper)@\spxentry{Projection}\spxextra{class in rhealpixdggs.projection\_wrapper}} \begin{fulllineitems} -\phantomsection\label{projection_wrapper:rhealpix_dggs.projection_wrapper.Proj}\pysiglinewithargsret{\strong{class }\code{rhealpix\_dggs.projection\_wrapper.}\bfcode{Proj}}{\emph{ellipsoid=\textless{}rhealpix\_dggs.ellipsoids.Ellipsoid object at 0x10354a8d0\textgreater{}}, \emph{proj=None}, \emph{**kwargs}}{} -Bases: \code{builtins.object} +\phantomsection\label{\detokenize{projection_wrapper:rhealpixdggs.projection_wrapper.Projection}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class\DUrole{w}{ }}}\sphinxcode{\sphinxupquote{rhealpixdggs.projection\_wrapper.}}\sphinxbfcode{\sphinxupquote{Projection}}}{\emph{\DUrole{n}{ellipsoid=\textless{}rhealpixdggs.ellipsoids.Ellipsoid object\textgreater{}}}, \emph{\DUrole{n}{proj=None}}, \emph{\DUrole{n}{**kwargs}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Bases: \sphinxcode{\sphinxupquote{object}} +\sphinxAtStartPar Represents a map projection of a given ellipsoid. +\sphinxAtStartPar INSTANCE ATTRIBUTES: \begin{itemize} \item {} -\emph{ellipsoid} - An ellipsoid (Ellipsoid instance) to project. +\sphinxAtStartPar +\sphinxtitleref{ellipsoid} \sphinxhyphen{} An ellipsoid (Ellipsoid instance) to project. \item {} -\emph{proj} - The name (string) of the map projection, either a valid PROJ.4 +\sphinxAtStartPar +\sphinxtitleref{proj} \sphinxhyphen{} The name (string) of the map projection, either a valid PROJ.4 projection name or a valid homemade projection name. \item {} -\emph{kwargs} - Keyword arguments (dictionary) needed for the projection's -definition, but not for the definition of the ellipsoid. For example, -these could be \{`north\_square':1, `south\_square': 2\} for the rhealpix +\sphinxAtStartPar +\sphinxtitleref{kwargs} \sphinxhyphen{} Keyword arguments (dictionary) needed for the projection’s +definition, but not for the definition of the ellipsoid. For example, +these could be \{‘north\_square’:1, ‘south\_square’: 2\} for the rhealpix projection. \end{itemize} +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.ellipsoids} \PYG{k+kn}{import} \PYG{n}{WGS84\PYGZus{}ELLIPSOID} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{f} \PYG{o}{=} \PYG{n}{Proj}\PYG{p}{(}\PYG{n}{ellipsoid}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}ELLIPSOID}\PYG{p}{,} \PYG{n}{proj}\PYG{o}{=}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{rhealpix}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{n}{north\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{south\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{f}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{30}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpixdggs}\PYG{n+nn}{.}\PYG{n+nn}{ellipsoids} \PYG{k+kn}{import} \PYG{n}{WGS84\PYGZus{}ELLIPSOID} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{f} \PYG{o}{=} \PYG{n}{Projection}\PYG{p}{(}\PYG{n}{ellipsoid}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}ELLIPSOID}\PYG{p}{,} \PYG{n}{proj}\PYG{o}{=}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{rhealpix}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{n}{north\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{south\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{f}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{30}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(0.0, 3748655.1150495014)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{f} \PYG{o}{=} \PYG{n}{Proj}\PYG{p}{(}\PYG{n}{ellipsoid}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}ELLIPSOID}\PYG{p}{,} \PYG{n}{proj}\PYG{o}{=}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{cea}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{f}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{30}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.0, 3180183.485774971)} -\end{Verbatim} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{f} \PYG{o}{=} \PYG{n}{Projection}\PYG{p}{(}\PYG{n}{ellipsoid}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}ELLIPSOID}\PYG{p}{,} \PYG{n}{proj}\PYG{o}{=}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{cea}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{f}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{30}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(0.0, 3180183.4857749646)} +\end{sphinxVerbatim} +\begin{description} +\sphinxlineitem{NOTES:: .. Issue \#1 was !!! ..} +\sphinxAtStartPar +(0.0, 3180183.485774971) * +\end{description} + +\sphinxAtStartPar NOTES: +\sphinxAtStartPar When accessing a homemade map projection assume that it can be called via -a function g(a, e), where a is the major radius of the ellipsoid to be +a function g(a, e), where a is the major radius of the ellipsoid to be projected and e is its eccentricity. -The output of g should be a function object of the form +The output of g should be a function object of the form f(u, v, radians=False, inverse=False). -For example, see the healpix() function in \code{pj\_healpix.py}. +For example, see the healpix() function in \sphinxcode{\sphinxupquote{pj\_healpix.py}}. \end{fulllineitems} +\sphinxstepscope -\chapter{The dggs Module} -\label{dggs::doc}\label{dggs:module-rhealpix_dggs.dggs}\label{dggs:the-dggs-module}\index{rhealpix\_dggs.dggs (module)} -This Python 3.3 module implements the rHEALPix discrete global grid system. -CHANGELOG: +\chapter{The dggs Module} +\label{\detokenize{dggs:module-rhealpixdggs.dggs}}\label{\detokenize{dggs:the-dggs-module}}\label{\detokenize{dggs::doc}}\index{module@\spxentry{module}!rhealpixdggs.dggs@\spxentry{rhealpixdggs.dggs}}\index{rhealpixdggs.dggs@\spxentry{rhealpixdggs.dggs}!module@\spxentry{module}} +\sphinxAtStartPar +This Python 3.11 module implements the rHEALPix discrete global grid system. \begin{itemize} \item {} -Alexander Raichev (AR), 2012-11-12: Initial version based upon grids.py. - -\item {} -AR, 2012-12-10: Corrected centroid() and moved some methods from graphics.py to here. - -\item {} -AR, 2012-12-19: Tested all the methods and added examples. - -\item {} -AR, 2013-01-01: Added ellipsoidal functionality to neighbor() and neighbors(). - -\item {} -AR, 2013-01-14: Added intersects\_meridian(), cell\_latitudes(), cells\_from\_meridian(), cells\_from\_parallel(), cells\_from\_region(). - -\item {} -AR, 2013-01-16: Changed the string keyword `surface' to a boolean keyword `plane'. - -\item {} -AR, 2013-03-11: Added minimal\_cover(), boundary(), interior(), triangle(), nw\_vertex(). - -\item {} -AR, 2013-03-14: Fixed bug in nw\_vertex(). - -\item {} -AR, 2013-07-23: Ported to Python 3.3. +\sphinxAtStartPar +Alexander Raichev (AR), 2012\sphinxhyphen{}11\sphinxhyphen{}12: Initial version based upon grids.py. \end{itemize} +\sphinxAtStartPar NOTES: -All lengths are measured in meters and all angles are measured in radians +\sphinxAtStartPar +All lengths are measured in meters and all angles are measured in radians unless indicated otherwise. -By `ellipsoid' throughout, i mean an ellipsoid of revolution and \emph{not} a general (triaxial) ellipsoid. +\sphinxAtStartPar +By ‘ellipsoid’ throughout, I mean an ellipsoid of revolution and \sphinxstyleemphasis{not} a general (triaxial) ellipsoid. +\sphinxAtStartPar Points lying on the plane are given in rectangular (horizontal, vertical) coordinates, and points lying on the ellipsoid are given in geodetic (longitude, latitude) coordinates unless indicated otherwise. -DGGS abbreviates `discrete global grid system'. +\sphinxAtStartPar +DGGS abbreviates ‘discrete global grid system’. -Except when manipulating positive integers, I avoid the modulo function `\%' -and insted write everything in terms of `floor()'. -This is because Python interprets the sign of `\%' differently than -Java or C, and I don't want to confuse people who are translating this code +\sphinxAtStartPar +Except when manipulating positive integers, I avoid the modulo function ‘\%’ +and insted write everything in terms of ‘floor()’. +This is because Python interprets the sign of ‘\%’ differently than +Java or C, and I don’t want to confuse people who are translating this code to those languages. +\sphinxAtStartPar EXAMPLES: -Create the (1, 2)-rHEALPix DGGS with N\_side = 3 that is based on the WGS84 ellipsoid. Use degrees instead of the default radians for angular measurements +\sphinxAtStartPar +Create the (1, 2)\sphinxhyphen{}rHEALPix DGGS with N\_side = 3 that is based on the WGS84 ellipsoid. Use degrees instead of the default radians for angular measurements -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.ellipsoids} \PYG{k+kn}{import} \PYG{n}{WGS84\PYGZus{}ELLIPSOID} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpixdggs}\PYG{n+nn}{.}\PYG{n+nn}{ellipsoids} \PYG{k+kn}{import} \PYG{n}{WGS84\PYGZus{}ELLIPSOID} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}ELLIPSOID} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{n}{ellipsoid}\PYG{o}{=}\PYG{n}{E}\PYG{p}{,} \PYG{n}{north\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{south\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{N\PYGZus{}side}\PYG{o}{=}\PYG{l+m+mi}{3}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{)} \PYG{g+go}{rHEALPix DGGS:} \PYG{g+go}{ N\PYGZus{}side = 3} \PYG{g+go}{ north\PYGZus{}square = 1} @@ -1591,88 +1771,124 @@ \chapter{The dggs Module} \PYG{g+go}{ max\PYGZus{}areal\PYGZus{}resolution = 1} \PYG{g+go}{ max\PYGZus{}resolution = 15} \PYG{g+go}{ ellipsoid:} -\PYG{g+go}{ R\PYGZus{}A = 6374581.4671} +\PYG{g+go}{ R\PYGZus{}A = 6374581.467096525} \PYG{g+go}{ a = 6378137.0} \PYG{g+go}{ b = 6356752.314140356} -\PYG{g+go}{ e = 0.0578063088401} +\PYG{g+go}{ e = 0.0578063088401125} \PYG{g+go}{ f = 0.003352810681182319} \PYG{g+go}{ lat\PYGZus{}0 = 0} \PYG{g+go}{ lon\PYGZus{}0 = 0} \PYG{g+go}{ radians = False} \PYG{g+go}{ sphere = False} -\end{Verbatim} +\end{sphinxVerbatim} +\begin{description} +\sphinxlineitem{NOTES:: .. Issue \#1 was ..}\begin{description} +\sphinxlineitem{ellipsoid:} +\sphinxAtStartPar +R\_A = 6374581.4671 * +a = 6378137.0 +b = 6356752.314140356 * +e = 0.0578063088401 +f = 0.003352810681182319 + +\end{description} -Pick a (longitude-latitude) point on the ellipsoid and find the resolution 1 cell that contains it +\end{description} -\begin{Verbatim}[commandchars=\\\{\}] +\sphinxAtStartPar +Pick a (longitude\sphinxhyphen{}latitude) point on the ellipsoid and find the resolution 1 cell that contains it + +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{45}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}from\PYGZus{}point}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{p}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{;} \PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}from\PYGZus{}point}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{p}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)}\PYG{p}{;} \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} \PYG{g+go}{N8} -\end{Verbatim} +\end{sphinxVerbatim} +\sphinxAtStartPar Find the ellipsoidal (edge) neighbors of this cell -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} \PYG{o+ow}{in} \PYG{n+nb}{sorted}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{neighbors}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{o}{.}\PYG{n}{items}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} \PYG{o+ow}{in} \PYG{n+nb}{sorted}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{neighbors}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)}\PYG{o}{.}\PYG{n}{items}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)}\PYG{p}{:} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} \PYG{g+go}{east N5} \PYG{g+go}{south\PYGZus{}east Q0} \PYG{g+go}{south\PYGZus{}west P2} \PYG{g+go}{west N7} -\end{Verbatim} +\end{sphinxVerbatim} +\sphinxAtStartPar Find the planar (edge) neighbors of this cell -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} \PYG{o+ow}{in} \PYG{n+nb}{sorted}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{neighbors}\PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{plane}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)}\PYG{o}{.}\PYG{n}{items}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} \PYG{o+ow}{in} \PYG{n+nb}{sorted}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{neighbors}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{plane}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}\PYG{o}{.}\PYG{n}{items}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)}\PYG{p}{:} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} \PYG{g+go}{down P2} \PYG{g+go}{left N7} \PYG{g+go}{right Q0} \PYG{g+go}{up N5} -\end{Verbatim} +\end{sphinxVerbatim} -Find all the resolution 1 cells intersecting the longitude-latitude aligned ellipsoidal quadrangle with given northwest and southeast corners +\sphinxAtStartPar +Find all the resolution 1 cells intersecting the longitude\sphinxhyphen{}latitude aligned ellipsoidal quadrangle with given northwest and southeast corners -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{nw} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{45}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{se} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{90}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{cells} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}region}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{nw}\PYG{p}{,} \PYG{n}{se}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{cells} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}region}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{nw}\PYG{p}{,} \PYG{n}{se}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{row} \PYG{o+ow}{in} \PYG{n}{cells}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{]}\PYG{p}{)} \PYG{g+go}{[\PYGZsq{}N8\PYGZsq{}, \PYGZsq{}N5\PYGZsq{}, \PYGZsq{}N2\PYGZsq{}]} \PYG{g+go}{[\PYGZsq{}Q0\PYGZsq{}, \PYGZsq{}Q1\PYGZsq{}, \PYGZsq{}Q2\PYGZsq{}, \PYGZsq{}R0\PYGZsq{}]} \PYG{g+go}{[\PYGZsq{}Q3\PYGZsq{}, \PYGZsq{}Q4\PYGZsq{}, \PYGZsq{}Q5\PYGZsq{}, \PYGZsq{}R3\PYGZsq{}]} -\end{Verbatim} +\end{sphinxVerbatim} +\sphinxAtStartPar Compute the ellipsoidal nuclei of these cells -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{row} \PYG{o+ow}{in} \PYG{n}{cells}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{,} \PYG{n}{cell}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{N8 (0.0, 58.470677829627363)} -\PYG{g+go}{N5 (45.000000000000036, 58.470677829627363)} -\PYG{g+go}{N2 (90.000000000000028, 58.470677829627355)} -\PYG{g+go}{Q0 (14.999999999999998, 26.438744923100096)} -\PYG{g+go}{Q1 (45.0, 26.438744923100096)} -\PYG{g+go}{Q2 (74.999999999999986, 26.438744923100096)} -\PYG{g+go}{R0 (105.00000000000001, 26.438744923100096)} -\PYG{g+go}{Q3 (14.999999999999998, 3.560649871414923e\PYGZhy{}15)} -\PYG{g+go}{Q4 (45.0, 3.560649871414923e\PYGZhy{}15)} -\PYG{g+go}{Q5 (74.999999999999986, 3.560649871414923e\PYGZhy{}15)} -\PYG{g+go}{R3 (105.00000000000001, 3.560649871414923e\PYGZhy{}15)} -\end{Verbatim} - -Create the (0, 0)-rHEALPix DGGS with N\_side = 3 that is based on the WGS84 ellipsoid. Use degrees instead of the default radians for angular measurements -and orient the DGGS so that the planar origin (0, 0) is on Auckland, New Zealand - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{174}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{37}\PYG{p}{)} \PYG{c}{\PYGZsh{} Approximate Auckland lon\PYGZhy{}lat coordinates} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.ellipsoids} \PYG{k+kn}{import} \PYG{o}{*} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{Ellipsoid}\PYG{p}{(}\PYG{n}{a}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}A}\PYG{p}{,} \PYG{n}{f}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}F}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{,} \PYG{n}{lon\PYGZus{}0}\PYG{o}{=}\PYG{n}{p}\PYG{p}{[}\PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{,} \PYG{n}{lat\PYGZus{}0}\PYG{o}{=}\PYG{n}{p}\PYG{p}{[}\PYG{l+m+mi}{1}\PYG{p}{]}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{expected\PYGZus{}results} \PYG{o}{=} \PYG{p}{[} +\PYG{g+gp}{... } \PYG{p}{[} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{0.0}\PYG{p}{,} \PYG{l+m+mf}{58.47067782962736}\PYG{p}{)}\PYG{p}{,} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{45.000000000000036}\PYG{p}{,} \PYG{l+m+mf}{58.47067782962734}\PYG{p}{)}\PYG{p}{,} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{89.99999999999996}\PYG{p}{,} \PYG{l+m+mf}{58.47067782962736}\PYG{p}{)} +\PYG{g+gp}{... } \PYG{p}{]}\PYG{p}{,} \PYG{p}{[} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{14.999999999999998}\PYG{p}{,} \PYG{l+m+mf}{26.438744923100096}\PYG{p}{)}\PYG{p}{,} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{45.0}\PYG{p}{,} \PYG{l+m+mf}{26.438744923100096}\PYG{p}{)}\PYG{p}{,} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{74.99999999999999}\PYG{p}{,} \PYG{l+m+mf}{26.438744923100096}\PYG{p}{)}\PYG{p}{,} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{105.00000000000001}\PYG{p}{,} \PYG{l+m+mf}{26.438744923100096}\PYG{p}{)} +\PYG{g+gp}{... } \PYG{p}{]}\PYG{p}{,} \PYG{p}{[} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{14.999999999999998}\PYG{p}{,} \PYG{l+m+mf}{3.560649871414923e\PYGZhy{}15}\PYG{p}{)}\PYG{p}{,} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{45.0}\PYG{p}{,} \PYG{l+m+mf}{3.560649871414923e\PYGZhy{}15}\PYG{p}{)}\PYG{p}{,} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{74.99999999999999}\PYG{p}{,} \PYG{l+m+mf}{3.560649871414923e\PYGZhy{}15}\PYG{p}{)}\PYG{p}{,} +\PYG{g+gp}{... } \PYG{p}{(}\PYG{l+m+mf}{105.00000000000001}\PYG{p}{,} \PYG{l+m+mf}{3.560649871414923e\PYGZhy{}15}\PYG{p}{)} +\PYG{g+gp}{... } \PYG{p}{]}\PYG{p}{]} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{i}\PYG{p}{,} \PYG{n}{row} \PYG{o+ow}{in} \PYG{n+nb}{enumerate}\PYG{p}{(}\PYG{n}{cells}\PYG{p}{)}\PYG{p}{:} +\PYG{g+gp}{... } \PYG{k}{for} \PYG{n}{j}\PYG{p}{,} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n+nb}{enumerate}\PYG{p}{(}\PYG{n}{row}\PYG{p}{)}\PYG{p}{:} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{,} \PYG{n}{assert\PYGZus{}allclose}\PYG{p}{(}\PYG{n}{cell}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)}\PYG{p}{,} \PYG{n}{expected\PYGZus{}results}\PYG{p}{[}\PYG{n}{i}\PYG{p}{]}\PYG{p}{[}\PYG{n}{j}\PYG{p}{]}\PYG{p}{,} \PYG{n}{rtol}\PYG{o}{=}\PYG{l+m+mf}{1e\PYGZhy{}15}\PYG{p}{,} \PYG{n}{atol}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{)} \PYG{o}{==} \PYG{k+kc}{None}\PYG{p}{)} +\PYG{g+go}{N8 True} +\PYG{g+go}{N5 True} +\PYG{g+go}{N2 True} +\PYG{g+go}{Q0 True} +\PYG{g+go}{Q1 True} +\PYG{g+go}{Q2 True} +\PYG{g+go}{R0 True} +\PYG{g+go}{Q3 True} +\PYG{g+go}{Q4 True} +\PYG{g+go}{Q5 True} +\PYG{g+go}{R3 True} +\end{sphinxVerbatim} + +\sphinxAtStartPar +Create a (0, 0)\sphinxhyphen{}rHEALPix DGGS with N\_side = 3 based on the WGS84 ellipsoid. +Use degrees instead of the default radians for angular measurements and +orient the DGGS so that the planar origin (0, 0) is on Auckland, New Zealand + +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{174}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{37}\PYG{p}{)} \PYG{c+c1}{\PYGZsh{} Approximate Auckland lon\PYGZhy{}lat coordinates} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpixdggs}\PYG{n+nn}{.}\PYG{n+nn}{ellipsoids} \PYG{k+kn}{import} \PYG{o}{*} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{Ellipsoid}\PYG{p}{(}\PYG{n}{a}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}A}\PYG{p}{,} \PYG{n}{f}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}F}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{,} \PYG{n}{lon\PYGZus{}0}\PYG{o}{=}\PYG{n}{p}\PYG{p}{[}\PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{,} \PYG{n}{lat\PYGZus{}0}\PYG{o}{=}\PYG{n}{p}\PYG{p}{[}\PYG{l+m+mi}{1}\PYG{p}{]}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{n}{E}\PYG{p}{,} \PYG{n}{N\PYGZus{}side}\PYG{o}{=}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{n}{north\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{south\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{)} \PYG{g+go}{rHEALPix DGGS:} \PYG{g+go}{ N\PYGZus{}side = 3} \PYG{g+go}{ north\PYGZus{}square = 0} @@ -1680,1673 +1896,1956 @@ \chapter{The dggs Module} \PYG{g+go}{ max\PYGZus{}areal\PYGZus{}resolution = 1} \PYG{g+go}{ max\PYGZus{}resolution = 15} \PYG{g+go}{ ellipsoid:} -\PYG{g+go}{ R\PYGZus{}A = 6374581.4671} +\PYG{g+go}{ R\PYGZus{}A = 6374581.467096525} \PYG{g+go}{ a = 6378137.0} \PYG{g+go}{ b = 6356752.314140356} -\PYG{g+go}{ e = 0.0578063088401} +\PYG{g+go}{ e = 0.0578063088401125} \PYG{g+go}{ f = 0.003352810681182319} \PYG{g+go}{ lat\PYGZus{}0 = \PYGZhy{}37} \PYG{g+go}{ lon\PYGZus{}0 = 174} \PYG{g+go}{ radians = False} \PYG{g+go}{ sphere = False} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}from\PYGZus{}point}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{p}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{)} +\end{sphinxVerbatim} +\begin{description} +\sphinxlineitem{NOTES:: .. Issue \#1 was ..}\begin{quote} +\begin{description} +\sphinxlineitem{ellipsoid:} +\sphinxAtStartPar +R\_A = 6374581.4671 * +a = 6378137.0 +b = 6356752.314140356 +e = 0.0578063088401 * +f = 0.003352810681182319 + +\end{description} +\end{quote} + +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}from\PYGZus{}point}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{p}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{Q3} -\end{Verbatim} -\index{Cell (class in rhealpix\_dggs.dggs)} +\end{sphinxVerbatim} + +\end{description} +\index{Cell (class in rhealpixdggs.dggs)@\spxentry{Cell}\spxextra{class in rhealpixdggs.dggs}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell}\pysiglinewithargsret{\strong{class }\code{rhealpix\_dggs.dggs.}\bfcode{Cell}}{\emph{rdggs=\textless{}rhealpix\_dggs.dggs.RHEALPixDGGS object at 0x10354aad0\textgreater{}}, \emph{suid=None}, \emph{level\_order\_index=None}, \emph{post\_order\_index=None}}{} -Bases: \code{builtins.object} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class\DUrole{w}{ }}}\sphinxcode{\sphinxupquote{rhealpixdggs.dggs.}}\sphinxbfcode{\sphinxupquote{Cell}}}{\emph{\DUrole{n}{rdggs=\textless{}rhealpixdggs.dggs.RHEALPixDGGS object\textgreater{}}}, \emph{\DUrole{n}{suid=None}}, \emph{\DUrole{n}{level\_order\_index=None}}, \emph{\DUrole{n}{post\_order\_index=None}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Bases: \sphinxcode{\sphinxupquote{object}} +\sphinxAtStartPar Represents a cell of the planar or ellipsoidal rHEALPix grid hierarchies. -Cell identifiers are of the form (p\_0, p\_1,...,p\_l), where p\_0 is one of -the characters `A', `B', `C', `D', `E', `F' and p\_i for i \textgreater{} 0 is one of -the integers 0, 1,..., N\_side**2 - 1, where N\_side is the instance -attribute from RHEALPixDGGS (the number of children cells along a cell's +Cell identifiers are of the form (p\_0, p\_1,…,p\_l), where p\_0 is one of +the characters ‘A’, ‘B’, ‘C’, ‘D’, ‘E’, ‘F’ and p\_i for i \textgreater{} 0 is one of +the integers 0, 1,…, N\_side**2 \sphinxhyphen{} 1, where N\_side is the instance +attribute from RHEALPixDGGS (the number of children cells along a cell’s side). +\sphinxAtStartPar INSTANCE ATTRIBUTES: \begin{itemize} \item {} -\emph{rdggs} - The DGGS that the cell comes from. +\sphinxAtStartPar +\sphinxtitleref{rdggs} \sphinxhyphen{} The DGGS that the cell comes from. \item {} -\emph{ellipsoid} - The underlying ellipsoid of the DGGS. +\sphinxAtStartPar +\sphinxtitleref{ellipsoid} \sphinxhyphen{} The underlying ellipsoid of the DGGS. \item {} -\emph{N\_side} - The N\_side attribute of the DGGS +\sphinxAtStartPar +\sphinxtitleref{N\_side} \sphinxhyphen{} The N\_side attribute of the DGGS \item {} -\emph{suid} - The cell's ID (tuple). SUID = spatially unique identifier. -(`id' is a reserved word in Python) +\sphinxAtStartPar +\sphinxtitleref{suid} \sphinxhyphen{} The cell’s ID (tuple). SUID = spatially unique identifier. +(‘id’ is a reserved word in Python) \item {} -\emph{resolution} - The cell's resolution (nonnegative integer). +\sphinxAtStartPar +\sphinxtitleref{resolution} \sphinxhyphen{} The cell’s resolution (nonnegative integer). \end{itemize} +\sphinxAtStartPar NOTE: -Several Cell methods have the keyword argument `plane'. -Setting it to True indicates that all input and output points and cells are +\sphinxAtStartPar +Several Cell methods have the keyword argument ‘plane’. +Setting it to True indicates that all input and output points and cells are to be interpreted as lying in the planar DGGS. -Setting it to False indicates that they are to be interpreted as lying in +Setting it to False indicates that they are to be interpreted as lying in the ellipsoidal DGGS. -\index{Cell.area() (in module rhealpix\_dggs.dggs)} +\index{area() (rhealpixdggs.dggs.Cell method)@\spxentry{area()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.area}\pysiglinewithargsret{\bfcode{area}}{\emph{self}, \emph{plane=True}}{} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.area}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{area}}}{\emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}}{} +\pysigstopsignatures +\sphinxAtStartPar Return the area of this cell. \end{fulllineitems} -\index{Cell.boundary() (in module rhealpix\_dggs.dggs)} +\index{boundary() (rhealpixdggs.dggs.Cell method)@\spxentry{boundary()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.boundary}\pysiglinewithargsret{\bfcode{boundary}}{\emph{self}, \emph{n=2}, \emph{plane=True}, \emph{interior=False}}{} -Return a list of \emph{4*n - 4} boundary points of this cell, -\emph{n} on each edge, where \emph{n} \textgreater{}= 2. -List the points in clockwise order starting from the cell's upper left -corner if \emph{plane} = True, or from the cell's northwest corner -if \emph{plane} = False. +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.boundary}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{boundary}}}{\emph{\DUrole{n}{n}\DUrole{o}{=}\DUrole{default_value}{2}}, \emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}, \emph{\DUrole{n}{interior}\DUrole{o}{=}\DUrole{default_value}{False}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return a list of \sphinxtitleref{4*n \sphinxhyphen{} 4} boundary points of this cell, +\sphinxtitleref{n} on each edge, where \sphinxtitleref{n} \textgreater{}= 2. +List the points in clockwise order starting from the cell’s upper left +corner if \sphinxtitleref{plane} = True, or from the cell’s northwest corner +if \sphinxtitleref{plane} = False. -If \emph{n} = 2, then the output is the same as vertices(). -If \emph{interior} = True, then push the boundary points slighly into the +\sphinxAtStartPar +If \sphinxtitleref{n} = 2, then the output is the same as vertices(). +If \sphinxtitleref{interior} = True, then push the boundary points slighly into the interior of the cell, which is convenient for some graphics methods. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c}\PYG{o}{.}\PYG{n}{boundary}\PYG{p}{(}\PYG{n}{n}\PYG{o}{=}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)} \PYG{o}{==} \PYG{n}{c}\PYG{o}{.}\PYG{n}{vertices}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c}\PYG{o}{.}\PYG{n}{boundary}\PYG{p}{(}\PYG{n}{n}\PYG{o}{=}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)} \PYG{o}{==} \PYG{n}{c}\PYG{o}{.}\PYG{n}{vertices}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)} \PYG{g+go}{True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{boundary}\PYG{p}{(}\PYG{n}{n}\PYG{o}{=}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}3.14159265358979, 1.3089969389957501)} -\PYG{g+go}{(\PYGZhy{}2.87979326579064, 1.3089969389957501)} -\PYG{g+go}{(\PYGZhy{}2.61799387799149, 1.3089969389957501)} -\PYG{g+go}{(\PYGZhy{}2.61799387799149, 1.0471975511966001)} -\PYG{g+go}{(\PYGZhy{}2.61799387799149, 0.78539816339745006)} -\PYG{g+go}{(\PYGZhy{}2.87979326579064, 0.78539816339745006)} -\PYG{g+go}{(\PYGZhy{}3.14159265358979, 0.78539816339745006)} -\PYG{g+go}{(\PYGZhy{}3.14159265358979, 1.0471975511966001)} - -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{boundary}\PYG{p}{(}\PYG{n}{n}\PYG{o}{=}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{boundary}\PYG{p}{(}\PYG{n}{n}\PYG{o}{=}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{:} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(\PYGZhy{}3.14159265358979, 1.30899693899575)} +\PYG{g+go}{(\PYGZhy{}2.87979326579064, 1.30899693899575)} +\PYG{g+go}{(\PYGZhy{}2.61799387799149, 1.30899693899575)} +\PYG{g+go}{(\PYGZhy{}2.61799387799149, 1.0471975511966)} +\PYG{g+go}{(\PYGZhy{}2.61799387799149, 0.78539816339745)} +\PYG{g+go}{(\PYGZhy{}2.87979326579064, 0.78539816339745)} +\PYG{g+go}{(\PYGZhy{}3.14159265358979, 0.78539816339745)} +\PYG{g+go}{(\PYGZhy{}3.14159265358979, 1.0471975511966)} +\end{sphinxVerbatim} +\begin{description} +\sphinxlineitem{NOTES:: .. Issue \#1 was ..} +\sphinxAtStartPar +(\sphinxhyphen{}3.14159265358979, 1.3089969389957501) * +(\sphinxhyphen{}2.87979326579064, 1.3089969389957501) * +(\sphinxhyphen{}2.61799387799149, 1.3089969389957501) * +(\sphinxhyphen{}2.61799387799149, 1.0471975511966001) * +(\sphinxhyphen{}2.61799387799149, 0.78539816339745006) * +(\sphinxhyphen{}2.87979326579064, 0.78539816339745006) * +(\sphinxhyphen{}3.14159265358979, 0.78539816339745006) * +(\sphinxhyphen{}3.14159265358979, 1.0471975511966001) * + +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{boundary}\PYG{p}{(}\PYG{n}{n}\PYG{o}{=}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)}\PYG{p}{:} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(\PYGZhy{}180.0, 74.35752898700072)} -\PYG{g+go}{(\PYGZhy{}157.50000000000003, 58.413661903472082)} -\PYG{g+go}{(\PYGZhy{}150.0, 41.810314895778603)} -\PYG{g+go}{(\PYGZhy{}165.00000000000003, 41.810314895778603)} -\PYG{g+go}{(\PYGZhy{}180.0, 41.810314895778603)} -\PYG{g+go}{(165.0, 41.810314895778603)} -\PYG{g+go}{(149.99999999999997, 41.810314895778603)} -\PYG{g+go}{(157.49999999999997, 58.413661903472082)} -\end{Verbatim} +\PYG{g+go}{(\PYGZhy{}157.50000000000003, 58.41366190347208)} +\PYG{g+go}{(\PYGZhy{}150.0, 41.8103148957786)} +\PYG{g+go}{(\PYGZhy{}165.00000000000003, 41.8103148957786)} +\PYG{g+go}{(\PYGZhy{}180.0, 41.8103148957786)} +\PYG{g+go}{(165.0, 41.8103148957786)} +\PYG{g+go}{(149.99999999999997, 41.8103148957786)} +\PYG{g+go}{(157.49999999999997, 58.41366190347208)} +\end{sphinxVerbatim} + +\sphinxlineitem{NOTES:: .. Issue \#1 was ..} +\sphinxAtStartPar +(\sphinxhyphen{}180.0, 74.35752898700072) +(\sphinxhyphen{}157.50000000000003, 58.413661903472082) * +(\sphinxhyphen{}150.0, 41.810314895778603) * +(\sphinxhyphen{}165.00000000000003, 41.810314895778603) * +(\sphinxhyphen{}180.0, 41.810314895778603) * +(165.0, 41.810314895778603) * +(149.99999999999997, 41.810314895778603) * +(157.49999999999997, 58.413661903472082) * + +\end{description} \end{fulllineitems} -\index{Cell.centroid() (in module rhealpix\_dggs.dggs)} +\index{centroid() (rhealpixdggs.dggs.Cell method)@\spxentry{centroid()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.centroid}\pysiglinewithargsret{\bfcode{centroid}}{\emph{self}, \emph{plane=True}}{} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.centroid}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{centroid}}}{\emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}}{} +\pysigstopsignatures +\sphinxAtStartPar Return the centroid of this planar or ellipsoidal cell. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{P}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{P}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{centroid} \PYG{o}{=} \PYG{n}{c}\PYG{o}{.}\PYG{n}{centroid}\PYG{p}{(}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{nucleus} \PYG{o}{=} \PYG{n}{c}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{centroid} \PYG{o}{==} \PYG{n}{nucleus}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{centroid} \PYG{o}{==} \PYG{n}{nucleus}\PYG{p}{)} \PYG{g+go}{True} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{Cell.color() (in module rhealpix\_dggs.dggs)} +\index{color() (rhealpixdggs.dggs.Cell method)@\spxentry{color()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.color}\pysiglinewithargsret{\bfcode{color}}{\emph{self}, \emph{saturation=0.5}}{} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.color}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{color}}}{\emph{\DUrole{n}{saturation}\DUrole{o}{=}\DUrole{default_value}{0.5}}}{} +\pysigstopsignatures +\sphinxAtStartPar Return a unique RGB color tuple for this cell. Inessential graphics method. \end{fulllineitems} -\index{Cell.contains() (in module rhealpix\_dggs.dggs)} +\index{contains() (rhealpixdggs.dggs.Cell method)@\spxentry{contains()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.contains}\pysiglinewithargsret{\bfcode{contains}}{\emph{self}, \emph{p}, \emph{plane=True}}{} -Return True if this cell contains point \emph{p}, and return False +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.contains}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{contains}}}{\emph{\DUrole{n}{p}}, \emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return True if this cell contains point \sphinxtitleref{p}, and return False otherwise. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}003\PYGZus{}RADIANS} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}from\PYGZus{}point}\PYG{p}{(}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{p}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}from\PYGZus{}point}\PYG{p}{(}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{p}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} \PYG{g+go}{Q44} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{contains}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{contains}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{True} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{Cell.ellipsoidal\_shape() (in module rhealpix\_dggs.dggs)} +\index{ellipsoidal\_shape() (rhealpixdggs.dggs.Cell method)@\spxentry{ellipsoidal\_shape()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.ellipsoidal_shape}\pysiglinewithargsret{\bfcode{ellipsoidal\_shape}}{\emph{self}}{} -Return the shape of this cell (`quad', `cap', `dart', or -`skew\_quad') when viewed on the ellipsoid. +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.ellipsoidal_shape}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{ellipsoidal\_shape}}}{}{} +\pysigstopsignatures +\sphinxAtStartPar +Return the shape of this cell (‘quad’, ‘cap’, ‘dart’, or +‘skew\_quad’) when viewed on the ellipsoid. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{P}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)}\PYG{o}{.}\PYG{n}{ellipsoidal\PYGZus{}shape}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{P}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)}\PYG{o}{.}\PYG{n}{ellipsoidal\PYGZus{}shape}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{quad} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)}\PYG{o}{.}\PYG{n}{ellipsoidal\PYGZus{}shape}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)}\PYG{o}{.}\PYG{n}{ellipsoidal\PYGZus{}shape}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{dart} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{Cell.index() (in module rhealpix\_dggs.dggs)} +\index{index() (rhealpixdggs.dggs.Cell method)@\spxentry{index()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.index}\pysiglinewithargsret{\bfcode{index}}{\emph{self}, \emph{order='resolution'}}{} -Return the index of \emph{self} when it's ordered according to \emph{order}. -Here \emph{order} can be `resolution' (default) or `post'. +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.index}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{index}}}{\emph{\DUrole{n}{order}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}resolution\textquotesingle{}}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return the index of \sphinxtitleref{self} when it’s ordered according to \sphinxtitleref{order}. +Here \sphinxtitleref{order} can be ‘resolution’ (default) or ‘post’. Indices start at 0. The empty cell has index None. -The ordering comes from the way of traversing the tree T +\sphinxAtStartPar +The ordering comes from the way of traversing the tree T of all cells defined as follows. -The root of T is a non-cell place holder. -The children of the root are the cells A \textless{} B \textless{} ... \textless{} F. -The children of a cell in T with suid s are s0 \textless{} s1 \textless{} ... \textless{} sn, +The root of T is a non\sphinxhyphen{}cell place holder. +The children of the root are the cells A \textless{} B \textless{} … \textless{} F. +The children of a cell in T with suid s are s0 \textless{} s1 \textless{} … \textless{} sn, where n = self.N\_side**2. -The level order index of a nonempty cell is its position +\sphinxAtStartPar +The level order index of a nonempty cell is its position (starting from 0) in the level order traversal of T starting at cell A. -The post order index of a nonempty cell is its position +\sphinxAtStartPar +The post order index of a nonempty cell is its position (starting from 0) in the post order traversal of T. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{index}\PYG{p}{(}\PYG{n}{order}\PYG{o}{=}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{resolution}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{index}\PYG{p}{(}\PYG{n}{order}\PYG{o}{=}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{resolution}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{8} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{index}\PYG{p}{(}\PYG{n}{order}\PYG{o}{=}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{post}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{index}\PYG{p}{(}\PYG{n}{order}\PYG{o}{=}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{post}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{2} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{Cell.interior() (in module rhealpix\_dggs.dggs)} +\index{interior() (rhealpixdggs.dggs.Cell method)@\spxentry{interior()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.interior}\pysiglinewithargsret{\bfcode{interior}}{\emph{self}, \emph{n=2}, \emph{plane=True}, \emph{flatten=False}}{} -Return an \emph{n} x \emph{n} matrix of interior points of this cell. +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.interior}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{interior}}}{\emph{\DUrole{n}{n}\DUrole{o}{=}\DUrole{default_value}{2}}, \emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}, \emph{\DUrole{n}{flatten}\DUrole{o}{=}\DUrole{default_value}{False}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return an \sphinxtitleref{n} x \sphinxtitleref{n} matrix of interior points of this cell. If the cell is planar, space the interior points on a regular square grid. -List the points in standard, row-major matrix order. +List the points in standard, row\sphinxhyphen{}major matrix order. If the cell is ellipsoidal, project the matrix of points to the -ellipsoid (longitude-latitude points). -If \emph{flatten} = True, then flatten the matrix into a one dimensional +ellipsoid (longitude\sphinxhyphen{}latitude points). +If \sphinxtitleref{flatten} = True, then flatten the matrix into a one dimensional array of pairs. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{interior}\PYG{p}{(}\PYG{n}{n}\PYG{o}{=}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{,} \PYG{n}{flatten}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(90.0, 41.810380145353903)} -\PYG{g+go}{(\PYGZhy{}180.0, 41.810380145353903)} -\PYG{g+go}{(\PYGZhy{}1e\PYGZhy{}14, 41.810380145353903)} -\PYG{g+go}{(\PYGZhy{}90.0, 41.810380145353903)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{all}\PYG{p}{(}\PYG{p}{[}\PYG{n}{c}\PYG{o}{.}\PYG{n}{contains}\PYG{p}{(}\PYG{n}{p}\PYG{p}{)} \PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{interior}\PYG{p}{(}\PYG{n}{n}\PYG{o}{=}\PYG{l+m+mi}{5}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{,} \PYG{n}{flatten}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{interior}\PYG{p}{(}\PYG{n}{n}\PYG{o}{=}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{,} \PYG{n}{flatten}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{:} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{13}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(90.0, 41.8103801453539)} +\PYG{g+go}{(\PYGZhy{}180.0, 41.8103801453539)} +\PYG{g+go}{(\PYGZhy{}0.0, 41.8103801453539)} +\PYG{g+go}{(\PYGZhy{}90.0, 41.8103801453539)} + +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{all}\PYG{p}{(}\PYG{p}{[}\PYG{n}{c}\PYG{o}{.}\PYG{n}{contains}\PYG{p}{(}\PYG{n}{p}\PYG{p}{)} \PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{interior}\PYG{p}{(}\PYG{n}{n}\PYG{o}{=}\PYG{l+m+mi}{5}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{,} \PYG{n}{flatten}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{]}\PYG{p}{)} \PYG{g+go}{True} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{Cell.intersects\_meridian() (in module rhealpix\_dggs.dggs)} +\index{intersects\_meridian() (rhealpixdggs.dggs.Cell method)@\spxentry{intersects\_meridian()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.intersects_meridian}\pysiglinewithargsret{\bfcode{intersects\_meridian}}{\emph{self}, \emph{lam}}{} -Return True if this ellipsoidal cell's boundary intersects the -meridian of longitude \emph{lam}, and return False otherwise. +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.intersects_meridian}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{intersects\_meridian}}}{\emph{\DUrole{n}{lam}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return True if this ellipsoidal cell’s boundary intersects the +meridian of longitude \sphinxtitleref{lam}, and return False otherwise. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}003\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{intersects\PYGZus{}meridian}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{intersects\PYGZus{}meridian}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{intersects\PYGZus{}meridian}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{intersects\PYGZus{}meridian}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{False} -\end{Verbatim} - -\end{fulllineitems} - -\index{Cell.intersects\_parallel() (in module rhealpix\_dggs.dggs)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.intersects_parallel}\pysiglinewithargsret{\bfcode{intersects\_parallel}}{\emph{self}, \emph{phi}}{} -Return True if this cell's boundary intersects the parallel of latitude -\emph{phi}, and return False otherwise. - -\end{fulllineitems} - -\index{Cell.neighbor() (in module rhealpix\_dggs.dggs)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.neighbor}\pysiglinewithargsret{\bfcode{neighbor}}{\emph{self}, \emph{direction}, \emph{plane=True}}{} -Return this cell's (edge) neighbor in the given direction. -If \emph{plane} = True, then the direction is one of the strings -`up', `right', `down', `left', which indicates the desired neighbor -relative to x-y coordinates -in the following planar neighbor diagram, (drawn for self.N\_side = 3) -where \emph{self} is the middle cell - -\begin{Verbatim}[commandchars=\\\{\}] - up - *-----* - \textbar{} \textbar{} - \textbar{} \textbar{} - \textbar{} \textbar{} - *-----*-----*-----* - \textbar{} \textbar{} 012 \textbar{} \textbar{} -left \textbar{} \textbar{} 345 \textbar{} \textbar{} right - \textbar{} \textbar{} 678 \textbar{} \textbar{} - *-----*-----*-----* - \textbar{} \textbar{} - \textbar{} \textbar{} - \textbar{} \textbar{} - *-----* - down -\end{Verbatim} - -If \emph{plane} = False, then the direction is relative to -longitude-latitude coordinates and is one of the strings -`west', `east', `north', `south' for a quad or skew quad cell; -`west', `east', `southwest', `southeast' for a northern dart cell; -`west', `east', `northwest', `northeast' for a southern dart cell; -`south\_0', `south\_1', `south\_2', `south\_3' for a northern cap cell; -`north\_0', `north\_1', `north\_2', `north\_3' for a southern cap cell; -For a cap cell, neighbor directions are numbered in increasing -longitude, so that the longitude of the (nucleus of) north\_0 is less +\end{sphinxVerbatim} + +\end{fulllineitems} + +\index{intersects\_parallel() (rhealpixdggs.dggs.Cell method)@\spxentry{intersects\_parallel()}\spxextra{rhealpixdggs.dggs.Cell method}} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.intersects_parallel}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{intersects\_parallel}}}{\emph{\DUrole{n}{phi}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return True if this cell’s boundary intersects the parallel of latitude +\sphinxtitleref{phi}, and return False otherwise. + +\end{fulllineitems} + +\index{neighbor() (rhealpixdggs.dggs.Cell method)@\spxentry{neighbor()}\spxextra{rhealpixdggs.dggs.Cell method}} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.neighbor}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{neighbor}}}{\emph{\DUrole{n}{direction}}, \emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return this cell’s (edge) neighbor in the given direction. +If \sphinxtitleref{plane} = True, then the direction is one of the strings +‘up’, ‘right’, ‘down’, ‘left’, which indicates the desired neighbor +relative to x\sphinxhyphen{}y coordinates +in the following planar neighbor diagram, (drawn for self.N\_side = 3) +where \sphinxtitleref{self} is the middle cell + +\begin{sphinxVerbatim}[commandchars=\\\{\}] + \PYG{n}{up} + \PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*} + \PYG{o}{|} \PYG{o}{|} + \PYG{o}{|} \PYG{o}{|} + \PYG{o}{|} \PYG{o}{|} + \PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*} + \PYG{o}{|} \PYG{o}{|} \PYG{l+m+mi}{012} \PYG{o}{|} \PYG{o}{|} +\PYG{n}{left} \PYG{o}{|} \PYG{o}{|} \PYG{l+m+mi}{345} \PYG{o}{|} \PYG{o}{|} \PYG{n}{right} + \PYG{o}{|} \PYG{o}{|} \PYG{l+m+mi}{678} \PYG{o}{|} \PYG{o}{|} + \PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*} + \PYG{o}{|} \PYG{o}{|} + \PYG{o}{|} \PYG{o}{|} + \PYG{o}{|} \PYG{o}{|} + \PYG{o}{*}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{\PYGZhy{}}\PYG{o}{*} + \PYG{n}{down} +\end{sphinxVerbatim} + +\sphinxAtStartPar +If \sphinxtitleref{plane} = False, then the direction is relative to +longitude\sphinxhyphen{}latitude coordinates and is one of the strings +‘west’, ‘east’, ‘north’, ‘south’ for a quad or skew quad cell; +‘west’, ‘east’, ‘southwest’, ‘southeast’ for a northern dart cell; +‘west’, ‘east’, ‘northwest’, ‘northeast’ for a southern dart cell; +‘south\_0’, ‘south\_1’, ‘south\_2’, ‘south\_3’ for a northern cap cell; +‘north\_0’, ‘north\_1’, ‘north\_2’, ‘north\_3’ for a southern cap cell; +For a cap cell, neighbor directions are numbered in increasing +longitude, so that the longitude of the (nucleus of) north\_0 is less than the longitude of north\_1 is less than the longitude of north\_2 is less than the longitude of north\_3, and the longitude of the south\_0 is less than the longitude of south\_1, etc. -The tricky part in the planar scenario is that the neighbor -relationships of the six resolution 0 cells is determined by the -positions of those cells on the surface of a cube, +\sphinxAtStartPar +The tricky part in the planar scenario is that the neighbor +relationships of the six resolution 0 cells is determined by the +positions of those cells on the surface of a cube, one cell on each face, and not on a plane. So sometimes rotating cells is needed to compute neighbors. +\sphinxAtStartPar Return None if the given direction is invalid for this cell. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{neighbor}\PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{down}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{neighbor}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{down}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{N3} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{Cell.neighbors() (in module rhealpix\_dggs.dggs)} +\index{neighbors() (rhealpixdggs.dggs.Cell method)@\spxentry{neighbors()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.neighbors}\pysiglinewithargsret{\bfcode{neighbors}}{\emph{self}, \emph{plane=True}}{} -Return this cell's planar or ellipsoidal (edge) neighbors +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.neighbors}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{neighbors}}}{\emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return this cell’s planar or ellipsoidal (edge) neighbors as a dictionary whose keys are the directions of the neighbors. See neighbor() for a list of valid directions. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{k}\PYG{p}{,} \PYG{n}{v} \PYG{o+ow}{in} \PYG{n+nb}{sorted}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{neighbors}\PYG{p}{(}\PYG{p}{)}\PYG{o}{.}\PYG{n}{items}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{k}\PYG{p}{,} \PYG{n}{v}\PYG{p}{)} -\PYG{g+gp}{... } +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{k}\PYG{p}{,} \PYG{n}{v}\PYG{p}{)} +\PYG{g+gp}{...} \PYG{g+go}{down N3} \PYG{g+go}{left R0} \PYG{g+go}{right N1} \PYG{g+go}{up Q2} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{Cell.nucleus() (in module rhealpix\_dggs.dggs)} +\index{nucleus() (rhealpixdggs.dggs.Cell method)@\spxentry{nucleus()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.nucleus}\pysiglinewithargsret{\bfcode{nucleus}}{\emph{self}, \emph{plane=True}}{} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.nucleus}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{nucleus}}}{\emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}}{} +\pysigstopsignatures +\sphinxAtStartPar Return the nucleus and vertices of this planar or ellipsoidal cell -in the order (nucleus, upper left corner, lower left corner, -lower right corner, upper right corner) with reference to the +in the order (nucleus, upper left corner, lower left corner, +lower right corner, upper right corner) with reference to the planar cell. The output for ellipsoidal cells is the projection onto the ellipsoid -of the output for planar cells. In particular, while the -nucleus of a planar cell is its centroid, the nucleus +of the output for planar cells. In particular, while the +nucleus of a planar cell is its centroid, the nucleus of an ellipsoidal cell is not its centroid. To compute the centroid of a cell, use centroid() below. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}2.35619449019234, 1.5707963267949001)} -\end{Verbatim} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(\PYGZhy{}2.35619449019234, 1.5707963267949)} +\end{sphinxVerbatim} +\begin{description} +\sphinxlineitem{NOTES:: .. Issue \#1 was ..} +\sphinxAtStartPar +(\sphinxhyphen{}2.35619449019234, 1.5707963267949001) * + +\end{description} \end{fulllineitems} -\index{Cell.nw\_vertex() (in module rhealpix\_dggs.dggs)} +\index{nw\_vertex() (rhealpixdggs.dggs.Cell method)@\spxentry{nw\_vertex()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.nw_vertex}\pysiglinewithargsret{\bfcode{nw\_vertex}}{\emph{self}, \emph{plane=True}}{} -If \emph{plane} = False, then return the northwest vertex of this +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.nw_vertex}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{nw\_vertex}}}{\emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}}{} +\pysigstopsignatures +\sphinxAtStartPar +If \sphinxtitleref{plane} = False, then return the northwest vertex of this ellipsoidal cell. -If \emph{plane} = True, then return the projection onto the plane +If \sphinxtitleref{plane} = True, then return the projection onto the plane of the ellipsoidal northwest vertex. -On quad cells and cap cells, this function returns the same output +On quad cells and cap cells, this function returns the same output as ul\_vertex(). On skew quad cells and dart cells, this function returns output different from ul\_vertex(). -WARNING: The northwest vertex of a cell might not lie in the cell, +\sphinxAtStartPar +WARNING: The northwest vertex of a cell might not lie in the cell, because not all cells contain their boundary. \begin{description} -\item[{EXAMPLES::}] \leavevmode -\begin{Verbatim}[commandchars=\\\{\}] +\sphinxlineitem{EXAMPLES::} +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{P}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{5}\PYG{p}{,} \PYG{l+m+mi}{7}\PYG{p}{]}\PYG{p}{)} \PYG{c}{\PYGZsh{} Quad cell.} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}2225148.7007489, \PYGZhy{}556287.17518722452)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nw\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}2225148.7007489, \PYGZhy{}556287.17518722452)} -\end{Verbatim} - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{S}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{4}\PYG{p}{]}\PYG{p}{)} \PYG{c}{\PYGZsh{} Cap cell.} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}16688615.255616743, \PYGZhy{}8344307.6278083706)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nw\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}16688615.255616743, \PYGZhy{}8344307.6278083706)} -\end{Verbatim} - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{4}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{]}\PYG{p}{)} \PYG{c}{\PYGZsh{} Skew quad cell.} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{P}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{5}\PYG{p}{,} \PYG{l+m+mi}{7}\PYG{p}{]}\PYG{p}{)} \PYG{c+c1}{\PYGZsh{} Quad cell.} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(\PYGZhy{}2225148.7007489, \PYGZhy{}556287.1751872245)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nw\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(\PYGZhy{}2225148.7007489, \PYGZhy{}556287.1751872245)} +\end{sphinxVerbatim} + +\sphinxlineitem{NOTES:: .. Issue \#1 was ..} +\sphinxAtStartPar +(\sphinxhyphen{}2225148.7007489, \sphinxhyphen{}556287.17518722452) * for both above tests + +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{S}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{4}\PYG{p}{]}\PYG{p}{)} \PYG{c+c1}{\PYGZsh{} Cap cell.} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(\PYGZhy{}16688615.255616743, \PYGZhy{}8344307.627808371)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nw\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(\PYGZhy{}16688615.255616743, \PYGZhy{}8344307.627808371)} +\end{sphinxVerbatim} + +\sphinxlineitem{NOTES:: .. Issue \#1 was ..} +\sphinxAtStartPar +(\sphinxhyphen{}16688615.255616743, \sphinxhyphen{}8344307.6278083706) * for both above tests + +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{4}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{]}\PYG{p}{)} \PYG{c+c1}{\PYGZsh{} Skew quad cell.} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(\PYGZhy{}16688615.255616743, 10569456.32855727)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nw\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nw\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(\PYGZhy{}15576040.905242294, 10569456.32855727)} -\end{Verbatim} +\end{sphinxVerbatim} -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{S}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{4}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{]}\PYG{p}{)} \PYG{c}{\PYGZsh{} Skew quad cell.} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}16688615.255616743, \PYGZhy{}9456881.9781828206)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nw\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{S}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{4}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{]}\PYG{p}{)} \PYG{c+c1}{\PYGZsh{} Skew quad cell.} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(\PYGZhy{}16688615.255616743, \PYGZhy{}9456881.97818282)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nw\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(\PYGZhy{}16688615.255616743, \PYGZhy{}10569456.32855727)} -\end{Verbatim} - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)} \PYG{c}{\PYGZsh{} Dart cell.} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}17801189.605991192, 8344307.6278083716)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nw\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}16688615.255616743, 8344307.6278083716)} -\end{Verbatim} - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{S}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)} \PYG{c}{\PYGZsh{} Dart cell.} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\end{sphinxVerbatim} + +\sphinxlineitem{NOTES:: .. Issue \#1 was ..} +\sphinxAtStartPar +(\sphinxhyphen{}16688615.255616743, \sphinxhyphen{}9456881.9781828206) * + +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)} \PYG{c+c1}{\PYGZsh{} Dart cell.} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(\PYGZhy{}17801189.605991192, 8344307.627808372)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nw\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(\PYGZhy{}16688615.255616743, 8344307.627808372)} +\end{sphinxVerbatim} + +\sphinxlineitem{NOTES:: .. Issue \#1 was ..} +\sphinxAtStartPar +(\sphinxhyphen{}16688615.255616743, 8344307.6278083716) * for both above tests + +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{S}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)} \PYG{c+c1}{\PYGZsh{} Dart cell.} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(\PYGZhy{}17801189.605991192, \PYGZhy{}11682030.678931719)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nw\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nw\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(\PYGZhy{}16688615.255616743, \PYGZhy{}12794605.029306168)} -\end{Verbatim} +\end{sphinxVerbatim} \end{description} \end{fulllineitems} -\index{Cell.predecessor() (in module rhealpix\_dggs.dggs)} +\index{overlaps() (rhealpixdggs.dggs.Cell method)@\spxentry{overlaps()}\spxextra{rhealpixdggs.dggs.Cell method}} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.overlaps}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{overlaps}}}{\emph{\DUrole{n}{other\_cell}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Determines whether two DGGS cells overlap. +Where cells are of different resolution, they will have different suid lengths. The zip function truncates the longer +to be the same length as the shorter, producing two lists for comparison. If these lists are equal, the cells overlap. +:param cell\_one: the first DGGS cell +:param cell\_two: the second DGGS cell +:return: True if overlaps + +\end{fulllineitems} + +\index{predecessor() (rhealpixdggs.dggs.Cell method)@\spxentry{predecessor()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.predecessor}\pysiglinewithargsret{\bfcode{predecessor}}{\emph{self}, \emph{resolution=None}}{} -Return the greatest resolution \emph{resolution} cell less than \emph{self}. -Note: \emph{self} need not be a resolution \emph{resolution} cell. +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.predecessor}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{predecessor}}}{\emph{\DUrole{n}{resolution}\DUrole{o}{=}\DUrole{default_value}{None}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return the greatest resolution \sphinxtitleref{resolution} cell less than \sphinxtitleref{self}. +Note: \sphinxtitleref{self} need not be a resolution \sphinxtitleref{resolution} cell. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{8}\PYG{p}{)}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{predecessor}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{8}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{predecessor}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{N07} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{predecessor}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{predecessor}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{None} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{predecessor}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{predecessor}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{None} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{predecessor}\PYG{p}{(}\PYG{l+m+mi}{3}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{predecessor}\PYG{p}{(}\PYG{l+m+mi}{3}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{N088} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{Cell.random\_point() (in module rhealpix\_dggs.dggs)} +\index{random\_point() (rhealpixdggs.dggs.Cell method)@\spxentry{random\_point()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.random_point}\pysiglinewithargsret{\bfcode{random\_point}}{\emph{self}, \emph{plane=True}}{} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.random_point}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{random\_point}}}{\emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}}{} +\pysigstopsignatures +\sphinxAtStartPar Return a random point in this cell. -If \emph{plane} = True, then choose the point from +If \sphinxtitleref{plane} = True, then choose the point from the planar cell. Otherwise, choose the point from the ellipsoidal cell. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{random\PYGZus{}point}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{random\PYGZus{}point}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(1.4840291937583836, 0.90042819146088571)} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{Cell.region() (in module rhealpix\_dggs.dggs)} +\index{region() (rhealpixdggs.dggs.Cell method)@\spxentry{region()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.region}\pysiglinewithargsret{\bfcode{region}}{\emph{self}}{} -Return the region of this cell: `equatorial', `north\_polar', or -`south\_polar'. +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.region}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{region}}}{}{} +\pysigstopsignatures +\sphinxAtStartPar +Return the region of this cell: ‘equatorial’, ‘north\_polar’, or +‘south\_polar’. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{P}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)}\PYG{o}{.}\PYG{n}{region}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{P}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)}\PYG{o}{.}\PYG{n}{region}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{equatorial} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)}\PYG{o}{.}\PYG{n}{region}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)}\PYG{o}{.}\PYG{n}{region}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{north\PYGZus{}polar} -\end{Verbatim} +\end{sphinxVerbatim} + +\end{fulllineitems} + +\index{region\_overlaps() (rhealpixdggs.dggs.Cell method)@\spxentry{region\_overlaps()}\spxextra{rhealpixdggs.dggs.Cell method}} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.region_overlaps}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{region\_overlaps}}}{\emph{\DUrole{n}{region}\DUrole{p}{:}\DUrole{w}{ }\DUrole{n}{list}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Determine whether a cell overlaps with any cell in a list of cells +:param cell: a DGGS cell +:param region: a list of DGGS cells +:return: True if any overlapping cells \end{fulllineitems} -\index{Cell.rotate() (in module rhealpix\_dggs.dggs)} +\index{rotate() (rhealpixdggs.dggs.Cell method)@\spxentry{rotate()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.rotate}\pysiglinewithargsret{\bfcode{rotate}}{\emph{self}, \emph{quarter\_turns}}{} -Return the cell that is the result of rotating this cell's -resolution 0 supercell by \emph{quarter\_turns} quarter turns anticlockwise. +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.rotate}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{rotate}}}{\emph{\DUrole{n}{quarter\_turns}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return the cell that is the result of rotating this cell’s +resolution 0 supercell by \sphinxtitleref{quarter\_turns} quarter turns anticlockwise. Used in neighbor(). +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{rotate}\PYG{p}{(}\PYG{n}{t}\PYG{p}{)}\PYG{p}{)} \PYG{k}{for} \PYG{n}{t} \PYG{o+ow}{in} \PYG{n+nb}{range}\PYG{p}{(}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{]}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{rotate}\PYG{p}{(}\PYG{n}{t}\PYG{p}{)}\PYG{p}{)} \PYG{k}{for} \PYG{n}{t} \PYG{o+ow}{in} \PYG{n+nb}{range}\PYG{p}{(}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{]}\PYG{p}{)} \PYG{g+go}{[\PYGZsq{}N0\PYGZsq{}, \PYGZsq{}N2\PYGZsq{}, \PYGZsq{}N8\PYGZsq{}, \PYGZsq{}N6\PYGZsq{}]} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{Cell.rotate\_entry() (in module rhealpix\_dggs.dggs)} +\index{rotate\_entry() (rhealpixdggs.dggs.Cell method)@\spxentry{rotate\_entry()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.rotate_entry}\pysiglinewithargsret{\bfcode{rotate\_entry}}{\emph{self}, \emph{x}, \emph{quarter\_turns}}{} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.rotate_entry}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{rotate\_entry}}}{\emph{\DUrole{n}{x}}, \emph{\DUrole{n}{quarter\_turns}}}{} +\pysigstopsignatures +\sphinxAtStartPar Let N = self.N\_side and rotate the N x N matrix of subcell numbers -\begin{Verbatim}[commandchars=\\\{\}] -0 1 ... N - 1 -N N+1 ... 2*N - 1 -... -(N-1)*N (N-1)*N+1 ... N**2-1 -\end{Verbatim} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{l+m+mi}{0} \PYG{l+m+mi}{1} \PYG{o}{.}\PYG{o}{.}\PYG{o}{.} \PYG{n}{N} \PYG{o}{\PYGZhy{}} \PYG{l+m+mi}{1} +\PYG{n}{N} \PYG{n}{N}\PYG{o}{+}\PYG{l+m+mi}{1} \PYG{o}{.}\PYG{o}{.}\PYG{o}{.} \PYG{l+m+mi}{2}\PYG{o}{*}\PYG{n}{N} \PYG{o}{\PYGZhy{}} \PYG{l+m+mi}{1} +\PYG{o}{.}\PYG{o}{.}\PYG{o}{.} +\PYG{p}{(}\PYG{n}{N}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{1}\PYG{p}{)}\PYG{o}{*}\PYG{n}{N} \PYG{p}{(}\PYG{n}{N}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{1}\PYG{p}{)}\PYG{o}{*}\PYG{n}{N}\PYG{o}{+}\PYG{l+m+mi}{1} \PYG{o}{.}\PYG{o}{.}\PYG{o}{.} \PYG{n}{N}\PYG{o}{*}\PYG{o}{*}\PYG{l+m+mi}{2}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{1} +\end{sphinxVerbatim} -anticlockwise by \emph{quarter\_turns} quarter turns to obtain a -new table with entries f(0), f(1), ..., f(N**2 - 1) read from +\sphinxAtStartPar +anticlockwise by \sphinxtitleref{quarter\_turns} quarter turns to obtain a +new table with entries f(0), f(1), …, f(N**2 \sphinxhyphen{} 1) read from left to right and top to bottom. -Given entry number \emph{x} in the original matrix, return \emph{f(x)}. +Given entry number \sphinxtitleref{x} in the original matrix, return \sphinxtitleref{f(x)}. Used in rotate(). +\sphinxAtStartPar INPUT: \begin{itemize} \item {} -\emph{x} - A letter from RHEALPixDGGS.cells0 or one of the integers -0, 1, ..., N**2 - 1. +\sphinxAtStartPar +\sphinxtitleref{x} \sphinxhyphen{} A letter from RHEALPixDGGS.cells0 or one of the integers +0, 1, …, N**2 \sphinxhyphen{} 1. \item {} -\emph{quarter\_turns} - 0, 1, 2, or 3. +\sphinxAtStartPar +\sphinxtitleref{quarter\_turns} \sphinxhyphen{} 0, 1, 2, or 3. \end{itemize} +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{P}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n}{c}\PYG{o}{.}\PYG{n}{rotate\PYGZus{}entry}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{t}\PYG{p}{)} \PYG{k}{for} \PYG{n}{t} \PYG{o+ow}{in} \PYG{n+nb}{range}\PYG{p}{(}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{]}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{P}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n}{c}\PYG{o}{.}\PYG{n}{rotate\PYGZus{}entry}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{t}\PYG{p}{)} \PYG{k}{for} \PYG{n}{t} \PYG{o+ow}{in} \PYG{n+nb}{range}\PYG{p}{(}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{]}\PYG{p}{)} \PYG{g+go}{[0, 2, 8, 6]} -\end{Verbatim} +\end{sphinxVerbatim} +\sphinxAtStartPar NOTES: +\sphinxAtStartPar Operates on letters from RHEALPixDGGS.cells0 too. They stay fixed under f. -Only depends on \emph{self} through \emph{self.N\_side}. +Only depends on \sphinxtitleref{self} through \sphinxtitleref{self.N\_side}. \end{fulllineitems} -\index{Cell.subcell() (in module rhealpix\_dggs.dggs)} +\index{subcell() (rhealpixdggs.dggs.Cell method)@\spxentry{subcell()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.subcell}\pysiglinewithargsret{\bfcode{subcell}}{\emph{self}, \emph{other}}{} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.subcell}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{subcell}}}{\emph{\DUrole{n}{other}}}{} +\pysigstopsignatures +\sphinxAtStartPar Subcell (subset) relation on cells. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{a} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{)}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{b} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{a}\PYG{o}{.}\PYG{n}{subcell}\PYG{p}{(}\PYG{n}{b}\PYG{p}{)}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{a} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{b} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{a}\PYG{o}{.}\PYG{n}{subcell}\PYG{p}{(}\PYG{n}{b}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{b}\PYG{o}{.}\PYG{n}{subcell}\PYG{p}{(}\PYG{n}{a}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{b}\PYG{o}{.}\PYG{n}{subcell}\PYG{p}{(}\PYG{n}{a}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{False} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{Cell.subcells() (in module rhealpix\_dggs.dggs)} +\index{subcells() (rhealpixdggs.dggs.Cell method)@\spxentry{subcells()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.subcells}\pysiglinewithargsret{\bfcode{subcells}}{\emph{self}, \emph{resolution=None}}{} -Generator function for the set of all resolution \emph{resolution} subcells -of this cell. -If \emph{resolution=None}, then return a generator function for the children +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.subcells}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{subcells}}}{\emph{\DUrole{n}{resolution}\DUrole{o}{=}\DUrole{default_value}{None}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Generator function for the set of all resolution \sphinxtitleref{resolution} subcells +of this cell. +If \sphinxtitleref{resolution=None}, then return a generator function for the children of this cell. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{subcells}\PYG{p}{(}\PYG{p}{)}\PYG{p}{]}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{subcells}\PYG{p}{(}\PYG{p}{)}\PYG{p}{]}\PYG{p}{)} \PYG{g+go}{[\PYGZsq{}N0\PYGZsq{}, \PYGZsq{}N1\PYGZsq{}, \PYGZsq{}N2\PYGZsq{}, \PYGZsq{}N3\PYGZsq{}, \PYGZsq{}N4\PYGZsq{}, \PYGZsq{}N5\PYGZsq{}, \PYGZsq{}N6\PYGZsq{}, \PYGZsq{}N7\PYGZsq{}, \PYGZsq{}N8\PYGZsq{}]} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{Cell.successor() (in module rhealpix\_dggs.dggs)} +\index{successor() (rhealpixdggs.dggs.Cell method)@\spxentry{successor()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.successor}\pysiglinewithargsret{\bfcode{successor}}{\emph{self}, \emph{resolution=None}}{} -Return the least resolution \emph{resolution} cell greater than \emph{self}. -Note: \emph{self} need not be a resolution \emph{resolution} cell. +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.successor}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{successor}}}{\emph{\DUrole{n}{resolution}\DUrole{o}{=}\DUrole{default_value}{None}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return the least resolution \sphinxtitleref{resolution} cell greater than \sphinxtitleref{self}. +Note: \sphinxtitleref{self} need not be a resolution \sphinxtitleref{resolution} cell. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{8}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{)}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{successor}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{8}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{successor}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{N83} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{successor}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{successor}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{O} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{successor}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{successor}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{O0} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{successor}\PYG{p}{(}\PYG{l+m+mi}{3}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{successor}\PYG{p}{(}\PYG{l+m+mi}{3}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{N830} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{Cell.suid\_from\_index() (in module rhealpix\_dggs.dggs)} +\index{suid\_from\_index() (rhealpixdggs.dggs.Cell static method)@\spxentry{suid\_from\_index()}\spxextra{rhealpixdggs.dggs.Cell static method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.suid_from_index}\pysiglinewithargsret{\bfcode{suid\_from\_index}}{\emph{rdggs}, \emph{index}, \emph{order='resolution'}}{} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.suid_from_index}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{static\DUrole{w}{ }}}\sphinxbfcode{\sphinxupquote{suid\_from\_index}}}{\emph{\DUrole{n}{rdggs}}, \emph{\DUrole{n}{index}}, \emph{\DUrole{n}{order}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}resolution\textquotesingle{}}}}{} +\pysigstopsignatures +\sphinxAtStartPar Return the suid of a cell from its index. -The index is according to the cell ordering \emph{order}, -which can be `resolution' (default) or `post'. -See the \emph{index()} docstring for more details on orderings. +The index is according to the cell ordering \sphinxtitleref{order}, +which can be ‘resolution’ (default) or ‘post’. +See the \sphinxtitleref{index()} docstring for more details on orderings. For internal use. \end{fulllineitems} -\index{Cell.suid\_rowcol() (in module rhealpix\_dggs.dggs)} +\index{suid\_rowcol() (rhealpixdggs.dggs.Cell method)@\spxentry{suid\_rowcol()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.suid_rowcol}\pysiglinewithargsret{\bfcode{suid\_rowcol}}{\emph{self}}{} -Return the pair of row- and column-suids of \emph{self}, each as tuples. +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.suid_rowcol}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{suid\_rowcol}}}{}{} +\pysigstopsignatures +\sphinxAtStartPar +Return the pair of row\sphinxhyphen{} and column\sphinxhyphen{}suids of \sphinxtitleref{self}, each as tuples. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{7}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{7}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{]}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rsuid}\PYG{p}{,} \PYG{n}{csuid} \PYG{o}{=} \PYG{n}{c}\PYG{o}{.}\PYG{n}{suid\PYGZus{}rowcol}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rsuid} \PYG{o}{==} \PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{rsuid} \PYG{o}{==} \PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{csuid} \PYG{o}{==} \PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{csuid} \PYG{o}{==} \PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{True} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{Cell.ul\_vertex() (in module rhealpix\_dggs.dggs)} +\index{ul\_vertex() (rhealpixdggs.dggs.Cell method)@\spxentry{ul\_vertex()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.ul_vertex}\pysiglinewithargsret{\bfcode{ul\_vertex}}{\emph{self}, \emph{plane=True}}{} -If \emph{plane} = True, then return the upper left vertex of this +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.ul_vertex}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{ul\_vertex}}}{\emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}}{} +\pysigstopsignatures +\sphinxAtStartPar +If \sphinxtitleref{plane} = True, then return the upper left vertex of this planar cell. -If \emph{plane} = False, then return the projection onto the ellipsoid +If \sphinxtitleref{plane} = False, then return the projection onto the ellipsoid of the planar upper left vertex. -Note that for polar cells, this projection is not necessarily the +Note that for polar cells, this projection is not necessarily the northwest vertex. For the latter vertex use nw\_vertex(). -WARNING: The upper left vertex of a cell might not lie in the cell, +\sphinxAtStartPar +WARNING: The upper left vertex of a cell might not lie in the cell, because not all cells contain their boundary. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{UNIT\PYGZus{}003}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{p}{)} \PYG{o}{==} \PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{UNIT\PYGZus{}003}\PYG{p}{,} \PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{p}{)} \PYG{o}{==} \PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{True} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{Cell.vertices() (in module rhealpix\_dggs.dggs)} +\index{vertices() (rhealpixdggs.dggs.Cell method)@\spxentry{vertices()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.vertices}\pysiglinewithargsret{\bfcode{vertices}}{\emph{self}, \emph{plane=True}, \emph{trim\_dart=False}}{} -If \emph{plane} = True, then assume this cell is planar and return -its four vertices in the order (upper left corner, upper right corner, +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.vertices}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{vertices}}}{\emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}, \emph{\DUrole{n}{trim\_dart}\DUrole{o}{=}\DUrole{default_value}{False}}}{} +\pysigstopsignatures +\sphinxAtStartPar +If \sphinxtitleref{plane} = True, then assume this cell is planar and return +its four vertices in the order (upper left corner, upper right corner, lower right corner, lower left corner). -If \emph{plane} = False, then assume this cell is ellipsoidal and return +If \sphinxtitleref{plane} = False, then assume this cell is ellipsoidal and return the projection of the planar vertices in the order (northwest, northeast, southeast, southwest). -If \emph{plane} = False, this cell is a dart cell, and -\emph{trim\_dart} = True, then remove the one non-vertex point from +If \sphinxtitleref{plane} = False, this cell is a dart cell, and +\sphinxtitleref{trim\_dart} = True, then remove the one non\sphinxhyphen{}vertex point from the output. (Dart cells only have three vertices.) +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{]}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{vertices}\PYG{p}{(}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(\PYGZhy{}3.14159265358979, 2.35619449019234)} -\PYG{g+go}{(\PYGZhy{}1.5707963267949001, 2.35619449019234)} -\PYG{g+go}{(\PYGZhy{}1.5707963267949001, 0.78539816339745006)} -\PYG{g+go}{(\PYGZhy{}3.14159265358979, 0.78539816339745006)} +\PYG{g+go}{(\PYGZhy{}1.5707963267949, 2.35619449019234)} +\PYG{g+go}{(\PYGZhy{}1.5707963267949, 0.78539816339745)} +\PYG{g+go}{(\PYGZhy{}3.14159265358979, 0.78539816339745)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{vertices}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(89.999999999999929, 74.39069094879062)} -\PYG{g+go}{(119.99999999999999, 41.87385774220941)} -\PYG{g+go}{(90.0, 41.87385774220941)} -\PYG{g+go}{(60.000000000000007, 41.87385774220941)} - -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{vertices}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{,} \PYG{n}{trim\PYGZus{}dart}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(89.999999999999929, 74.39069094879062)} -\PYG{g+go}{(119.99999999999999, 41.87385774220941)} -\PYG{g+go}{(60.000000000000007, 41.87385774220941)} - -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{S}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{vertices}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{vertices}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)}\PYG{p}{:} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{13}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(89.9999999999999, 74.3906909487906)} +\PYG{g+go}{(120.0, 41.8738577422094)} +\PYG{g+go}{(90.0, 41.8738577422094)} +\PYG{g+go}{(60.0, 41.8738577422094)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{vertices}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{,} \PYG{n}{trim\PYGZus{}dart}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{:} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{13}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(89.9999999999999, 74.3906909487906)} +\PYG{g+go}{(120.0, 41.8738577422094)} +\PYG{g+go}{(60.0, 41.8738577422094)} + +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{S}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{vertices}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)}\PYG{p}{:} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(149.99999999999997, \PYGZhy{}41.87385774220941)} \PYG{g+go}{(\PYGZhy{}180.0, \PYGZhy{}41.87385774220941)} \PYG{g+go}{(\PYGZhy{}150.0, \PYGZhy{}41.87385774220941)} -\PYG{g+go}{(\PYGZhy{}180.0, \PYGZhy{}74.390690948790649)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{vertices}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{,} \PYG{n}{trim\PYGZus{}dart}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(\PYGZhy{}180.0, \PYGZhy{}74.39069094879065)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{vertices}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{,} \PYG{n}{trim\PYGZus{}dart}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{:} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(149.99999999999997, \PYGZhy{}41.87385774220941)} \PYG{g+go}{(\PYGZhy{}150.0, \PYGZhy{}41.87385774220941)} -\PYG{g+go}{(\PYGZhy{}180.0, \PYGZhy{}74.390690948790649)} -\end{Verbatim} +\PYG{g+go}{(\PYGZhy{}180.0, \PYGZhy{}74.39069094879065)} +\end{sphinxVerbatim} \end{fulllineitems} -\index{Cell.width() (in module rhealpix\_dggs.dggs)} +\index{width() (rhealpixdggs.dggs.Cell method)@\spxentry{width()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.width}\pysiglinewithargsret{\bfcode{width}}{\emph{self}, \emph{plane=True}}{} -Return the width of this cell. -If \emph{plane} = False, then return None, because ellipsoidal cells -don't have a fixed width. +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.width}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{width}}}{\emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return the width of this cell. +If \sphinxtitleref{plane} = False, then return None, because ellipsoidal cells +don’t have a fixed width. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{UNIT\PYGZus{}003}\PYG{p}{,} \PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{8}\PYG{p}{)}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{UNIT\PYGZus{}003}\PYG{p}{,} \PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{8}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} \PYG{g+go}{N8} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c}\PYG{o}{.}\PYG{n}{width}\PYG{p}{(}\PYG{p}{)} \PYG{o}{==} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{o}{*}\PYG{l+m+mi}{3}\PYG{o}{*}\PYG{o}{*}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{1}\PYG{p}{)} \PYG{g+go}{True} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{Cell.xy\_range() (in module rhealpix\_dggs.dggs)} +\index{xy\_range() (rhealpixdggs.dggs.Cell method)@\spxentry{xy\_range()}\spxextra{rhealpixdggs.dggs.Cell method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.xy_range}\pysiglinewithargsret{\bfcode{xy\_range}}{\emph{self}}{} -Return the x- and y-coordinate extremes of the planar version of +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.Cell.xy_range}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{xy\_range}}}{}{} +\pysigstopsignatures +\sphinxAtStartPar +Return the x\sphinxhyphen{} and y\sphinxhyphen{}coordinate extremes of the planar version of this cell in the format ((x\_min, x\_max), (y\_min, y\_max)). +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{]}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c}\PYG{o}{.}\PYG{n}{xy\PYGZus{}range}\PYG{p}{(}\PYG{p}{)} \PYG{o}{==} \PYG{p}{(}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)}\PYG{p}{,} \PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{True} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} \end{fulllineitems} -\index{RHEALPixDGGS (class in rhealpix\_dggs.dggs)} +\index{RHEALPixDGGS (class in rhealpixdggs.dggs)@\spxentry{RHEALPixDGGS}\spxextra{class in rhealpixdggs.dggs}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS}\pysiglinewithargsret{\strong{class }\code{rhealpix\_dggs.dggs.}\bfcode{RHEALPixDGGS}}{\emph{ellipsoid=\textless{}rhealpix\_dggs.ellipsoids.Ellipsoid object at 0x10354a8d0\textgreater{}}, \emph{N\_side=3}, \emph{north\_square=0}, \emph{south\_square=0}, \emph{max\_areal\_resolution=1}}{} -Bases: \code{builtins.object} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class\DUrole{w}{ }}}\sphinxcode{\sphinxupquote{rhealpixdggs.dggs.}}\sphinxbfcode{\sphinxupquote{RHEALPixDGGS}}}{\emph{\DUrole{n}{ellipsoid=\textless{}rhealpixdggs.ellipsoids.Ellipsoid object\textgreater{}}}, \emph{\DUrole{n}{N\_side=3}}, \emph{\DUrole{n}{north\_square=0}}, \emph{\DUrole{n}{south\_square=0}}, \emph{\DUrole{n}{max\_areal\_resolution=1}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Bases: \sphinxcode{\sphinxupquote{object}} +\sphinxAtStartPar Represents an rHEALPix DGGS on a given ellipsoid. +\sphinxAtStartPar CLASS ATTRIBUTES: \begin{itemize} \item {} -\emph{cells0} - A list of the resolution 0 cell IDs (strings). +\sphinxAtStartPar +\sphinxtitleref{cells0} \sphinxhyphen{} A list of the resolution 0 cell IDs (strings). \end{itemize} +\sphinxAtStartPar INSTANCE ATTRIBUTES: \begin{itemize} \item {} -\emph{ellipsoid} - The underlying ellipsoid (Ellipsoid instance). +\sphinxAtStartPar +\sphinxtitleref{ellipsoid} \sphinxhyphen{} The underlying ellipsoid (Ellipsoid instance). \item {} -\emph{N\_side} - An integer of size at least 2. +\sphinxAtStartPar +\sphinxtitleref{N\_side} \sphinxhyphen{} An integer of size at least 2. Each planar cell has N\_side x N\_side child cells. \item {} -\emph{(north\_square, south\_square)} - Integers between 0 and 3 indicating +\sphinxAtStartPar +\sphinxtitleref{(north\_square, south\_square)} \sphinxhyphen{} Integers between 0 and 3 indicating the positions of north polar and south polar squares, respectively, of the rHEALPix projection used. \item {} -\emph{max\_areal\_resolution} - An area measured in square meters that +\sphinxAtStartPar +\sphinxtitleref{max\_areal\_resolution} \sphinxhyphen{} An area measured in square meters that upper bounds the area of the smallest ellipsoidal grid cells. \item {} -\emph{max\_resolution} - A nonnegative integer that is the maximum grid +\sphinxAtStartPar +\sphinxtitleref{max\_resolution} \sphinxhyphen{} A nonnegative integer that is the maximum grid resolution needed to have ellipsoidal cells of area at most -\emph{max\_areal\_resolution}. +\sphinxtitleref{max\_areal\_resolution}. \item {} -\emph{child\_order} - A dictionary of the ordering (Morton order) of child -cells of a cell in terms of the row-column coordinates in the matrix -of child cells. Child cell are numbered 0 to \emph{N\_side**2 -1} from +\sphinxAtStartPar +\sphinxtitleref{child\_order} \sphinxhyphen{} A dictionary of the ordering (Morton order) of child +cells of a cell in terms of the row\sphinxhyphen{}column coordinates in the matrix +of child cells. Child cell are numbered 0 to \sphinxtitleref{N\_side**2 \sphinxhyphen{}1} from left to right and top to bottom. \item {} -\emph{ul\_vertex} - A dictionary with key-value pairs (c, (x, y)), where -c is an element of \emph{cells0} and (x, y) is the upper left corner point +\sphinxAtStartPar +\sphinxtitleref{ul\_vertex} \sphinxhyphen{} A dictionary with key\sphinxhyphen{}value pairs (c, (x, y)), where +c is an element of \sphinxtitleref{cells0} and (x, y) is the upper left corner point of the resolution 0 planar cell c. \item {} -\emph{atomic\_neighbors} - A dictionary with key-value pairs -(n, \{`up': a, `down': b, `left': c, `right': d\}), -where n, a, b, c, and d are elements of \emph{cells0} or -\{0, 1, ..., \emph{N\_side**2 -1}\}. -Describes the planar (edge) neighbors of cell0 letter / child cell number +\sphinxAtStartPar +\sphinxtitleref{atomic\_neighbors} \sphinxhyphen{} A dictionary with key\sphinxhyphen{}value pairs +(n, \{‘up’: a, ‘down’: b, ‘left’: c, ‘right’: d\}), +where n, a, b, c, and d are elements of \sphinxtitleref{cells0} or +\{0, 1, …, \sphinxtitleref{N\_side**2 \sphinxhyphen{}1}\}. +Describes the planar (edge) neighbors of cell0 letter / child cell number n. \end{itemize} +\sphinxAtStartPar NOTE: -Several RHEALPixDGGS methods have the keyword argument `plane'. -Setting it to True indicates that all input and output points and cells are +\sphinxAtStartPar +Several RHEALPixDGGS methods have the keyword argument ‘plane’. +Setting it to True indicates that all input and output points and cells are interpreted as lying in the planar DGGS. -Setting it to False indicates that they are interpreted as lying in +Setting it to False indicates that they are interpreted as lying in the ellipsoidal DGGS. -\index{RHEALPixDGGS.cell() (in module rhealpix\_dggs.dggs)} +\index{cell() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{cell()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cell}\pysiglinewithargsret{\bfcode{cell}}{\emph{self}, \emph{suid=None}, \emph{level\_order\_index=None}, \emph{post\_order\_index=None}}{} -Return a cell (Cell instance) of this DGGS either from its ID or +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.cell}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cell}}}{\emph{\DUrole{n}{suid}\DUrole{o}{=}\DUrole{default_value}{None}}, \emph{\DUrole{n}{level\_order\_index}\DUrole{o}{=}\DUrole{default_value}{None}}, \emph{\DUrole{n}{post\_order\_index}\DUrole{o}{=}\DUrole{default_value}{None}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return a cell (Cell instance) of this DGGS either from its ID or from its resolution and index. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{4}\PYG{p}{,} \PYG{l+m+mi}{5}\PYG{p}{)}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n+nb}{isinstance}\PYG{p}{(}\PYG{n}{c}\PYG{p}{,} \PYG{n}{Cell}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{4}\PYG{p}{,} \PYG{l+m+mi}{5}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n+nb}{isinstance}\PYG{p}{(}\PYG{n}{c}\PYG{p}{,} \PYG{n}{Cell}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} \PYG{g+go}{N45} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{RHEALPixDGGS.cell\_area() (in module rhealpix\_dggs.dggs)} +\index{cell\_area() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{cell\_area()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cell_area}\pysiglinewithargsret{\bfcode{cell\_area}}{\emph{self}, \emph{resolution}, \emph{plane=True}}{} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.cell_area}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cell\_area}}}{\emph{\DUrole{n}{resolution}}, \emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}}{} +\pysigstopsignatures +\sphinxAtStartPar Return the area of a planar or ellipsoidal cell at the given resolution. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{a} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}area}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{a} \PYG{o}{==} \PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{6}\PYG{p}{)}\PYG{o}{*}\PYG{o}{*}\PYG{l+m+mi}{2}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{a} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}area}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{a} \PYG{o}{==} \PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{6}\PYG{p}{)}\PYG{o}{*}\PYG{o}{*}\PYG{l+m+mi}{2}\PYG{p}{)} \PYG{g+go}{True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}area}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} \PYG{o}{==} \PYG{l+m+mi}{8}\PYG{o}{/}\PYG{p}{(}\PYG{l+m+mi}{3}\PYG{o}{*}\PYG{n}{pi}\PYG{p}{)}\PYG{o}{*}\PYG{n}{a}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}area}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)} \PYG{o}{==} \PYG{l+m+mi}{8}\PYG{o}{/}\PYG{p}{(}\PYG{l+m+mi}{3}\PYG{o}{*}\PYG{n}{pi}\PYG{p}{)}\PYG{o}{*}\PYG{n}{a}\PYG{p}{)} \PYG{g+go}{True} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{RHEALPixDGGS.cell\_from\_point() (in module rhealpix\_dggs.dggs)} +\index{cell\_from\_point() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{cell\_from\_point()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cell_from_point}\pysiglinewithargsret{\bfcode{cell\_from\_point}}{\emph{self}, \emph{resolution}, \emph{p}, \emph{plane=True}}{} -Return the resolution \emph{resolution} cell that contains the point \emph{p}. -If \emph{plane} = True, then \emph{p} and the output cell lie in the +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.cell_from_point}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cell\_from\_point}}}{\emph{\DUrole{n}{resolution}}, \emph{\DUrole{n}{p}}, \emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return the resolution \sphinxtitleref{resolution} cell that contains the point \sphinxtitleref{p}. +If \sphinxtitleref{plane} = True, then \sphinxtitleref{p} and the output cell lie in the planar DGGS. -Otherwise, \emph{p} and the output cell lie in the ellipsoidal DGGS. +Otherwise, \sphinxtitleref{p} and the output cell lie in the ellipsoidal DGGS. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}from\PYGZus{}point}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{p}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} \PYG{g+go}{Q3} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{RHEALPixDGGS.cell\_from\_region() (in module rhealpix\_dggs.dggs)} +\index{cell\_from\_region() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{cell\_from\_region()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cell_from_region}\pysiglinewithargsret{\bfcode{cell\_from\_region}}{\emph{self}, \emph{ul}, \emph{dr}, \emph{plane=True}}{} -Return the smallest planar or ellipsoidal cell wholly containing -the region bounded by the axis-aligned rectangle with upper left -and lower right vertices given by the the points \emph{ul} and \emph{dr}, -respectively. +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.cell_from_region}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cell\_from\_region}}}{\emph{\DUrole{n}{ul}}, \emph{\DUrole{n}{dr}}, \emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return the smallest planar or ellipsoidal cell wholly containing +the region bounded by the axis\sphinxhyphen{}aligned rectangle with upper left +and lower right vertices given by the the points \sphinxtitleref{ul} and \sphinxtitleref{dr}, +respectively. If such as cell does not exist, then return None. -If \emph{plane} = True, then \emph{ul} and \emph{dr} and the returned cell +If \sphinxtitleref{plane} = True, then \sphinxtitleref{ul} and \sphinxtitleref{dr} and the returned cell lie in the planar DGGS. -Otherwise, \emph{ul} and \emph{dr} and the returned cell lie in the ellipsoidal +Otherwise, \sphinxtitleref{ul} and \sphinxtitleref{dr} and the returned cell lie in the ellipsoidal DGGS. -To specify an ellipsoidal cap region, set \emph{ul} = (-pi, pi/2) and -\emph{dr} = (-pi, phi) for a northern cap from latitudes pi/2 to phi, or -set \emph{ul} = (-pi, phi) and \emph{dr} = (-pi, -pi/2) for a southern cap from -latitudes phi to -pi/2. -(As usual, if \emph{self.ellipsoid.radians} = False, +\sphinxAtStartPar +To specify an ellipsoidal cap region, set \sphinxtitleref{ul} = (\sphinxhyphen{}pi, pi/2) and +\sphinxtitleref{dr} = (\sphinxhyphen{}pi, phi) for a northern cap from latitudes pi/2 to phi, or +set \sphinxtitleref{ul} = (\sphinxhyphen{}pi, phi) and \sphinxtitleref{dr} = (\sphinxhyphen{}pi, \sphinxhyphen{}pi/2) for a southern cap from +latitudes phi to \sphinxhyphen{}pi/2. +(As usual, if \sphinxtitleref{self.ellipsoid.radians} = False, then use degrees instead of radians when specifying ul and dr.) +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{12}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{q} \PYG{o}{=} \PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{6} \PYG{o}{\PYGZhy{}} \PYG{l+m+mf}{1e\PYGZhy{}6}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}from\PYGZus{}region}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{n}{q}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} \PYG{g+go}{Q3} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{RHEALPixDGGS.cell\_latitudes() (in module rhealpix\_dggs.dggs)} +\index{cell\_latitudes() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{cell\_latitudes()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cell_latitudes}\pysiglinewithargsret{\bfcode{cell\_latitudes}}{\emph{self}, \emph{resolution}, \emph{phi\_min}, \emph{phi\_max}, \emph{nucleus=True}, \emph{plane=True}}{} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.cell_latitudes}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cell\_latitudes}}}{\emph{\DUrole{n}{resolution}}, \emph{\DUrole{n}{phi\_min}}, \emph{\DUrole{n}{phi\_max}}, \emph{\DUrole{n}{nucleus}\DUrole{o}{=}\DUrole{default_value}{True}}, \emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}}{} +\pysigstopsignatures +\sphinxAtStartPar Return a list of every latitude phi whose parallel intersects -a resolution \emph{resolution} cell nucleus and satisfies -\emph{phi\_min} \textless{} phi \textless{} \emph{phi\_max}. -If \emph{plane} = True, then use rHEALPix y-coordinates for \emph{phi\_min}, -\emph{phi\_max}, and the result. Return the list in increasing order. -If \emph{nucleus} = False, then return a list of every latitude phi whose -parallel intersects the north or south boundary of a resolution -\emph{resolution} cell and that satisfies \emph{phi\_min} \textless{} phi \textless{} \emph{phi\_max}. - +a resolution \sphinxtitleref{resolution} cell nucleus and satisfies +\sphinxtitleref{phi\_min} \textless{} phi \textless{} \sphinxtitleref{phi\_max}. +If \sphinxtitleref{plane} = True, then use rHEALPix y\sphinxhyphen{}coordinates for \sphinxtitleref{phi\_min}, +\sphinxtitleref{phi\_max}, and the result. Return the list in increasing order. +If \sphinxtitleref{nucleus} = False, then return a list of every latitude phi whose +parallel intersects the north or south boundary of a resolution +\sphinxtitleref{resolution} cell and that satisfies \sphinxtitleref{phi\_min} \textless{} phi \textless{} \sphinxtitleref{phi\_max}. + +\sphinxAtStartPar NOTE: -By convention, the pole latitudes pi/2 and -pi/2 (or their -corresponding rHEALPix y-coordinates) will be excluded. +\sphinxAtStartPar +By convention, the pole latitudes pi/2 and \sphinxhyphen{}pi/2 (or their +corresponding rHEALPix y\sphinxhyphen{}coordinates) will be excluded. -There are 2*self.N\_side**resolution - 1 nuclei -latitudes between the poles if self.N\_side is odd and +\sphinxAtStartPar +There are 2*self.N\_side**resolution \sphinxhyphen{} 1 nuclei +latitudes between the poles if self.N\_side is odd and 2*self.N\_side**resolution if self.N\_side is even. -Consequently, there are 2*self.N\_side**resolution -boundary latitudes between the poles if self.N\_side is odd and -2*self.N\_side**resolution - 1 boundary latitudes if self.N\_side is +Consequently, there are 2*self.N\_side**resolution +boundary latitudes between the poles if self.N\_side is odd and +2*self.N\_side**resolution \sphinxhyphen{} 1 boundary latitudes if self.N\_side is even. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}003\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{phi} \PYG{o+ow}{in} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}latitudes}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{phi}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{\PYGZhy{}1.020505844} -\PYG{g+go}{\PYGZhy{}0.461443149003} -\PYG{g+go}{\PYGZhy{}0} -\PYG{g+go}{0.461443149003} -\PYG{g+go}{1.020505844} -\PYG{g+go}{1.57079632679} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{phi} \PYG{o+ow}{in} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}latitudes}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{nucleus}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{phi}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{\PYGZhy{}1.29836248989} -\PYG{g+go}{\PYGZhy{}0.730836688113} -\PYG{g+go}{\PYGZhy{}0.224577156195} -\PYG{g+go}{0.224577156195} -\PYG{g+go}{0.730836688113} -\PYG{g+go}{1.29836248989} -\end{Verbatim} - -\end{fulllineitems} - -\index{RHEALPixDGGS.cell\_width() (in module rhealpix\_dggs.dggs)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cell_width}\pysiglinewithargsret{\bfcode{cell\_width}}{\emph{self}, \emph{resolution}, \emph{plane=True}}{} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{phi} \PYG{o+ow}{in} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}latitudes}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)}\PYG{p}{:} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{phi}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{\PYGZhy{}1.02050584399985} +\PYG{g+go}{\PYGZhy{}0.46144314900303} +\PYG{g+go}{\PYGZhy{}0.0} +\PYG{g+go}{0.46144314900303} +\PYG{g+go}{1.02050584399985} +\PYG{g+go}{1.5707963267949} +\end{sphinxVerbatim} +\begin{description} +\sphinxlineitem{NOTES:: .. Issue @1 was ..} +\sphinxAtStartPar +\sphinxhyphen{}1.020505844 +\sphinxhyphen{}0.461443149003 +\sphinxhyphen{}0 +0.461443149003 +1.020505844 +1.57079632679 + +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{phi} \PYG{o+ow}{in} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}latitudes}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{nucleus}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)}\PYG{p}{:} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{phi}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{\PYGZhy{}1.29836248988994} +\PYG{g+go}{\PYGZhy{}0.73083668811327} +\PYG{g+go}{\PYGZhy{}0.22457715619516} +\PYG{g+go}{0.22457715619516} +\PYG{g+go}{0.73083668811327} +\PYG{g+go}{1.29836248988994} +\end{sphinxVerbatim} + +\sphinxlineitem{NOTES:: .. Issue @1 was ..} +\sphinxAtStartPar +\sphinxhyphen{}1.29836248989 +\sphinxhyphen{}0.730836688113 +\sphinxhyphen{}0.224577156195 +0.224577156195 +0.730836688113 +1.29836248989 + +\end{description} + +\end{fulllineitems} + +\index{cell\_width() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{cell\_width()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} + +\begin{fulllineitems} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.cell_width}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cell\_width}}}{\emph{\DUrole{n}{resolution}}, \emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}}{} +\pysigstopsignatures +\sphinxAtStartPar Return the width of a planar cell at the given resolution. -If \emph{plane} = False, then return None, -because the ellipsoidal cells don't have constant width. +If \sphinxtitleref{plane} = False, then return None, +because the ellipsoidal cells don’t have constant width. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}width}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{)} \PYG{o}{==} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}width}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{)} \PYG{o}{==} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)} \PYG{g+go}{True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}width}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{)} \PYG{o}{==} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{6}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}width}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{)} \PYG{o}{==} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{6}\PYG{p}{)} \PYG{g+go}{True} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{cells0 (rhealpix\_dggs.dggs.RHEALPixDGGS attribute)} +\index{cells0 (rhealpixdggs.dggs.RHEALPixDGGS attribute)@\spxentry{cells0}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS attribute}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cells0}\pysigline{\bfcode{cells0}\strong{ = {[}'N', `O', `P', `Q', `R', `S'{]}}} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.cells0}} +\pysigstartsignatures +\pysigline{\sphinxbfcode{\sphinxupquote{cells0}}\sphinxbfcode{\sphinxupquote{\DUrole{w}{ }\DUrole{p}{=}\DUrole{w}{ }{[}\textquotesingle{}N\textquotesingle{}, \textquotesingle{}O\textquotesingle{}, \textquotesingle{}P\textquotesingle{}, \textquotesingle{}Q\textquotesingle{}, \textquotesingle{}R\textquotesingle{}, \textquotesingle{}S\textquotesingle{}{]}}}} +\pysigstopsignatures \end{fulllineitems} -\index{RHEALPixDGGS.cells\_from\_meridian() (in module rhealpix\_dggs.dggs)} +\index{cells\_from\_meridian() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{cells\_from\_meridian()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cells_from_meridian}\pysiglinewithargsret{\bfcode{cells\_from\_meridian}}{\emph{self}, \emph{resolution}, \emph{lam}, \emph{phi\_min}, \emph{phi\_max}}{} -Return a list of the resolution \emph{resolution} cells that intersect -the meridian segment of longitude \emph{lam} whose least latitude is -\emph{phi\_min} and whose greatest latitude is \emph{phi\_max}. +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.cells_from_meridian}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cells\_from\_meridian}}}{\emph{\DUrole{n}{resolution}}, \emph{\DUrole{n}{lam}}, \emph{\DUrole{n}{phi\_min}}, \emph{\DUrole{n}{phi\_max}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return a list of the resolution \sphinxtitleref{resolution} cells that intersect +the meridian segment of longitude \sphinxtitleref{lam} whose least latitude is +\sphinxtitleref{phi\_min} and whose greatest latitude is \sphinxtitleref{phi\_max}. Sort the cells from north to south and west to east in case two cells with the same nucleus latitude intersect the meridian. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}003\PYGZus{}RADIANS} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{cells} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}meridian}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{l+m+mf}{0.1}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{cells}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{cells}\PYG{p}{]}\PYG{p}{)} \PYG{g+go}{[\PYGZsq{}N4\PYGZsq{}, \PYGZsq{}N2\PYGZsq{}, \PYGZsq{}N1\PYGZsq{}, \PYGZsq{}Q0\PYGZsq{}, \PYGZsq{}Q3\PYGZsq{}, \PYGZsq{}Q6\PYGZsq{}, \PYGZsq{}S8\PYGZsq{}, \PYGZsq{}S7\PYGZsq{}, \PYGZsq{}S4\PYGZsq{}]} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{RHEALPixDGGS.cells\_from\_parallel() (in module rhealpix\_dggs.dggs)} +\index{cells\_from\_parallel() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{cells\_from\_parallel()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cells_from_parallel}\pysiglinewithargsret{\bfcode{cells\_from\_parallel}}{\emph{self}, \emph{resolution}, \emph{phi}, \emph{lam\_min}, \emph{lam\_max}}{} -Return a list of the resolution \emph{resolution} cells that intersect -the parallel segment of latitude \emph{phi} whose least longitude is -\emph{lam\_min} and whose greatest longitude is \emph{lam\_max}. +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.cells_from_parallel}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cells\_from\_parallel}}}{\emph{\DUrole{n}{resolution}}, \emph{\DUrole{n}{phi}}, \emph{\DUrole{n}{lam\_min}}, \emph{\DUrole{n}{lam\_max}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return a list of the resolution \sphinxtitleref{resolution} cells that intersect +the parallel segment of latitude \sphinxtitleref{phi} whose least longitude is +\sphinxtitleref{lam\_min} and whose greatest longitude is \sphinxtitleref{lam\_max}. Sort the list from west to east. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}003\PYGZus{}RADIANS} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{cells} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}parallel}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{p}{,} \PYG{n}{pi}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{cells}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{cells}\PYG{p}{]}\PYG{p}{)} \PYG{g+go}{[\PYGZsq{}N6\PYGZsq{}, \PYGZsq{}N7\PYGZsq{}, \PYGZsq{}N8\PYGZsq{}, \PYGZsq{}N5\PYGZsq{}, \PYGZsq{}N2\PYGZsq{}, \PYGZsq{}N1\PYGZsq{}, \PYGZsq{}N0\PYGZsq{}, \PYGZsq{}N3\PYGZsq{}]} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{RHEALPixDGGS.cells\_from\_region() (in module rhealpix\_dggs.dggs)} +\index{cells\_from\_region() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{cells\_from\_region()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cells_from_region}\pysiglinewithargsret{\bfcode{cells\_from\_region}}{\emph{self}, \emph{resolution}, \emph{ul}, \emph{dr}, \emph{plane=True}}{} -If \emph{plane} = True, then return a list of lists of resolution -\emph{resolution} cells that cover the axis-aligned rectangle whose -upper left and lower right vertices are the points \emph{ul} and \emph{dr}, -respectively. -In the output, sort each sublist of cells from left to right (in the +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.cells_from_region}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{cells\_from\_region}}}{\emph{\DUrole{n}{resolution}}, \emph{\DUrole{n}{ul}}, \emph{\DUrole{n}{dr}}, \emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}}{} +\pysigstopsignatures +\sphinxAtStartPar +If \sphinxtitleref{plane} = True, then return a list of lists of resolution +\sphinxtitleref{resolution} cells that cover the axis\sphinxhyphen{}aligned rectangle whose +upper left and lower right vertices are the points \sphinxtitleref{ul} and \sphinxtitleref{dr}, +respectively. +In the output, sort each sublist of cells from left to right (in the planar DGGS) and sort the sublists from top to bottom. -If \emph{plane} = False, then return a list of lists of resolution -\emph{resolution} -cells that cover the longitude-latitude aligned ellipsoidal quadrangle -whose northwest and southeast vertices are the points \emph{ul} and \emph{dr}, -respectively. Defunct quads with \emph{ul} = (stuff, pi/2) or -\emph{dr} = (stuff, -pi/2) also work -(and rely on the fact that the north and south pole can both +\sphinxAtStartPar +If \sphinxtitleref{plane} = False, then return a list of lists of resolution +\sphinxtitleref{resolution} +cells that cover the longitude\sphinxhyphen{}latitude aligned ellipsoidal quadrangle +whose northwest and southeast vertices are the points \sphinxtitleref{ul} and \sphinxtitleref{dr}, +respectively. Defunct quads with \sphinxtitleref{ul} = (stuff, pi/2) or +\sphinxtitleref{dr} = (stuff, \sphinxhyphen{}pi/2) also work +(and rely on the fact that the north and south pole can both be specified by infinitely many longitudes). -To specify an ellipsoidal cap region, set \emph{ul} = (-pi, pi/2) and -\emph{dr} = (-pi, phi) for a northern cap from latitudes pi/2 to phi, or -set \emph{ul} = (-pi, phi) and \emph{dr} = (-pi, -pi/2) for a southern cap from -latitudes phi to -pi/2. (As usual, if \emph{self.ellipsoid.radians} = False, +\sphinxAtStartPar +To specify an ellipsoidal cap region, set \sphinxtitleref{ul} = (\sphinxhyphen{}pi, pi/2) and +\sphinxtitleref{dr} = (\sphinxhyphen{}pi, phi) for a northern cap from latitudes pi/2 to phi, or +set \sphinxtitleref{ul} = (\sphinxhyphen{}pi, phi) and \sphinxtitleref{dr} = (\sphinxhyphen{}pi, \sphinxhyphen{}pi/2) for a southern cap from +latitudes phi to \sphinxhyphen{}pi/2. (As usual, if \sphinxtitleref{self.ellipsoid.radians} = False, then use degrees instead of radians when specifying ul and dr.) -In the output, sort each sublist of cells from west to east (in the +\sphinxAtStartPar +In the output, sort each sublist of cells from west to east (in the ellipsoidal DGGS) and sort the sublists from north to south. -Return the empty list if if \emph{ul{[}0{]} \textgreater{} dr{[}0{]}} or \emph{ul{[}1{]} \textless{} dr{[}1{]}}. +\sphinxAtStartPar +Return the empty list if if \sphinxtitleref{ul{[}0{]} \textgreater{} dr{[}0{]}} or \sphinxtitleref{ul{[}1{]} \textless{} dr{[}1{]}}. +\sphinxAtStartPar NOTE: -If \emph{plane} = True, then the resulting list is a matrix, that is, +\sphinxAtStartPar +If \sphinxtitleref{plane} = True, then the resulting list is a matrix, that is, each sublist has the same length. This is not necessarily so if -\emph{plane} = False; see the examples below. +\sphinxtitleref{plane} = False; see the examples below. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}003\PYGZus{}RADIANS} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{R\PYGZus{}A} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{ellipsoid}\PYG{o}{.}\PYG{n}{R\PYGZus{}A} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{ul} \PYG{o}{=} \PYG{n}{R\PYGZus{}A}\PYG{o}{*}\PYG{n}{array}\PYG{p}{(}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mf}{0.1}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{dr} \PYG{o}{=} \PYG{n}{R\PYGZus{}A}\PYG{o}{*}\PYG{n}{array}\PYG{p}{(}\PYG{p}{(}\PYG{l+m+mf}{0.1}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{)} \PYG{c}{\PYGZsh{} Rectangle } +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{dr} \PYG{o}{=} \PYG{n}{R\PYGZus{}A}\PYG{o}{*}\PYG{n}{array}\PYG{p}{(}\PYG{p}{(}\PYG{l+m+mf}{0.1}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{)} \PYG{c+c1}{\PYGZsh{} Rectangle} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{M} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}region}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{ul}\PYG{p}{,} \PYG{n}{dr}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{row} \PYG{o+ow}{in} \PYG{n}{M}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{]}\PYG{p}{)} \PYG{g+go}{[\PYGZsq{}P2\PYGZsq{}, \PYGZsq{}Q0\PYGZsq{}]} \PYG{g+go}{[\PYGZsq{}P5\PYGZsq{}, \PYGZsq{}Q3\PYGZsq{}]} \PYG{g+go}{[\PYGZsq{}P8\PYGZsq{}, \PYGZsq{}Q6\PYGZsq{}]} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{ul} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{dr} \PYG{o}{=} \PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)} \PYG{c}{\PYGZsh{} Quad } -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{M} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}region}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{ul}\PYG{p}{,} \PYG{n}{dr}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{dr} \PYG{o}{=} \PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)} \PYG{c+c1}{\PYGZsh{} Quad} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{M} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}region}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{ul}\PYG{p}{,} \PYG{n}{dr}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{row} \PYG{o+ow}{in} \PYG{n}{M}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{]}\PYG{p}{)} \PYG{g+go}{[\PYGZsq{}N2\PYGZsq{}, \PYGZsq{}N1\PYGZsq{}, \PYGZsq{}N0\PYGZsq{}]} \PYG{g+go}{[\PYGZsq{}Q0\PYGZsq{}, \PYGZsq{}Q1\PYGZsq{}, \PYGZsq{}Q2\PYGZsq{}, \PYGZsq{}R0\PYGZsq{}]} \PYG{g+go}{[\PYGZsq{}Q3\PYGZsq{}, \PYGZsq{}Q4\PYGZsq{}, \PYGZsq{}Q5\PYGZsq{}, \PYGZsq{}R3\PYGZsq{}]} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{ul} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{6}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{dr} \PYG{o}{=} \PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)} \PYG{c}{\PYGZsh{} Defunct quad / lune segment } -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{M} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}region}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{ul}\PYG{p}{,} \PYG{n}{dr}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{dr} \PYG{o}{=} \PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)} \PYG{c+c1}{\PYGZsh{} Defunct quad / lune segment} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{M} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}region}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{ul}\PYG{p}{,} \PYG{n}{dr}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{row} \PYG{o+ow}{in} \PYG{n}{M}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{]}\PYG{p}{)} \PYG{g+go}{[\PYGZsq{}Q6\PYGZsq{}, \PYGZsq{}Q7\PYGZsq{}, \PYGZsq{}Q8\PYGZsq{}, \PYGZsq{}R6\PYGZsq{}]} \PYG{g+go}{[\PYGZsq{}S8\PYGZsq{}, \PYGZsq{}S7\PYGZsq{}, \PYGZsq{}S6\PYGZsq{}]} \PYG{g+go}{[\PYGZsq{}S4\PYGZsq{}]} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{ul} \PYG{o}{=} \PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{5}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{dr} \PYG{o}{=} \PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)} \PYG{c}{\PYGZsh{} Cap} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{M} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}region}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{ul}\PYG{p}{,} \PYG{n}{dr}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{ul} \PYG{o}{=} \PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{5}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{dr} \PYG{o}{=} \PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)} \PYG{c+c1}{\PYGZsh{} Cap} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{M} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}region}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{ul}\PYG{p}{,} \PYG{n}{dr}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{k+kc}{False}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{row} \PYG{o+ow}{in} \PYG{n}{M}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{]}\PYG{p}{)} \PYG{g+go}{[\PYGZsq{}O6\PYGZsq{}, \PYGZsq{}O7\PYGZsq{}, \PYGZsq{}O8\PYGZsq{}, \PYGZsq{}P6\PYGZsq{}, \PYGZsq{}P7\PYGZsq{}, \PYGZsq{}P8\PYGZsq{}, \PYGZsq{}Q6\PYGZsq{}, \PYGZsq{}Q7\PYGZsq{}, \PYGZsq{}Q8\PYGZsq{}, \PYGZsq{}R6\PYGZsq{}, \PYGZsq{}R7\PYGZsq{}, \PYGZsq{}R8\PYGZsq{}]} \PYG{g+go}{[\PYGZsq{}S0\PYGZsq{}, \PYGZsq{}S1\PYGZsq{}, \PYGZsq{}S2\PYGZsq{}, \PYGZsq{}S5\PYGZsq{}, \PYGZsq{}S8\PYGZsq{}, \PYGZsq{}S7\PYGZsq{}, \PYGZsq{}S6\PYGZsq{}, \PYGZsq{}S3\PYGZsq{}]} \PYG{g+go}{[\PYGZsq{}S4\PYGZsq{}]} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{RHEALPixDGGS.combine\_triangles() (in module rhealpix\_dggs.dggs)} +\index{combine\_triangles() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{combine\_triangles()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.combine_triangles}\pysiglinewithargsret{\bfcode{combine\_triangles}}{\emph{self}, \emph{u}, \emph{v}, \emph{inverse=False}}{} -Return the combine\_triangles() transformation of the point \emph{(u, v)} -(or its inverse if \emph{inverse} = True) appropriate to the underlying +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.combine_triangles}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{combine\_triangles}}}{\emph{\DUrole{n}{u}}, \emph{\DUrole{n}{v}}, \emph{\DUrole{n}{inverse}\DUrole{o}{=}\DUrole{default_value}{False}}, \emph{\DUrole{n}{region}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}none\textquotesingle{}}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return the combine\_triangles() transformation of the point \sphinxtitleref{(u, v)} +(or its inverse if \sphinxtitleref{inverse} = True) appropriate to the underlying ellipsoid. It maps the HEALPix projection to the rHEALPix projection. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{q} \PYG{o}{=} \PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{combine\PYGZus{}triangles}\PYG{p}{(}\PYG{o}{*}\PYG{n}{p}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{combine\PYGZus{}triangles}\PYG{p}{(}\PYG{o}{*}\PYG{n}{p}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(0.0, 0.0)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{combine\PYGZus{}triangles}\PYG{p}{(}\PYG{o}{*}\PYG{n}{q}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}2.35619449019234, 1.5707963267949001)} -\end{Verbatim} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{combine\PYGZus{}triangles}\PYG{p}{(}\PYG{o}{*}\PYG{n}{q}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(\PYGZhy{}2.35619449019234, 1.5707963267949)} +\end{sphinxVerbatim} +\begin{description} +\sphinxlineitem{NOTES:: Issue \#1 was ..} +\sphinxAtStartPar +(\sphinxhyphen{}2.35619449019234, 1.5707963267949001) + +\end{description} \end{fulllineitems} -\index{RHEALPixDGGS.grid() (in module rhealpix\_dggs.dggs)} +\index{grid() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{grid()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.grid}\pysiglinewithargsret{\bfcode{grid}}{\emph{self}, \emph{resolution}}{} -Generator function for all the cells at resolution \emph{resolution}. +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.grid}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{grid}}}{\emph{\DUrole{n}{resolution}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Generator function for all the cells at resolution \sphinxtitleref{resolution}. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{grid0} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{grid}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{x}\PYG{p}{)} \PYG{k}{for} \PYG{n}{x} \PYG{o+ow}{in} \PYG{n}{grid0}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{x}\PYG{p}{)} \PYG{k}{for} \PYG{n}{x} \PYG{o+ow}{in} \PYG{n}{grid0}\PYG{p}{]}\PYG{p}{)} \PYG{g+go}{[\PYGZsq{}N\PYGZsq{}, \PYGZsq{}O\PYGZsq{}, \PYGZsq{}P\PYGZsq{}, \PYGZsq{}Q\PYGZsq{}, \PYGZsq{}R\PYGZsq{}, \PYGZsq{}S\PYGZsq{}]} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{RHEALPixDGGS.healpix() (in module rhealpix\_dggs.dggs)} +\index{healpix() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{healpix()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.healpix}\pysiglinewithargsret{\bfcode{healpix}}{\emph{self}, \emph{u}, \emph{v}, \emph{inverse=False}}{} -Return the HEALPix projection of point \emph{(u, v)} (or its inverse if -\emph{inverse} = True) appropriate to this rHEALPix DGGS. +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.healpix}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{healpix}}}{\emph{\DUrole{n}{u}}, \emph{\DUrole{n}{v}}, \emph{\DUrole{n}{inverse}\DUrole{o}{=}\DUrole{default_value}{False}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return the HEALPix projection of point \sphinxtitleref{(u, v)} (or its inverse if +\sphinxtitleref{inverse} = True) appropriate to this rHEALPix DGGS. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{healpix}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}2.35619449019234, 1.5707963267949001)} -\end{Verbatim} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{healpix}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(\PYGZhy{}2.35619449019234, 1.5707963267949)} +\end{sphinxVerbatim} +\begin{description} +\sphinxlineitem{NOTES:: Issue \#1 was ..} +\sphinxAtStartPar +(\sphinxhyphen{}2.35619449019234, 1.5707963267949001) * + +\end{description} +\sphinxAtStartPar NOTE: -Uses \code{pj\_healpix} instead of the PROJ.4 version of HEALPix. +\sphinxAtStartPar +Uses \sphinxcode{\sphinxupquote{pj\_healpix}} instead of the PROJ.4 version of HEALPix. \end{fulllineitems} -\index{RHEALPixDGGS.interval() (in module rhealpix\_dggs.dggs)} +\index{interval() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{interval()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.interval}\pysiglinewithargsret{\bfcode{interval}}{\emph{self}, \emph{a}, \emph{b}}{} -Generator function for all the resolution -\emph{max(a.resolution, b.resolution)} cells between cell -\emph{a} and cell \emph{b} (inclusive and with respect to the +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.interval}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{interval}}}{\emph{\DUrole{n}{a}}, \emph{\DUrole{n}{b}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Generator function for all the resolution +\sphinxtitleref{max(a.resolution, b.resolution)} cells between cell +\sphinxtitleref{a} and cell \sphinxtitleref{b} (inclusive and with respect to the postorder ordering on cells). -Note that \emph{a} and \emph{b} don't have to lie at the same resolution. +Note that \sphinxtitleref{a} and \sphinxtitleref{b} don’t have to lie at the same resolution. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{a} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{)}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{b} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,}\PYG{p}{)}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} \PYG{k}{for} \PYG{n}{c} \PYG{o+ow}{in} \PYG{n+nb}{list}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{interval}\PYG{p}{(}\PYG{n}{a}\PYG{p}{,} \PYG{n}{b}\PYG{p}{)}\PYG{p}{)}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{a} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{b} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{(}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} \PYG{k}{for} \PYG{n}{c} \PYG{o+ow}{in} \PYG{n+nb}{list}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{interval}\PYG{p}{(}\PYG{n}{a}\PYG{p}{,} \PYG{n}{b}\PYG{p}{)}\PYG{p}{)}\PYG{p}{]}\PYG{p}{)} \PYG{g+go}{[\PYGZsq{}N1\PYGZsq{}, \PYGZsq{}N2\PYGZsq{}, \PYGZsq{}N3\PYGZsq{}, \PYGZsq{}N4\PYGZsq{}, \PYGZsq{}N5\PYGZsq{}, \PYGZsq{}N6\PYGZsq{}, \PYGZsq{}N7\PYGZsq{}, \PYGZsq{}N8\PYGZsq{}]} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{RHEALPixDGGS.minimal\_cover() (in module rhealpix\_dggs.dggs)} +\index{minimal\_cover() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{minimal\_cover()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.minimal_cover}\pysiglinewithargsret{\bfcode{minimal\_cover}}{\emph{self}, \emph{resolution}, \emph{points}, \emph{plane=True}}{} -Find the minimal set of resolution \emph{resolution} cells that covers -the list of points \emph{points}. -If \emph{plane} = True, then assume \emph{points} is a list of x-y +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.minimal_cover}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{minimal\_cover}}}{\emph{\DUrole{n}{resolution}}, \emph{\DUrole{n}{points}}, \emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Find the minimal set of resolution \sphinxtitleref{resolution} cells that covers +the list of points \sphinxtitleref{points}. +If \sphinxtitleref{plane} = True, then assume \sphinxtitleref{points} is a list of x\sphinxhyphen{}y coordinates in the planar DGGS. -If \emph{plane} = False, then assume \emph{points} is a list of -longitude-latitude coordinates in the ellipsoidal DGGS. -This method will be made redundant by standard GIS rasterization +If \sphinxtitleref{plane} = False, then assume \sphinxtitleref{points} is a list of +longitude\sphinxhyphen{}latitude coordinates in the ellipsoidal DGGS. +This method will be made redundant by standard GIS rasterization tools that implement the rHEALPix projection. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c1} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c2} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{P}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{7}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c1} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c2} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{P}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{7}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{]}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{points} \PYG{o}{=} \PYG{p}{[}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{p}{)} \PYG{k}{for} \PYG{n}{c} \PYG{o+ow}{in} \PYG{p}{[}\PYG{n}{c1}\PYG{p}{,} \PYG{n}{c2}\PYG{p}{]}\PYG{p}{]} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{r} \PYG{o+ow}{in} \PYG{n+nb}{range}\PYG{p}{(}\PYG{l+m+mi}{5}\PYG{p}{)}\PYG{p}{:} \PYG{g+gp}{... } \PYG{n}{cover} \PYG{o}{=} \PYG{n+nb}{sorted}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{minimal\PYGZus{}cover}\PYG{p}{(}\PYG{n}{r}\PYG{p}{,} \PYG{n}{points}\PYG{p}{)}\PYG{p}{)} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} \PYG{k}{for} \PYG{n}{c} \PYG{o+ow}{in} \PYG{n}{cover}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{... } \PYG{n+nb}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} \PYG{k}{for} \PYG{n}{c} \PYG{o+ow}{in} \PYG{n}{cover}\PYG{p}{]}\PYG{p}{)} \PYG{g+go}{[\PYGZsq{}N\PYGZsq{}, \PYGZsq{}P\PYGZsq{}]} \PYG{g+go}{[\PYGZsq{}N0\PYGZsq{}, \PYGZsq{}P7\PYGZsq{}]} \PYG{g+go}{[\PYGZsq{}N02\PYGZsq{}, \PYGZsq{}P73\PYGZsq{}]} \PYG{g+go}{[\PYGZsq{}N021\PYGZsq{}, \PYGZsq{}P733\PYGZsq{}]} \PYG{g+go}{[\PYGZsq{}N0214\PYGZsq{}, \PYGZsq{}P7334\PYGZsq{}]} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{RHEALPixDGGS.num\_cells() (in module rhealpix\_dggs.dggs)} +\index{num\_cells() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{num\_cells()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.num_cells}\pysiglinewithargsret{\bfcode{num\_cells}}{\emph{self}, \emph{res\_1}, \emph{res\_2=None}, \emph{subcells=False}}{} -Return the number of cells of resolutions \emph{res\_1} to \emph{res\_2} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.num_cells}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{num\_cells}}}{\emph{\DUrole{n}{res\_1}}, \emph{\DUrole{n}{res\_2}\DUrole{o}{=}\DUrole{default_value}{None}}, \emph{\DUrole{n}{subcells}\DUrole{o}{=}\DUrole{default_value}{False}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return the number of cells of resolutions \sphinxtitleref{res\_1} to \sphinxtitleref{res\_2} (inclusive). -Assume \emph{res\_1 \textless{}= res\_2}. -If \emph{subcells} = True, then return the number of subcells at resolutions -\emph{res\_1} to \emph{res\_2} (inclusive) of a cell at resolution \emph{res\_1}. -If \emph{res\_2=None} and \emph{subcells=False, then return the number of -cells at resolution {}`res\_1}. -If \emph{res\_2=None} and \emph{subcells} = True, then return the number of -subcells from resolution \emph{res\_1} to resolution \emph{self.max\_resolution}. +Assume \sphinxtitleref{res\_1 \textless{}= res\_2}. +If \sphinxtitleref{subcells} = True, then return the number of subcells at resolutions +\sphinxtitleref{res\_1} to \sphinxtitleref{res\_2} (inclusive) of a cell at resolution \sphinxtitleref{res\_1}. +If \sphinxtitleref{res\_2=None} and \sphinxtitleref{subcells=False, then return the number of +cells at resolution \textasciigrave{}res\_1}. +If \sphinxtitleref{res\_2=None} and \sphinxtitleref{subcells} = True, then return the number of +subcells from resolution \sphinxtitleref{res\_1} to resolution \sphinxtitleref{self.max\_resolution}. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{num\PYGZus{}cells}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{)} \PYG{g+go}{6} \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{num\PYGZus{}cells}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{)} \PYG{g+go}{60} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{num\PYGZus{}cells}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{subcells}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{num\PYGZus{}cells}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{subcells}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)} \PYG{g+go}{231627523606480} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{num\PYGZus{}cells}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{subcells}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{num\PYGZus{}cells}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{subcells}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)} \PYG{g+go}{10} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{num\PYGZus{}cells}\PYG{p}{(}\PYG{l+m+mi}{5}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{,} \PYG{n}{subcells}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{num\PYGZus{}cells}\PYG{p}{(}\PYG{l+m+mi}{5}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{,} \PYG{n}{subcells}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)} \PYG{g+go}{10} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{RHEALPixDGGS.plot\_cells() (in module rhealpix\_dggs.dggs)} +\index{random\_cell() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{random\_cell()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.plot_cells}\pysiglinewithargsret{\bfcode{plot\_cells}}{\emph{self}, \emph{cells}, \emph{surface='plane'}, \emph{label=True}, \emph{fontsize=15}, \emph{saturation=0.5}}{} -Plot the given list of cells on the given surface. -The cells should all come from the same rHEALPix DGGS. -Inessential graphics method. -Requires Sage graphics methods. - -INPUT: -\begin{itemize} -\item {} -\emph{cells} - A list of cells from a common rHEALPix DGGS. - -\item {} -\emph{surface} - (Optional; default = `plane'). -One of the strings `plane', `plane\_lonlat', `cube', or `ellipsoid'. -Surface to draw cells on. - -\item {} -\emph{label} - (Optional; default = True). If True, then label cells -with their names. If False, then don't. - -\item {} -\emph{saturation} - (Optional) Number between 0 and 1 indicating the -saturation value of the cell color. - -\end{itemize} - -\end{fulllineitems} - -\index{RHEALPixDGGS.random\_cell() (in module rhealpix\_dggs.dggs)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.random_cell}\pysiglinewithargsret{\bfcode{random\_cell}}{\emph{self}, \emph{resolution=None}}{} -Return a cell of the given resolution chosen uniformly at random +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.random_cell}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{random\_cell}}}{\emph{\DUrole{n}{resolution}\DUrole{o}{=}\DUrole{default_value}{None}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return a cell of the given resolution chosen uniformly at random from all cells at that resolution. -If \emph{resolution=None}, then the cell resolution is first chosen +If \sphinxtitleref{resolution=None}, then the cell resolution is first chosen uniformly at random from {[}0,..,self.max\_resolution{]}. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{o}{.}\PYG{n}{random\PYGZus{}cell}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} +\begin{sphinxVerbatim}[commandchars=\\\{\}] +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{o}{.}\PYG{n}{random\PYGZus{}cell}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{S480586367780080} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{RHEALPixDGGS.random\_point() (in module rhealpix\_dggs.dggs)} +\index{random\_point() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{random\_point()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.random_point}\pysiglinewithargsret{\bfcode{random\_point}}{\emph{self}, \emph{plane=True}}{} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.random_point}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{random\_point}}}{\emph{\DUrole{n}{plane}\DUrole{o}{=}\DUrole{default_value}{True}}}{} +\pysigstopsignatures +\sphinxAtStartPar Return a point in this DGGS sampled uniformly at random from the plane or from the ellipsoid. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{E}\PYG{o}{.}\PYG{n}{random\PYGZus{}point}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{E}\PYG{o}{.}\PYG{n}{random\PYGZus{}point}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(\PYGZhy{}1.0999574573422948, 0.21029104897701129)} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{RHEALPixDGGS.rhealpix() (in module rhealpix\_dggs.dggs)} +\index{rhealpix() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{rhealpix()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.rhealpix}\pysiglinewithargsret{\bfcode{rhealpix}}{\emph{self}, \emph{u}, \emph{v}, \emph{inverse=False}}{} -Return the rHEALPix projection of the point \emph{(u, v)} (or its inverse if -\emph{inverse} = True) appropriate to this rHEALPix DGGS. +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.rhealpix}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{rhealpix}}}{\emph{\DUrole{n}{u}}, \emph{\DUrole{n}{v}}, \emph{\DUrole{n}{inverse}\DUrole{o}{=}\DUrole{default_value}{False}}, \emph{\DUrole{n}{region}\DUrole{o}{=}\DUrole{default_value}{\textquotesingle{}none\textquotesingle{}}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Return the rHEALPix projection of the point \sphinxtitleref{(u, v)} (or its inverse if +\sphinxtitleref{inverse} = True) appropriate to this rHEALPix DGGS. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{rhealpix}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}1.8582720066839999, 2.0687188103032401)} -\end{Verbatim} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{rhealpix}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(\PYGZhy{}1.858272006684, 2.06871881030324)} +\end{sphinxVerbatim} +\begin{description} +\sphinxlineitem{NOTES:: Issue \#1 was ..} +\sphinxAtStartPar +(\sphinxhyphen{}1.8582720066839999, 2.0687188103032401) + +\end{description} +\sphinxAtStartPar NOTE: -Uses \code{pj\_rhealpix} instead of the PROJ.4 version of rHEALPix. +\sphinxAtStartPar +Uses \sphinxcode{\sphinxupquote{pj\_rhealpix}} instead of the PROJ.4 version of rHEALPix. \end{fulllineitems} -\index{RHEALPixDGGS.triangle() (in module rhealpix\_dggs.dggs)} +\index{triangle() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{triangle()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.triangle}\pysiglinewithargsret{\bfcode{triangle}}{\emph{self}, \emph{x}, \emph{y}, \emph{inverse=True}}{} -If \emph{inverse} = False, then assume \emph{(x,y)} lies in the image of the -HEALPix projection that comes with this DGGS, and -return the number of the HEALPix polar triangle (0, 1, 2, 3, or None) -and the region (`north\_polar', `south\_polar', or `equatorial') that -\emph{(x, y)} lies in. -If \emph{inverse} = True, then assume \emph{(x, y)} lies in the image of -the rHEALPix projection that comes with this DGGS, map \emph{(x, y)} -to its HEALPix image (x', y'), and return the number of the HEALPix -polar triangle and the region that (x', y') lies in. -If \emph{(x, y)} lies in the equatorial region, then the triangle number +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.triangle}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{triangle}}}{\emph{\DUrole{n}{x}}, \emph{\DUrole{n}{y}}, \emph{\DUrole{n}{inverse}\DUrole{o}{=}\DUrole{default_value}{True}}}{} +\pysigstopsignatures +\sphinxAtStartPar +If \sphinxtitleref{inverse} = False, then assume \sphinxtitleref{(x,y)} lies in the image of the +HEALPix projection that comes with this DGGS, and +return the number of the HEALPix polar triangle (0, 1, 2, 3, or None) +and the region (‘north\_polar’, ‘south\_polar’, or ‘equatorial’) that +\sphinxtitleref{(x, y)} lies in. +If \sphinxtitleref{inverse} = True, then assume \sphinxtitleref{(x, y)} lies in the image of +the rHEALPix projection that comes with this DGGS, map \sphinxtitleref{(x, y)} +to its HEALPix image (x’, y’), and return the number of the HEALPix +polar triangle and the region that (x’, y’) lies in. +If \sphinxtitleref{(x, y)} lies in the equatorial region, then the triangle number returned is None. +\sphinxAtStartPar OUTPUT: +\sphinxAtStartPar The pair (triangle\_number, region). +\sphinxAtStartPar NOTES: +\sphinxAtStartPar This is a wrapper for pjr.triangle(). +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{7}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{triangle}\PYG{p}{(}\PYG{o}{*}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{7}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{triangle}\PYG{p}{(}\PYG{o}{*}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(0, \PYGZsq{}north\PYGZus{}polar\PYGZsq{})} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{triangle}\PYG{p}{(}\PYG{o}{*}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{N}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{triangle}\PYG{p}{(}\PYG{o}{*}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(3, \PYGZsq{}north\PYGZus{}polar\PYGZsq{})} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{P}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{triangle}\PYG{p}{(}\PYG{o}{*}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{P}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{triangle}\PYG{p}{(}\PYG{o}{*}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(None, \PYGZsq{}equatorial\PYGZsq{})} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{S}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{5}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{triangle}\PYG{p}{(}\PYG{o}{*}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{S}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{5}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{triangle}\PYG{p}{(}\PYG{o}{*}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{)} \PYG{g+go}{(1, \PYGZsq{}south\PYGZus{}polar\PYGZsq{})} -\end{Verbatim} +\end{sphinxVerbatim} \end{fulllineitems} -\index{RHEALPixDGGS.xyz() (in module rhealpix\_dggs.dggs)} +\index{xyz() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{xyz()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.xyz}\pysiglinewithargsret{\bfcode{xyz}}{\emph{self}, \emph{u}, \emph{v}, \emph{lonlat=False}}{} -Given a point \emph{(u, v)} in the planar image of the rHEALPix projection, -project it back to the ellipsoid and return its 3D rectangular +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.xyz}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{xyz}}}{\emph{\DUrole{n}{u}}, \emph{\DUrole{n}{v}}, \emph{\DUrole{n}{lonlat}\DUrole{o}{=}\DUrole{default_value}{False}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Given a point \sphinxtitleref{(u, v)} in the planar image of the rHEALPix projection, +project it back to the ellipsoid and return its 3D rectangular coordinates. -If \emph{lonlat} = True, then assume \emph{(u, v)} is a longitude-latitude +If \sphinxtitleref{lonlat} = True, then assume \sphinxtitleref{(u, v)} is a longitude\sphinxhyphen{}latitude point. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{xyz}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{n}{lonlat}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.70710678118655002, 0.0, 0.70710678118655002)} -\end{Verbatim} +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{xyz}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{n}{lonlat}\PYG{o}{=}\PYG{k+kc}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(0.70710678118655, 0.0, 0.70710678118655)} +\end{sphinxVerbatim} +\begin{description} +\sphinxlineitem{NOTES:: Issue \#1 was ..} +\sphinxAtStartPar +(0.70710678118655002, 0.0, 0.70710678118655002) + +\end{description} \end{fulllineitems} -\index{RHEALPixDGGS.xyz\_cube() (in module rhealpix\_dggs.dggs)} +\index{xyz\_cube() (rhealpixdggs.dggs.RHEALPixDGGS method)@\spxentry{xyz\_cube()}\spxextra{rhealpixdggs.dggs.RHEALPixDGGS method}} \begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.xyz_cube}\pysiglinewithargsret{\bfcode{xyz\_cube}}{\emph{self}, \emph{u}, \emph{v}, \emph{lonlat=False}}{} -Given a point \emph{(u, v)} in the planar version of this rHEALPix DGGS, -fold the rHEALPix image into a cube centered at the origin, -and return the resulting point's 3D rectangular coordinates. -If \emph{lonlat} = True, then assume \emph{(u, v)} is a longitude-latitude +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RHEALPixDGGS.xyz_cube}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{xyz\_cube}}}{\emph{\DUrole{n}{u}}, \emph{\DUrole{n}{v}}, \emph{\DUrole{n}{lonlat}\DUrole{o}{=}\DUrole{default_value}{False}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Given a point \sphinxtitleref{(u, v)} in the planar version of this rHEALPix DGGS, +fold the rHEALPix image into a cube centered at the origin, +and return the resulting point’s 3D rectangular coordinates. +If \sphinxtitleref{lonlat} = True, then assume \sphinxtitleref{(u, v)} is a longitude\sphinxhyphen{}latitude point. +\sphinxAtStartPar EXAMPLES: -\begin{Verbatim}[commandchars=\\\{\}] +\begin{sphinxVerbatim}[commandchars=\\\{\}] \PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{xyz\PYGZus{}cube}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.78539816339745006, 0.0, \PYGZhy{}0.78539816339745006)} -\end{Verbatim} - -\end{fulllineitems} - - -\end{fulllineitems} - - - -\chapter{The distortion Module} -\label{distortion::doc}\label{distortion:the-distortion-module}\label{distortion:module-rhealpix_dggs.distortion}\index{rhealpix\_dggs.distortion (module)} -This Python 3.3 module computes linear and areal distortion statistics of -map projections. -It is used for analysis only and so is not essential to manipulating -the rHEALPix discrete global grid system. - -CHANGELOG: -\begin{itemize} -\item {} -Alexander Raichev (AR), 2012-10-01: Initial version. - -\item {} -AR, 2013-01-21: Wasn't working in degrees mode. Fixed that bug. - -\item {} -AR, 2013-07-23: Ported to Python 3.3. - -\end{itemize} -\index{distortion() (in module rhealpix\_dggs.distortion)} - -\begin{fulllineitems} -\phantomsection\label{distortion:rhealpix_dggs.distortion.distortion}\pysiglinewithargsret{\code{rhealpix\_dggs.distortion.}\bfcode{distortion}}{\emph{T}, \emph{lam}, \emph{phi}}{} -Return ((x, y), mad, ld, ad) -Here \emph{(x, y) = T(lam, phi)}, the image under the map projection \emph{T} -(an projection\_tools.Proj or projection\_tools.Proj4 instance) -of the longitude-latitude point \emph{(lam, phi)}; -mad = maximum angular distortion at (x, y) = 2*arcsin((A - B)/(A + B)) -ld = linear distortion at (x, y) = A/B; -ad = areal distortion at (x, y) = AB; -A and B are the major and minor radii, respectively, of the Tissot ellipse -at (x, y). - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.projection\PYGZus{}wrapper} \PYG{k+kn}{import} \PYG{n}{Proj} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.ellipsoids} \PYG{k+kn}{import} \PYG{n}{WGS84\PYGZus{}ELLIPSOID\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{f} \PYG{o}{=} \PYG{n}{Proj}\PYG{p}{(}\PYG{n}{ellipsoid}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}ELLIPSOID\PYGZus{}RADIANS}\PYG{p}{,} \PYG{n}{proj}\PYG{o}{=}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{healpix}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{distortion}\PYG{p}{(}\PYG{n}{f}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{6}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{((0.0, 3748655.1150495014), 0.121755482930707, 1.1295629172526771, 1.1780969100283301)} -\end{Verbatim} - -\end{fulllineitems} - -\index{distortion\_stats() (in module rhealpix\_dggs.distortion)} - -\begin{fulllineitems} -\phantomsection\label{distortion:rhealpix_dggs.distortion.distortion_stats}\pysiglinewithargsret{\code{rhealpix\_dggs.distortion.}\bfcode{distortion\_stats}}{\emph{T}, \emph{sample}, \emph{my\_round\_numbers=3}}{} -Return the sample minimum, sample maximum, sample median, sample mean, -and sample standard deviation of the maximum angular distortion, linear -distortion, and area distortion functions -for the map projection \emph{T} -(an projection\_tools.Proj or projection\_tools.Proj4 instance) -of the list \emph{sample} of longitude-latitude -points chosen from the surface \emph{T.ellipsoid}. -Most likely you will want sample to comprise points sampled uniformly -at random from the surface of \emph{T.ellipsoid} (and not simply sampled -uniformly at random from the rectangle (-pi, pi) x (-pi/2, pi/2)). - -OUTPUT: - -(distortions, stats), where -distortions is a list of distortion() outputs for each longitude- -latitude point sampled; -stats is the list of lists {[}maximum angular distortion stats, -linear distortion stats, area distortion stats{]}, where each stats sublist -is of the form {[}sample mean, sample standard deviation, sample minimum, -sample maximum, sample median{]}. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.projection\PYGZus{}wrapper} \PYG{k+kn}{import} \PYG{n}{Proj} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.ellipsoids} \PYG{k+kn}{import} \PYG{n}{WGS84\PYGZus{}ELLIPSOID\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}ELLIPSOID\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{f} \PYG{o}{=} \PYG{n}{Proj}\PYG{p}{(}\PYG{n}{ellipsoid}\PYG{o}{=}\PYG{n}{E}\PYG{p}{,} \PYG{n}{proj}\PYG{o}{=}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{healpix}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{sample} \PYG{o}{=} \PYG{p}{[}\PYG{n}{E}\PYG{o}{.}\PYG{n}{random\PYGZus{}point}\PYG{p}{(}\PYG{p}{)} \PYG{k}{for} \PYG{n}{i} \PYG{o+ow}{in} \PYG{n+nb}{range}\PYG{p}{(}\PYG{l+m+mi}{100}\PYG{p}{)}\PYG{p}{]} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{distortion\PYGZus{}stats}\PYG{p}{(}\PYG{n}{f}\PYG{p}{,} \PYG{n}{sample}\PYG{p}{)}\PYG{p}{[}\PYG{l+m+mi}{1}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{[[0.309, 0.238, 0.001, 0.838, 0.178], [1.41, 0.375, 1.001, 2.372, 1.195], [1.178, 0.0, 1.178, 1.178, 1.178]]} -\end{Verbatim} - -\end{fulllineitems} - -\index{fff\_coeffs() (in module rhealpix\_dggs.distortion)} - -\begin{fulllineitems} -\phantomsection\label{distortion:rhealpix_dggs.distortion.fff_coeffs}\pysiglinewithargsret{\code{rhealpix\_dggs.distortion.}\bfcode{fff\_coeffs}}{\emph{T}, \emph{lam}, \emph{phi}}{} -Return numerical approximations of the \href{http://en.wikipedia.org/wiki/First\_fundamental\_form}{first fundamental form} coefficients -E, F, and G (in that order) of map projection \emph{T} -(an projection\_tools.Proj or projection\_tools.Proj4 instance) at longitude \emph{lam} and -latitude \emph{phi}. - -EXAMPLES: +\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{xyz\PYGZus{}cube}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} +\PYG{g+go}{(0.78539816339745, 0.0, \PYGZhy{}0.78539816339745)} +\end{sphinxVerbatim} +\begin{description} +\sphinxlineitem{NOTES:: Issue \#1 was ..} +\sphinxAtStartPar +(0.78539816339745006, 0.0, \sphinxhyphen{}0.78539816339745006) -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.projection\PYGZus{}wrapper} \PYG{k+kn}{import} \PYG{n}{Proj} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.ellipsoids} \PYG{k+kn}{import} \PYG{n}{WGS84\PYGZus{}ELLIPSOID\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{f} \PYG{o}{=} \PYG{n}{Proj}\PYG{p}{(}\PYG{n}{ellipsoid}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}ELLIPSOID\PYGZus{}RADIANS}\PYG{p}{,} \PYG{n}{proj}\PYG{o}{=}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{healpix}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{fff\PYGZus{}coeffs}\PYG{p}{(}\PYG{n}{f}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{6}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(40635288880650.484, 0.0, 42251277118793.328)} -\end{Verbatim} +\end{description} \end{fulllineitems} -\index{scale\_factors() (in module rhealpix\_dggs.distortion)} - -\begin{fulllineitems} -\phantomsection\label{distortion:rhealpix_dggs.distortion.scale_factors}\pysiglinewithargsret{\code{rhealpix\_dggs.distortion.}\bfcode{scale\_factors}}{\emph{T}, \emph{lam}, \emph{phi}}{} -Return numerical approximations of the local scale factors s\_M, s\_P, and -s\_A of the map projection \emph{T} -(an projection\_tools.Proj or projection\_tools.Proj4 instance) -at longitude \emph{lam} and latitude \emph{phi}, where -s\_M is the local linear scale along meridians, -s\_P is the local linear scale along parallels, and -s\_A is the local area scale. -Also return theta (in radians), the angle between the vectors (delxdellam, delydellam) -and (delxdelphi, delydelphi). - -OUTPUT: - -(s\_M, s\_P, s\_A, theta) - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.projection\PYGZus{}wrapper} \PYG{k+kn}{import} \PYG{n}{Proj} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.ellipsoids} \PYG{k+kn}{import} \PYG{n}{WGS84\PYGZus{}ELLIPSOID\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{f} \PYG{o}{=} \PYG{n}{Proj}\PYG{p}{(}\PYG{n}{ellipsoid}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}ELLIPSOID\PYGZus{}RADIANS}\PYG{p}{,} \PYG{n}{proj}\PYG{o}{=}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{healpix}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{scale\PYGZus{}factors}\PYG{p}{(}\PYG{n}{f}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{6}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(1.0212575853790069, 1.1535746974071359, 1.1780969100283301, 1.5707963267948959)} -\end{Verbatim} \end{fulllineitems} -\index{utm\_zone() (in module rhealpix\_dggs.distortion)} +\index{RhealPolygon (class in rhealpixdggs.dggs)@\spxentry{RhealPolygon}\spxextra{class in rhealpixdggs.dggs}} \begin{fulllineitems} -\phantomsection\label{distortion:rhealpix_dggs.distortion.utm_zone}\pysiglinewithargsret{\code{rhealpix\_dggs.distortion.}\bfcode{utm\_zone}}{\emph{lam}, \emph{phi}}{} -Return the Universal Transverse Mercator zone and hemisphere for longitude -\emph{lam} and latitude \emph{phi} given in radians. -Based on the WGS84 ellipsoid. -Return None if \emph{phi} is out of bounds, that is, if \emph{phi} is greater than -84 degrees or less than 80 degrees. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{utm\PYGZus{}zone}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{84}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{180}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{31} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{utm\PYGZus{}zone}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{85}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{180}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{None} -\end{Verbatim} +\phantomsection\label{\detokenize{dggs:rhealpixdggs.dggs.RhealPolygon}} +\pysigstartsignatures +\pysiglinewithargsret{\sphinxbfcode{\sphinxupquote{class\DUrole{w}{ }}}\sphinxcode{\sphinxupquote{rhealpixdggs.dggs.}}\sphinxbfcode{\sphinxupquote{RhealPolygon}}}{\emph{\DUrole{n}{rdggs=\textless{}rhealpixdggs.dggs.RHEALPixDGGS object\textgreater{}}}, \emph{\DUrole{n}{suid\_list=None}}}{} +\pysigstopsignatures +\sphinxAtStartPar +Bases: \sphinxcode{\sphinxupquote{object}} \end{fulllineitems} \chapter{Indices and tables} -\label{index:indices-and-tables}\begin{itemize} +\label{\detokenize{index:indices-and-tables}}\begin{itemize} \item {} -\emph{genindex} +\sphinxAtStartPar +\DUrole{xref,std,std-ref}{genindex} \item {} -\emph{modindex} +\sphinxAtStartPar +\DUrole{xref,std,std-ref}{modindex} \item {} -\emph{search} +\sphinxAtStartPar +\DUrole{xref,std,std-ref}{search} \end{itemize} -\begin{thebibliography}{CaRo2007} -\bibitem[GRS2013]{GRS2013}{\phantomsection\label{introduction:grs2013} -Robert Gibb, Alexander Raichev, Michael Speth, \href{http://code.scenzgrid.org/index.php/p/scenzgrid-py/source/tree/master/rHEALPixDGGS-0.5/docs/rhealpix\_dggs\_preprint.pdf}{The rHEALPix discrete global grid system}, in preparation, 2013. -} -\bibitem[CaRo2007]{CaRo2007}{\phantomsection\label{pj_healpix:caro2007} -Mark R. Calabretta and Boudewijn F. Roukema, Mapping on the healpix grid, Monthly Notices of the Royal Astronomical Society 381 (2007), no. 2, 865--872. -} -\end{thebibliography} +\begin{sphinxthebibliography}{CaRo2007} +\bibitem[GRS2013]{introduction:grs2013} +\sphinxAtStartPar +Robert Gibb, Alexander Raichev, Michael Speth, \sphinxhref{https://github.com/manaakiwhenua/rhealpixdggs-2013-gibb-raichev-speth/blob/master/rhealpix\_dggs\_preprint.pdf}{The rHEALPix discrete global grid system}, in preparation, 2013. +\bibitem[CaRo2007]{pj_healpix:caro2007} +\sphinxAtStartPar +Mark R. Calabretta and Boudewijn F. Roukema, Mapping on the healpix grid, Monthly Notices of the Royal Astronomical Society 381 (2007), no. 2, 865\textendash{}872. +\end{sphinxthebibliography} \renewcommand{\indexname}{Python Module Index} -\begin{theindex} -\def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}} +\begin{sphinxtheindex} +\let\bigletter\sphinxstyleindexlettergroup \bigletter{r} -\item {\texttt{rhealpix\_dggs.dggs}}, \pageref{dggs:module-rhealpix_dggs.dggs} -\item {\texttt{rhealpix\_dggs.distortion}}, \pageref{distortion:module-rhealpix_dggs.distortion} -\item {\texttt{rhealpix\_dggs.ellipsoids}}, \pageref{ellipsoids:module-rhealpix_dggs.ellipsoids} -\item {\texttt{rhealpix\_dggs.pj\_healpix}}, \pageref{pj_healpix:module-rhealpix_dggs.pj_healpix} -\item {\texttt{rhealpix\_dggs.pj\_rhealpix}}, \pageref{pj_rhealpix:module-rhealpix_dggs.pj_rhealpix} -\item {\texttt{rhealpix\_dggs.projection\_wrapper}}, \pageref{projection_wrapper:module-rhealpix_dggs.projection_wrapper} -\item {\texttt{rhealpix\_dggs.utils}}, \pageref{utils:module-rhealpix_dggs.utils} -\end{theindex} +\item\relax\sphinxstyleindexentry{rhealpixdggs.dggs}\sphinxstyleindexpageref{dggs:\detokenize{module-rhealpixdggs.dggs}} +\item\relax\sphinxstyleindexentry{rhealpixdggs.ellipsoids}\sphinxstyleindexpageref{ellipsoids:\detokenize{module-rhealpixdggs.ellipsoids}} +\item\relax\sphinxstyleindexentry{rhealpixdggs.pj\_healpix}\sphinxstyleindexpageref{pj_healpix:\detokenize{module-rhealpixdggs.pj_healpix}} +\item\relax\sphinxstyleindexentry{rhealpixdggs.pj\_rhealpix}\sphinxstyleindexpageref{pj_rhealpix:\detokenize{module-rhealpixdggs.pj_rhealpix}} +\item\relax\sphinxstyleindexentry{rhealpixdggs.projection\_wrapper}\sphinxstyleindexpageref{projection_wrapper:\detokenize{module-rhealpixdggs.projection_wrapper}} +\item\relax\sphinxstyleindexentry{rhealpixdggs.utils}\sphinxstyleindexpageref{utils:\detokenize{module-rhealpixdggs.utils}} +\end{sphinxtheindex} \renewcommand{\indexname}{Index} \printindex -\end{document} +\end{document} \ No newline at end of file diff --git a/docs/build/latex/rHEALPixDGGS.toc b/docs/build/latex/rHEALPixDGGS.toc index 52e0780..43f85f0 100644 --- a/docs/build/latex/rHEALPixDGGS.toc +++ b/docs/build/latex/rHEALPixDGGS.toc @@ -1,19 +1,17 @@ -\select@language {english} -\contentsline {chapter}{\numberline {1}Introduction}{1}{chapter.1} -\contentsline {section}{\numberline {1.1}Requirements}{1}{section.1.1} -\contentsline {section}{\numberline {1.2}Installation}{1}{section.1.2} -\contentsline {section}{\numberline {1.3}Usage}{1}{section.1.3} -\contentsline {subsection}{\numberline {1.3.1}Using the \texttt {ellipsoids} and \texttt {projection\_wrapper} Modules}{2}{subsection.1.3.1} -\contentsline {subsection}{\numberline {1.3.2}Using the \texttt {dggs} Module}{3}{subsection.1.3.2} -\contentsline {subsection}{\numberline {1.3.3}Using the \texttt {distortion} Module}{6}{subsection.1.3.3} -\contentsline {chapter}{\numberline {2}The utils Module}{7}{chapter.2} -\contentsline {chapter}{\numberline {3}The pj\_healpix Module}{9}{chapter.3} -\contentsline {chapter}{\numberline {4}The pj\_rhealpix Module}{12}{chapter.4} -\contentsline {chapter}{\numberline {5}The ellipsoids Module}{16}{chapter.5} -\contentsline {chapter}{\numberline {6}The projection\_wrapper Module}{19}{chapter.6} -\contentsline {chapter}{\numberline {7}The dggs Module}{20}{chapter.7} -\contentsline {chapter}{\numberline {8}The distortion Module}{37}{chapter.8} -\contentsline {chapter}{\numberline {9}Indices and tables}{39}{chapter.9} -\contentsline {chapter}{Bibliography}{40}{chapter*.95} -\contentsline {chapter}{Python Module Index}{41}{section*.98} -\contentsline {chapter}{Index}{42}{section*.99} +\babel@toc {english}{}\relax +\contentsline {chapter}{\numberline {1}Introduction}{1}{chapter.1}% +\contentsline {section}{\numberline {1.1}Requirements}{1}{section.1.1}% +\contentsline {section}{\numberline {1.2}Installation}{1}{section.1.2}% +\contentsline {section}{\numberline {1.3}Usage}{1}{section.1.3}% +\contentsline {subsection}{\numberline {1.3.1}Using the \sphinxstyleliteralintitle {\sphinxupquote {ellipsoids}} and \sphinxstyleliteralintitle {\sphinxupquote {projection\_wrapper}} Modules}{1}{subsection.1.3.1}% +\contentsline {subsection}{\numberline {1.3.2}Using the \sphinxstyleliteralintitle {\sphinxupquote {dggs}} Module}{3}{subsection.1.3.2}% +\contentsline {chapter}{\numberline {2}The utils Module}{7}{chapter.2}% +\contentsline {chapter}{\numberline {3}The pj\_healpix Module}{10}{chapter.3}% +\contentsline {chapter}{\numberline {4}The pj\_rhealpix Module}{13}{chapter.4}% +\contentsline {chapter}{\numberline {5}The ellipsoids Module}{18}{chapter.5}% +\contentsline {chapter}{\numberline {6}The projection\_wrapper Module}{21}{chapter.6}% +\contentsline {chapter}{\numberline {7}The dggs Module}{23}{chapter.7}% +\contentsline {chapter}{\numberline {8}Indices and tables}{43}{chapter.8}% +\contentsline {chapter}{Bibliography}{44}{chapter*.89}% +\contentsline {chapter}{Python Module Index}{45}{section*.90}% +\contentsline {chapter}{Index}{46}{section*.91}% diff --git a/docs/build/latex/sphinx.sty b/docs/build/latex/sphinx.sty index 08adec9..1f7eb1b 100644 --- a/docs/build/latex/sphinx.sty +++ b/docs/build/latex/sphinx.sty @@ -6,473 +6,339 @@ % \NeedsTeXFormat{LaTeX2e}[1995/12/01] -\ProvidesPackage{sphinx}[2010/01/15 LaTeX package (Sphinx markup)] +\ProvidesPackage{sphinx}[2021/01/27 v4.0.0 LaTeX package (Sphinx markup)] + +% provides \ltx@ifundefined +% (many packages load ltxcmds: graphicx does for pdftex and lualatex but +% not xelatex, and anyhow kvoptions does, but it may be needed in future to +% use \sphinxdeprecationwarning earlier, and it needs \ltx@ifundefined) +\RequirePackage{ltxcmds} + +%% for deprecation warnings +\newcommand\sphinxdeprecationwarning[4]{% #1 the deprecated macro or name, +% #2 = when deprecated, #3 = when removed, #4 = additional info + \edef\spx@tempa{\detokenize{#1}}% + \ltx@ifundefined{sphinx_depr_\spx@tempa}{% + \global\expandafter\let\csname sphinx_depr_\spx@tempa\endcsname\spx@tempa + \expandafter\AtEndDocument\expandafter{\expandafter\let\expandafter + \sphinxdeprecatedmacro\csname sphinx_depr_\spx@tempa\endcsname + \PackageWarningNoLine{sphinx}{^^J**** SPHINX DEPRECATION WARNING:^^J + \sphinxdeprecatedmacro^^J + \@spaces- is deprecated at Sphinx #2^^J + \@spaces- and removed at Sphinx #3.^^J + #4^^J****}}% + }{% warning already emitted (at end of latex log), don't repeat + }} -\RequirePackage{textcomp} -\RequirePackage{fancyhdr} -\RequirePackage{fancybox} -\RequirePackage{titlesec} -\RequirePackage{tabulary} -\RequirePackage{amsmath} % for \text -\RequirePackage{makeidx} -\RequirePackage{framed} -\RequirePackage{ifthen} -\RequirePackage{color} -% For highlighted code. -\RequirePackage{fancyvrb} -% For table captions. -\RequirePackage{threeparttable} -% Handle footnotes in tables. -\RequirePackage{footnote} -\makesavenoteenv{tabulary} -% For floating figures in the text. -\RequirePackage{wrapfig} -% Separate paragraphs by space by default. -\RequirePackage{parskip} - -% Redefine these colors to your liking in the preamble. -\definecolor{TitleColor}{rgb}{0.126,0.263,0.361} -\definecolor{InnerLinkColor}{rgb}{0.208,0.374,0.486} -\definecolor{OuterLinkColor}{rgb}{0.216,0.439,0.388} -% Redefine these colors to something not white if you want to have colored -% background and border for code examples. -\definecolor{VerbatimColor}{rgb}{1,1,1} -\definecolor{VerbatimBorderColor}{rgb}{1,1,1} - -% Uncomment these two lines to ignore the paper size and make the page -% size more like a typical published manual. -%\renewcommand{\paperheight}{9in} -%\renewcommand{\paperwidth}{8.5in} % typical squarish manual -%\renewcommand{\paperwidth}{7in} % O'Reilly ``Programmming Python'' - -% For graphicx, check if we are compiling under latex or pdflatex. -\ifx\pdftexversion\undefined - \usepackage{graphicx} -\else - \usepackage[pdftex]{graphicx} -\fi -% for PDF output, use colors and maximal compression -\newif\ifsphinxpdfoutput\sphinxpdfoutputfalse -\ifx\pdfoutput\undefined\else\ifcase\pdfoutput - \let\py@NormalColor\relax - \let\py@TitleColor\relax -\else - \sphinxpdfoutputtrue - \input{pdfcolor} - \def\py@NormalColor{\color[rgb]{0.0,0.0,0.0}} - \def\py@TitleColor{\color{TitleColor}} - \pdfcompresslevel=9 -\fi\fi - -% XeLaTeX can do colors, too -\ifx\XeTeXrevision\undefined\else - \def\py@NormalColor{\color[rgb]{0.0,0.0,0.0}} - \def\py@TitleColor{\color{TitleColor}} -\fi +%% OPTION HANDLING +% + +% We first handle options then load packages, but we need \definecolor from +% xcolor/color. -% Increase printable page size (copied from fullpage.sty) -\topmargin 0pt -\advance \topmargin by -\headheight -\advance \topmargin by -\headsep - -% attempt to work a little better for A4 users -\textheight \paperheight -\advance\textheight by -2in - -\oddsidemargin 0pt -\evensidemargin 0pt -%\evensidemargin -.25in % for ``manual size'' documents -\marginparwidth 0.5in - -\textwidth \paperwidth -\advance\textwidth by -2in - - -% Style parameters and macros used by most documents here -\raggedbottom -\sloppy -\hbadness = 5000 % don't print trivial gripes - -\pagestyle{empty} % start this way; change for -\pagenumbering{roman} % ToC & chapters - -% Use this to set the font family for headers and other decor: -\newcommand{\py@HeaderFamily}{\sffamily\bfseries} - -% Redefine the 'normal' header/footer style when using "fancyhdr" package: -\@ifundefined{fancyhf}{}{ - % Use \pagestyle{normal} as the primary pagestyle for text. - \fancypagestyle{normal}{ - \fancyhf{} - \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}} - \fancyfoot[LO]{{\py@HeaderFamily\nouppercase{\rightmark}}} - \fancyfoot[RE]{{\py@HeaderFamily\nouppercase{\leftmark}}} - \fancyhead[LE,RO]{{\py@HeaderFamily \@title, \py@release}} - \renewcommand{\headrulewidth}{0.4pt} - \renewcommand{\footrulewidth}{0.4pt} - } - % Update the plain style so we get the page number & footer line, - % but not a chapter or section title. This is to keep the first - % page of a chapter and the blank page between chapters `clean.' - \fancypagestyle{plain}{ - \fancyhf{} - \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}} - \renewcommand{\headrulewidth}{0pt} - \renewcommand{\footrulewidth}{0.4pt} - } +% FIXME: we should \RequirePackage{xcolor} always now +% The xcolor package draws better fcolorboxes around verbatim code +\IfFileExists{xcolor.sty}{ + \RequirePackage{xcolor} +}{ + \RequirePackage{color} } -% Some custom font markup commands. +% Handle options via "kvoptions" (later loaded by hyperref anyhow) +\RequirePackage{kvoptions} +\SetupKeyvalOptions{prefix=spx@opt@} % use \spx@opt@ prefix + +% Sphinx legacy text layout: 1in margins on all four sides +\ifx\@jsc@uplatextrue\@undefined +\DeclareStringOption[1in]{hmargin} +\DeclareStringOption[1in]{vmargin} +\DeclareStringOption[.5in]{marginpar} +\else +% Japanese standard document classes handle \mag in a special way +\DeclareStringOption[\inv@mag in]{hmargin} +\DeclareStringOption[\inv@mag in]{vmargin} +\DeclareStringOption[.5\dimexpr\inv@mag in\relax]{marginpar} +\fi + +\DeclareStringOption[0]{maxlistdepth}% \newcommand*\spx@opt@maxlistdepth{0} +\DeclareStringOption[-1]{numfigreset} +\DeclareBoolOption[false]{nonumfigreset} +\DeclareBoolOption[false]{mathnumfig} +\define@key{sphinx}{bookmarksdepth}{\AtBeginDocument{\hypersetup{bookmarksdepth=#1}}} +\AtBeginDocument{\define@key{sphinx}{bookmarksdepth}{\hypersetup{bookmarksdepth=#1}}} +% \DeclareBoolOption[false]{usespart}% not used +% dimensions, we declare the \dimen registers here. +\newdimen\sphinxverbatimsep +\newdimen\sphinxverbatimborder +\newdimen\sphinxshadowsep +\newdimen\sphinxshadowsize +\newdimen\sphinxshadowrule +% \DeclareStringOption is not convenient for the handling of these dimensions +% because we want to assign the values to the corresponding registers. Even if +% we added the code to the key handler it would be too late for the initial +% set-up and we would need to do initial assignments explicitly. We end up +% using \define@key directly. +% verbatim +\sphinxverbatimsep=\fboxsep + \define@key{sphinx}{verbatimsep}{\sphinxverbatimsep\dimexpr #1\relax} +\sphinxverbatimborder=\fboxrule + \define@key{sphinx}{verbatimborder}{\sphinxverbatimborder\dimexpr #1\relax} +% topic boxes +\sphinxshadowsep =5pt + \define@key{sphinx}{shadowsep}{\sphinxshadowsep\dimexpr #1\relax} +\sphinxshadowsize=4pt + \define@key{sphinx}{shadowsize}{\sphinxshadowsize\dimexpr #1\relax} +\sphinxshadowrule=\fboxrule + \define@key{sphinx}{shadowrule}{\sphinxshadowrule\dimexpr #1\relax} +% verbatim +\DeclareBoolOption[true]{verbatimwithframe} +\DeclareBoolOption[true]{verbatimwrapslines} +\DeclareBoolOption[false]{verbatimforcewraps} +\DeclareStringOption[3]{verbatimmaxoverfull} +\DeclareStringOption[100]{verbatimmaxunderfull} +\DeclareBoolOption[true]{verbatimhintsturnover} +\DeclareBoolOption[true]{inlineliteralwraps} +\DeclareStringOption[t]{literalblockcappos} +\DeclareStringOption[r]{verbatimcontinuedalign} +\DeclareStringOption[r]{verbatimcontinuesalign} +% parsed literal +\DeclareBoolOption[true]{parsedliteralwraps} +% \textvisiblespace for compatibility with fontspec+XeTeX/LuaTeX +\DeclareStringOption[\textcolor{red}{\textvisiblespace}]{verbatimvisiblespace} +\DeclareStringOption % must use braces to hide the brackets + [{\makebox[2\fontcharwd\font`\x][r]{\textcolor{red}{\tiny$\m@th\hookrightarrow$}}}]% + {verbatimcontinued} +% notices/admonitions +% the dimensions for notices/admonitions are kept as macros and assigned to +% \spx@notice@border at time of use, hence \DeclareStringOption is ok for this +\newdimen\spx@notice@border +\DeclareStringOption[0.5pt]{noteborder} +\DeclareStringOption[0.5pt]{hintborder} +\DeclareStringOption[0.5pt]{importantborder} +\DeclareStringOption[0.5pt]{tipborder} +\DeclareStringOption[1pt]{warningborder} +\DeclareStringOption[1pt]{cautionborder} +\DeclareStringOption[1pt]{attentionborder} +\DeclareStringOption[1pt]{dangerborder} +\DeclareStringOption[1pt]{errorborder} +% footnotes +\DeclareStringOption[\mbox{ }]{AtStartFootnote} +% we need a public macro name for direct use in latex file +\newcommand*{\sphinxAtStartFootnote}{\spx@opt@AtStartFootnote} +% no such need for this one, as it is used inside other macros +\DeclareStringOption[\leavevmode\unskip]{BeforeFootnote} +% some font styling. +\DeclareStringOption[\sffamily\bfseries]{HeaderFamily} +% colours +% same problems as for dimensions: we want the key handler to use \definecolor. +% first, some colours with no prefix, for backwards compatibility +\newcommand*{\sphinxDeclareColorOption}[2]{% + \definecolor{#1}#2% + \define@key{sphinx}{#1}{\definecolor{#1}##1}% +}% +\sphinxDeclareColorOption{TitleColor}{{rgb}{0.126,0.263,0.361}} +\sphinxDeclareColorOption{InnerLinkColor}{{rgb}{0.208,0.374,0.486}} +\sphinxDeclareColorOption{OuterLinkColor}{{rgb}{0.216,0.439,0.388}} +\sphinxDeclareColorOption{VerbatimColor}{{rgb}{1,1,1}} +\sphinxDeclareColorOption{VerbatimBorderColor}{{rgb}{0,0,0}} +% now the colours defined with "sphinx" prefix in their names +\newcommand*{\sphinxDeclareSphinxColorOption}[2]{% + % set the initial default + \definecolor{sphinx#1}#2% + % set the key handler. The "value" ##1 must be acceptable by \definecolor. + \define@key{sphinx}{#1}{\definecolor{sphinx#1}##1}% +}% +% Default color chosen to be as in minted.sty LaTeX package! +\sphinxDeclareSphinxColorOption{VerbatimHighlightColor}{{rgb}{0.878,1,1}} +% admonition boxes, "light" style +\sphinxDeclareSphinxColorOption{noteBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{hintBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{importantBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{tipBorderColor}{{rgb}{0,0,0}} +% admonition boxes, "heavy" style +\sphinxDeclareSphinxColorOption{warningBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{cautionBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{attentionBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{dangerBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{errorBorderColor}{{rgb}{0,0,0}} +\sphinxDeclareSphinxColorOption{warningBgColor}{{rgb}{1,1,1}} +\sphinxDeclareSphinxColorOption{cautionBgColor}{{rgb}{1,1,1}} +\sphinxDeclareSphinxColorOption{attentionBgColor}{{rgb}{1,1,1}} +\sphinxDeclareSphinxColorOption{dangerBgColor}{{rgb}{1,1,1}} +\sphinxDeclareSphinxColorOption{errorBgColor}{{rgb}{1,1,1}} + +\DeclareDefaultOption{\@unknownoptionerror} +\ProcessKeyvalOptions* +% don't allow use of maxlistdepth via \sphinxsetup. +\DisableKeyvalOption{sphinx}{maxlistdepth} +\DisableKeyvalOption{sphinx}{numfigreset} +\DisableKeyvalOption{sphinx}{nonumfigreset} +\DisableKeyvalOption{sphinx}{mathnumfig} +% FIXME: this is unrelated to an option, move this elsewhere +% To allow hyphenation of first word in narrow contexts; no option, +% customization to be done via 'preamble' key +\newcommand*\sphinxAtStartPar{\leavevmode\nobreak\hskip\z@skip} +% No need for the \hspace{0pt} trick (\hskip\z@skip) with luatex +\ifdefined\directlua\let\sphinxAtStartPar\@empty\fi +% user interface: options can be changed midway in a document! +\newcommand\sphinxsetup[1]{\setkeys{sphinx}{#1}} + + +%% MISCELLANEOUS CONTEXT % -\newcommand{\strong}[1]{{\bf #1}} -\newcommand{\code}[1]{\texttt{#1}} -\newcommand{\bfcode}[1]{\code{\bfseries#1}} -\newcommand{\email}[1]{\textsf{#1}} - -% Redefine the Verbatim environment to allow border and background colors. -% The original environment is still used for verbatims within tables. -\let\OriginalVerbatim=\Verbatim -\let\endOriginalVerbatim=\endVerbatim - -% Play with vspace to be able to keep the indentation. -\newlength\distancetoright -\def\mycolorbox#1{% - \setlength\distancetoright{\linewidth}% - \advance\distancetoright -\@totalleftmargin % - \fcolorbox{VerbatimBorderColor}{VerbatimColor}{% - \begin{minipage}{\distancetoright}% - #1 - \end{minipage}% - }% -} -\def\FrameCommand{\mycolorbox} - -\renewcommand{\Verbatim}[1][1]{% - % list starts new par, but we don't want it to be set apart vertically - \bgroup\parskip=0pt% - \smallskip% - % The list environement is needed to control perfectly the vertical - % space. - \list{}{% - \setlength\parskip{0pt}% - \setlength\itemsep{0ex}% - \setlength\topsep{0ex}% - \setlength\partopsep{0pt}% - \setlength\leftmargin{0pt}% - }% - \item\MakeFramed {\FrameRestore}% - \small% - \OriginalVerbatim[#1]% -} -\renewcommand{\endVerbatim}{% - \endOriginalVerbatim% - \endMakeFramed% - \endlist% - % close group to restore \parskip - \egroup% +% flag to be set in a framed environment +% (defined here as currently needed by three sphinxlatex....sty files and +% even if not needed if such files are replaced, the definition does no harm) +\newif\ifspx@inframed +% +% \spx@ifcaptionpackage (defined at begin document) +% is needed currently in macros from: +% sphinxlatexliterals.sty (sphinxVerbatim) +% sphinxlatextables.sty (for some macros used in the table templates) +% +% \sphinxcaption is mark-up injected by the tabular and tabulary templates +% it is defined in sphinxlatextables.sty +% +% store the original \caption macro for usage with figures inside longtable +% and tabulary cells. Make sure we get the final \caption in presence of +% caption package, whether the latter was loaded before or after sphinx. +\AtBeginDocument{% + \let\spx@originalcaption\caption + \@ifpackageloaded{caption} + {\let\spx@ifcaptionpackage\@firstoftwo + \caption@AtBeginDocument*{\let\spx@originalcaption\caption}% +% in presence of caption package, drop our own \sphinxcaption whose aim was to +% ensure same width of caption to all kinds of tables (tabular(y), longtable), +% because caption package has its own width (or margin) option + \def\sphinxcaption{\caption}% + }% + {\let\spx@ifcaptionpackage\@secondoftwo}% } +%% PASS OPTIONS +% +% pass options to hyperref; it must not have been loaded already +\input{sphinxoptionshyperref.sty} +% pass options to geometry; it must not have been loaded already +\input{sphinxoptionsgeometry.sty} -% \moduleauthor{name}{email} -\newcommand{\moduleauthor}[2]{} -% \sectionauthor{name}{email} -\newcommand{\sectionauthor}[2]{} +%% COLOR (general) +% +% FIXME: these two should be deprecated +% +% FIXME: \normalcolor should be used and \py@NormalColor never defined +\def\py@NormalColor{\color{black}} +% FIXME: \color{TitleColor} should be used directly and \py@TitleColor +% should never get defined. +\def\py@TitleColor{\color{TitleColor}} -% Augment the sectioning commands used to get our own font family in place, -% and reset some internal data items: -\titleformat{\section}{\Large\py@HeaderFamily}% - {\py@TitleColor\thesection}{0.5em}{\py@TitleColor}{\py@NormalColor} -\titleformat{\subsection}{\large\py@HeaderFamily}% - {\py@TitleColor\thesubsection}{0.5em}{\py@TitleColor}{\py@NormalColor} -\titleformat{\subsubsection}{\py@HeaderFamily}% - {\py@TitleColor\thesubsubsection}{0.5em}{\py@TitleColor}{\py@NormalColor} -\titleformat{\paragraph}{\small\py@HeaderFamily}% - {\py@TitleColor}{0em}{\py@TitleColor}{\py@NormalColor} -% {fulllineitems} is the main environment for object descriptions. +%% PACKAGES % -\newcommand{\py@itemnewline}[1]{% - \@tempdima\linewidth% - \advance\@tempdima \leftmargin\makebox[\@tempdima][l]{#1}% -} +% as will be indicated below, secondary style files load some more packages +% +% For \text macro (sphinx.util.texescape) +% also for usage of \firstchoice@true(false) in sphinxlatexgraphics.sty +\RequirePackage{amstext} +% It was passed "warn" option from latex template in case it is already loaded +% via some other package before \usepackage{sphinx} in preamble +\RequirePackage{textcomp} +% For the H specifier. Do not \restylefloat{figure}, it breaks Sphinx code +% for allowing figures in tables. +\RequirePackage{float} +% For floating figures in the text. Better to load after float. +\RequirePackage{wrapfig} +% Provides \captionof, used once by latex writer (\captionof{figure}) +\RequirePackage{capt-of} +% Support hlist directive +\RequirePackage{multicol} + -\newenvironment{fulllineitems}{ - \begin{list}{}{\labelwidth \leftmargin \labelsep 0pt - \rightmargin 0pt \topsep -\parskip \partopsep \parskip - \itemsep -\parsep - \let\makelabel=\py@itemnewline} -}{\end{list}} - -% \optional is used for ``[, arg]``, i.e. desc_optional nodes. -\newcommand{\optional}[1]{% - {\textnormal{\Large[}}{#1}\hspace{0.5mm}{\textnormal{\Large]}}} - -\newlength{\py@argswidth} -\newcommand{\py@sigparams}[2]{% - \parbox[t]{\py@argswidth}{#1\code{)}#2}} -\newcommand{\pysigline}[1]{\item[#1]\nopagebreak} -\newcommand{\pysiglinewithargsret}[3]{% - \settowidth{\py@argswidth}{#1\code{(}}% - \addtolength{\py@argswidth}{-2\py@argswidth}% - \addtolength{\py@argswidth}{\linewidth}% - \item[#1\code{(}\py@sigparams{#2}{#3}]} - -% Production lists +%% GRAPHICS % -\newenvironment{productionlist}{ -% \def\optional##1{{\Large[}##1{\Large]}} - \def\production##1##2{\\\code{##1}&::=&\code{##2}} - \def\productioncont##1{\\& &\code{##1}} - \parindent=2em - \indent - \begin{tabular}{lcl} -}{% - \end{tabular} -} +% It will always be needed, so let's load it here +\RequirePackage{graphicx} +\input{sphinxlatexgraphics.sty} + -% Notices / Admonitions +%% FRAMED ENVIRONMENTS % -\newlength{\py@noticelength} - -\newcommand{\py@heavybox}{ - \setlength{\fboxrule}{1pt} - \setlength{\fboxsep}{6pt} - \setlength{\py@noticelength}{\linewidth} - \addtolength{\py@noticelength}{-2\fboxsep} - \addtolength{\py@noticelength}{-2\fboxrule} - %\setlength{\shadowsize}{3pt} - \Sbox - \minipage{\py@noticelength} -} -\newcommand{\py@endheavybox}{ - \endminipage - \endSbox - \fbox{\TheSbox} -} +\input{sphinxlatexadmonitions.sty} +\input{sphinxlatexliterals.sty} +\input{sphinxlatexshadowbox.sty} -\newcommand{\py@lightbox}{{% - \setlength\parskip{0pt}\par - \rule[0ex]{\linewidth}{0.5pt}% - \par\vspace{-0.5ex}% - }} -\newcommand{\py@endlightbox}{{% - \setlength{\parskip}{0pt}% - \par\rule[0.5ex]{\linewidth}{0.5pt}% - \par\vspace{-0.5ex}% - }} -% Some are quite plain: -\newcommand{\py@noticestart@note}{\py@lightbox} -\newcommand{\py@noticeend@note}{\py@endlightbox} -\newcommand{\py@noticestart@hint}{\py@lightbox} -\newcommand{\py@noticeend@hint}{\py@endlightbox} -\newcommand{\py@noticestart@important}{\py@lightbox} -\newcommand{\py@noticeend@important}{\py@endlightbox} -\newcommand{\py@noticestart@tip}{\py@lightbox} -\newcommand{\py@noticeend@tip}{\py@endlightbox} - -% Others gets more visible distinction: -\newcommand{\py@noticestart@warning}{\py@heavybox} -\newcommand{\py@noticeend@warning}{\py@endheavybox} -\newcommand{\py@noticestart@caution}{\py@heavybox} -\newcommand{\py@noticeend@caution}{\py@endheavybox} -\newcommand{\py@noticestart@attention}{\py@heavybox} -\newcommand{\py@noticeend@attention}{\py@endheavybox} -\newcommand{\py@noticestart@danger}{\py@heavybox} -\newcommand{\py@noticeend@danger}{\py@endheavybox} -\newcommand{\py@noticestart@error}{\py@heavybox} -\newcommand{\py@noticeend@error}{\py@endheavybox} - -\newenvironment{notice}[2]{ - \def\py@noticetype{#1} - \csname py@noticestart@#1\endcsname - \strong{#2} -}{\csname py@noticeend@\py@noticetype\endcsname} - -% Allow the release number to be specified independently of the -% \date{}. This allows the date to reflect the document's date and -% release to specify the release that is documented. +%% CONTAINERS % -\newcommand{\py@release}{} -\newcommand{\version}{} -\newcommand{\shortversion}{} -\newcommand{\releaseinfo}{} -\newcommand{\releasename}{Release} -\newcommand{\release}[1]{% - \renewcommand{\py@release}{\releasename\space\version}% - \renewcommand{\version}{#1}} -\newcommand{\setshortversion}[1]{% - \renewcommand{\shortversion}{#1}} -\newcommand{\setreleaseinfo}[1]{% - \renewcommand{\releaseinfo}{#1}} - -% Allow specification of the author's address separately from the -% author's name. This can be used to format them differently, which -% is a good thing. +\input{sphinxlatexcontainers.sty} + + +%% PYGMENTS +% stylesheet for highlighting with pygments +\RequirePackage{sphinxhighlight} + + +%% TABLES % -\newcommand{\py@authoraddress}{} -\newcommand{\authoraddress}[1]{\renewcommand{\py@authoraddress}{#1}} +\input{sphinxlatextables.sty} -% This sets up the fancy chapter headings that make the documents look -% at least a little better than the usual LaTeX output. + +%% NUMBERING OF FIGURES, TABLES, AND LITERAL BLOCKS % -\@ifundefined{ChTitleVar}{}{ - \ChNameVar{\raggedleft\normalsize\py@HeaderFamily} - \ChNumVar{\raggedleft \bfseries\Large\py@HeaderFamily} - \ChTitleVar{\raggedleft \rm\Huge\py@HeaderFamily} - % This creates chapter heads without the leading \vspace*{}: - \def\@makechapterhead#1{% - {\parindent \z@ \raggedright \normalfont - \ifnum \c@secnumdepth >\m@ne - \DOCH - \fi - \interlinepenalty\@M - \DOTI{#1} - } - } -} +\input{sphinxlatexnumfig.sty} + -% Redefine description environment so that it is usable inside fulllineitems. +%% LISTS % -\renewcommand{\description}{% - \list{}{\labelwidth\z@% - \itemindent-\leftmargin% - \labelsep5pt% - \let\makelabel=\descriptionlabel}} - -% Definition lists; requested by AMK for HOWTO documents. Probably useful -% elsewhere as well, so keep in in the general style support. +\input{sphinxlatexlists.sty} + + +%% FOOTNOTES % -\newenvironment{definitions}{% - \begin{description}% - \def\term##1{\item[##1]\mbox{}\\*[0mm]} -}{% - \end{description}% +% Support scopes for footnote numbering +% This is currently stepped at each input file +\newcounter{sphinxscope} +\newcommand{\sphinxstepscope}{\stepcounter{sphinxscope}} +% We ensure \thesphinxscope expands to digits tokens, independently of language +\renewcommand{\thesphinxscope}{\number\value{sphinxscope}} +\newcommand\sphinxthefootnotemark[2]{% + % this is used to make reference to an explicitly numbered footnote not on same page + % #1=label of footnote text, #2=page number where footnote text was printed + \ifdefined\pagename + \pagename\space#2, % <- space + \else + p. #2, % <- space + \fi #1% no space } - -% Tell TeX about pathological hyphenation cases: -\hyphenation{Base-HTTP-Re-quest-Hand-ler} +% support large numbered footnotes in minipage; but this is now obsolete +% from systematic use of savenotes environment around minipages +\def\thempfootnote{\arabic{mpfootnote}} +% This package is needed to support hyperlinked footnotes in tables and +% framed contents, and to allow code-blocks in footnotes. +\RequirePackage{sphinxpackagefootnote} -% The following is stuff copied from docutils' latex writer. +%% INDEX, BIBLIOGRAPHY, APPENDIX, TABLE OF CONTENTS % -\newcommand{\optionlistlabel}[1]{\bf #1 \hfill} -\newenvironment{optionlist}[1] -{\begin{list}{} - {\setlength{\labelwidth}{#1} - \setlength{\rightmargin}{1cm} - \setlength{\leftmargin}{\rightmargin} - \addtolength{\leftmargin}{\labelwidth} - \addtolength{\leftmargin}{\labelsep} - \renewcommand{\makelabel}{\optionlistlabel}} -}{\end{list}} - -\newlength{\lineblockindentation} -\setlength{\lineblockindentation}{2.5em} -\newenvironment{lineblock}[1] -{\begin{list}{} - {\setlength{\partopsep}{\parskip} - \addtolength{\partopsep}{\baselineskip} - \topsep0pt\itemsep0.15\baselineskip\parsep0pt - \leftmargin#1} - \raggedright} -{\end{list}} - -% Redefine includgraphics for avoiding images larger than the screen size -% If the size is not specified. -\let\py@Oldincludegraphics\includegraphics - -\newbox\image@box% -\newdimen\image@width% -\renewcommand\includegraphics[2][\@empty]{% - \ifx#1\@empty% - \setbox\image@box=\hbox{\py@Oldincludegraphics{#2}}% - \image@width\wd\image@box% - \ifdim \image@width>\linewidth% - \setbox\image@box=\hbox{\py@Oldincludegraphics[width=\linewidth]{#2}}% - \box\image@box% - \else% - \py@Oldincludegraphics{#2}% - \fi% - \else% - \py@Oldincludegraphics[#1]{#2}% - \fi% -} +\input{sphinxlatexindbibtoc.sty} -% Fix the index environment to add an entry to the Table of -% Contents; this is much nicer than just having to jump to the end of the book -% and flip around, especially with multiple indexes. +%% STYLING % -% A similiar fix must be done to the bibliography environment, although -% dependant on document class. In particular, the '\addcontentsline' command -% should use 'chapter' for a report and 'section' for an article. -% See sphinxmanual.cls and sphinxhowto.cls for specific fixes. +\input{sphinxlatexstylepage.sty} +\input{sphinxlatexstyleheadings.sty} +\input{sphinxlatexstyletext.sty} + + +%% MODULE RELEASE DATA AND OBJECT DESCRIPTIONS % -\let\py@OldTheindex=\theindex -\renewcommand{\theindex}{ - \cleardoublepage - \phantomsection - \py@OldTheindex - \addcontentsline{toc}{chapter}{\indexname} -} +\input{sphinxlatexobjects.sty} -% Include hyperref last. -\RequirePackage[colorlinks,breaklinks, - linkcolor=InnerLinkColor,filecolor=OuterLinkColor, - menucolor=OuterLinkColor,urlcolor=OuterLinkColor, - citecolor=InnerLinkColor]{hyperref} -% Fix anchor placement for figures with captions. -% (Note: we don't use a package option here; instead, we give an explicit -% \capstart for figures that actually have a caption.) -\RequirePackage{hypcap} - -% From docutils.writers.latex2e -\providecommand{\DUspan}[2]{% - {% group ("span") to limit the scope of styling commands - \@for\node@class@name:=#1\do{% - \ifcsname docutilsrole\node@class@name\endcsname% - \csname docutilsrole\node@class@name\endcsname% - \fi% - }% - {#2}% node content - }% close "span" -} -\providecommand*{\DUprovidelength}[2]{ - \ifthenelse{\isundefined{#1}}{\newlength{#1}\setlength{#1}{#2}}{} -} +% FIXME: this line should be dropped, as "9" is default anyhow. +\ifdefined\pdfcompresslevel\pdfcompresslevel = 9 \fi -\DUprovidelength{\DUlineblockindent}{2.5em} -\ifthenelse{\isundefined{\DUlineblock}}{ - \newenvironment{DUlineblock}[1]{% - \list{}{\setlength{\partopsep}{\parskip} - \addtolength{\partopsep}{\baselineskip} - \setlength{\topsep}{0pt} - \setlength{\itemsep}{0.15\baselineskip} - \setlength{\parsep}{0pt} - \setlength{\leftmargin}{#1}} - \raggedright - } - {\endlist} -}{} - - -% From footmisc.sty: allows footnotes in titles -\let\FN@sf@@footnote\footnote -\def\footnote{\ifx\protect\@typeset@protect - \expandafter\FN@sf@@footnote - \else - \expandafter\FN@sf@gobble@opt - \fi -} -\edef\FN@sf@gobble@opt{\noexpand\protect - \expandafter\noexpand\csname FN@sf@gobble@opt \endcsname} -\expandafter\def\csname FN@sf@gobble@opt \endcsname{% - \@ifnextchar[%] - \FN@sf@gobble@twobracket - \@gobble -} -\def\FN@sf@gobble@twobracket[#1]#2{} + +\endinput diff --git a/docs/build/latex/sphinxhowto.cls b/docs/build/latex/sphinxhowto.cls index f4e3d2f..8d7dd0e 100644 --- a/docs/build/latex/sphinxhowto.cls +++ b/docs/build/latex/sphinxhowto.cls @@ -1,9 +1,9 @@ % -% sphinxhowto.cls for Sphinx (http://sphinx.pocoo.org/) +% sphinxhowto.cls for Sphinx (https://www.sphinx-doc.org/) % \NeedsTeXFormat{LaTeX2e}[1995/12/01] -\ProvidesClass{sphinxhowto}[2009/06/02 Document class (Sphinx HOWTO)] +\ProvidesClass{sphinxhowto}[2019/12/01 v2.3.0 Document class (Sphinx howto)] % 'oneside' option overriding the 'twoside' default \newif\if@oneside @@ -25,34 +25,39 @@ % reset these counters in your preamble. % \setcounter{secnumdepth}{2} +\setcounter{tocdepth}{2}% i.e. section and subsection +% Adapt \and command to the flushright context of \sphinxmaketitle, to +% avoid ragged line endings if author names do not fit all on one single line +\DeclareRobustCommand{\and}{% + \end{tabular}\kern-\tabcolsep + \allowbreak + \hskip\dimexpr1em+\tabcolsep\@plus.17fil\begin{tabular}[t]{c}% +}% +% If it is desired that each author name be on its own line, use in preamble: +%\DeclareRobustCommand{\and}{% +% \end{tabular}\kern-\tabcolsep\\\begin{tabular}[t]{c}% +%}% % Change the title page to look a bit better, and fit in with the fncychap % ``Bjarne'' style a bit better. % -\renewcommand{\maketitle}{ - \rule{\textwidth}{1pt} - \ifsphinxpdfoutput - \begingroup - % These \defs are required to deal with multi-line authors; it - % changes \\ to ', ' (comma-space), making it pass muster for - % generating document info in the PDF file. - \def\\{, } - \def\and{and } - \pdfinfo{ - /Author (\@author) - /Title (\@title) - } +\newcommand{\sphinxmaketitle}{% + \noindent\rule{\linewidth}{1pt}\par + \begingroup % for PDF information dictionary + \def\endgraf{ }\def\and{\& }% + \pdfstringdefDisableCommands{\def\\{, }}% overwrite hyperref setup + \hypersetup{pdfauthor={\@author}, pdftitle={\@title}}% \endgroup - \fi \begin{flushright} - \sphinxlogo% - {\rm\Huge\py@HeaderFamily \@title} \par - {\em\large\py@HeaderFamily \py@release\releaseinfo} \par + \sphinxlogo + \py@HeaderFamily + {\Huge \@title }\par + {\itshape\large \py@release \releaseinfo}\par \vspace{25pt} - {\Large\py@HeaderFamily + {\Large \begin{tabular}[t]{c} \@author - \end{tabular}} \par + \end{tabular}\kern-\tabcolsep}\par \vspace{25pt} \@date \par \py@authoraddress \par @@ -63,30 +68,35 @@ %\gdef\@thanks{}\gdef\@author{}\gdef\@title{} } -\let\py@OldTableofcontents=\tableofcontents -\renewcommand{\tableofcontents}{ +\newcommand{\sphinxtableofcontents}{% \begingroup - \parskip = 0mm - \py@OldTableofcontents + \parskip \z@skip + \sphinxtableofcontentshook + \tableofcontents \endgroup - \rule{\textwidth}{1pt} - \vspace{12pt} -} - -\@ifundefined{fancyhf}{ - \pagestyle{plain}}{ - \pagestyle{normal}} % start this way; change for -\pagenumbering{arabic} % ToC & chapters - -\thispagestyle{empty} + \noindent\rule{\linewidth}{1pt}\par + \vspace{12pt}% +} +\newcommand\sphinxtableofcontentshook{} +\pagenumbering{arabic} % Fix the bibliography environment to add an entry to the Table of % Contents. % For an article document class this environment is a section, % so no page break before it. -\let\py@OldThebibliography=\thebibliography -\renewcommand{\thebibliography}[1]{ - \phantomsection - \py@OldThebibliography{1} - \addcontentsline{toc}{section}{\bibname} -} +% +\newenvironment{sphinxthebibliography}[1]{% + % \phantomsection % not needed here since TeXLive 2010's hyperref + \begin{thebibliography}{#1}% + \addcontentsline{toc}{section}{\ifdefined\refname\refname\else\ifdefined\bibname\bibname\fi\fi}}{\end{thebibliography}} + + +% Same for the indices. +% The memoir class already does this, so we don't duplicate it in that case. +% +\@ifclassloaded{memoir} + {\newenvironment{sphinxtheindex}{\begin{theindex}}{\end{theindex}}} + {\newenvironment{sphinxtheindex}{% + \phantomsection % needed because no chapter, section, ... is created by theindex + \begin{theindex}% + \addcontentsline{toc}{section}{\indexname}}{\end{theindex}}} diff --git a/docs/build/latex/sphinxmanual.cls b/docs/build/latex/sphinxmanual.cls index 57fad1a..2e4b30d 100644 --- a/docs/build/latex/sphinxmanual.cls +++ b/docs/build/latex/sphinxmanual.cls @@ -1,9 +1,9 @@ % -% sphinxmanual.cls for Sphinx (http://sphinx.pocoo.org/) +% sphinxmanual.cls for Sphinx (https://www.sphinx-doc.org/) % \NeedsTeXFormat{LaTeX2e}[1995/12/01] -\ProvidesClass{sphinxmanual}[2009/06/02 Document class (Sphinx manual)] +\ProvidesClass{sphinxmanual}[2019/12/01 v2.3.0 Document class (Sphinx manual)] % chapters starting at odd pages (overridden by 'openany' document option) \PassOptionsToClass{openright}{\sphinxdocclass} @@ -30,36 +30,43 @@ \setcounter{secnumdepth}{2} \setcounter{tocdepth}{1} +% Adapt \and command to the flushright context of \sphinxmaketitle, to +% avoid ragged line endings if author names do not fit all on one single line +\DeclareRobustCommand{\and}{% + \end{tabular}\kern-\tabcolsep + \allowbreak + \hskip\dimexpr1em+\tabcolsep\@plus.17fil\begin{tabular}[t]{c}% +}% +% If it is desired that each author name be on its own line, use in preamble: +%\DeclareRobustCommand{\and}{% +% \end{tabular}\kern-\tabcolsep\\\begin{tabular}[t]{c}% +%}% % Change the title page to look a bit better, and fit in with the fncychap % ``Bjarne'' style a bit better. % -\renewcommand{\maketitle}{% +\newcommand{\sphinxmaketitle}{% + \let\sphinxrestorepageanchorsetting\relax + \ifHy@pageanchor\def\sphinxrestorepageanchorsetting{\Hy@pageanchortrue}\fi + \hypersetup{pageanchor=false}% avoid duplicate destination warnings \begin{titlepage}% \let\footnotesize\small \let\footnoterule\relax - \rule{\textwidth}{1pt}% - \ifsphinxpdfoutput - \begingroup - % These \defs are required to deal with multi-line authors; it - % changes \\ to ', ' (comma-space), making it pass muster for - % generating document info in the PDF file. - \def\\{, } - \def\and{and } - \pdfinfo{ - /Author (\@author) - /Title (\@title) - } + \noindent\rule{\textwidth}{1pt}\par + \begingroup % for PDF information dictionary + \def\endgraf{ }\def\and{\& }% + \pdfstringdefDisableCommands{\def\\{, }}% overwrite hyperref setup + \hypersetup{pdfauthor={\@author}, pdftitle={\@title}}% \endgroup - \fi \begin{flushright}% - \sphinxlogo% - {\rm\Huge\py@HeaderFamily \@title \par}% - {\em\LARGE\py@HeaderFamily \py@release\releaseinfo \par} + \sphinxlogo + \py@HeaderFamily + {\Huge \@title \par} + {\itshape\LARGE \py@release\releaseinfo \par} \vfill - {\LARGE\py@HeaderFamily + {\LARGE \begin{tabular}[t]{c} \@author - \end{tabular} + \end{tabular}\kern-\tabcolsep \par} \vfill\vfill {\large @@ -70,64 +77,52 @@ \end{flushright}%\par \@thanks \end{titlepage}% - \cleardoublepage% \setcounter{footnote}{0}% \let\thanks\relax\let\maketitle\relax %\gdef\@thanks{}\gdef\@author{}\gdef\@title{} + \clearpage + \ifdefined\sphinxbackoftitlepage\sphinxbackoftitlepage\fi + \if@openright\cleardoublepage\else\clearpage\fi + \sphinxrestorepageanchorsetting } - -% Catch the end of the {abstract} environment, but here make sure the abstract -% is followed by a blank page if the 'openright' option is used. -% -\let\py@OldEndAbstract=\endabstract -\renewcommand{\endabstract}{ - \if@openright - \ifodd\value{page} - \typeout{Adding blank page after the abstract.} - \vfil\pagebreak - \fi - \fi - \py@OldEndAbstract -} - -% This wraps the \tableofcontents macro with all the magic to get the spacing -% right and have the right number of pages if the 'openright' option has been -% used. This eliminates a fair amount of crud in the individual document files. -% -\let\py@OldTableofcontents=\tableofcontents -\renewcommand{\tableofcontents}{% - \setcounter{page}{1}% - \pagebreak% - \pagestyle{plain}% - {% - \parskip = 0mm% - \py@OldTableofcontents% - \if@openright% - \ifodd\value{page}% - \typeout{Adding blank page after the table of contents.}% - \pagebreak\hspace{0pt}% - \fi% - \fi% - \cleardoublepage% - }% +\newcommand{\sphinxtableofcontents}{% + \pagenumbering{roman}% + \begingroup + \parskip \z@skip + \sphinxtableofcontentshook + \tableofcontents + \endgroup + % before resetting page counter, let's do the right thing. + \if@openright\cleardoublepage\else\clearpage\fi \pagenumbering{arabic}% - \@ifundefined{fancyhf}{}{\pagestyle{normal}}% } % This is needed to get the width of the section # area wide enough in the % library reference. Doing it here keeps it the same for all the manuals. % -\renewcommand*\l@section{\@dottedtocline{1}{1.5em}{2.6em}} -\renewcommand*\l@subsection{\@dottedtocline{2}{4.1em}{3.5em}} +\newcommand{\sphinxtableofcontentshook}{% + \renewcommand*\l@section{\@dottedtocline{1}{1.5em}{2.6em}}% + \renewcommand*\l@subsection{\@dottedtocline{2}{4.1em}{3.5em}}% +} % Fix the bibliography environment to add an entry to the Table of % Contents. % For a report document class this environment is a chapter. -\let\py@OldThebibliography=\thebibliography -\renewcommand{\thebibliography}[1]{ - \cleardoublepage - \phantomsection - \py@OldThebibliography{1} - \addcontentsline{toc}{chapter}{\bibname} -} +% +\newenvironment{sphinxthebibliography}[1]{% + \if@openright\cleardoublepage\else\clearpage\fi + % \phantomsection % not needed here since TeXLive 2010's hyperref + \begin{thebibliography}{#1}% + \addcontentsline{toc}{chapter}{\bibname}}{\end{thebibliography}} + +% Same for the indices. +% The memoir class already does this, so we don't duplicate it in that case. +% +\@ifclassloaded{memoir} + {\newenvironment{sphinxtheindex}{\begin{theindex}}{\end{theindex}}} + {\newenvironment{sphinxtheindex}{% + \if@openright\cleardoublepage\else\clearpage\fi + \phantomsection % needed as no chapter, section, ... created + \begin{theindex}% + \addcontentsline{toc}{chapter}{\indexname}}{\end{theindex}}} diff --git a/docs/build/latex/tabulary.sty b/docs/build/latex/tabulary.sty deleted file mode 100644 index ba83c0a..0000000 --- a/docs/build/latex/tabulary.sty +++ /dev/null @@ -1,452 +0,0 @@ -%% -%% This is file `tabulary.sty', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% tabulary.dtx (with options: `package') -%% DRAFT VERSION -%% -%% File `tabulary.dtx'. -%% Copyright (C) 1995 1996 2003 David Carlisle -%% This file may be distributed under the terms of the LPPL. -%% See 00readme.txt for details. -%% -\NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{tabulary} - [2007/10/02 v0.9 tabulary package (DPC)] -\RequirePackage{array} -\catcode`\Z=14 -\DeclareOption{debugshow}{\catcode`\Z=9\relax} -\ProcessOptions -\def\arraybackslash{\let\\=\@arraycr} -\def\@finalstrut#1{% - \unskip\ifhmode\nobreak\fi\vrule\@width\z@\@height\z@\@depth\dp#1} -\newcount\TY@count -\def\tabulary{% - \let\TY@final\tabular - \let\endTY@final\endtabular - \TY@tabular} -\def\TY@tabular#1{% - \edef\TY@{\@currenvir}% - {\ifnum0=`}\fi - \@ovxx\TY@linewidth - \@ovyy\TY@tablewidth - \count@\z@ - \@tempswatrue - \@whilesw\if@tempswa\fi{% - \advance\count@\@ne - \expandafter\ifx\csname TY@F\the\count@\endcsname\relax - \@tempswafalse - \else - \expandafter\let\csname TY@SF\the\count@\expandafter\endcsname - \csname TY@F\the\count@\endcsname - \global\expandafter\let\csname TY@F\the\count@\endcsname\relax - \expandafter\let\csname TY@S\the\count@\expandafter\endcsname - \csname TY@\the\count@\endcsname - \fi}% - \global\TY@count\@ne - \TY@width\xdef{0pt}% - \global\TY@tablewidth\z@ - \global\TY@linewidth#1\relax -Z\message{^^J^^JTable^^J% -Z Target Width: \the\TY@linewidth^^J% -Z \string\tabcolsep: \the\tabcolsep\space -Z \string\arrayrulewidth: \the\arrayrulewidth\space -Z \string\doublerulesep: \the\doublerulesep^^J% -Z \string\tymin: \the\tymin\space -Z \string\tymax: \the\tymax^^J}% - \let\@classz\TY@classz - \let\verb\TX@verb - \toks@{}\TY@get@body} -\let\TY@@mkpream\@mkpream -\def\TY@mkpream{% - \def\@addamp{% - \if@firstamp \@firstampfalse \else - \global\advance\TY@count\@ne - \edef\@preamble{\@preamble &}\fi - \TY@width\xdef{0pt}}% - \def\@acol{% - \TY@subwidth\col@sep - \@addtopreamble{\hskip\col@sep}}% - \let\@arrayrule\TY@arrayrule - \let\@classvi\TY@classvi - \def\@classv{\save@decl - \expandafter\NC@ecs\@nextchar\extracolsep{}\extracolsep\@@@ - \sbox\z@{\d@llarbegin\@nextchar\d@llarend}% - \TY@subwidth{\wd\z@}% - \@addtopreamble{\d@llarbegin\the@toks\the\count@\relax\d@llarend}% - \prepnext@tok}% - \global\let\@mkpream\TY@@mkpream - \TY@@mkpream} -\def\TY@arrayrule{% - \TY@subwidth\arrayrulewidth - \@addtopreamble \vline} -\def\TY@classvi{\ifcase \@lastchclass - \@acol \or - \TY@subwidth\doublerulesep - \@addtopreamble{\hskip \doublerulesep}\or - \@acol \or - \@classvii - \fi} -\def\TY@tab{% - \setbox\z@\hbox\bgroup - \let\[$\let\]$% - \let\equation$\let\endequation$% - \col@sep\tabcolsep - \let\d@llarbegin\begingroup\let\d@llarend\endgroup - \let\@mkpream\TY@mkpream - \def\multicolumn##1##2##3{\multispan##1\relax}% - \CT@start\TY@tabarray} -\def\TY@tabarray{\@ifnextchar[{\TY@array}{\@array[t]}} -\def\TY@array[#1]{\@array[t]} -\def\TY@width#1{% - \expandafter#1\csname TY@\the\TY@count\endcsname} -\def\TY@subwidth#1{% - \TY@width\dimen@ - \advance\dimen@-#1\relax - \TY@width\xdef{\the\dimen@}% - \global\advance\TY@linewidth-#1\relax} -\def\endtabulary{% - \gdef\@halignto{}% - \let\TY@footnote\footnote% - \def\footnote{}% prevent footnotes from doing anything - \expandafter\TY@tab\the\toks@ - \crcr\omit - {\xdef\TY@save@row{}% - \loop - \advance\TY@count\m@ne - \ifnum\TY@count>\z@ - \xdef\TY@save@row{\TY@save@row&\omit}% - \repeat}\TY@save@row - \endarray\global\setbox1=\lastbox\setbox0=\vbox{\unvbox1 - \unskip\global\setbox1=\lastbox}\egroup - \dimen@\TY@linewidth - \divide\dimen@\TY@count - \ifdim\dimen@<\tymin - \TY@warn{tymin too large (\the\tymin), resetting to \the\dimen@}% - \tymin\dimen@ - \fi - \setbox\tw@=\hbox{\unhbox\@ne - \loop -\@tempdima=\lastskip -\ifdim\@tempdima>\z@ -Z \message{ecs=\the\@tempdima^^J}% - \global\advance\TY@linewidth-\@tempdima -\fi - \unskip - \setbox\tw@=\lastbox - \ifhbox\tw@ -Z \message{Col \the\TY@count: Initial=\the\wd\tw@\space}% - \ifdim\wd\tw@>\tymax - \wd\tw@\tymax -Z \message{> max\space}% -Z \else -Z \message{ \@spaces\space}% - \fi - \TY@width\dimen@ -Z \message{\the\dimen@\space}% - \advance\dimen@\wd\tw@ -Z \message{Final=\the\dimen@\space}% - \TY@width\xdef{\the\dimen@}% - \ifdim\dimen@<\tymin -Z \message{< tymin}% - \global\advance\TY@linewidth-\dimen@ - \expandafter\xdef\csname TY@F\the\TY@count\endcsname - {\the\dimen@}% - \else - \expandafter\ifx\csname TY@F\the\TY@count\endcsname\z@ -Z \message{***}% - \global\advance\TY@linewidth-\dimen@ - \expandafter\xdef\csname TY@F\the\TY@count\endcsname - {\the\dimen@}% - \else -Z \message{> tymin}% - \global\advance\TY@tablewidth\dimen@ - \global\expandafter\let\csname TY@F\the\TY@count\endcsname - \maxdimen - \fi\fi - \advance\TY@count\m@ne - \repeat}% - \TY@checkmin - \TY@checkmin - \TY@checkmin - \TY@checkmin - \TY@count\z@ - \let\TY@box\TY@box@v - \let\footnote\TY@footnote % restore footnotes - {\expandafter\TY@final\the\toks@\endTY@final}% - \count@\z@ - \@tempswatrue - \@whilesw\if@tempswa\fi{% - \advance\count@\@ne - \expandafter\ifx\csname TY@SF\the\count@\endcsname\relax - \@tempswafalse - \else - \global\expandafter\let\csname TY@F\the\count@\expandafter\endcsname - \csname TY@SF\the\count@\endcsname - \global\expandafter\let\csname TY@\the\count@\expandafter\endcsname - \csname TY@S\the\count@\endcsname - \fi}% - \TY@linewidth\@ovxx - \TY@tablewidth\@ovyy - \ifnum0=`{\fi}} -\def\TY@checkmin{% - \let\TY@checkmin\relax -\ifdim\TY@tablewidth>\z@ - \Gscale@div\TY@ratio\TY@linewidth\TY@tablewidth - \ifdim\TY@tablewidth <\linewidth - \def\TY@ratio{1}% - \fi -\else - \TY@warn{No suitable columns!}% - \def\TY@ratio{1}% -\fi -\count@\z@ -Z \message{^^JLine Width: \the\TY@linewidth, -Z Natural Width: \the\TY@tablewidth, -Z Ratio: \TY@ratio^^J}% -\@tempdima\z@ -\loop -\ifnum\count@<\TY@count -\advance\count@\@ne - \ifdim\csname TY@F\the\count@\endcsname>\tymin - \dimen@\csname TY@\the\count@\endcsname - \dimen@\TY@ratio\dimen@ - \ifdim\dimen@<\tymin -Z \message{Column \the\count@\space ->}% - \global\expandafter\let\csname TY@F\the\count@\endcsname\tymin - \global\advance\TY@linewidth-\tymin - \global\advance\TY@tablewidth-\csname TY@\the\count@\endcsname - \let\TY@checkmin\TY@@checkmin - \else - \expandafter\xdef\csname TY@F\the\count@\endcsname{\the\dimen@}% - \advance\@tempdima\csname TY@F\the\count@\endcsname - \fi - \fi -Z \dimen@\csname TY@F\the\count@\endcsname\message{\the\dimen@, }% -\repeat -Z \message{^^JTotal:\the\@tempdima^^J}% -} -\let\TY@@checkmin\TY@checkmin -\newdimen\TY@linewidth -\def\tyformat{\everypar{{\nobreak\hskip\z@skip}}} -\newdimen\tymin -\tymin=10pt -\newdimen\tymax -\tymax=2\textwidth -\def\@testpach{\@chclass - \ifnum \@lastchclass=6 \@ne \@chnum \@ne \else - \ifnum \@lastchclass=7 5 \else - \ifnum \@lastchclass=8 \tw@ \else - \ifnum \@lastchclass=9 \thr@@ - \else \z@ - \ifnum \@lastchclass = 10 \else - \edef\@nextchar{\expandafter\string\@nextchar}% - \@chnum - \if \@nextchar c\z@ \else - \if \@nextchar l\@ne \else - \if \@nextchar r\tw@ \else - \if \@nextchar C7 \else - \if \@nextchar L8 \else - \if \@nextchar R9 \else - \if \@nextchar J10 \else - \z@ \@chclass - \if\@nextchar |\@ne \else - \if \@nextchar !6 \else - \if \@nextchar @7 \else - \if \@nextchar <8 \else - \if \@nextchar >9 \else - 10 - \@chnum - \if \@nextchar m\thr@@\else - \if \@nextchar p4 \else - \if \@nextchar b5 \else - \z@ \@chclass \z@ \@preamerr \z@ \fi \fi \fi \fi\fi \fi \fi\fi \fi - \fi \fi \fi \fi \fi \fi \fi \fi \fi \fi \fi} -\def\TY@classz{% - \@classx - \@tempcnta\count@ - \ifx\TY@box\TY@box@v - \global\advance\TY@count\@ne - \fi - \let\centering c% - \let\raggedright\noindent - \let\raggedleft\indent - \let\arraybackslash\relax - \prepnext@tok - \ifnum\@chnum<4 - \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@ - \fi - \ifnum\@chnum=6 - \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@ - \fi - \@addtopreamble{% - \ifcase\@chnum - \hfil \d@llarbegin\insert@column\d@llarend \hfil \or - \kern\z@ - \d@llarbegin \insert@column \d@llarend \hfil \or - \hfil\kern\z@ \d@llarbegin \insert@column \d@llarend \or - $\vcenter\@startpbox{\@nextchar}\insert@column \@endpbox $\or - \vtop \@startpbox{\@nextchar}\insert@column \@endpbox \or - \vbox \@startpbox{\@nextchar}\insert@column \@endpbox \or - \d@llarbegin \insert@column \d@llarend \or% dubious "s" case - \TY@box\centering\or - \TY@box\raggedright\or - \TY@box\raggedleft\or - \TY@box\relax - \fi}\prepnext@tok} -\def\TY@box#1{% - \ifx\centering#1% - \hfil \d@llarbegin\insert@column\d@llarend \hfil \else - \ifx\raggedright#1% - \kern\z@%<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< - \d@llarbegin \insert@column \d@llarend \hfil \else - \ifx\raggedleft#1% - \hfil\kern\z@ \d@llarbegin \insert@column \d@llarend \else - \ifx\relax#1% - \d@llarbegin \insert@column \d@llarend - \fi \fi \fi \fi} -\def\TY@box@v#1{% - \vtop \@startpbox{\csname TY@F\the\TY@count\endcsname}% - #1\arraybackslash\tyformat - \insert@column\@endpbox} -\newdimen\TY@tablewidth -\def\Gscale@div#1#2#3{% - \setlength\dimen@{#3}% - \ifdim\dimen@=\z@ - \PackageError{graphics}{Division by 0}\@eha - \dimen@#2% - \fi - \edef\@tempd{\the\dimen@}% - \setlength\dimen@{#2}% - \count@65536\relax - \ifdim\dimen@<\z@ - \dimen@-\dimen@ - \count@-\count@ - \fi - \loop - \ifdim\dimen@<8192\p@ - \dimen@\tw@\dimen@ - \divide\count@\tw@ - \repeat - \dimen@ii=\@tempd\relax - \divide\dimen@ii\count@ - \divide\dimen@\dimen@ii - \edef#1{\strip@pt\dimen@}} -\long\def\TY@get@body#1\end - {\toks@\expandafter{\the\toks@#1}\TY@find@end} -\def\TY@find@end#1{% - \def\@tempa{#1}% - \ifx\@tempa\TY@\def\@tempa{\end{#1}}\expandafter\@tempa - \else\toks@\expandafter - {\the\toks@\end{#1}}\expandafter\TY@get@body\fi} -\def\TY@warn{% - \PackageWarning{tabulary}} -\catcode`\Z=11 -\AtBeginDocument{ -\@ifpackageloaded{colortbl}{% -\expandafter\def\expandafter\@mkpream\expandafter#\expandafter1% - \expandafter{% - \expandafter\let\expandafter\CT@setup\expandafter\relax - \expandafter\let\expandafter\CT@color\expandafter\relax - \expandafter\let\expandafter\CT@do@color\expandafter\relax - \expandafter\let\expandafter\color\expandafter\relax - \expandafter\let\expandafter\CT@column@color\expandafter\relax - \expandafter\let\expandafter\CT@row@color\expandafter\relax - \@mkpream{#1}} -\let\TY@@mkpream\@mkpream -\def\TY@classz{% - \@classx - \@tempcnta\count@ - \ifx\TY@box\TY@box@v - \global\advance\TY@count\@ne - \fi - \let\centering c% - \let\raggedright\noindent - \let\raggedleft\indent - \let\arraybackslash\relax - \prepnext@tok -\expandafter\CT@extract\the\toks\@tempcnta\columncolor!\@nil - \ifnum\@chnum<4 - \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@ - \fi - \ifnum\@chnum=6 - \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@ - \fi - \@addtopreamble{% - \setbox\z@\hbox\bgroup\bgroup - \ifcase\@chnum - \hskip\stretch{.5}\kern\z@ - \d@llarbegin\insert@column\d@llarend\hskip\stretch{.5}\or - \kern\z@%<<<<<<<<<<<<<<<<<<<<<<<<<<< - \d@llarbegin \insert@column \d@llarend \hfill \or - \hfill\kern\z@ \d@llarbegin \insert@column \d@llarend \or - $\vcenter\@startpbox{\@nextchar}\insert@column \@endpbox $\or - \vtop \@startpbox{\@nextchar}\insert@column \@endpbox \or - \vbox \@startpbox{\@nextchar}\insert@column \@endpbox \or - \d@llarbegin \insert@column \d@llarend \or% dubious s case - \TY@box\centering\or - \TY@box\raggedright\or - \TY@box\raggedleft\or - \TY@box\relax - \fi - \egroup\egroup -\begingroup - \CT@setup - \CT@column@color - \CT@row@color - \CT@do@color -\endgroup - \@tempdima\ht\z@ - \advance\@tempdima\minrowclearance - \vrule\@height\@tempdima\@width\z@ -\unhbox\z@ -}\prepnext@tok}% - \def\TY@arrayrule{% - \TY@subwidth\arrayrulewidth - \@addtopreamble{{\CT@arc@\vline}}}% - \def\TY@classvi{\ifcase \@lastchclass - \@acol \or - \TY@subwidth\doublerulesep - \ifx\CT@drsc@\relax - \@addtopreamble{\hskip\doublerulesep}% - \else - \@addtopreamble{{\CT@drsc@\vrule\@width\doublerulesep}}% - \fi\or - \@acol \or - \@classvii - \fi}% -}{% -\let\CT@start\relax -} -} -{\uccode`\*=`\ % -\uppercase{\gdef\TX@verb{% - \leavevmode\null\TX@vwarn - {\ifnum0=`}\fi\ttfamily\let\\\ignorespaces - \@ifstar{\let~*\TX@vb}{\TX@vb}}}} -\def\TX@vb#1{\def\@tempa##1#1{\toks@{##1}\edef\@tempa{\the\toks@}% - \expandafter\TX@v\meaning\@tempa\\ \\\ifnum0=`{\fi}}\@tempa!} -\def\TX@v#1!{\afterassignment\TX@vfirst\let\@tempa= } -\begingroup -\catcode`\*=\catcode`\# -\catcode`\#=12 -\gdef\TX@vfirst{% - \if\@tempa#% - \def\@tempb{\TX@v@#}% - \else - \let\@tempb\TX@v@ - \if\@tempa\space~\else\@tempa\fi - \fi - \@tempb} -\gdef\TX@v@*1 *2{% - \TX@v@hash*1##\relax\if*2\\\else~\expandafter\TX@v@\fi*2} -\gdef\TX@v@hash*1##*2{*1\ifx*2\relax\else#\expandafter\TX@v@hash\fi*2} -\endgroup -\def\TX@vwarn{% - \@warning{\noexpand\verb may be unreliable inside tabularx/y}% - \global\let\TX@vwarn\@empty} -\endinput -%% -%% End of file `tabulary.sty'. diff --git a/docs/build/python.ist b/docs/build/python.ist deleted file mode 100644 index 9ffa0f9..0000000 --- a/docs/build/python.ist +++ /dev/null @@ -1,11 +0,0 @@ -line_max 100 -headings_flag 1 -heading_prefix " \\bigletter " - -preamble "\\begin{theindex} -\\def\\bigletter#1{{\\Large\\sffamily#1}\\nopagebreak\\vspace{1mm}} - -" - -symhead_positive "{Symbols}" -numhead_positive "{Numbers}" diff --git a/docs/build/rHEALPixDGGS.tex b/docs/build/rHEALPixDGGS.tex deleted file mode 100644 index 5bca7b3..0000000 --- a/docs/build/rHEALPixDGGS.tex +++ /dev/null @@ -1,3349 +0,0 @@ -% Generated by Sphinx. -\def\sphinxdocclass{report} -\documentclass[a4paper,12ptopenany,oneside]{sphinxmanual} -\usepackage[utf8]{inputenc} -\DeclareUnicodeCharacter{00A0}{\nobreakspace} -\usepackage[T1]{fontenc} -\usepackage[english]{babel} -\usepackage{times} -\usepackage[Bjarne]{fncychap} -\usepackage{longtable} -\usepackage{sphinx} -\usepackage{multirow} - - -\title{rHEALPixDGGS Documentation} -\date{August 12, 2013} -\release{0.5.1} -\author{Alexander Raichev} -\newcommand{\sphinxlogo}{} -\renewcommand{\releasename}{Release} -\makeindex - -\makeatletter -\def\PYG@reset{\let\PYG@it=\relax \let\PYG@bf=\relax% - \let\PYG@ul=\relax \let\PYG@tc=\relax% - \let\PYG@bc=\relax \let\PYG@ff=\relax} -\def\PYG@tok#1{\csname PYG@tok@#1\endcsname} -\def\PYG@toks#1+{\ifx\relax#1\empty\else% - \PYG@tok{#1}\expandafter\PYG@toks\fi} -\def\PYG@do#1{\PYG@bc{\PYG@tc{\PYG@ul{% - \PYG@it{\PYG@bf{\PYG@ff{#1}}}}}}} -\def\PYG#1#2{\PYG@reset\PYG@toks#1+\relax+\PYG@do{#2}} - -\expandafter\def\csname PYG@tok@vg\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} -\expandafter\def\csname PYG@tok@vc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} -\expandafter\def\csname PYG@tok@nv\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} -\expandafter\def\csname PYG@tok@err\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\fcolorbox[rgb]{1.00,0.00,0.00}{1,1,1}{\strut ##1}}} -\expandafter\def\csname PYG@tok@vi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}} -\expandafter\def\csname PYG@tok@w\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.73,0.73}{##1}}} -\expandafter\def\csname PYG@tok@no\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.38,0.68,0.84}{##1}}} -\expandafter\def\csname PYG@tok@nn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}} -\expandafter\def\csname PYG@tok@k\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@m\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} -\expandafter\def\csname PYG@tok@ni\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.84,0.33,0.22}{##1}}} -\expandafter\def\csname PYG@tok@o\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.40,0.40,0.40}{##1}}} -\expandafter\def\csname PYG@tok@nf\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.49}{##1}}} -\expandafter\def\csname PYG@tok@ne\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@c\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}} -\expandafter\def\csname PYG@tok@nc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}} -\expandafter\def\csname PYG@tok@nb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@na\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} -\expandafter\def\csname PYG@tok@go\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.20,0.20,0.20}{##1}}} -\expandafter\def\csname PYG@tok@sx\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}} -\expandafter\def\csname PYG@tok@nd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.33,0.33,0.33}{##1}}} -\expandafter\def\csname PYG@tok@sr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.14,0.33,0.53}{##1}}} -\expandafter\def\csname PYG@tok@ss\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.32,0.47,0.09}{##1}}} -\expandafter\def\csname PYG@tok@sh\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} -\expandafter\def\csname PYG@tok@si\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.44,0.63,0.82}{##1}}} -\expandafter\def\csname PYG@tok@c1\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}} -\expandafter\def\csname PYG@tok@sb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} -\expandafter\def\csname PYG@tok@sc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} -\expandafter\def\csname PYG@tok@sd\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} -\expandafter\def\csname PYG@tok@se\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} -\expandafter\def\csname PYG@tok@kp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@kr\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@nt\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.45}{##1}}} -\expandafter\def\csname PYG@tok@kt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.56,0.13,0.00}{##1}}} -\expandafter\def\csname PYG@tok@ow\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@kc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@kd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@gp\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}} -\expandafter\def\csname PYG@tok@il\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} -\expandafter\def\csname PYG@tok@kn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@gt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.27,0.87}{##1}}} -\expandafter\def\csname PYG@tok@gu\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.50,0.00,0.50}{##1}}} -\expandafter\def\csname PYG@tok@bp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@mf\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} -\expandafter\def\csname PYG@tok@cm\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}} -\expandafter\def\csname PYG@tok@gr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{1.00,0.00,0.00}{##1}}} -\expandafter\def\csname PYG@tok@gs\endcsname{\let\PYG@bf=\textbf} -\expandafter\def\csname PYG@tok@s1\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} -\expandafter\def\csname PYG@tok@mh\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} -\expandafter\def\csname PYG@tok@mi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} -\expandafter\def\csname PYG@tok@s\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} -\expandafter\def\csname PYG@tok@mo\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}} -\expandafter\def\csname PYG@tok@gi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.63,0.00}{##1}}} -\expandafter\def\csname PYG@tok@gd\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.63,0.00,0.00}{##1}}} -\expandafter\def\csname PYG@tok@ge\endcsname{\let\PYG@it=\textit} -\expandafter\def\csname PYG@tok@nl\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.13,0.44}{##1}}} -\expandafter\def\csname PYG@tok@cp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}} -\expandafter\def\csname PYG@tok@cs\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}} -\expandafter\def\csname PYG@tok@gh\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.50}{##1}}} -\expandafter\def\csname PYG@tok@s2\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}} - -\def\PYGZbs{\char`\\} -\def\PYGZus{\char`\_} -\def\PYGZob{\char`\{} -\def\PYGZcb{\char`\}} -\def\PYGZca{\char`\^} -\def\PYGZam{\char`\&} -\def\PYGZlt{\char`\<} -\def\PYGZgt{\char`\>} -\def\PYGZsh{\char`\#} -\def\PYGZpc{\char`\%} -\def\PYGZdl{\char`\$} -\def\PYGZhy{\char`\-} -\def\PYGZsq{\char`\'} -\def\PYGZdq{\char`\"} -\def\PYGZti{\char`\~} -% for compatibility with earlier versions -\def\PYGZat{@} -\def\PYGZlb{[} -\def\PYGZrb{]} -\makeatother - -\begin{document} - -\maketitle -\tableofcontents -\phantomsection\label{index::doc} - - - -\chapter{Introduction} -\label{introduction::doc}\label{introduction:welcome-the-rhealpixdggs-documentation}\label{introduction:introduction} -rHEALPixDGGS is a Python 3.3 package that implements the rHEALPix discrete global grid system (DGGS). -This documentation assumes you are familiar with the rHEALPix DGGS as described in {\hyperref[introduction:grs2013]{{[}GRS2013{]}}} and familiar with basic Python 3.3 usage as described in \href{http://docs.python.org/3/tutorial/}{The Python Tutorial}. - - -\section{Requirements} -\label{introduction:requirements}\begin{itemize} -\item {} -\href{http://python.org/}{Python \textgreater{}=3.3} - -\item {} -\href{http://www.numpy.org/}{NumPy \textgreater{}=1.7} Base N-dimensional array package - -\item {} -\href{http://www.scipy.org/}{SciPy \textgreater{}=0.12} Fundamental library for scientific computing - -\item {} -\href{http://matplotlib.org/}{Matplotlib \textgreater{}=1.2.1} Comprehensive 2D Plotting - -\item {} -\href{http://code.google.com/p/pyproj/}{Pyproj \textgreater{}=1.9.3} -Python interface to the PROJ.4 cartographic library - -\item {} -\href{http://www.sagemath.org}{Sage \textgreater{}=5.10} -(Optional) Comprehensive mathematics package. -Needed only for a few optional graphics methods. -To use the optional graphics methods, start a Sage notebook session and import/attach the Python module that contains the methods. -For examples, see the Sage worksheet \code{rhealpix\_dggs/tests/test\_dggs.sws}. - -\end{itemize} - - -\section{Installation} -\label{introduction:installation} -rHEALPixDGGS is available for download at Landcare Research's git repository \href{http://code.scenzgrid.org/index.php/p/scenzgrid-py/source/tree/master/rHEALPixDGGS-0.5}{http://code.scenzgrid.org/index.php/p/scenzgrid-py/source/tree/master/rHEALPixDGGS-0.5} and can be cloned via the command \code{git clone git@code.scenzgrid.org:scenzgrid-py.git}. - -To install Sage, download and install the appropriate binary file from \href{http://www.sagemath.org}{sagemath.org}. -Then install Pyproj within Sage by downloading the Pyproj source, changing to the Pyproj directory, starting a Sage shell via \code{sage -sh}, then typing \code{python setup.py build}, then \code{python setup.py install}. -If that doesn't work, try again but first start in superuser mode via \code{sudo su}. - - -\section{Usage} -\label{introduction:usage} -To use rHEALPixDGGS after installing it, start a Python session in the directory where you downloaded the modules and import the modules. -Here are some examples. -For a list of all methods available, see the application programming interface (API) in the following chapters. - - -\subsection{Using the \texttt{projection\_wrapper} Module} -\label{introduction:using-the-projection-wrapper-module} -The module \code{projection\_wrapper} implements a wrapper for map projections of ellipsoids of revolution (which include spheres but not general triaxial ellipsoids) defined in \code{pj\_healpix}, \code{pj\_rhealpix}, and Pyproj. -For brevity hereafter, the word `ellipsoid' abbreviates `ellipsoid of revolution'. - -Currently \code{projection\_wrapper} uses the HEALPix and rHEALPix projections -defined in \code{pj\_healpix} and \code{pj\_rhealpix} and \emph{not} the buggy versions defined in Pyproj 1.9.3 as \code{PJ\_healpix.c}. -Alternatively, you can download a corrected version of \code{PJ\_healpix.c} from -\href{http://trac.osgeo.org/proj/changeset/2378}{trac.osgeo.org/proj/changeset/2378}, rebuild Pyproj with it, and use it in \code{dggs} by editing the \code{HOMEMADE\_PROJECTIONS} line in \code{projection\_wrapper}. - -Import all the classes, methods, and constants from the module: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.projection\PYGZus{}wrapper} \PYG{k+kn}{import} \PYG{o}{*} -\end{Verbatim} - -Create an ellipsoid, say, one with major radius 5 and eccentricity 0.8: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.ellipsoids} \PYG{k+kn}{import} \PYG{o}{*} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{ellps\PYGZus{}1} \PYG{o}{=} \PYG{n}{Ellipsoid}\PYG{p}{(}\PYG{n}{a}\PYG{o}{=}\PYG{l+m+mi}{5}\PYG{p}{,} \PYG{n}{e}\PYG{o}{=}\PYG{l+m+mf}{0.8}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{ellps\PYGZus{}1}\PYG{p}{)} -\PYG{g+go}{ellipsoid:} -\PYG{g+go}{ R\PYGZus{}A = 4.32200117119} -\PYG{g+go}{ a = 5} -\PYG{g+go}{ b = 3.0} -\PYG{g+go}{ e = 0.8} -\PYG{g+go}{ f = 0.4} -\PYG{g+go}{ lat\PYGZus{}0 = 0} -\PYG{g+go}{ lon\PYGZus{}0 = 0} -\PYG{g+go}{ radians = False} -\PYG{g+go}{ sphere = False} -\end{Verbatim} - -The names of the ellipsoid attributes agree with the names of the \href{http://trac.osgeo.org/proj/wiki/GenParms}{PROJ.4 ellipsoid parameters}. - -By default, angles are measured in degrees. -If you prefer radians, then do: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{ellps\PYGZus{}2} \PYG{o}{=} \PYG{n}{Ellipsoid}\PYG{p}{(}\PYG{n}{a}\PYG{o}{=}\PYG{l+m+mi}{5}\PYG{p}{,} \PYG{n}{e}\PYG{o}{=}\PYG{l+m+mf}{0.8}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{ellps\PYGZus{}2}\PYG{p}{)} -\PYG{g+go}{ellipsoid:} -\PYG{g+go}{ R\PYGZus{}A = 4.32200117119} -\PYG{g+go}{ a = 5} -\PYG{g+go}{ b = 3.0} -\PYG{g+go}{ e = 0.8} -\PYG{g+go}{ f = 0.4} -\PYG{g+go}{ lat\PYGZus{}0 = 0} -\PYG{g+go}{ lon\PYGZus{}0 = 0} -\PYG{g+go}{ radians = True} -\PYG{g+go}{ sphere = False} -\end{Verbatim} - -Some common ellipsoids are predefined as constants. - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{UNIT\PYGZus{}SPHERE}\PYG{p}{)} -\PYG{g+go}{ellipsoid:} -\PYG{g+go}{ R = 1} -\PYG{g+go}{ R\PYGZus{}A = 1} -\PYG{g+go}{ a = 1} -\PYG{g+go}{ b = 1} -\PYG{g+go}{ e = 0} -\PYG{g+go}{ f = 0} -\PYG{g+go}{ lat\PYGZus{}0 = 0} -\PYG{g+go}{ lon\PYGZus{}0 = 0} -\PYG{g+go}{ radians = False} -\PYG{g+go}{ sphere = True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{WGS84\PYGZus{}ELLIPSOID}\PYG{p}{)} -\PYG{g+go}{ellipsoid:} -\PYG{g+go}{ R\PYGZus{}A = 6374581.4671} -\PYG{g+go}{ a = 6378137.0} -\PYG{g+go}{ b = 6356752.314140356} -\PYG{g+go}{ e = 0.0578063088401} -\PYG{g+go}{ f = 0.003352810681182} -\PYG{g+go}{ lat\PYGZus{}0 = 0} -\PYG{g+go}{ lon\PYGZus{}0 = 0} -\PYG{g+go}{ radians = False} -\PYG{g+go}{ sphere = False} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{WGS84\PYGZus{}ELLIPSOID\PYGZus{}RADIANS}\PYG{p}{)} -\PYG{g+go}{ellipsoid:} -\PYG{g+go}{ R\PYGZus{}A = 6374581.4671} -\PYG{g+go}{ a = 6378137.0} -\PYG{g+go}{ b = 6356752.314140356} -\PYG{g+go}{ e = 0.0578063088401} -\PYG{g+go}{ f = 0.003352810681182} -\PYG{g+go}{ lat\PYGZus{}0 = 0} -\PYG{g+go}{ lon\PYGZus{}0 = 0} -\PYG{g+go}{ radians = True} -\PYG{g+go}{ sphere = False} -\end{Verbatim} - -Ellipsoid instances are parametrized by geographic longitude and latitude with the central meridian at \code{lon\_0} and the parallel of origin at \code{lat\_0}. - -Project some points of the ellipsoid using the HEALPix and rHEALPix projections: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{h} \PYG{o}{=} \PYG{n}{Proj}\PYG{p}{(}\PYG{n}{ellps\PYGZus{}1}\PYG{p}{,} \PYG{l+s}{\PYGZsq{}}\PYG{l+s}{healpix}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rh} \PYG{o}{=} \PYG{n}{Proj}\PYG{p}{(}\PYG{n}{ellps\PYGZus{}1}\PYG{p}{,} \PYG{l+s}{\PYGZsq{}}\PYG{l+s}{rhealpix}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{n}{north\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{south\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{2}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{h}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{60}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.0, 3.351278550178026)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rh}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{60}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.0, 3.351278550178026)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{h}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{70}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.864006732389895, 4.2584985144432679)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rh}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{70}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}0.86400673238989445, 4.2584985144432679)} -\end{Verbatim} - - -\subsection{Using the \texttt{dggs} Module} -\label{introduction:using-the-dggs-module} -The module \code{dggs} implements the rHEALPix DGGS and various operations thereupon. - -Import all the classes, methods, and constants from the module - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.dggs} \PYG{k+kn}{import} \PYG{o}{*} -\end{Verbatim} - -Create the (0, 0)-rHEALPix DGGS with N\_side=3 that is based upon the WGS84 ellipsoid: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.ellipsoids} \PYG{k+kn}{import} \PYG{n}{WGS84\PYGZus{}ELLIPSOID} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}ELLIPSOID} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{n}{ellipsoid}\PYG{o}{=}\PYG{n}{E}\PYG{p}{,} \PYG{n}{north\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{south\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{N\PYGZus{}side}\PYG{o}{=}\PYG{l+m+mi}{3}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{)} -\PYG{g+go}{rHEALPix DGGS:} -\PYG{g+go}{ N\PYGZus{}side = 3} -\PYG{g+go}{ north\PYGZus{}square = 0} -\PYG{g+go}{ south\PYGZus{}square = 0} -\PYG{g+go}{ max\PYGZus{}areal\PYGZus{}resolution = 1} -\PYG{g+go}{ max\PYGZus{}resolution = 15} -\PYG{g+go}{ ellipsoid:} -\PYG{g+go}{ R\PYGZus{}A = 6374581.4671} -\PYG{g+go}{ a = 6378137.0} -\PYG{g+go}{ b = 6356752.314140356} -\PYG{g+go}{ e = 0.0578063088401} -\PYG{g+go}{ f = 0.003352810681182319} -\PYG{g+go}{ lat\PYGZus{}0 = 0} -\PYG{g+go}{ lon\PYGZus{}0 = 0} -\PYG{g+go}{ radians = False} -\PYG{g+go}{ sphere = False} -\end{Verbatim} - -Some common rHEALPix DGGSs are predefined as constants: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{UNIT\PYGZus{}003}\PYG{p}{)} -\PYG{g+go}{rHEALPix DGGS:} -\PYG{g+go}{ N\PYGZus{}side = 3} -\PYG{g+go}{ north\PYGZus{}square = 0} -\PYG{g+go}{ south\PYGZus{}square = 0} -\PYG{g+go}{ max\PYGZus{}areal\PYGZus{}resolution = 1} -\PYG{g+go}{ max\PYGZus{}resolution = 1} -\PYG{g+go}{ ellipsoid:} -\PYG{g+go}{ R = 1} -\PYG{g+go}{ R\PYGZus{}A = 1} -\PYG{g+go}{ a = 1} -\PYG{g+go}{ b = 1} -\PYG{g+go}{ e = 0} -\PYG{g+go}{ f = 0} -\PYG{g+go}{ lat\PYGZus{}0 = 0} -\PYG{g+go}{ lon\PYGZus{}0 = 0} -\PYG{g+go}{ radians = False} -\PYG{g+go}{ sphere = True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{WGS84\PYGZus{}003}\PYG{p}{)} -\PYG{g+go}{rHEALPix DGGS:} -\PYG{g+go}{ N\PYGZus{}side = 3} -\PYG{g+go}{ north\PYGZus{}square = 0} -\PYG{g+go}{ south\PYGZus{}square = 0} -\PYG{g+go}{ max\PYGZus{}areal\PYGZus{}resolution = 1} -\PYG{g+go}{ max\PYGZus{}resolution = 15} -\PYG{g+go}{ ellipsoid:} -\PYG{g+go}{ R\PYGZus{}A = 6374581.4671} -\PYG{g+go}{ a = 6378137.0} -\PYG{g+go}{ b = 6356752.314140356} -\PYG{g+go}{ e = 0.0578063088401} -\PYG{g+go}{ f = 0.003352810681182319} -\PYG{g+go}{ lat\PYGZus{}0 = 0} -\PYG{g+go}{ lon\PYGZus{}0 = 0} -\PYG{g+go}{ radians = False} -\PYG{g+go}{ sphere = False} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{UNIT\PYGZus{}003\PYGZus{}RADIANS}\PYG{p}{)} -\PYG{g+go}{rHEALPix DGGS:} -\PYG{g+go}{ N\PYGZus{}side = 3} -\PYG{g+go}{ north\PYGZus{}square = 0} -\PYG{g+go}{ south\PYGZus{}square = 0} -\PYG{g+go}{ max\PYGZus{}areal\PYGZus{}resolution = 1} -\PYG{g+go}{ max\PYGZus{}resolution = 1} -\PYG{g+go}{ ellipsoid:} -\PYG{g+go}{ R = 1} -\PYG{g+go}{ R\PYGZus{}A = 1} -\PYG{g+go}{ a = 1} -\PYG{g+go}{ b = 1} -\PYG{g+go}{ e = 0} -\PYG{g+go}{ f = 0} -\PYG{g+go}{ lat\PYGZus{}0 = 0} -\PYG{g+go}{ lon\PYGZus{}0 = 0} -\PYG{g+go}{ radians = True} -\PYG{g+go}{ sphere = True} -\end{Verbatim} - -Pick a (longitude-latitude) point on the ellipsoid and find the level 1 cell that contains it - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}from\PYGZus{}point}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{p}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{;} \PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} -\PYG{g+go}{Q0} -\end{Verbatim} - -Find the ellipsoidal (edge) neighbors of this cell - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} \PYG{o+ow}{in} \PYG{n+nb}{sorted}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{neighbors}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{o}{.}\PYG{n}{items}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} -\PYG{g+go}{east Q1} -\PYG{g+go}{north N2} -\PYG{g+go}{south Q3} -\PYG{g+go}{west P2} -\end{Verbatim} - -Find the planar (edge) neighbors of this cell - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} \PYG{o+ow}{in} \PYG{n+nb}{sorted}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{neighbors}\PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{plane}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)}\PYG{o}{.}\PYG{n}{items}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} -\PYG{g+go}{down Q3} -\PYG{g+go}{left P2} -\PYG{g+go}{right Q1} -\PYG{g+go}{up N2} -\end{Verbatim} - -Find all the level 1 cells intersecting the longitude-latitude aligned ellipsoidal quadrangle with given northwest and southeast corners - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{nw} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{45}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{se} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{90}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{cells} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}region}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{nw}\PYG{p}{,} \PYG{n}{se}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{row} \PYG{o+ow}{in} \PYG{n}{cells}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{[\PYGZsq{}N2\PYGZsq{}, \PYGZsq{}N1\PYGZsq{}, \PYGZsq{}N0\PYGZsq{}]} -\PYG{g+go}{[\PYGZsq{}Q0\PYGZsq{}, \PYGZsq{}Q1\PYGZsq{}, \PYGZsq{}Q2\PYGZsq{}, \PYGZsq{}R0\PYGZsq{}]} -\PYG{g+go}{[\PYGZsq{}Q3\PYGZsq{}, \PYGZsq{}Q4\PYGZsq{}, \PYGZsq{}Q5\PYGZsq{}, \PYGZsq{}R3\PYGZsq{}]} -\end{Verbatim} - -Compute the ellipsoidal shape and ellipsoidal nuclei of these cells - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{row} \PYG{o+ow}{in} \PYG{n}{cells}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{,} \PYG{n}{cell}\PYG{o}{.}\PYG{n}{ellipsoidal\PYGZus{}shape}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{n}{cell}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{N2 dart (5.0888874903416268e\PYGZhy{}14, 58.470677829627355)} -\PYG{g+go}{N1 skew\PYGZus{}quad (45.000000000000036, 58.470677829627355)} -\PYG{g+go}{N0 dart (89.999999999999957, 58.470677829627363)} -\PYG{g+go}{Q0 quad (14.999999999999998, 26.438744923100096)} -\PYG{g+go}{Q1 quad (45.0, 26.438744923100096)} -\PYG{g+go}{Q2 quad (74.999999999999986, 26.438744923100096)} -\PYG{g+go}{R0 quad (105.00000000000001, 26.438744923100096)} -\PYG{g+go}{Q3 quad (14.999999999999998, 3.560649871414923e\PYGZhy{}15)} -\PYG{g+go}{Q4 quad (45.0, 3.560649871414923e\PYGZhy{}15)} -\PYG{g+go}{Q5 quad (74.999999999999986, 3.560649871414923e\PYGZhy{}15)} -\PYG{g+go}{R3 quad (105.00000000000001, 3.560649871414923e\PYGZhy{}15)} -\end{Verbatim} - -Create the (0, 0)-rHEALPix DGGS with N\_side = 3 that is based on the WGS84 ellipsoid. -Orient the DGGS so that the planar origin (0, 0) is on Auckland, New Zealand: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{174}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{37}\PYG{p}{)} \PYG{c}{\PYGZsh{} Approximate Auckland lon\PYGZhy{}lat coordinates} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.projection\PYGZus{}wrapper} \PYG{k+kn}{import} \PYG{o}{*} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{Ellipsoid}\PYG{p}{(}\PYG{n}{a}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}A}\PYG{p}{,} \PYG{n}{f}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}F}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{,} \PYG{n}{lon\PYGZus{}0}\PYG{o}{=}\PYG{n}{p}\PYG{p}{[}\PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{,} \PYG{n}{lat\PYGZus{}0}\PYG{o}{=}\PYG{n}{p}\PYG{p}{[}\PYG{l+m+mi}{1}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{n}{E}\PYG{p}{,} \PYG{n}{N\PYGZus{}side}\PYG{o}{=}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{n}{north\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{south\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{)} -\PYG{g+go}{rHEALPix DGGS:} -\PYG{g+go}{ N\PYGZus{}side = 3} -\PYG{g+go}{ north\PYGZus{}square = 0} -\PYG{g+go}{ south\PYGZus{}square = 0} -\PYG{g+go}{ max\PYGZus{}areal\PYGZus{}resolution = 1} -\PYG{g+go}{ max\PYGZus{}resolution = 15} -\PYG{g+go}{ ellipsoid:} -\PYG{g+go}{ R\PYGZus{}A = 6374581.4671} -\PYG{g+go}{ a = 6378137.0} -\PYG{g+go}{ b = 6356752.314140356} -\PYG{g+go}{ e = 0.0578063088401} -\PYG{g+go}{ f = 0.003352810681182319} -\PYG{g+go}{ lat\PYGZus{}0 = \PYGZhy{}37} -\PYG{g+go}{ lon\PYGZus{}0 = 174} -\PYG{g+go}{ radians = False} -\PYG{g+go}{ sphere = False} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}from\PYGZus{}point}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{p}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{Q3} -\end{Verbatim} - - -\subsection{Using the \texttt{distortion} Module} -\label{introduction:using-the-distortion-module} -The module \code{distortion} computes distortions of map projections created via \code{projection\_wrapper} and was used to produce the tables in {\hyperref[introduction:grs2013]{{[}GRS2013{]}}}. -The module is not necessary for manipulating the rHEALPix DGGS. - -Import all the classes, methods, and constants from the module: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.distortion} \PYG{k+kn}{import} \PYG{o}{*} -\end{Verbatim} - -Import the WGS84 ellipsoid, define the rHEALPix projection on the ellipsoid, and compute linear distortion and areal distortion for the projection at a given point: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.ellipsoids} \PYG{k+kn}{import} \PYG{n}{WGS84\PYGZus{}ELLIPSOID} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}ELLIPSOID} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.projection\PYGZus{}wrapper} \PYG{k+kn}{import} \PYG{n}{Proj} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{f} \PYG{o}{=} \PYG{n}{Proj}\PYG{p}{(}\PYG{n}{ellipsoid}\PYG{o}{=}\PYG{n}{E}\PYG{p}{,} \PYG{n}{proj}\PYG{o}{=}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{rhealpix}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{n}{north\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{south\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{30}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{distortion}\PYG{p}{(}\PYG{n}{f}\PYG{p}{,} \PYG{o}{*}\PYG{n}{p}\PYG{p}{)} \PYG{c}{\PYGZsh{} First entry of output is f(*p)) } -\PYG{g+go}{((0.0, 3748655.115049511), 6.976075406932126, 1.1295629192757011, 1.1780969079183845)} -\end{Verbatim} - -Sample 100 random points from the WGS84 ellipsoid and compute the sample minimum, sample maximum, sample median, sample mean, and sample standard deviation of the linear and area distortion functions of the rHEALPix projection of those points: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{sample} \PYG{o}{=} \PYG{p}{[}\PYG{n}{E}\PYG{o}{.}\PYG{n}{random\PYGZus{}point}\PYG{p}{(}\PYG{p}{)} \PYG{k}{for} \PYG{n}{i} \PYG{o+ow}{in} \PYG{n+nb}{range}\PYG{p}{(}\PYG{l+m+mi}{100}\PYG{p}{)}\PYG{p}{]} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{distortion\PYGZus{}stats}\PYG{p}{(}\PYG{n}{f}\PYG{p}{,} \PYG{n}{sample}\PYG{p}{)}\PYG{p}{[}\PYG{l+m+mi}{1}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{[[14.918, 13.82, 0.124, 48.086, 8.623], [1.345, 0.371, 1.002, 2.375, 1.163], [1.178, 0.0, 1.178, 1.178, 1.178]]} -\end{Verbatim} - -Do the same for 100 points chosen at random from an rHEALPix DGGS dart cell: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.dggs} \PYG{k+kn}{import} \PYG{o}{*} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{cell} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{sample} \PYG{o}{=} \PYG{p}{[}\PYG{n}{cell}\PYG{o}{.}\PYG{n}{random\PYGZus{}point}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} \PYG{k}{for} \PYG{n}{i} \PYG{o+ow}{in} \PYG{n+nb}{range}\PYG{p}{(}\PYG{l+m+mi}{100}\PYG{p}{)}\PYG{p}{]} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{distortion\PYGZus{}stats}\PYG{p}{(}\PYG{n}{f}\PYG{p}{,} \PYG{n}{sample}\PYG{p}{)}\PYG{p}{[}\PYG{l+m+mi}{1}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{[[38.907, 6.044, 28.189, 48.963, 38.701], [2.013, 0.226, 1.644, 2.415, 1.991], [1.178, 0.0, 1.178, 1.178, 1.178]]} -\end{Verbatim} - - -\chapter{The utils Module} -\label{utils::doc}\label{utils:module-rhealpix_dggs.utils}\label{utils:the-utils-module}\index{rhealpix\_dggs.utils (module)} -This Python 3.3 module implements several helper functions for coding map projections. - -CHANGELOG: -\begin{itemize} -\item {} -Alexander Raichev (AR), 2012-01-26: Refactored code from release 0.3. - -\item {} -AR, 2013-07-23: Ported to Python 3.3. - -\end{itemize} - -NOTE: - -All lengths are measured in meters and all angles are measured in radians -unless indicated otherwise. -\index{auth\_lat() (in module rhealpix\_dggs.utils)} - -\begin{fulllineitems} -\phantomsection\label{utils:rhealpix_dggs.utils.auth_lat}\pysiglinewithargsret{\code{rhealpix\_dggs.utils.}\bfcode{auth\_lat}}{\emph{phi}, \emph{e}, \emph{inverse=False}, \emph{radians=False}}{} -Given a point of geographic latitude \emph{phi} on an ellipse of -eccentricity \emph{e}, return the authalic latitude of the point. -If \emph{inverse} =True, then compute its inverse approximately. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{beta} \PYG{o}{=} \PYG{n}{auth\PYGZus{}lat}\PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{l+m+mf}{0.5}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{beta}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{0.689518212435} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{auth\PYGZus{}lat}\PYG{p}{(}\PYG{n}{beta}\PYG{p}{,} \PYG{l+m+mf}{0.5}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{0.785126523581} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{0.785398163397448} -\end{Verbatim} - -NOTES: - -The power series approximation used for the inverse is -standard in cartography (PROJ.4 uses it, for instance) -and accurate for small eccentricities. - -\end{fulllineitems} - -\index{auth\_rad() (in module rhealpix\_dggs.utils)} - -\begin{fulllineitems} -\phantomsection\label{utils:rhealpix_dggs.utils.auth_rad}\pysiglinewithargsret{\code{rhealpix\_dggs.utils.}\bfcode{auth\_rad}}{\emph{a}, \emph{e}, \emph{inverse=False}}{} -Return the radius of the authalic sphere of the ellipsoid with major -radius \emph{a} and eccentricity \emph{e}. -If \emph{inverse} = True, then return the major radius of the ellipsoid -with authalic radius \emph{a} and eccentricity \emph{e}. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{auth\PYGZus{}rad}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+go}{1} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{i} \PYG{o+ow}{in} \PYG{n+nb}{range}\PYG{p}{(}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{l+m+mi}{11}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{n}{e} \PYG{o}{=} \PYG{l+m+mf}{1.0}\PYG{o}{/}\PYG{n}{i}\PYG{o}{*}\PYG{o}{*}\PYG{l+m+mi}{2} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{p}{(}\PYG{n}{e}\PYG{p}{,} \PYG{n}{auth\PYGZus{}rad}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{l+m+mf}{1.0}\PYG{o}{/}\PYG{n}{i}\PYG{o}{*}\PYG{o}{*}\PYG{l+m+mi}{2}\PYG{p}{)}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.25, 0.98939325967009495)} -\PYG{g+go}{(0.111111111111111, 0.99793514742994305)} -\PYG{g+go}{(0.0625, 0.99934823645582505)} -\PYG{g+go}{(0.04, 0.99973321235361001)} -\PYG{g+go}{(0.027777777777778, 0.99987137105187995)} -\PYG{g+go}{(0.020408163265306, 0.99993057628561399)} -\PYG{g+go}{(0.015625, 0.99995930708084702)} -\PYG{g+go}{(0.012345679012346, 0.99997459627121099)} -\PYG{g+go}{(0.01, 0.99998333286108898)} -\end{Verbatim} - -\end{fulllineitems} - -\index{my\_round() (in module rhealpix\_dggs.utils)} - -\begin{fulllineitems} -\phantomsection\label{utils:rhealpix_dggs.utils.my_round}\pysiglinewithargsret{\code{rhealpix\_dggs.utils.}\bfcode{my\_round}}{\emph{x}, \emph{digits=0}}{} -Round the floating point number or list/tuple of floating point -numbers to \code{digits} number of digits. -Calls Python's \code{round()} function. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{l+m+mf}{1.}\PYG{o}{/}\PYG{l+m+mi}{7}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{0.142857} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{p}{(}\PYG{l+m+mf}{1.}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{l+m+mf}{1.}\PYG{o}{/}\PYG{l+m+mi}{7}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.333333, 0.142857)} -\end{Verbatim} - -\end{fulllineitems} - -\index{wrap\_latitude() (in module rhealpix\_dggs.utils)} - -\begin{fulllineitems} -\phantomsection\label{utils:rhealpix_dggs.utils.wrap_latitude}\pysiglinewithargsret{\code{rhealpix\_dggs.utils.}\bfcode{wrap\_latitude}}{\emph{phi}, \emph{radians=False}}{} -Given a point p on the unit circle at angle \emph{phi} from the positive x-axis, -if p lies in the right half of the circle, then return its angle that lies -in the interval {[}-pi/2, pi/2{]}. -If p lies in the left half of the circle, then reflect it through the -origin, and return the angle of the reflected point that lies in the -interval {[}-pi/2, pi/2{]}. -If \emph{radians} = True, then \emph{phi} and the output are given in radians. -Otherwise, they are given in degrees. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}latitude}\PYG{p}{(}\PYG{l+m+mi}{45}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} -\PYG{g+go}{45.0} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}latitude}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{45}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} -\PYG{g+go}{\PYGZhy{}45.0} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}latitude}\PYG{p}{(}\PYG{l+m+mi}{90}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} -\PYG{g+go}{90.0} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}latitude}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{90}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} -\PYG{g+go}{\PYGZhy{}90.0} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}latitude}\PYG{p}{(}\PYG{l+m+mi}{135}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} -\PYG{g+go}{\PYGZhy{}45.0} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}latitude}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{135}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} -\PYG{g+go}{45.0} -\end{Verbatim} - -\end{fulllineitems} - -\index{wrap\_longitude() (in module rhealpix\_dggs.utils)} - -\begin{fulllineitems} -\phantomsection\label{utils:rhealpix_dggs.utils.wrap_longitude}\pysiglinewithargsret{\code{rhealpix\_dggs.utils.}\bfcode{wrap\_longitude}}{\emph{lam}, \emph{radians=False}}{} -Given a point p on the unit circle at angle \emph{lam} from the positive -x-axis, return its angle theta in the range -pi \textless{}= theta \textless{} pi. -If \emph{radians} = True, then \emph{lam} and the output are given in radians. -Otherwise, they are given in degrees. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}longitude}\PYG{p}{(}\PYG{l+m+mi}{2}\PYG{o}{*}\PYG{n}{pi} \PYG{o}{+} \PYG{n}{pi}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)} -\PYG{g+go}{\PYGZhy{}3.1415926535897931} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}longitude}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{185}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} -\PYG{g+go}{175.0} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}longitude}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{180}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} -\PYG{g+go}{\PYGZhy{}180.0} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{wrap\PYGZus{}longitude}\PYG{p}{(}\PYG{l+m+mi}{185}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} -\PYG{g+go}{\PYGZhy{}175.0} -\end{Verbatim} - -\end{fulllineitems} - - - -\chapter{The pj\_healpix Module} -\label{pj_healpix:module-rhealpix_dggs.pj_healpix}\label{pj_healpix::doc}\label{pj_healpix:the-pj-healpix-module}\index{rhealpix\_dggs.pj\_healpix (module)} -This Python 3.3 module implements the HEALPix map projection as described in {\hyperref[pj_healpix:caro2007]{{[}CaRo2007{]}}}. - -CHANGELOG: -\begin{itemize} -\item {} -Alexander Raichev (AR), 2013-01-26: Refactored code from release 0.3. - -\item {} -AR, 2013-03-05: In in\_healpix\_image() increased eps to 1e-10 to decrease out-of-bounds errors i was getting when drawing figures. - -\item {} -AR, 2013-07-23: Ported to Python 3.3. - -\end{itemize} - -NOTE: - -All lengths are measured in meters and all angles are measured in radians -unless indicated otherwise. -By `ellipsoid' below, i mean an oblate ellipsoid of revolution. -\index{healpix() (in module rhealpix\_dggs.pj\_healpix)} - -\begin{fulllineitems} -\phantomsection\label{pj_healpix:rhealpix_dggs.pj_healpix.healpix}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_healpix.}\bfcode{healpix}}{\emph{a=1}, \emph{e=0}}{} -Return a function object that wraps the HEALPix projection and its inverse -of an ellipsoid with major radius \emph{a} and eccentricity \emph{e}. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{f} \PYG{o}{=} \PYG{n}{healpix}\PYG{p}{(}\PYG{n}{a}\PYG{o}{=}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{e}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{f}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.57495135977821499, 2.1457476865731109)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{60}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{q} \PYG{o}{=} \PYG{n}{f}\PYG{p}{(}\PYG{o}{*}\PYG{n}{p}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{;} \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{q}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.57495135977821499, 2.1457476865731109)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{f}\PYG{p}{(}\PYG{o}{*}\PYG{n}{q}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(5.9999999999999997e\PYGZhy{}15, 59.999999999999986)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0, 60)} -\end{Verbatim} - -OUTPUT: -\begin{itemize} -\item {} -A function object of the form f(u, v, radians=False, inverse=False). - -\end{itemize} - -\end{fulllineitems} - -\index{healpix\_diagram() (in module rhealpix\_dggs.pj\_healpix)} - -\begin{fulllineitems} -\phantomsection\label{pj_healpix:rhealpix_dggs.pj_healpix.healpix_diagram}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_healpix.}\bfcode{healpix\_diagram}}{\emph{a=1}, \emph{e=0}, \emph{shade\_polar\_region=True}}{} -Return a Sage Graphics object diagramming the HEALPix projection -boundary and polar triangles for the ellipsoid with major radius \emph{a} -and eccentricity \emph{e}. -Inessential graphics method. -Requires Sage graphics methods. - -\end{fulllineitems} - -\index{healpix\_ellipsoid() (in module rhealpix\_dggs.pj\_healpix)} - -\begin{fulllineitems} -\phantomsection\label{pj_healpix:rhealpix_dggs.pj_healpix.healpix_ellipsoid}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_healpix.}\bfcode{healpix\_ellipsoid}}{\emph{lam}, \emph{phi}, \emph{e=0}}{} -Compute the signature functions of the HEALPix projection of an oblate -ellipsoid with eccentricity \emph{e} whose authalic sphere is the unit sphere. -Works when \emph{e} = 0 (spherical case) too. - -INPUT: -\begin{itemize} -\item {} -\emph{lam, phi} - Geodetic longitude-latitude coordinates in radians. -Assume -pi \textless{}= \emph{lam} \textless{} pi and -pi/2 \textless{}= \emph{phi} \textless{}= pi/2. - -\item {} -\emph{e} - Eccentricity of the oblate ellipsoid. - -\end{itemize} - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{healpix\PYGZus{}ellipsoid}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{7}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0, 0.51115723774642197)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{healpix\PYGZus{}ellipsoid}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{7}\PYG{p}{,} \PYG{n}{e}\PYG{o}{=}\PYG{l+m+mf}{0.8}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0, 0.26848445085783701)} -\end{Verbatim} - -\end{fulllineitems} - -\index{healpix\_ellipsoid\_inverse() (in module rhealpix\_dggs.pj\_healpix)} - -\begin{fulllineitems} -\phantomsection\label{pj_healpix:rhealpix_dggs.pj_healpix.healpix_ellipsoid_inverse}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_healpix.}\bfcode{healpix\_ellipsoid\_inverse}}{\emph{x}, \emph{y}, \emph{e=0}}{} -Compute the inverse of healpix\_ellipsoid(). - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{7}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{q} \PYG{o}{=} \PYG{n}{healpix\PYGZus{}ellipsoid}\PYG{p}{(}\PYG{o}{*}\PYG{n}{p}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{healpix\PYGZus{}ellipsoid\PYGZus{}inverse}\PYG{p}{(}\PYG{o}{*}\PYG{n}{q}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0, 0.44879895051282798)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0, 0.448798950512828)} -\end{Verbatim} - -\end{fulllineitems} - -\index{healpix\_sphere() (in module rhealpix\_dggs.pj\_healpix)} - -\begin{fulllineitems} -\phantomsection\label{pj_healpix:rhealpix_dggs.pj_healpix.healpix_sphere}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_healpix.}\bfcode{healpix\_sphere}}{\emph{lam}, \emph{phi}}{} -Compute the signature function of the HEALPix -projection of the unit sphere. - -INPUT: -\begin{itemize} -\item {} -\emph{lam, phi} - Geodetic longitude-latitude coordinates in radians. -Assume -pi \textless{}= \emph{lam} \textless{} pi and -pi/2 \textless{}= \emph{phi} \textless{}= pi/2. - -\end{itemize} - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{healpix\PYGZus{}sphere}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{arcsin}\PYG{p}{(}\PYG{l+m+mf}{2.0}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{)}\PYG{p}{)} \PYG{o}{==} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{True} -\end{Verbatim} - -\end{fulllineitems} - -\index{healpix\_sphere\_inverse() (in module rhealpix\_dggs.pj\_healpix)} - -\begin{fulllineitems} -\phantomsection\label{pj_healpix:rhealpix_dggs.pj_healpix.healpix_sphere_inverse}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_healpix.}\bfcode{healpix\_sphere\_inverse}}{\emph{x}, \emph{y}}{} -Compute the inverse of the healpix\_sphere(). - -INPUT: -\begin{itemize} -\item {} -\emph{x, y} - Planar coordinates in meters in the image of the -HEALPix projection of the unit sphere. - -\end{itemize} - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{healpix\PYGZus{}sphere\PYGZus{}inverse}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)} \PYG{o}{==} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{arcsin}\PYG{p}{(}\PYG{l+m+mf}{2.0}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{)}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{True} -\end{Verbatim} - -\end{fulllineitems} - -\index{healpix\_vertices() (in module rhealpix\_dggs.pj\_healpix)} - -\begin{fulllineitems} -\phantomsection\label{pj_healpix:rhealpix_dggs.pj_healpix.healpix_vertices}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_healpix.}\bfcode{healpix\_vertices}}{}{} -Return a list of the planar vertices of the HEALPix projection of -the unit sphere. - -\end{fulllineitems} - -\index{in\_healpix\_image() (in module rhealpix\_dggs.pj\_healpix)} - -\begin{fulllineitems} -\phantomsection\label{pj_healpix:rhealpix_dggs.pj_healpix.in_healpix_image}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_healpix.}\bfcode{in\_healpix\_image}}{\emph{x}, \emph{y}}{} -Return True if and only if \emph{(x, y)} lies in the image of the HEALPix -projection of the unit sphere. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{eps} \PYG{o}{=} \PYG{l+m+mi}{0} \PYG{c}{\PYGZsh{} Test boundary points.} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{hp} \PYG{o}{=} \PYG{p}{[} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{3}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{l+m+mi}{3}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{n}{pi} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{n}{pi} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{,}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{l+m+mi}{3}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{3}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{,}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)} -\PYG{g+gp}{... }\PYG{p}{]} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{hp}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{if} \PYG{o+ow}{not} \PYG{n}{in\PYGZus{}healpix\PYGZus{}image}\PYG{p}{(}\PYG{o}{*}\PYG{n}{p}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{Fail}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)} -\PYG{g+gp}{... } -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{in\PYGZus{}healpix\PYGZus{}image}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+go}{True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{in\PYGZus{}healpix\PYGZus{}image}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{+} \PYG{l+m+mf}{0.1}\PYG{p}{)} -\PYG{g+go}{False} -\end{Verbatim} - -\end{fulllineitems} - - - -\chapter{The pj\_rhealpix Module} -\label{pj_rhealpix:the-pj-rhealpix-module}\label{pj_rhealpix::doc}\label{pj_rhealpix:module-rhealpix_dggs.pj_rhealpix}\index{rhealpix\_dggs.pj\_rhealpix (module)} -This Python 3.3 module implements the rHEALPix map projection. - -CHANGELOG: -\begin{itemize} -\item {} -Alexander Raichev (AR), 2013-01-26: Refactored code from release 0.3. - -\item {} -AR, 2013-07-23: Ported to Python 3.3. - -\end{itemize} - -NOTE: - -All lengths are measured in meters and all angles are measured in radians -unless indicated otherwise. -By `ellipsoid' below, i mean an oblate ellipsoid of revolution. -\index{combine\_triangles() (in module rhealpix\_dggs.pj\_rhealpix)} - -\begin{fulllineitems} -\phantomsection\label{pj_rhealpix:rhealpix_dggs.pj_rhealpix.combine_triangles}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_rhealpix.}\bfcode{combine\_triangles}}{\emph{x}, \emph{y}, \emph{north\_square=0}, \emph{south\_square=0}, \emph{inverse=False}}{} -Rearrange point \emph{(x, y)} in the HEALPix projection by -combining the polar triangles into two polar squares. -Put the north polar square in position \emph{north\_square} and -the south polar square in position \emph{south\_square}. -If \emph{inverse} = True, uncombine the polar triangles. - -INPUT: -\begin{itemize} -\item {} -\emph{x, y} - Coordinates in the HEALPix projection of the unit sphere. - -\item {} -\emph{north\_square, south\_square} - Integers between 0 and 3 indicating -the positions of the north\_square polar square and south\_square polar -square respectively. -See rhealpix\_sphere() docstring for a diagram. - -\item {} -\emph{inverse} - (Optional; default = False) Boolean. If False, then compute -forward function. If True, then compute inverse function. - -\end{itemize} - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{u}\PYG{p}{,} \PYG{n}{v} \PYG{o}{=} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{3} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{x}\PYG{p}{,} \PYG{n}{y} \PYG{o}{=} \PYG{n}{combine\PYGZus{}triangles}\PYG{p}{(}\PYG{n}{u}\PYG{p}{,} \PYG{n}{v}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{p}{(}\PYG{n}{x}\PYG{p}{,} \PYG{n}{y}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}1.8325957145940459, 1.5707963267948959)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{combine\PYGZus{}triangles}\PYG{p}{(}\PYG{n}{x}\PYG{p}{,} \PYG{n}{y}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}0.78539816339744795, 1.0471975511965981)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{p}{(}\PYG{n}{u}\PYG{p}{,} \PYG{n}{v}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}0.785398163397448, 1.047197551196598)} -\end{Verbatim} - -\end{fulllineitems} - -\index{in\_rhealpix\_image() (in module rhealpix\_dggs.pj\_rhealpix)} - -\begin{fulllineitems} -\phantomsection\label{pj_rhealpix:rhealpix_dggs.pj_rhealpix.in_rhealpix_image}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_rhealpix.}\bfcode{in\_rhealpix\_image}}{\emph{x}, \emph{y}, \emph{north\_square=0}, \emph{south\_square=0}}{} -Return True if and only if the point \emph{(x, y)} lies in the image of -the rHEALPix projection of the unit sphere. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{eps} \PYG{o}{=} \PYG{l+m+mi}{0} \PYG{c}{\PYGZsh{} Test boundary points.} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{north\PYGZus{}square}\PYG{p}{,} \PYG{n}{south\PYGZus{}square} \PYG{o}{=} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{0} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rhp} \PYG{o}{=} \PYG{p}{[} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi} \PYG{o}{+} \PYG{n}{north\PYGZus{}square}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi} \PYG{o}{+} \PYG{n}{north\PYGZus{}square}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi} \PYG{o}{+} \PYG{p}{(}\PYG{n}{north\PYGZus{}square} \PYG{o}{+} \PYG{l+m+mi}{1}\PYG{p}{)}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi} \PYG{o}{+} \PYG{p}{(}\PYG{n}{north\PYGZus{}square} \PYG{o}{+} \PYG{l+m+mi}{1}\PYG{p}{)}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{n}{pi} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{n}{pi} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{,}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi} \PYG{o}{+} \PYG{p}{(}\PYG{n}{south\PYGZus{}square} \PYG{o}{+} \PYG{l+m+mi}{1}\PYG{p}{)}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{,}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi} \PYG{o}{+} \PYG{p}{(}\PYG{n}{south\PYGZus{}square} \PYG{o}{+} \PYG{l+m+mi}{1}\PYG{p}{)}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2} \PYG{o}{+} \PYG{n}{eps}\PYG{p}{,}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{3}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi} \PYG{o}{+} \PYG{n}{south\PYGZus{}square}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{,}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{3}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi} \PYG{o}{+} \PYG{n}{south\PYGZus{}square}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2} \PYG{o}{\PYGZhy{}}\PYG{n}{eps}\PYG{p}{,}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{)}\PYG{p}{,} -\PYG{g+gp}{... }\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{,}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{\PYGZhy{}} \PYG{n}{eps}\PYG{p}{)} -\PYG{g+gp}{... }\PYG{p}{]} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{rhp}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{if} \PYG{o+ow}{not} \PYG{n}{in\PYGZus{}rhealpix\PYGZus{}image}\PYG{p}{(}\PYG{o}{*}\PYG{n}{p}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{Fail}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)} -\PYG{g+gp}{... } -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{in\PYGZus{}rhealpix\PYGZus{}image}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{in\PYGZus{}rhealpix\PYGZus{}image}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{+} \PYG{l+m+mf}{0.1}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{False} -\end{Verbatim} - -\end{fulllineitems} - -\index{rhealpix() (in module rhealpix\_dggs.pj\_rhealpix)} - -\begin{fulllineitems} -\phantomsection\label{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_rhealpix.}\bfcode{rhealpix}}{\emph{a=1}, \emph{e=0}, \emph{north\_square=0}, \emph{south\_square=0}}{} -Return a function object that wraps the rHEALPix projection and its inverse -of an ellipsoid with major radius \emph{a} and eccentricity \emph{e}. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{f} \PYG{o}{=} \PYG{n}{rhealpix}\PYG{p}{(}\PYG{n}{a}\PYG{o}{=}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{e}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{north\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{south\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{2}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{f}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}0.57495135977821499, 2.1457476865731109)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{60}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{q} \PYG{o}{=} \PYG{n}{f}\PYG{p}{(}\PYG{o}{*}\PYG{n}{p}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{q}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}0.57495135977821499, 2.1457476865731109)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{f}\PYG{p}{(}\PYG{o}{*}\PYG{n}{q}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(5.9999999999999997e\PYGZhy{}15, 59.999999999999986)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0, 60)} -\end{Verbatim} - -OUTPUT: -\begin{itemize} -\item {} -A function object of the form f(u, v, radians=False, inverse=False). - -\end{itemize} - -\end{fulllineitems} - -\index{rhealpix\_diagram() (in module rhealpix\_dggs.pj\_rhealpix)} - -\begin{fulllineitems} -\phantomsection\label{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix_diagram}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_rhealpix.}\bfcode{rhealpix\_diagram}}{\emph{a=1}, \emph{e=0}, \emph{north\_square=0}, \emph{south\_square=0}, \emph{shade\_polar\_region=True}}{} -Return a Sage Graphics object diagramming the rHEALPix projection -boundary and polar triangles for the ellipsoid with major radius \emph{a} -and eccentricity \emph{e}. -Inessential graphics method. -Requires Sage graphics methods. - -\end{fulllineitems} - -\index{rhealpix\_ellipsoid() (in module rhealpix\_dggs.pj\_rhealpix)} - -\begin{fulllineitems} -\phantomsection\label{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix_ellipsoid}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_rhealpix.}\bfcode{rhealpix\_ellipsoid}}{\emph{lam}, \emph{phi}, \emph{e=0}, \emph{north\_square=0}, \emph{south\_square=0}}{} -Compute the signature functions of the rHEALPix map -projection of an oblate ellipsoid with eccentricity \emph{e} whose -authalic sphere is the unit sphere. -The north polar square is put in position \emph{north\_square}, -and the south polar square is put in position \emph{south\_square}. -Works when \emph{e} = 0 (spherical case) too. - -INPUT: -\begin{itemize} -\item {} -\emph{lam, phi} - Geographic longitude-latitude coordinates in radian. -Assume -pi \textless{}= \emph{lam} \textless{} pi and -pi/2 \textless{}= \emph{phi} \textless{}= pi/2. - -\item {} -\emph{e} - Eccentricity of the ellipsoid. - -\item {} -\emph{north\_square, south\_square} - (Optional; defaults = 0, 0) Integers -between 0 and 3 indicating positions of north polar and -south polar squares, respectively. -See rhealpix\_sphere() docstring for a diagram. - -\end{itemize} - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{numpy} \PYG{k+kn}{import} \PYG{n}{arcsin} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rhealpix\PYGZus{}ellipsoid}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{arcsin}\PYG{p}{(}\PYG{l+m+mf}{2.0}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{)}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0, 0.78539816339744795)} -\end{Verbatim} - -\end{fulllineitems} - -\index{rhealpix\_ellipsoid\_inverse() (in module rhealpix\_dggs.pj\_rhealpix)} - -\begin{fulllineitems} -\phantomsection\label{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix_ellipsoid_inverse}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_rhealpix.}\bfcode{rhealpix\_ellipsoid\_inverse}}{\emph{x}, \emph{y}, \emph{e=0}, \emph{north\_square=0}, \emph{south\_square=0}}{} -Compute the inverse of rhealpix\_ellipsoid. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{q} \PYG{o}{=} \PYG{n}{rhealpix\PYGZus{}ellipsoid}\PYG{p}{(}\PYG{o}{*}\PYG{n}{p}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rhealpix\PYGZus{}ellipsoid\PYGZus{}inverse}\PYG{p}{(}\PYG{o}{*}\PYG{n}{q}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.0, 0.78539816339744795)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0, 0.785398163397448)} -\end{Verbatim} - -\end{fulllineitems} - -\index{rhealpix\_sphere() (in module rhealpix\_dggs.pj\_rhealpix)} - -\begin{fulllineitems} -\phantomsection\label{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix_sphere}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_rhealpix.}\bfcode{rhealpix\_sphere}}{\emph{lam}, \emph{phi}, \emph{north\_square=0}, \emph{south\_square=0}}{} -Compute the signature functions of the rHEALPix map projection of -the unit sphere. -The north polar square is put in position \emph{north\_square}, and the -south polar square is put in position \emph{south\_square}. - -INPUT: -\begin{itemize} -\item {} -\emph{lam, phi} -Geographic longitude-latitude coordinates in radians. -Assume -pi \textless{}= \emph{lam} \textless{} pi and -pi/2 \textless{}= \emph{phi} \textless{}= pi/2. - -\item {} -\emph{north\_square, south\_square} - (Optional; defaults = 0, 0) Integers -between 0 and 3 indicating positions of north polar and -south polar squares, respectively. - -\end{itemize} - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rhealpix\PYGZus{}sphere}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}1.619978633413937, 2.307012183573304)} -\end{Verbatim} - -NOTE: - -The polar squares are labeled 0, 1, 2, 3 from east to west like this: - -\begin{Verbatim}[commandchars=\\\{\}] -east west -*---*---*---*---* -\textbar{} 0 \textbar{} 1 \textbar{} 2 \textbar{} 3 \textbar{} -*---*---*---*---* -\textbar{} \textbar{} \textbar{} \textbar{} \textbar{} -*---*---*---*---* -\textbar{} 0 \textbar{} 1 \textbar{} 2 \textbar{} 3 \textbar{} -*---*---*---*---* -\end{Verbatim} - -\end{fulllineitems} - -\index{rhealpix\_sphere\_inverse() (in module rhealpix\_dggs.pj\_rhealpix)} - -\begin{fulllineitems} -\phantomsection\label{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix_sphere_inverse}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_rhealpix.}\bfcode{rhealpix\_sphere\_inverse}}{\emph{x}, \emph{y}, \emph{north\_square=0}, \emph{south\_square=0}}{} -Compute the inverse of rhealpix\_sphere(). - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{q} \PYG{o}{=} \PYG{n}{rhealpix\PYGZus{}sphere}\PYG{p}{(}\PYG{o}{*}\PYG{n}{p}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rhealpix\PYGZus{}sphere\PYGZus{}inverse}\PYG{p}{(}\PYG{o}{*}\PYG{n}{q}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.0, 0.78539816339744795)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0, 0.785398163397448)} -\end{Verbatim} - -\end{fulllineitems} - -\index{rhealpix\_vertices() (in module rhealpix\_dggs.pj\_rhealpix)} - -\begin{fulllineitems} -\phantomsection\label{pj_rhealpix:rhealpix_dggs.pj_rhealpix.rhealpix_vertices}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_rhealpix.}\bfcode{rhealpix\_vertices}}{\emph{north\_square=0}, \emph{south\_square=0}}{} -Return a list of the planar vertices of the rHEALPix projection of -the unit sphere. - -\end{fulllineitems} - -\index{triangle() (in module rhealpix\_dggs.pj\_rhealpix)} - -\begin{fulllineitems} -\phantomsection\label{pj_rhealpix:rhealpix_dggs.pj_rhealpix.triangle}\pysiglinewithargsret{\code{rhealpix\_dggs.pj\_rhealpix.}\bfcode{triangle}}{\emph{x}, \emph{y}, \emph{north\_square=0}, \emph{south\_square=0}, \emph{inverse=False}}{} -Return the number of the polar triangle and region that \emph{(x, y)} lies in. -If \emph{inverse} = False, then assume \emph{(x,y)} lies in the image of the HEALPix -projection of the unit sphere. -If \emph{inverse} = True, then assume \emph{(x,y)} lies in the image of the -\emph{(north\_square, south\_square)}-rHEALPix projection of the unit sphere. - -INPUT: -\begin{itemize} -\item {} -\emph{x, y} - Coordinates in the HEALPix or rHEALPix (if \emph{inverse} = True) -projection of the unit sphere. - -\item {} -\emph{north\_square, south\_square} - Integers between 0 and 3 indicating the -positions of the north\_square pole square and south\_square pole square -respectively. -See rhealpix\_sphere() docstring for a diagram. - -\item {} -\emph{inverse} - (Optional; default = False) Boolean. If False, then compute -forward function. If True, then compute inverse function. - -\end{itemize} - -OUTPUT: - -The pair (triangle\_number, region). -Here region equals `north\_polar' (polar), `south\_polar' (polar), or -`equatorial', indicating where \emph{(x, y)} lies. -If region = `equatorial', then triangle\_number = None. -Suppose now that region != `equatorial'. -If \emph{inverse} = False, then triangle\_number is the number (0, 1, 2, or 3) of -the HEALPix polar triangle Z that \emph{(x, y)} lies in. -If \emph{inverse} = True, then triangle\_number is the number (0, 1, 2, or 3) of -the HEALPix polar triangle that \emph{(x, y)} will get moved into. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{triangle}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{+} \PYG{l+m+mf}{0.1}\PYG{p}{)} -\PYG{g+go}{(1, \PYGZsq{}north\PYGZus{}polar\PYGZsq{})} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{triangle}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{3}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4} \PYG{o}{+} \PYG{l+m+mf}{0.1}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)} -\PYG{g+go}{(1, \PYGZsq{}north\PYGZus{}polar\PYGZsq{})} -\end{Verbatim} - -NOTES: - -In the HEALPix projection, the polar triangles are labeled 0--3 from -east to west like this: - -\begin{Verbatim}[commandchars=\\\{\}] - * * * * - * 0 * * 1 * * 2 * * 3 * -*-------*-------*-------*-------* -\textbar{} \textbar{} \textbar{} \textbar{} \textbar{} -\textbar{} \textbar{} \textbar{} \textbar{} \textbar{} -\textbar{} \textbar{} \textbar{} \textbar{} \textbar{} -*-------*-------*-------*-------* - * 0 * * 1 * * 2 * * 3 * - * * * * -\end{Verbatim} - -In the rHEALPix projection these polar triangles get rearranged -into a square with the triangles numbered \emph{north\_square} and \emph{south\_square} -remaining fixed. -For example, if \emph{north\_square} = 1 and \emph{south\_square} = 3, -then the triangles get rearranged this way: - -\begin{Verbatim}[commandchars=\\\{\}] -North polar square: *-------* - \textbar{} * 3 * \textbar{} - \textbar{} 0 * 2 \textbar{} - \textbar{} * 1 * \textbar{} - ----*-------*---- - -South polar square: ----*-------*---- - \textbar{} * 3 * \textbar{} - \textbar{} 2 * 0 \textbar{} - \textbar{} * 1 * \textbar{} - *-------* -\end{Verbatim} - -\end{fulllineitems} - - - -\chapter{The ellipsoids Module} -\label{ellipsoids::doc}\label{ellipsoids:the-ellipsoids-module}\label{ellipsoids:module-rhealpix_dggs.ellipsoids}\index{rhealpix\_dggs.ellipsoids (module)} -This Python 3.3 code implements ellipsoids of revolution. - -CHANGELOG: -\begin{itemize} -\item {} -Alexander Raichev (AR), 2012-01-26: Refactored code from release 0.3. - -\item {} -AR, 2013-07-23: Ported to Python 3.3. - -\end{itemize} - -NOTE: - -All lengths are measured in meters and all angles are measured in radians -unless indicated otherwise. - -By `ellipsoid' throughout, i mean an ellipsoid of revolution and \emph{not} a general (triaxial) ellipsoid. -Points lying on an ellipsoid are given in geodetic (longitude, latitude) coordinates. -\index{Ellipsoid (class in rhealpix\_dggs.ellipsoids)} - -\begin{fulllineitems} -\phantomsection\label{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid}\pysiglinewithargsret{\strong{class }\code{rhealpix\_dggs.ellipsoids.}\bfcode{Ellipsoid}}{\emph{R=None}, \emph{a=6378137.0}, \emph{b=None}, \emph{e=None}, \emph{f=0.003352810681182319}, \emph{lon\_0=0}, \emph{lat\_0=0}, \emph{radians=False}}{} -Bases: \code{builtins.object} - -Represents an ellipsoid of revolution (possibly a sphere) with a -geodetic longitude-latitude coordinate frame. - -INSTANCE ATTRIBUTES: -\begin{itemize} -\item {} -\emph{sphere} - True if the ellipsoid is a sphere, and False otherwise. - -\item {} -\emph{R} - The radius of the ellipsoid in meters, implying that it is a -sphere. - -\item {} -\emph{a} - Major radius of the ellipsoid in meters. - -\item {} -\emph{b} - Minor radius of the ellipsoid in meters. - -\item {} -\emph{e} - Eccentricity of the ellipsoid. - -\item {} -\emph{f} - Flattening of the ellipsoid. - -\item {} -\emph{R\_A} - Authalic radius of the ellipsoid in meters. - -\item {} -\emph{lon\_0} - Central meridian. - -\item {} -\emph{lat\_0} - Latitude of origin. - -\item {} -\emph{radians} - If True, use angles measured in radians for all calculations. -Use degrees otherwise. - -\item {} -\emph{phi\_0} - The latitude separating the equatorial region and -the north polar region in the context of the (r)HEALPix projection. - -\end{itemize} - -Except for phi\_0, these attribute names match the names of the -\href{http://trac.osgeo.org/proj/wiki/GenParms}{PROJ.4 ellipsoid parameters}. -\index{get\_points() (rhealpix\_dggs.ellipsoids.Ellipsoid method)} - -\begin{fulllineitems} -\phantomsection\label{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.get_points}\pysiglinewithargsret{\bfcode{get\_points}}{\emph{filename}}{} -Return a list of longitude-latitude points contained in -the file with filename \emph{filename}. -Assume the file is a text file containing at most one -longitude-latitude point per line with the coordinates separated by -whitespace and angles given in degrees. - -\end{fulllineitems} - -\index{graticule() (rhealpix\_dggs.ellipsoids.Ellipsoid method)} - -\begin{fulllineitems} -\phantomsection\label{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.graticule}\pysiglinewithargsret{\bfcode{graticule}}{\emph{n=400}, \emph{spacing=None}}{} -Return a list of longitude-latitude points sampled from a -longitude-latitude graticule on this ellipsoid with the given -spacing between meridians and between parallels. -The number of points on longitude and latitude per pi radians is \emph{n}. -The spacing should be specified in the angle units used for this -ellipsoid. -If \emph{spacing=None}, then a default spacing of pi/16 radians will be set. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}SPHERE} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n+nb}{len}\PYG{p}{(}\PYG{n}{E}\PYG{o}{.}\PYG{n}{graticule}\PYG{p}{(}\PYG{n}{n}\PYG{o}{=}\PYG{l+m+mi}{400}\PYG{p}{)}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{25600} -\end{Verbatim} - -\end{fulllineitems} - -\index{lattice() (rhealpix\_dggs.ellipsoids.Ellipsoid method)} - -\begin{fulllineitems} -\phantomsection\label{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.lattice}\pysiglinewithargsret{\bfcode{lattice}}{\emph{n=90}}{} -Return a 2n x n square lattice of longitude-latitude points. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}SPHERE} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{E}\PYG{o}{.}\PYG{n}{lattice}\PYG{p}{(}\PYG{n}{n}\PYG{o}{=}\PYG{l+m+mi}{3}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{p}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}150.0, \PYGZhy{}60.0)} -\PYG{g+go}{(\PYGZhy{}150.0, 0.0)} -\PYG{g+go}{(\PYGZhy{}150.0, 60.0)} -\PYG{g+go}{(\PYGZhy{}90.0, \PYGZhy{}60.0)} -\PYG{g+go}{(\PYGZhy{}90.0, 0.0)} -\PYG{g+go}{(\PYGZhy{}90.0, 60.0)} -\PYG{g+go}{(\PYGZhy{}30.0, \PYGZhy{}60.0)} -\PYG{g+go}{(\PYGZhy{}30.0, 0.0)} -\PYG{g+go}{(\PYGZhy{}30.0, 60.0)} -\PYG{g+go}{(30.0, \PYGZhy{}60.0)} -\PYG{g+go}{(30.0, 0.0)} -\PYG{g+go}{(30.0, 60.0)} -\PYG{g+go}{(90.0, \PYGZhy{}60.0)} -\PYG{g+go}{(90.0, 0.0)} -\PYG{g+go}{(90.0, 60.0)} -\PYG{g+go}{(150.0, \PYGZhy{}60.0)} -\PYG{g+go}{(150.0, 0.0)} -\PYG{g+go}{(150.0, 60.0)} -\end{Verbatim} - -\end{fulllineitems} - -\index{meridian() (rhealpix\_dggs.ellipsoids.Ellipsoid method)} - -\begin{fulllineitems} -\phantomsection\label{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.meridian}\pysiglinewithargsret{\bfcode{meridian}}{\emph{lam}, \emph{n=200}}{} -Return a list of \emph{n} equispaced longitude-latitude -points lying along the meridian of longitude \emph{lam}. -Avoid the poles. - -\end{fulllineitems} - -\index{parallel() (rhealpix\_dggs.ellipsoids.Ellipsoid method)} - -\begin{fulllineitems} -\phantomsection\label{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.parallel}\pysiglinewithargsret{\bfcode{parallel}}{\emph{phi}, \emph{n=200}}{} -Return a list of \emph{2*n} equispaced longitude-latitude -points lying along the parallel of latitude \emph{phi}. - -\end{fulllineitems} - -\index{pi() (rhealpix\_dggs.ellipsoids.Ellipsoid method)} - -\begin{fulllineitems} -\phantomsection\label{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.pi}\pysiglinewithargsret{\bfcode{pi}}{}{} -Return pi if \emph{self.radians} = True and 180 otherwise. - -\end{fulllineitems} - -\index{random\_point() (rhealpix\_dggs.ellipsoids.Ellipsoid method)} - -\begin{fulllineitems} -\phantomsection\label{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.random_point}\pysiglinewithargsret{\bfcode{random\_point}}{\emph{lam\_min=None}, \emph{lam\_max=None}, \emph{phi\_min=None}, \emph{phi\_max=None}}{} -Return a point (given in geodetic coordinates) sampled uniformly at -random from the section of this ellipsoid with longitude in the range -\emph{lam\_min \textless{}= lam \textless{} lam\_max} and latitude in the range -\emph{phi\_min \textless{}= phi \textless{} phi\_max}. -But avoid the poles. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}SPHERE} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{E}\PYG{o}{.}\PYG{n}{random\PYGZus{}point}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}1.0999574573422948, 0.21029104897701129)} -\end{Verbatim} - -\end{fulllineitems} - -\index{xyz() (rhealpix\_dggs.ellipsoids.Ellipsoid method)} - -\begin{fulllineitems} -\phantomsection\label{ellipsoids:rhealpix_dggs.ellipsoids.Ellipsoid.xyz}\pysiglinewithargsret{\bfcode{xyz}}{\emph{lam}, \emph{phi}}{} -Given a point on this ellipsoid with longitude-latitude coordinates -\emph{(lam, phi)}, return the point's 3D rectangular coordinates. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}SPHERE} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{E}\PYG{o}{.}\PYG{n}{xyz}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{45}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.70710678118654802, 0.0, 0.70710678118654802)} -\end{Verbatim} - -\end{fulllineitems} - - -\end{fulllineitems} - - - -\chapter{The projection\_wrapper Module} -\label{projection_wrapper:module-rhealpix_dggs.projection_wrapper}\label{projection_wrapper:the-projection-wrapper-module}\label{projection_wrapper::doc}\index{rhealpix\_dggs.projection\_wrapper (module)} -This Python 3.3 module implements a wrapper for map projections. - -CHANGELOG: -\begin{itemize} -\item {} -Alexander Raichev (AR), 2013-01-25: Refactored code from release 0.3. - -\item {} -AR, 2013-07-23: Ported to Python 3.3. - -\end{itemize} - -NOTE: - -All lengths are measured in meters and all angles are measured in radians -unless indicated otherwise. -By `ellipsoid' below, i mean an oblate ellipsoid of revolution. -\index{Proj (class in rhealpix\_dggs.projection\_wrapper)} - -\begin{fulllineitems} -\phantomsection\label{projection_wrapper:rhealpix_dggs.projection_wrapper.Proj}\pysiglinewithargsret{\strong{class }\code{rhealpix\_dggs.projection\_wrapper.}\bfcode{Proj}}{\emph{ellipsoid=\textless{}rhealpix\_dggs.ellipsoids.Ellipsoid object at 0x10356e590\textgreater{}}, \emph{proj=None}, \emph{**kwargs}}{} -Bases: \code{builtins.object} - -Represents a map projection of a given ellipsoid. - -INSTANCE ATTRIBUTES: -\begin{itemize} -\item {} -\emph{ellipsoid} - An ellipsoid (Ellipsoid instance) to project. - -\item {} -\emph{proj} - The name (string) of the map projection, either a valid PROJ.4 -projection name or a valid homemade projection name. - -\item {} -\emph{kwargs} - Keyword arguments (dictionary) needed for the projection's -definition, but not for the definition of the ellipsoid. For example, -these could be \{`north\_square':1, `south\_square': 2\} for the rhealpix -projection. - -\end{itemize} - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.ellipsoids} \PYG{k+kn}{import} \PYG{n}{WGS84\PYGZus{}ELLIPSOID} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{f} \PYG{o}{=} \PYG{n}{Proj}\PYG{p}{(}\PYG{n}{ellipsoid}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}ELLIPSOID}\PYG{p}{,} \PYG{n}{proj}\PYG{o}{=}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{rhealpix}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{n}{north\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{south\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{f}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{30}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.0, 3748655.1150495014)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{f} \PYG{o}{=} \PYG{n}{Proj}\PYG{p}{(}\PYG{n}{ellipsoid}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}ELLIPSOID}\PYG{p}{,} \PYG{n}{proj}\PYG{o}{=}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{cea}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{f}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{30}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.0, 3180183.485774971)} -\end{Verbatim} - -NOTES: - -When accessing a homemade map projection assume that it can be called via -a function g(a, e), where a is the major radius of the ellipsoid to be -projected and e is its eccentricity. -The output of g should be a function object of the form -f(u, v, radians=False, inverse=False). -For example, see the healpix() function in \code{pj\_healpix.py}. - -\end{fulllineitems} - - - -\chapter{The dggs Module} -\label{dggs:the-dggs-module}\label{dggs::doc}\label{dggs:module-rhealpix_dggs.dggs}\index{rhealpix\_dggs.dggs (module)} -This Python 3.3 module implements the rHEALPix discrete global grid system. - -CHANGELOG: -\begin{itemize} -\item {} -Alexander Raichev (AR), 2012-11-12: Initial version based upon grids.py. - -\item {} -AR, 2012-12-10: Corrected centroid() and moved some methods from graphics.py to here. - -\item {} -AR, 2012-12-19: Tested all the methods and added examples. - -\item {} -AR, 2013-01-01: Added ellipsoidal functionality to neighbor() and neighbors(). - -\item {} -AR, 2013-01-14: Added intersects\_meridian(), cell\_latitudes(), cells\_from\_meridian(), cells\_from\_parallel(), cells\_from\_region(). - -\item {} -AR, 2013-01-16: Changed the string keyword `surface' to a boolean keyword `plane'. - -\item {} -AR, 2013-03-11: Added minimal\_cover(), boundary(), interior(), triangle(), nw\_vertex(). - -\item {} -AR, 2013-03-14: Fixed bug in nw\_vertex(). - -\item {} -AR, 2013-07-23: Ported to Python 3.3. - -\end{itemize} - -NOTES: - -All lengths are measured in meters and all angles are measured in radians -unless indicated otherwise. - -By `ellipsoid' throughout, i mean an ellipsoid of revolution and \emph{not} a general (triaxial) ellipsoid. - -Points lying on the plane are given in rectangular (horizontal, vertical) coordinates, and points lying on the ellipsoid are given in geodetic (longitude, latitude) coordinates unless indicated otherwise. - -DGGS abbreviates `discrete global grid system'. - -Except when manipulating positive integers, I avoid the modulo function `\%' -and insted write everything in terms of `floor()'. -This is because Python interprets the sign of `\%' differently than -Java or C, and I don't want to confuse people who are translating this code -to those languages. - -EXAMPLES: - -Create the (1, 2)-rHEALPix DGGS with N\_side = 3 that is based on the WGS84 ellipsoid. Use degrees instead of the default radians for angular measurements - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.ellipsoids} \PYG{k+kn}{import} \PYG{n}{WGS84\PYGZus{}ELLIPSOID} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}ELLIPSOID} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{n}{ellipsoid}\PYG{o}{=}\PYG{n}{E}\PYG{p}{,} \PYG{n}{north\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{south\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{N\PYGZus{}side}\PYG{o}{=}\PYG{l+m+mi}{3}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{)} -\PYG{g+go}{rHEALPix DGGS:} -\PYG{g+go}{ N\PYGZus{}side = 3} -\PYG{g+go}{ north\PYGZus{}square = 1} -\PYG{g+go}{ south\PYGZus{}square = 2} -\PYG{g+go}{ max\PYGZus{}areal\PYGZus{}resolution = 1} -\PYG{g+go}{ max\PYGZus{}resolution = 15} -\PYG{g+go}{ ellipsoid:} -\PYG{g+go}{ R\PYGZus{}A = 6374581.4671} -\PYG{g+go}{ a = 6378137.0} -\PYG{g+go}{ b = 6356752.314140356} -\PYG{g+go}{ e = 0.0578063088401} -\PYG{g+go}{ f = 0.003352810681182319} -\PYG{g+go}{ lat\PYGZus{}0 = 0} -\PYG{g+go}{ lon\PYGZus{}0 = 0} -\PYG{g+go}{ radians = False} -\PYG{g+go}{ sphere = False} -\end{Verbatim} - -Pick a (longitude-latitude) point on the ellipsoid and find the resolution 1 cell that contains it - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{45}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}from\PYGZus{}point}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{p}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{;} \PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} -\PYG{g+go}{N8} -\end{Verbatim} - -Find the ellipsoidal (edge) neighbors of this cell - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} \PYG{o+ow}{in} \PYG{n+nb}{sorted}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{neighbors}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{o}{.}\PYG{n}{items}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} -\PYG{g+go}{east N5} -\PYG{g+go}{south\PYGZus{}east Q0} -\PYG{g+go}{south\PYGZus{}west P2} -\PYG{g+go}{west N7} -\end{Verbatim} - -Find the planar (edge) neighbors of this cell - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} \PYG{o+ow}{in} \PYG{n+nb}{sorted}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{neighbors}\PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{plane}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)}\PYG{o}{.}\PYG{n}{items}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{direction}\PYG{p}{,} \PYG{n}{cell}\PYG{p}{)} -\PYG{g+go}{down P2} -\PYG{g+go}{left N7} -\PYG{g+go}{right Q0} -\PYG{g+go}{up N5} -\end{Verbatim} - -Find all the resolution 1 cells intersecting the longitude-latitude aligned ellipsoidal quadrangle with given northwest and southeast corners - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{nw} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{45}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{se} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{90}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{cells} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}region}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{nw}\PYG{p}{,} \PYG{n}{se}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{row} \PYG{o+ow}{in} \PYG{n}{cells}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{[\PYGZsq{}N8\PYGZsq{}, \PYGZsq{}N5\PYGZsq{}, \PYGZsq{}N2\PYGZsq{}]} -\PYG{g+go}{[\PYGZsq{}Q0\PYGZsq{}, \PYGZsq{}Q1\PYGZsq{}, \PYGZsq{}Q2\PYGZsq{}, \PYGZsq{}R0\PYGZsq{}]} -\PYG{g+go}{[\PYGZsq{}Q3\PYGZsq{}, \PYGZsq{}Q4\PYGZsq{}, \PYGZsq{}Q5\PYGZsq{}, \PYGZsq{}R3\PYGZsq{}]} -\end{Verbatim} - -Compute the ellipsoidal nuclei of these cells - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{row} \PYG{o+ow}{in} \PYG{n}{cells}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{,} \PYG{n}{cell}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{N8 (0.0, 58.470677829627363)} -\PYG{g+go}{N5 (45.000000000000036, 58.470677829627363)} -\PYG{g+go}{N2 (90.000000000000028, 58.470677829627355)} -\PYG{g+go}{Q0 (14.999999999999998, 26.438744923100096)} -\PYG{g+go}{Q1 (45.0, 26.438744923100096)} -\PYG{g+go}{Q2 (74.999999999999986, 26.438744923100096)} -\PYG{g+go}{R0 (105.00000000000001, 26.438744923100096)} -\PYG{g+go}{Q3 (14.999999999999998, 3.560649871414923e\PYGZhy{}15)} -\PYG{g+go}{Q4 (45.0, 3.560649871414923e\PYGZhy{}15)} -\PYG{g+go}{Q5 (74.999999999999986, 3.560649871414923e\PYGZhy{}15)} -\PYG{g+go}{R3 (105.00000000000001, 3.560649871414923e\PYGZhy{}15)} -\end{Verbatim} - -Create the (0, 0)-rHEALPix DGGS with N\_side = 3 that is based on the WGS84 ellipsoid. Use degrees instead of the default radians for angular measurements -and orient the DGGS so that the planar origin (0, 0) is on Auckland, New Zealand - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{174}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{37}\PYG{p}{)} \PYG{c}{\PYGZsh{} Approximate Auckland lon\PYGZhy{}lat coordinates} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.ellipsoids} \PYG{k+kn}{import} \PYG{o}{*} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{Ellipsoid}\PYG{p}{(}\PYG{n}{a}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}A}\PYG{p}{,} \PYG{n}{f}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}F}\PYG{p}{,} \PYG{n}{radians}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{,} \PYG{n}{lon\PYGZus{}0}\PYG{o}{=}\PYG{n}{p}\PYG{p}{[}\PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{,} \PYG{n}{lat\PYGZus{}0}\PYG{o}{=}\PYG{n}{p}\PYG{p}{[}\PYG{l+m+mi}{1}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{n}{E}\PYG{p}{,} \PYG{n}{N\PYGZus{}side}\PYG{o}{=}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{n}{north\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{south\PYGZus{}square}\PYG{o}{=}\PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{)} -\PYG{g+go}{rHEALPix DGGS:} -\PYG{g+go}{ N\PYGZus{}side = 3} -\PYG{g+go}{ north\PYGZus{}square = 0} -\PYG{g+go}{ south\PYGZus{}square = 0} -\PYG{g+go}{ max\PYGZus{}areal\PYGZus{}resolution = 1} -\PYG{g+go}{ max\PYGZus{}resolution = 15} -\PYG{g+go}{ ellipsoid:} -\PYG{g+go}{ R\PYGZus{}A = 6374581.4671} -\PYG{g+go}{ a = 6378137.0} -\PYG{g+go}{ b = 6356752.314140356} -\PYG{g+go}{ e = 0.0578063088401} -\PYG{g+go}{ f = 0.003352810681182319} -\PYG{g+go}{ lat\PYGZus{}0 = \PYGZhy{}37} -\PYG{g+go}{ lon\PYGZus{}0 = 174} -\PYG{g+go}{ radians = False} -\PYG{g+go}{ sphere = False} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}from\PYGZus{}point}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{p}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{Q3} -\end{Verbatim} -\index{Cell (class in rhealpix\_dggs.dggs)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell}\pysiglinewithargsret{\strong{class }\code{rhealpix\_dggs.dggs.}\bfcode{Cell}}{\emph{rdggs=\textless{}rhealpix\_dggs.dggs.RHEALPixDGGS object at 0x10356e790\textgreater{}}, \emph{suid=None}, \emph{level\_order\_index=None}, \emph{post\_order\_index=None}}{} -Bases: \code{builtins.object} - -Represents a cell of the planar or ellipsoidal rHEALPix grid hierarchies. -Cell identifiers are of the form (p\_0, p\_1,...,p\_l), where p\_0 is one of -the characters `A', `B', `C', `D', `E', `F' and p\_i for i \textgreater{} 0 is one of -the integers 0, 1,..., N\_side**2 - 1, where N\_side is the instance -attribute from RHEALPixDGGS (the number of children cells along a cell's -side). - -INSTANCE ATTRIBUTES: -\begin{itemize} -\item {} -\emph{rdggs} - The DGGS that the cell comes from. - -\item {} -\emph{ellipsoid} - The underlying ellipsoid of the DGGS. - -\item {} -\emph{N\_side} - The N\_side attribute of the DGGS - -\item {} -\emph{suid} - The cell's ID (tuple). SUID = spatially unique identifier. -(`id' is a reserved word in Python) - -\item {} -\emph{resolution} - The cell's resolution (nonnegative integer). - -\end{itemize} - -NOTE: - -Several Cell methods have the keyword argument `plane'. -Setting it to True indicates that all input and output points and cells are -to be interpreted as lying in the planar DGGS. -Setting it to False indicates that they are to be interpreted as lying in -the ellipsoidal DGGS. -\index{area() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.area}\pysiglinewithargsret{\bfcode{area}}{\emph{plane=True}}{} -Return the area of this cell. - -\end{fulllineitems} - -\index{boundary() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.boundary}\pysiglinewithargsret{\bfcode{boundary}}{\emph{n=2}, \emph{plane=True}, \emph{interior=False}}{} -Return a list of \emph{4*n - 4} boundary points of this cell, -\emph{n} on each edge, where \emph{n} \textgreater{}= 2. -List the points in clockwise order starting from the cell's upper left -corner if \emph{plane} = True, or from the cell's northwest corner -if \emph{plane} = False. - -If \emph{n} = 2, then the output is the same as vertices(). -If \emph{interior} = True, then push the boundary points slighly into the -interior of the cell, which is convenient for some graphics methods. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c}\PYG{o}{.}\PYG{n}{boundary}\PYG{p}{(}\PYG{n}{n}\PYG{o}{=}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)} \PYG{o}{==} \PYG{n}{c}\PYG{o}{.}\PYG{n}{vertices}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)} -\PYG{g+go}{True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{boundary}\PYG{p}{(}\PYG{n}{n}\PYG{o}{=}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}3.14159265358979, 1.3089969389957501)} -\PYG{g+go}{(\PYGZhy{}2.87979326579064, 1.3089969389957501)} -\PYG{g+go}{(\PYGZhy{}2.61799387799149, 1.3089969389957501)} -\PYG{g+go}{(\PYGZhy{}2.61799387799149, 1.0471975511966001)} -\PYG{g+go}{(\PYGZhy{}2.61799387799149, 0.78539816339745006)} -\PYG{g+go}{(\PYGZhy{}2.87979326579064, 0.78539816339745006)} -\PYG{g+go}{(\PYGZhy{}3.14159265358979, 0.78539816339745006)} -\PYG{g+go}{(\PYGZhy{}3.14159265358979, 1.0471975511966001)} - -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{boundary}\PYG{p}{(}\PYG{n}{n}\PYG{o}{=}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}180.0, 74.35752898700072)} -\PYG{g+go}{(\PYGZhy{}157.50000000000003, 58.413661903472082)} -\PYG{g+go}{(\PYGZhy{}150.0, 41.810314895778603)} -\PYG{g+go}{(\PYGZhy{}165.00000000000003, 41.810314895778603)} -\PYG{g+go}{(\PYGZhy{}180.0, 41.810314895778603)} -\PYG{g+go}{(165.0, 41.810314895778603)} -\PYG{g+go}{(149.99999999999997, 41.810314895778603)} -\PYG{g+go}{(157.49999999999997, 58.413661903472082)} -\end{Verbatim} - -\end{fulllineitems} - -\index{centroid() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.centroid}\pysiglinewithargsret{\bfcode{centroid}}{\emph{plane=True}}{} -Return the centroid of this planar or ellipsoidal cell. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{P}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{centroid} \PYG{o}{=} \PYG{n}{c}\PYG{o}{.}\PYG{n}{centroid}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{nucleus} \PYG{o}{=} \PYG{n}{c}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{centroid} \PYG{o}{==} \PYG{n}{nucleus}\PYG{p}{)} -\PYG{g+go}{True} -\end{Verbatim} - -\end{fulllineitems} - -\index{color() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.color}\pysiglinewithargsret{\bfcode{color}}{\emph{saturation=0.5}}{} -Return a unique RGB color tuple for this cell. -Inessential graphics method. - -\end{fulllineitems} - -\index{contains() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.contains}\pysiglinewithargsret{\bfcode{contains}}{\emph{p}, \emph{plane=True}}{} -Return True if this cell contains point \emph{p}, and return False -otherwise. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}003\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}from\PYGZus{}point}\PYG{p}{(}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{p}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} -\PYG{g+go}{Q44} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{contains}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{True} -\end{Verbatim} - -\end{fulllineitems} - -\index{ellipsoidal\_shape() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.ellipsoidal_shape}\pysiglinewithargsret{\bfcode{ellipsoidal\_shape}}{}{} -Return the shape of this cell (`quad', `cap', `dart', or -`skew\_quad') when viewed on the ellipsoid. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{P}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)}\PYG{o}{.}\PYG{n}{ellipsoidal\PYGZus{}shape}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{quad} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)}\PYG{o}{.}\PYG{n}{ellipsoidal\PYGZus{}shape}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{dart} -\end{Verbatim} - -\end{fulllineitems} - -\index{index() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.index}\pysiglinewithargsret{\bfcode{index}}{\emph{order='resolution'}}{} -Return the index of \emph{self} when it's ordered according to \emph{order}. -Here \emph{order} can be `resolution' (default) or `post'. -Indices start at 0. -The empty cell has index None. - -The ordering comes from the way of traversing the tree T -of all cells defined as follows. -The root of T is a non-cell place holder. -The children of the root are the cells A \textless{} B \textless{} ... \textless{} F. -The children of a cell in T with suid s are s0 \textless{} s1 \textless{} ... \textless{} sn, -where n = self.N\_side**2. - -The level order index of a nonempty cell is its position -(starting from 0) in the level order traversal of T starting at cell A. - -The post order index of a nonempty cell is its position -(starting from 0) in the post order traversal of T. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{index}\PYG{p}{(}\PYG{n}{order}\PYG{o}{=}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{resolution}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{8} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{index}\PYG{p}{(}\PYG{n}{order}\PYG{o}{=}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{post}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{2} -\end{Verbatim} - -\end{fulllineitems} - -\index{interior() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.interior}\pysiglinewithargsret{\bfcode{interior}}{\emph{n=2}, \emph{plane=True}, \emph{flatten=False}}{} -Return an \emph{n} x \emph{n} matrix of interior points of this cell. -If the cell is planar, space the interior points on a regular -square grid. -List the points in standard, row-major matrix order. -If the cell is ellipsoidal, project the matrix of points to the -ellipsoid (longitude-latitude points). -If \emph{flatten} = True, then flatten the matrix into a one dimensional -array of pairs. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{interior}\PYG{p}{(}\PYG{n}{n}\PYG{o}{=}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{,} \PYG{n}{flatten}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(90.0, 41.810380145353903)} -\PYG{g+go}{(\PYGZhy{}180.0, 41.810380145353903)} -\PYG{g+go}{(\PYGZhy{}1e\PYGZhy{}14, 41.810380145353903)} -\PYG{g+go}{(\PYGZhy{}90.0, 41.810380145353903)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n+nb}{all}\PYG{p}{(}\PYG{p}{[}\PYG{n}{c}\PYG{o}{.}\PYG{n}{contains}\PYG{p}{(}\PYG{n}{p}\PYG{p}{)} \PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{interior}\PYG{p}{(}\PYG{n}{n}\PYG{o}{=}\PYG{l+m+mi}{5}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{,} \PYG{n}{flatten}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{True} -\end{Verbatim} - -\end{fulllineitems} - -\index{intersects\_meridian() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.intersects_meridian}\pysiglinewithargsret{\bfcode{intersects\_meridian}}{\emph{lam}}{} -Return True if this ellipsoidal cell's boundary intersects the -meridian of longitude \emph{lam}, and return False otherwise. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}003\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{intersects\PYGZus{}meridian}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{intersects\PYGZus{}meridian}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{False} -\end{Verbatim} - -\end{fulllineitems} - -\index{intersects\_parallel() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.intersects_parallel}\pysiglinewithargsret{\bfcode{intersects\_parallel}}{\emph{phi}}{} -Return True if this cell's boundary intersects the parallel of latitude -\emph{phi}, and return False otherwise. - -\end{fulllineitems} - -\index{neighbor() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.neighbor}\pysiglinewithargsret{\bfcode{neighbor}}{\emph{direction}, \emph{plane=True}}{} -Return this cell's (edge) neighbor in the given direction. -If \emph{plane} = True, then the direction is one of the strings -`up', `right', `down', `left', which indicates the desired neighbor -relative to x-y coordinates -in the following planar neighbor diagram, (drawn for self.N\_side = 3) -where \emph{self} is the middle cell - -\begin{Verbatim}[commandchars=\\\{\}] - up - *-----* - \textbar{} \textbar{} - \textbar{} \textbar{} - \textbar{} \textbar{} - *-----*-----*-----* - \textbar{} \textbar{} 012 \textbar{} \textbar{} -left \textbar{} \textbar{} 345 \textbar{} \textbar{} right - \textbar{} \textbar{} 678 \textbar{} \textbar{} - *-----*-----*-----* - \textbar{} \textbar{} - \textbar{} \textbar{} - \textbar{} \textbar{} - *-----* - down -\end{Verbatim} - -If \emph{plane} = False, then the direction is relative to -longitude-latitude coordinates and is one of the strings -`west', `east', `north', `south' for a quad or skew quad cell; -`west', `east', `southwest', `southeast' for a northern dart cell; -`west', `east', `northwest', `northeast' for a southern dart cell; -`south\_0', `south\_1', `south\_2', `south\_3' for a northern cap cell; -`north\_0', `north\_1', `north\_2', `north\_3' for a southern cap cell; -For a cap cell, neighbor directions are numbered in increasing -longitude, so that the longitude of the (nucleus of) north\_0 is less -than the longitude of north\_1 is less than the longitude of north\_2 is -less than the longitude of north\_3, and the longitude of the south\_0 is -less than the longitude of south\_1, etc. - -The tricky part in the planar scenario is that the neighbor -relationships of the six resolution 0 cells is determined by the -positions of those cells on the surface of a cube, -one cell on each face, and not on a plane. -So sometimes rotating cells is needed to compute neighbors. - -Return None if the given direction is invalid for this cell. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{neighbor}\PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{down}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{N3} -\end{Verbatim} - -\end{fulllineitems} - -\index{neighbors() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.neighbors}\pysiglinewithargsret{\bfcode{neighbors}}{\emph{plane=True}}{} -Return this cell's planar or ellipsoidal (edge) neighbors -as a dictionary whose keys are the directions of the neighbors. -See neighbor() for a list of valid directions. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{k}\PYG{p}{,} \PYG{n}{v} \PYG{o+ow}{in} \PYG{n+nb}{sorted}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{neighbors}\PYG{p}{(}\PYG{p}{)}\PYG{o}{.}\PYG{n}{items}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{k}\PYG{p}{,} \PYG{n}{v}\PYG{p}{)} -\PYG{g+gp}{... } -\PYG{g+go}{down N3} -\PYG{g+go}{left R0} -\PYG{g+go}{right N1} -\PYG{g+go}{up Q2} -\end{Verbatim} - -\end{fulllineitems} - -\index{nucleus() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.nucleus}\pysiglinewithargsret{\bfcode{nucleus}}{\emph{plane=True}}{} -Return the nucleus and vertices of this planar or ellipsoidal cell -in the order (nucleus, upper left corner, lower left corner, -lower right corner, upper right corner) with reference to the -planar cell. -The output for ellipsoidal cells is the projection onto the ellipsoid -of the output for planar cells. In particular, while the -nucleus of a planar cell is its centroid, the nucleus -of an ellipsoidal cell is not its centroid. -To compute the centroid of a cell, use centroid() below. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}2.35619449019234, 1.5707963267949001)} -\end{Verbatim} - -\end{fulllineitems} - -\index{nw\_vertex() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.nw_vertex}\pysiglinewithargsret{\bfcode{nw\_vertex}}{\emph{plane=True}}{} -If \emph{plane} = False, then return the northwest vertex of this -ellipsoidal cell. -If \emph{plane} = True, then return the projection onto the plane -of the ellipsoidal northwest vertex. -On quad cells and cap cells, this function returns the same output -as ul\_vertex(). -On skew quad cells and dart cells, this function returns output -different from ul\_vertex(). - -WARNING: The northwest vertex of a cell might not lie in the cell, -because not all cells contain their boundary. -\begin{description} -\item[{EXAMPLES::}] \leavevmode -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{P}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{5}\PYG{p}{,} \PYG{l+m+mi}{7}\PYG{p}{]}\PYG{p}{)} \PYG{c}{\PYGZsh{} Quad cell.} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}2225148.7007489, \PYGZhy{}556287.17518722452)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nw\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}2225148.7007489, \PYGZhy{}556287.17518722452)} -\end{Verbatim} - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{S}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{4}\PYG{p}{]}\PYG{p}{)} \PYG{c}{\PYGZsh{} Cap cell.} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}16688615.255616743, \PYGZhy{}8344307.6278083706)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nw\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}16688615.255616743, \PYGZhy{}8344307.6278083706)} -\end{Verbatim} - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{4}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{]}\PYG{p}{)} \PYG{c}{\PYGZsh{} Skew quad cell.} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}16688615.255616743, 10569456.32855727)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nw\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}15576040.905242294, 10569456.32855727)} -\end{Verbatim} - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{S}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{4}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{]}\PYG{p}{)} \PYG{c}{\PYGZsh{} Skew quad cell.} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}16688615.255616743, \PYGZhy{}9456881.9781828206)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nw\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}16688615.255616743, \PYGZhy{}10569456.32855727)} -\end{Verbatim} - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)} \PYG{c}{\PYGZsh{} Dart cell.} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}17801189.605991192, 8344307.6278083716)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nw\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}16688615.255616743, 8344307.6278083716)} -\end{Verbatim} - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{S}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)} \PYG{c}{\PYGZsh{} Dart cell.} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}17801189.605991192, \PYGZhy{}11682030.678931719)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nw\PYGZus{}vertex}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}16688615.255616743, \PYGZhy{}12794605.029306168)} -\end{Verbatim} - -\end{description} - -\end{fulllineitems} - -\index{predecessor() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.predecessor}\pysiglinewithargsret{\bfcode{predecessor}}{\emph{resolution=None}}{} -Return the greatest resolution \emph{resolution} cell less than \emph{self}. -Note: \emph{self} need not be a resolution \emph{resolution} cell. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{8}\PYG{p}{)}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{predecessor}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{N07} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{predecessor}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{None} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{predecessor}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{None} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{predecessor}\PYG{p}{(}\PYG{l+m+mi}{3}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{N088} -\end{Verbatim} - -\end{fulllineitems} - -\index{random\_point() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.random_point}\pysiglinewithargsret{\bfcode{random\_point}}{\emph{plane=True}}{} -Return a random point in this cell. -If \emph{plane} = True, then choose the point from -the planar cell. -Otherwise, choose the point from the ellipsoidal cell. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{random\PYGZus{}point}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(1.4840291937583836, 0.90042819146088571)} -\end{Verbatim} - -\end{fulllineitems} - -\index{region() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.region}\pysiglinewithargsret{\bfcode{region}}{}{} -Return the region of this cell: `equatorial', `north\_polar', or -`south\_polar'. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{P}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)}\PYG{o}{.}\PYG{n}{region}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{equatorial} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)}\PYG{o}{.}\PYG{n}{region}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{north\PYGZus{}polar} -\end{Verbatim} - -\end{fulllineitems} - -\index{rotate() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.rotate}\pysiglinewithargsret{\bfcode{rotate}}{\emph{quarter\_turns}}{} -Return the cell that is the result of rotating this cell's -resolution 0 supercell by \emph{quarter\_turns} quarter turns anticlockwise. -Used in neighbor(). - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{rotate}\PYG{p}{(}\PYG{n}{t}\PYG{p}{)}\PYG{p}{)} \PYG{k}{for} \PYG{n}{t} \PYG{o+ow}{in} \PYG{n+nb}{range}\PYG{p}{(}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{[\PYGZsq{}N0\PYGZsq{}, \PYGZsq{}N2\PYGZsq{}, \PYGZsq{}N8\PYGZsq{}, \PYGZsq{}N6\PYGZsq{}]} -\end{Verbatim} - -\end{fulllineitems} - -\index{rotate\_entry() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.rotate_entry}\pysiglinewithargsret{\bfcode{rotate\_entry}}{\emph{x}, \emph{quarter\_turns}}{} -Let N = self.N\_side and rotate the N x N matrix of subcell numbers - -\begin{Verbatim}[commandchars=\\\{\}] -0 1 ... N - 1 -N N+1 ... 2*N - 1 -... -(N-1)*N (N-1)*N+1 ... N**2-1 -\end{Verbatim} - -anticlockwise by \emph{quarter\_turns} quarter turns to obtain a -new table with entries f(0), f(1), ..., f(N**2 - 1) read from -left to right and top to bottom. -Given entry number \emph{x} in the original matrix, return \emph{f(x)}. -Used in rotate(). - -INPUT: -\begin{itemize} -\item {} -\emph{x} - A letter from RHEALPixDGGS.cells0 or one of the integers -0, 1, ..., N**2 - 1. - -\item {} -\emph{quarter\_turns} - 0, 1, 2, or 3. - -\end{itemize} - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{P}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n}{c}\PYG{o}{.}\PYG{n}{rotate\PYGZus{}entry}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{t}\PYG{p}{)} \PYG{k}{for} \PYG{n}{t} \PYG{o+ow}{in} \PYG{n+nb}{range}\PYG{p}{(}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{[0, 2, 8, 6]} -\end{Verbatim} - -NOTES: - -Operates on letters from RHEALPixDGGS.cells0 too. -They stay fixed under f. -Only depends on \emph{self} through \emph{self.N\_side}. - -\end{fulllineitems} - -\index{subcell() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.subcell}\pysiglinewithargsret{\bfcode{subcell}}{\emph{other}}{} -Subcell (subset) relation on cells. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{a} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{)}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{b} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{a}\PYG{o}{.}\PYG{n}{subcell}\PYG{p}{(}\PYG{n}{b}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{b}\PYG{o}{.}\PYG{n}{subcell}\PYG{p}{(}\PYG{n}{a}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{False} -\end{Verbatim} - -\end{fulllineitems} - -\index{subcells() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.subcells}\pysiglinewithargsret{\bfcode{subcells}}{\emph{resolution=None}}{} -Generator function for the set of all resolution \emph{resolution} subcells -of this cell. -If \emph{resolution=None}, then return a generator function for the children -of this cell. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{subcells}\PYG{p}{(}\PYG{p}{)}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{[\PYGZsq{}N0\PYGZsq{}, \PYGZsq{}N1\PYGZsq{}, \PYGZsq{}N2\PYGZsq{}, \PYGZsq{}N3\PYGZsq{}, \PYGZsq{}N4\PYGZsq{}, \PYGZsq{}N5\PYGZsq{}, \PYGZsq{}N6\PYGZsq{}, \PYGZsq{}N7\PYGZsq{}, \PYGZsq{}N8\PYGZsq{}]} -\end{Verbatim} - -\end{fulllineitems} - -\index{successor() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.successor}\pysiglinewithargsret{\bfcode{successor}}{\emph{resolution=None}}{} -Return the least resolution \emph{resolution} cell greater than \emph{self}. -Note: \emph{self} need not be a resolution \emph{resolution} cell. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{8}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{)}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{successor}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{N83} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{successor}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{O} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{successor}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{O0} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{successor}\PYG{p}{(}\PYG{l+m+mi}{3}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{N830} -\end{Verbatim} - -\end{fulllineitems} - -\index{suid\_from\_index() (rhealpix\_dggs.dggs.Cell static method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.suid_from_index}\pysiglinewithargsret{\strong{static }\bfcode{suid\_from\_index}}{\emph{rdggs}, \emph{index}, \emph{order='resolution'}}{} -Return the suid of a cell from its index. -The index is according to the cell ordering \emph{order}, -which can be `resolution' (default) or `post'. -See the \emph{index()} docstring for more details on orderings. -For internal use. - -\end{fulllineitems} - -\index{suid\_rowcol() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.suid_rowcol}\pysiglinewithargsret{\bfcode{suid\_rowcol}}{}{} -Return the pair of row- and column-suids of \emph{self}, each as tuples. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{rdggs}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{7}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rsuid}\PYG{p}{,} \PYG{n}{csuid} \PYG{o}{=} \PYG{n}{c}\PYG{o}{.}\PYG{n}{suid\PYGZus{}rowcol}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rsuid} \PYG{o}{==} \PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{csuid} \PYG{o}{==} \PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{True} -\end{Verbatim} - -\end{fulllineitems} - -\index{ul\_vertex() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.ul_vertex}\pysiglinewithargsret{\bfcode{ul\_vertex}}{\emph{plane=True}}{} -If \emph{plane} = True, then return the upper left vertex of this -planar cell. -If \emph{plane} = False, then return the projection onto the ellipsoid -of the planar upper left vertex. -Note that for polar cells, this projection is not necessarily the -northwest vertex. -For the latter vertex use nw\_vertex(). - -WARNING: The upper left vertex of a cell might not lie in the cell, -because not all cells contain their boundary. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{UNIT\PYGZus{}003}\PYG{p}{,} \PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{o}{.}\PYG{n}{ul\PYGZus{}vertex}\PYG{p}{(}\PYG{p}{)} \PYG{o}{==} \PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{True} -\end{Verbatim} - -\end{fulllineitems} - -\index{vertices() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.vertices}\pysiglinewithargsret{\bfcode{vertices}}{\emph{plane=True}, \emph{trim\_dart=False}}{} -If \emph{plane} = True, then assume this cell is planar and return -its four vertices in the order (upper left corner, upper right corner, -lower right corner, lower left corner). -If \emph{plane} = False, then assume this cell is ellipsoidal and return -the projection of the planar vertices in the order -(northwest, northeast, southeast, southwest). -If \emph{plane} = False, this cell is a dart cell, and -\emph{trim\_dart} = True, then remove the one non-vertex point from -the output. (Dart cells only have three vertices.) - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{vertices}\PYG{p}{(}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}3.14159265358979, 2.35619449019234)} -\PYG{g+go}{(\PYGZhy{}1.5707963267949001, 2.35619449019234)} -\PYG{g+go}{(\PYGZhy{}1.5707963267949001, 0.78539816339745006)} -\PYG{g+go}{(\PYGZhy{}3.14159265358979, 0.78539816339745006)} - -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{vertices}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(89.999999999999929, 74.39069094879062)} -\PYG{g+go}{(119.99999999999999, 41.87385774220941)} -\PYG{g+go}{(90.0, 41.87385774220941)} -\PYG{g+go}{(60.000000000000007, 41.87385774220941)} - -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{vertices}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{,} \PYG{n}{trim\PYGZus{}dart}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(89.999999999999929, 74.39069094879062)} -\PYG{g+go}{(119.99999999999999, 41.87385774220941)} -\PYG{g+go}{(60.000000000000007, 41.87385774220941)} - -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{S}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{vertices}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(149.99999999999997, \PYGZhy{}41.87385774220941)} -\PYG{g+go}{(\PYGZhy{}180.0, \PYGZhy{}41.87385774220941)} -\PYG{g+go}{(\PYGZhy{}150.0, \PYGZhy{}41.87385774220941)} -\PYG{g+go}{(\PYGZhy{}180.0, \PYGZhy{}74.390690948790649)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{p} \PYG{o+ow}{in} \PYG{n}{c}\PYG{o}{.}\PYG{n}{vertices}\PYG{p}{(}\PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{,} \PYG{n}{trim\PYGZus{}dart}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(149.99999999999997, \PYGZhy{}41.87385774220941)} -\PYG{g+go}{(\PYGZhy{}150.0, \PYGZhy{}41.87385774220941)} -\PYG{g+go}{(\PYGZhy{}180.0, \PYGZhy{}74.390690948790649)} -\end{Verbatim} - -\end{fulllineitems} - -\index{width() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.width}\pysiglinewithargsret{\bfcode{width}}{\emph{plane=True}}{} -Return the width of this cell. -If \emph{plane} = False, then return None, because ellipsoidal cells -don't have a fixed width. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{Cell}\PYG{p}{(}\PYG{n}{UNIT\PYGZus{}003}\PYG{p}{,} \PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{8}\PYG{p}{)}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} -\PYG{g+go}{N8} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c}\PYG{o}{.}\PYG{n}{width}\PYG{p}{(}\PYG{p}{)} \PYG{o}{==} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{o}{*}\PYG{l+m+mi}{3}\PYG{o}{*}\PYG{o}{*}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mi}{1}\PYG{p}{)} -\PYG{g+go}{True} -\end{Verbatim} - -\end{fulllineitems} - -\index{xy\_range() (rhealpix\_dggs.dggs.Cell method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.Cell.xy_range}\pysiglinewithargsret{\bfcode{xy\_range}}{}{} -Return the x- and y-coordinate extremes of the planar version of -this cell in the format ((x\_min, x\_max), (y\_min, y\_max)). - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c}\PYG{o}{.}\PYG{n}{xy\PYGZus{}range}\PYG{p}{(}\PYG{p}{)} \PYG{o}{==} \PYG{p}{(}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)}\PYG{p}{,} \PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{True} -\end{Verbatim} - -\end{fulllineitems} - - -\end{fulllineitems} - -\index{RHEALPixDGGS (class in rhealpix\_dggs.dggs)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS}\pysiglinewithargsret{\strong{class }\code{rhealpix\_dggs.dggs.}\bfcode{RHEALPixDGGS}}{\emph{ellipsoid=\textless{}rhealpix\_dggs.ellipsoids.Ellipsoid object at 0x10356e590\textgreater{}}, \emph{N\_side=3}, \emph{north\_square=0}, \emph{south\_square=0}, \emph{max\_areal\_resolution=1}}{} -Bases: \code{builtins.object} - -Represents an rHEALPix DGGS on a given ellipsoid. - -CLASS ATTRIBUTES: -\begin{itemize} -\item {} -\emph{cells0} - A list of the resolution 0 cell IDs (strings). - -\end{itemize} - -INSTANCE ATTRIBUTES: -\begin{itemize} -\item {} -\emph{ellipsoid} - The underlying ellipsoid (Ellipsoid instance). - -\item {} -\emph{N\_side} - An integer of size at least 2. -Each planar cell has N\_side x N\_side child cells. - -\item {} -\emph{(north\_square, south\_square)} - Integers between 0 and 3 indicating -the positions of north polar and south polar squares, respectively, -of the rHEALPix projection used. - -\item {} -\emph{max\_areal\_resolution} - An area measured in square meters that -upper bounds the area of the smallest ellipsoidal grid cells. - -\item {} -\emph{max\_resolution} - A nonnegative integer that is the maximum grid -resolution needed to have ellipsoidal cells of area at most -\emph{max\_areal\_resolution}. - -\item {} -\emph{child\_order} - A dictionary of the ordering (Morton order) of child -cells of a cell in terms of the row-column coordinates in the matrix -of child cells. Child cell are numbered 0 to \emph{N\_side**2 -1} from -left to right and top to bottom. - -\item {} -\emph{ul\_vertex} - A dictionary with key-value pairs (c, (x, y)), where -c is an element of \emph{cells0} and (x, y) is the upper left corner point -of the resolution 0 planar cell c. - -\item {} -\emph{atomic\_neighbors} - A dictionary with key-value pairs -(n, \{`up': a, `down': b, `left': c, `right': d\}), -where n, a, b, c, and d are elements of \emph{cells0} or -\{0, 1, ..., \emph{N\_side**2 -1}\}. -Describes the planar (edge) neighbors of cell0 letter / child cell number -n. - -\end{itemize} - -NOTE: - -Several RHEALPixDGGS methods have the keyword argument `plane'. -Setting it to True indicates that all input and output points and cells are -interpreted as lying in the planar DGGS. -Setting it to False indicates that they are interpreted as lying in -the ellipsoidal DGGS. -\index{cell() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cell}\pysiglinewithargsret{\bfcode{cell}}{\emph{suid=None}, \emph{level\_order\_index=None}, \emph{post\_order\_index=None}}{} -Return a cell (Cell instance) of this DGGS either from its ID or -from its resolution and index. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{4}\PYG{p}{,} \PYG{l+m+mi}{5}\PYG{p}{)}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n+nb}{isinstance}\PYG{p}{(}\PYG{n}{c}\PYG{p}{,} \PYG{n}{Cell}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} -\PYG{g+go}{N45} -\end{Verbatim} - -\end{fulllineitems} - -\index{cell\_area() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cell_area}\pysiglinewithargsret{\bfcode{cell\_area}}{\emph{resolution}, \emph{plane=True}}{} -Return the area of a planar or ellipsoidal cell at the given -resolution. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{a} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}area}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{a} \PYG{o}{==} \PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{6}\PYG{p}{)}\PYG{o}{*}\PYG{o}{*}\PYG{l+m+mi}{2}\PYG{p}{)} -\PYG{g+go}{True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}area}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} \PYG{o}{==} \PYG{l+m+mi}{8}\PYG{o}{/}\PYG{p}{(}\PYG{l+m+mi}{3}\PYG{o}{*}\PYG{n}{pi}\PYG{p}{)}\PYG{o}{*}\PYG{n}{a}\PYG{p}{)} -\PYG{g+go}{True} -\end{Verbatim} - -\end{fulllineitems} - -\index{cell\_from\_point() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cell_from_point}\pysiglinewithargsret{\bfcode{cell\_from\_point}}{\emph{resolution}, \emph{p}, \emph{plane=True}}{} -Return the resolution \emph{resolution} cell that contains the point \emph{p}. -If \emph{plane} = True, then \emph{p} and the output cell lie in the -planar DGGS. -Otherwise, \emph{p} and the output cell lie in the ellipsoidal DGGS. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}from\PYGZus{}point}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{p}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} -\PYG{g+go}{Q3} -\end{Verbatim} - -\end{fulllineitems} - -\index{cell\_from\_region() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cell_from_region}\pysiglinewithargsret{\bfcode{cell\_from\_region}}{\emph{ul}, \emph{dr}, \emph{plane=True}}{} -Return the smallest planar or ellipsoidal cell wholly containing -the region bounded by the axis-aligned rectangle with upper left -and lower right vertices given by the the points \emph{ul} and \emph{dr}, -respectively. -If such as cell does not exist, then return None. -If \emph{plane} = True, then \emph{ul} and \emph{dr} and the returned cell -lie in the planar DGGS. -Otherwise, \emph{ul} and \emph{dr} and the returned cell lie in the ellipsoidal -DGGS. - -To specify an ellipsoidal cap region, set \emph{ul} = (-pi, pi/2) and -\emph{dr} = (-pi, phi) for a northern cap from latitudes pi/2 to phi, or -set \emph{ul} = (-pi, phi) and \emph{dr} = (-pi, -pi/2) for a southern cap from -latitudes phi to -pi/2. -(As usual, if \emph{self.ellipsoid.radians} = False, -then use degrees instead of radians when specifying ul and dr.) - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{12}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{q} \PYG{o}{=} \PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{6} \PYG{o}{\PYGZhy{}} \PYG{l+m+mf}{1e\PYGZhy{}6}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}from\PYGZus{}region}\PYG{p}{(}\PYG{n}{p}\PYG{p}{,} \PYG{n}{q}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} -\PYG{g+go}{Q3} -\end{Verbatim} - -\end{fulllineitems} - -\index{cell\_latitudes() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cell_latitudes}\pysiglinewithargsret{\bfcode{cell\_latitudes}}{\emph{resolution}, \emph{phi\_min}, \emph{phi\_max}, \emph{nucleus=True}, \emph{plane=True}}{} -Return a list of every latitude phi whose parallel intersects -a resolution \emph{resolution} cell nucleus and satisfies -\emph{phi\_min} \textless{} phi \textless{} \emph{phi\_max}. -If \emph{plane} = True, then use rHEALPix y-coordinates for \emph{phi\_min}, -\emph{phi\_max}, and the result. Return the list in increasing order. -If \emph{nucleus} = False, then return a list of every latitude phi whose -parallel intersects the north or south boundary of a resolution -\emph{resolution} cell and that satisfies \emph{phi\_min} \textless{} phi \textless{} \emph{phi\_max}. - -NOTE: - -By convention, the pole latitudes pi/2 and -pi/2 (or their -corresponding rHEALPix y-coordinates) will be excluded. - -There are 2*self.N\_side**resolution - 1 nuclei -latitudes between the poles if self.N\_side is odd and -2*self.N\_side**resolution if self.N\_side is even. -Consequently, there are 2*self.N\_side**resolution -boundary latitudes between the poles if self.N\_side is odd and -2*self.N\_side**resolution - 1 boundary latitudes if self.N\_side is -even. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}003\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{phi} \PYG{o+ow}{in} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}latitudes}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{phi}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{\PYGZhy{}1.020505844} -\PYG{g+go}{\PYGZhy{}0.461443149003} -\PYG{g+go}{\PYGZhy{}0} -\PYG{g+go}{0.461443149003} -\PYG{g+go}{1.020505844} -\PYG{g+go}{1.57079632679} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{phi} \PYG{o+ow}{in} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}latitudes}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{nucleus}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{phi}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{\PYGZhy{}1.29836248989} -\PYG{g+go}{\PYGZhy{}0.730836688113} -\PYG{g+go}{\PYGZhy{}0.224577156195} -\PYG{g+go}{0.224577156195} -\PYG{g+go}{0.730836688113} -\PYG{g+go}{1.29836248989} -\end{Verbatim} - -\end{fulllineitems} - -\index{cell\_width() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cell_width}\pysiglinewithargsret{\bfcode{cell\_width}}{\emph{resolution}, \emph{plane=True}}{} -Return the width of a planar cell at the given resolution. -If \emph{plane} = False, then return None, -because the ellipsoidal cells don't have constant width. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}width}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{)} \PYG{o}{==} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)} -\PYG{g+go}{True} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell\PYGZus{}width}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{)} \PYG{o}{==} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{6}\PYG{p}{)} -\PYG{g+go}{True} -\end{Verbatim} - -\end{fulllineitems} - -\index{cells0 (rhealpix\_dggs.dggs.RHEALPixDGGS attribute)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cells0}\pysigline{\bfcode{cells0}\strong{ = {[}'N', `O', `P', `Q', `R', `S'{]}}} -\end{fulllineitems} - -\index{cells\_from\_meridian() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cells_from_meridian}\pysiglinewithargsret{\bfcode{cells\_from\_meridian}}{\emph{resolution}, \emph{lam}, \emph{phi\_min}, \emph{phi\_max}}{} -Return a list of the resolution \emph{resolution} cells that intersect -the meridian segment of longitude \emph{lam} whose least latitude is -\emph{phi\_min} and whose greatest latitude is \emph{phi\_max}. -Sort the cells from north to south and west to east in case -two cells with the same nucleus latitude intersect the -meridian. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}003\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{cells} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}meridian}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{l+m+mf}{0.1}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{cells}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{[\PYGZsq{}N4\PYGZsq{}, \PYGZsq{}N2\PYGZsq{}, \PYGZsq{}N1\PYGZsq{}, \PYGZsq{}Q0\PYGZsq{}, \PYGZsq{}Q3\PYGZsq{}, \PYGZsq{}Q6\PYGZsq{}, \PYGZsq{}S8\PYGZsq{}, \PYGZsq{}S7\PYGZsq{}, \PYGZsq{}S4\PYGZsq{}]} -\end{Verbatim} - -\end{fulllineitems} - -\index{cells\_from\_parallel() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cells_from_parallel}\pysiglinewithargsret{\bfcode{cells\_from\_parallel}}{\emph{resolution}, \emph{phi}, \emph{lam\_min}, \emph{lam\_max}}{} -Return a list of the resolution \emph{resolution} cells that intersect -the parallel segment of latitude \emph{phi} whose least longitude is -\emph{lam\_min} and whose greatest longitude is \emph{lam\_max}. -Sort the list from west to east. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}003\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{cells} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}parallel}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{p}{,} \PYG{n}{pi}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{cells}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{[\PYGZsq{}N6\PYGZsq{}, \PYGZsq{}N7\PYGZsq{}, \PYGZsq{}N8\PYGZsq{}, \PYGZsq{}N5\PYGZsq{}, \PYGZsq{}N2\PYGZsq{}, \PYGZsq{}N1\PYGZsq{}, \PYGZsq{}N0\PYGZsq{}, \PYGZsq{}N3\PYGZsq{}]} -\end{Verbatim} - -\end{fulllineitems} - -\index{cells\_from\_region() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.cells_from_region}\pysiglinewithargsret{\bfcode{cells\_from\_region}}{\emph{resolution}, \emph{ul}, \emph{dr}, \emph{plane=True}}{} -If \emph{plane} = True, then return a list of lists of resolution -\emph{resolution} cells that cover the axis-aligned rectangle whose -upper left and lower right vertices are the points \emph{ul} and \emph{dr}, -respectively. -In the output, sort each sublist of cells from left to right (in the -planar DGGS) and sort the sublists from top to bottom. - -If \emph{plane} = False, then return a list of lists of resolution -\emph{resolution} -cells that cover the longitude-latitude aligned ellipsoidal quadrangle -whose northwest and southeast vertices are the points \emph{ul} and \emph{dr}, -respectively. Defunct quads with \emph{ul} = (stuff, pi/2) or -\emph{dr} = (stuff, -pi/2) also work -(and rely on the fact that the north and south pole can both -be specified by infinitely many longitudes). - -To specify an ellipsoidal cap region, set \emph{ul} = (-pi, pi/2) and -\emph{dr} = (-pi, phi) for a northern cap from latitudes pi/2 to phi, or -set \emph{ul} = (-pi, phi) and \emph{dr} = (-pi, -pi/2) for a southern cap from -latitudes phi to -pi/2. (As usual, if \emph{self.ellipsoid.radians} = False, -then use degrees instead of radians when specifying ul and dr.) - -In the output, sort each sublist of cells from west to east (in the -ellipsoidal DGGS) and sort the sublists from north to south. - -Return the empty list if if \emph{ul{[}0{]} \textgreater{} dr{[}0{]}} or \emph{ul{[}1{]} \textless{} dr{[}1{]}}. - -NOTE: - -If \emph{plane} = True, then the resulting list is a matrix, that is, -each sublist has the same length. This is not necessarily so if -\emph{plane} = False; see the examples below. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}003\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{R\PYGZus{}A} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{ellipsoid}\PYG{o}{.}\PYG{n}{R\PYGZus{}A} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{ul} \PYG{o}{=} \PYG{n}{R\PYGZus{}A}\PYG{o}{*}\PYG{n}{array}\PYG{p}{(}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{l+m+mf}{0.1}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{dr} \PYG{o}{=} \PYG{n}{R\PYGZus{}A}\PYG{o}{*}\PYG{n}{array}\PYG{p}{(}\PYG{p}{(}\PYG{l+m+mf}{0.1}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{)}\PYG{p}{)} \PYG{c}{\PYGZsh{} Rectangle } -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{M} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}region}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{ul}\PYG{p}{,} \PYG{n}{dr}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{row} \PYG{o+ow}{in} \PYG{n}{M}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{[\PYGZsq{}P2\PYGZsq{}, \PYGZsq{}Q0\PYGZsq{}]} -\PYG{g+go}{[\PYGZsq{}P5\PYGZsq{}, \PYGZsq{}Q3\PYGZsq{}]} -\PYG{g+go}{[\PYGZsq{}P8\PYGZsq{}, \PYGZsq{}Q6\PYGZsq{}]} - -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{ul} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{dr} \PYG{o}{=} \PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)} \PYG{c}{\PYGZsh{} Quad } -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{M} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}region}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{ul}\PYG{p}{,} \PYG{n}{dr}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{row} \PYG{o+ow}{in} \PYG{n}{M}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{[\PYGZsq{}N2\PYGZsq{}, \PYGZsq{}N1\PYGZsq{}, \PYGZsq{}N0\PYGZsq{}]} -\PYG{g+go}{[\PYGZsq{}Q0\PYGZsq{}, \PYGZsq{}Q1\PYGZsq{}, \PYGZsq{}Q2\PYGZsq{}, \PYGZsq{}R0\PYGZsq{}]} -\PYG{g+go}{[\PYGZsq{}Q3\PYGZsq{}, \PYGZsq{}Q4\PYGZsq{}, \PYGZsq{}Q5\PYGZsq{}, \PYGZsq{}R3\PYGZsq{}]} - -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{ul} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{6}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{dr} \PYG{o}{=} \PYG{p}{(}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)} \PYG{c}{\PYGZsh{} Defunct quad / lune segment } -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{M} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}region}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{ul}\PYG{p}{,} \PYG{n}{dr}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{row} \PYG{o+ow}{in} \PYG{n}{M}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{[\PYGZsq{}Q6\PYGZsq{}, \PYGZsq{}Q7\PYGZsq{}, \PYGZsq{}Q8\PYGZsq{}, \PYGZsq{}R6\PYGZsq{}]} -\PYG{g+go}{[\PYGZsq{}S8\PYGZsq{}, \PYGZsq{}S7\PYGZsq{}, \PYGZsq{}S6\PYGZsq{}]} -\PYG{g+go}{[\PYGZsq{}S4\PYGZsq{}]} - -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{ul} \PYG{o}{=} \PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{5}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{dr} \PYG{o}{=} \PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{p}{,} \PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)} \PYG{c}{\PYGZsh{} Cap} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{M} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cells\PYGZus{}from\PYGZus{}region}\PYG{p}{(}\PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{ul}\PYG{p}{,} \PYG{n}{dr}\PYG{p}{,} \PYG{n}{plane}\PYG{o}{=}\PYG{n+nb+bp}{False}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{row} \PYG{o+ow}{in} \PYG{n}{M}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{cell}\PYG{p}{)} \PYG{k}{for} \PYG{n}{cell} \PYG{o+ow}{in} \PYG{n}{row}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{[\PYGZsq{}O6\PYGZsq{}, \PYGZsq{}O7\PYGZsq{}, \PYGZsq{}O8\PYGZsq{}, \PYGZsq{}P6\PYGZsq{}, \PYGZsq{}P7\PYGZsq{}, \PYGZsq{}P8\PYGZsq{}, \PYGZsq{}Q6\PYGZsq{}, \PYGZsq{}Q7\PYGZsq{}, \PYGZsq{}Q8\PYGZsq{}, \PYGZsq{}R6\PYGZsq{}, \PYGZsq{}R7\PYGZsq{}, \PYGZsq{}R8\PYGZsq{}]} -\PYG{g+go}{[\PYGZsq{}S0\PYGZsq{}, \PYGZsq{}S1\PYGZsq{}, \PYGZsq{}S2\PYGZsq{}, \PYGZsq{}S5\PYGZsq{}, \PYGZsq{}S8\PYGZsq{}, \PYGZsq{}S7\PYGZsq{}, \PYGZsq{}S6\PYGZsq{}, \PYGZsq{}S3\PYGZsq{}]} -\PYG{g+go}{[\PYGZsq{}S4\PYGZsq{}]} -\end{Verbatim} - -\end{fulllineitems} - -\index{combine\_triangles() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.combine_triangles}\pysiglinewithargsret{\bfcode{combine\_triangles}}{\emph{u}, \emph{v}, \emph{inverse=False}}{} -Return the combine\_triangles() transformation of the point \emph{(u, v)} -(or its inverse if \emph{inverse} = True) appropriate to the underlying -ellipsoid. -It maps the HEALPix projection to the rHEALPix projection. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{p} \PYG{o}{=} \PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{q} \PYG{o}{=} \PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{combine\PYGZus{}triangles}\PYG{p}{(}\PYG{o}{*}\PYG{n}{p}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.0, 0.0)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{combine\PYGZus{}triangles}\PYG{p}{(}\PYG{o}{*}\PYG{n}{q}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}2.35619449019234, 1.5707963267949001)} -\end{Verbatim} - -\end{fulllineitems} - -\index{grid() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.grid}\pysiglinewithargsret{\bfcode{grid}}{\emph{resolution}}{} -Generator function for all the cells at resolution \emph{resolution}. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{grid0} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{grid}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{x}\PYG{p}{)} \PYG{k}{for} \PYG{n}{x} \PYG{o+ow}{in} \PYG{n}{grid0}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{[\PYGZsq{}N\PYGZsq{}, \PYGZsq{}O\PYGZsq{}, \PYGZsq{}P\PYGZsq{}, \PYGZsq{}Q\PYGZsq{}, \PYGZsq{}R\PYGZsq{}, \PYGZsq{}S\PYGZsq{}]} -\end{Verbatim} - -\end{fulllineitems} - -\index{healpix() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.healpix}\pysiglinewithargsret{\bfcode{healpix}}{\emph{u}, \emph{v}, \emph{inverse=False}}{} -Return the HEALPix projection of point \emph{(u, v)} (or its inverse if -\emph{inverse} = True) appropriate to this rHEALPix DGGS. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{healpix}\PYG{p}{(}\PYG{o}{\PYGZhy{}}\PYG{n}{pi}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{2}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}2.35619449019234, 1.5707963267949001)} -\end{Verbatim} - -NOTE: - -Uses \code{pj\_healpix} instead of the PROJ.4 version of HEALPix. - -\end{fulllineitems} - -\index{interval() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.interval}\pysiglinewithargsret{\bfcode{interval}}{\emph{a}, \emph{b}}{} -Generator function for all the resolution -\emph{max(a.resolution, b.resolution)} cells between cell -\emph{a} and cell \emph{b} (inclusive and with respect to the -postorder ordering on cells). -Note that \emph{a} and \emph{b} don't have to lie at the same resolution. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{a} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{)}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{b} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,}\PYG{p}{)}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} \PYG{k}{for} \PYG{n}{c} \PYG{o+ow}{in} \PYG{n+nb}{list}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{interval}\PYG{p}{(}\PYG{n}{a}\PYG{p}{,} \PYG{n}{b}\PYG{p}{)}\PYG{p}{)}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{[\PYGZsq{}N1\PYGZsq{}, \PYGZsq{}N2\PYGZsq{}, \PYGZsq{}N3\PYGZsq{}, \PYGZsq{}N4\PYGZsq{}, \PYGZsq{}N5\PYGZsq{}, \PYGZsq{}N6\PYGZsq{}, \PYGZsq{}N7\PYGZsq{}, \PYGZsq{}N8\PYGZsq{}]} -\end{Verbatim} - -\end{fulllineitems} - -\index{minimal\_cover() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.minimal_cover}\pysiglinewithargsret{\bfcode{minimal\_cover}}{\emph{resolution}, \emph{points}, \emph{plane=True}}{} -Find the minimal set of resolution \emph{resolution} cells that covers -the list of points \emph{points}. -If \emph{plane} = True, then assume \emph{points} is a list of x-y -coordinates in the planar DGGS. -If \emph{plane} = False, then assume \emph{points} is a list of -longitude-latitude coordinates in the ellipsoidal DGGS. -This method will be made redundant by standard GIS rasterization -tools that implement the rHEALPix projection. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c1} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c2} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{P}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{7}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{points} \PYG{o}{=} \PYG{p}{[}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{p}{)} \PYG{k}{for} \PYG{n}{c} \PYG{o+ow}{in} \PYG{p}{[}\PYG{n}{c1}\PYG{p}{,} \PYG{n}{c2}\PYG{p}{]}\PYG{p}{]} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{for} \PYG{n}{r} \PYG{o+ow}{in} \PYG{n+nb}{range}\PYG{p}{(}\PYG{l+m+mi}{5}\PYG{p}{)}\PYG{p}{:} -\PYG{g+gp}{... } \PYG{n}{cover} \PYG{o}{=} \PYG{n+nb}{sorted}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{minimal\PYGZus{}cover}\PYG{p}{(}\PYG{n}{r}\PYG{p}{,} \PYG{n}{points}\PYG{p}{)}\PYG{p}{)} -\PYG{g+gp}{... } \PYG{k}{print}\PYG{p}{(}\PYG{p}{[}\PYG{n+nb}{str}\PYG{p}{(}\PYG{n}{c}\PYG{p}{)} \PYG{k}{for} \PYG{n}{c} \PYG{o+ow}{in} \PYG{n}{cover}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{[\PYGZsq{}N\PYGZsq{}, \PYGZsq{}P\PYGZsq{}]} -\PYG{g+go}{[\PYGZsq{}N0\PYGZsq{}, \PYGZsq{}P7\PYGZsq{}]} -\PYG{g+go}{[\PYGZsq{}N02\PYGZsq{}, \PYGZsq{}P73\PYGZsq{}]} -\PYG{g+go}{[\PYGZsq{}N021\PYGZsq{}, \PYGZsq{}P733\PYGZsq{}]} -\PYG{g+go}{[\PYGZsq{}N0214\PYGZsq{}, \PYGZsq{}P7334\PYGZsq{}]} -\end{Verbatim} - -\end{fulllineitems} - -\index{num\_cells() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.num_cells}\pysiglinewithargsret{\bfcode{num\_cells}}{\emph{res\_1}, \emph{res\_2=None}, \emph{subcells=False}}{} -Return the number of cells of resolutions \emph{res\_1} to \emph{res\_2} -(inclusive). -Assume \emph{res\_1 \textless{}= res\_2}. -If \emph{subcells} = True, then return the number of subcells at resolutions -\emph{res\_1} to \emph{res\_2} (inclusive) of a cell at resolution \emph{res\_1}. -If \emph{res\_2=None} and \emph{subcells=False, then return the number of -cells at resolution {}`res\_1}. -If \emph{res\_2=None} and \emph{subcells} = True, then return the number of -subcells from resolution \emph{res\_1} to resolution \emph{self.max\_resolution}. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{num\PYGZus{}cells}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{)} -\PYG{g+go}{6} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{num\PYGZus{}cells}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{)} -\PYG{g+go}{60} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{num\PYGZus{}cells}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{subcells}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)} -\PYG{g+go}{231627523606480} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{num\PYGZus{}cells}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{1}\PYG{p}{,} \PYG{n}{subcells}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)} -\PYG{g+go}{10} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{num\PYGZus{}cells}\PYG{p}{(}\PYG{l+m+mi}{5}\PYG{p}{,} \PYG{l+m+mi}{6}\PYG{p}{,} \PYG{n}{subcells}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)} -\PYG{g+go}{10} -\end{Verbatim} - -\end{fulllineitems} - -\index{plot\_cells() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.plot_cells}\pysiglinewithargsret{\bfcode{plot\_cells}}{\emph{cells}, \emph{surface='plane'}, \emph{label=True}, \emph{fontsize=15}, \emph{saturation=0.5}}{} -Plot the given list of cells on the given surface. -The cells should all come from the same rHEALPix DGGS. -Inessential graphics method. -Requires Sage graphics methods. - -INPUT: -\begin{itemize} -\item {} -\emph{cells} - A list of cells from a common rHEALPix DGGS. - -\item {} -\emph{surface} - (Optional; default = `plane'). -One of the strings `plane', `plane\_lonlat', `cube', or `ellipsoid'. -Surface to draw cells on. - -\item {} -\emph{label} - (Optional; default = True). If True, then label cells -with their names. If False, then don't. - -\item {} -\emph{saturation} - (Optional) Number between 0 and 1 indicating the -saturation value of the cell color. - -\end{itemize} - -\end{fulllineitems} - -\index{random\_cell() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.random_cell}\pysiglinewithargsret{\bfcode{random\_cell}}{\emph{resolution=None}}{} -Return a cell of the given resolution chosen uniformly at random -from all cells at that resolution. -If \emph{resolution=None}, then the cell resolution is first chosen -uniformly at random from {[}0,..,self.max\_resolution{]}. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)}\PYG{o}{.}\PYG{n}{random\PYGZus{}cell}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{S480586367780080} -\end{Verbatim} - -\end{fulllineitems} - -\index{random\_point() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.random_point}\pysiglinewithargsret{\bfcode{random\_point}}{\emph{plane=True}}{} -Return a point in this DGGS sampled uniformly at -random from the plane or from the ellipsoid. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{E}\PYG{o}{.}\PYG{n}{random\PYGZus{}point}\PYG{p}{(}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}1.0999574573422948, 0.21029104897701129)} -\end{Verbatim} - -\end{fulllineitems} - -\index{rhealpix() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.rhealpix}\pysiglinewithargsret{\bfcode{rhealpix}}{\emph{u}, \emph{v}, \emph{inverse=False}}{} -Return the rHEALPix projection of the point \emph{(u, v)} (or its inverse if -\emph{inverse} = True) appropriate to this rHEALPix DGGS. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{rhealpix}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{3}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(\PYGZhy{}1.8582720066839999, 2.0687188103032401)} -\end{Verbatim} - -NOTE: - -Uses \code{pj\_rhealpix} instead of the PROJ.4 version of rHEALPix. - -\end{fulllineitems} - -\index{triangle() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.triangle}\pysiglinewithargsret{\bfcode{triangle}}{\emph{x}, \emph{y}, \emph{inverse=True}}{} -If \emph{inverse} = False, then assume \emph{(x,y)} lies in the image of the -HEALPix projection that comes with this DGGS, and -return the number of the HEALPix polar triangle (0, 1, 2, 3, or None) -and the region (`north\_polar', `south\_polar', or `equatorial') that -\emph{(x, y)} lies in. -If \emph{inverse} = True, then assume \emph{(x, y)} lies in the image of -the rHEALPix projection that comes with this DGGS, map \emph{(x, y)} -to its HEALPix image (x', y'), and return the number of the HEALPix -polar triangle and the region that (x', y') lies in. -If \emph{(x, y)} lies in the equatorial region, then the triangle number -returned is None. - -OUTPUT: - -The pair (triangle\_number, region). - -NOTES: - -This is a wrapper for pjr.triangle(). - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{RHEALPixDGGS}\PYG{p}{(}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{7}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{triangle}\PYG{p}{(}\PYG{o}{*}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0, \PYGZsq{}north\PYGZus{}polar\PYGZsq{})} - -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{N}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{triangle}\PYG{p}{(}\PYG{o}{*}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(3, \PYGZsq{}north\PYGZus{}polar\PYGZsq{})} - -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{P}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{3}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{triangle}\PYG{p}{(}\PYG{o}{*}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(None, \PYGZsq{}equatorial\PYGZsq{})} - -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{c} \PYG{o}{=} \PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{cell}\PYG{p}{(}\PYG{p}{[}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{S}\PYG{l+s}{\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{5}\PYG{p}{,} \PYG{l+m+mi}{2}\PYG{p}{]}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{triangle}\PYG{p}{(}\PYG{o}{*}\PYG{n}{c}\PYG{o}{.}\PYG{n}{nucleus}\PYG{p}{(}\PYG{p}{)}\PYG{p}{,} \PYG{n}{inverse}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(1, \PYGZsq{}south\PYGZus{}polar\PYGZsq{})} -\end{Verbatim} - -\end{fulllineitems} - -\index{xyz() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.xyz}\pysiglinewithargsret{\bfcode{xyz}}{\emph{u}, \emph{v}, \emph{lonlat=False}}{} -Given a point \emph{(u, v)} in the planar image of the rHEALPix projection, -project it back to the ellipsoid and return its 3D rectangular -coordinates. -If \emph{lonlat} = True, then assume \emph{(u, v)} is a longitude-latitude -point. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{xyz}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{4}\PYG{p}{,} \PYG{n}{lonlat}\PYG{o}{=}\PYG{n+nb+bp}{True}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.70710678118655002, 0.0, 0.70710678118655002)} -\end{Verbatim} - -\end{fulllineitems} - -\index{xyz\_cube() (rhealpix\_dggs.dggs.RHEALPixDGGS method)} - -\begin{fulllineitems} -\phantomsection\label{dggs:rhealpix_dggs.dggs.RHEALPixDGGS.xyz_cube}\pysiglinewithargsret{\bfcode{xyz\_cube}}{\emph{u}, \emph{v}, \emph{lonlat=False}}{} -Given a point \emph{(u, v)} in the planar version of this rHEALPix DGGS, -fold the rHEALPix image into a cube centered at the origin, -and return the resulting point's 3D rectangular coordinates. -If \emph{lonlat} = True, then assume \emph{(u, v)} is a longitude-latitude -point. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{rdggs} \PYG{o}{=} \PYG{n}{UNIT\PYGZus{}003} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{rdggs}\PYG{o}{.}\PYG{n}{xyz\PYGZus{}cube}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{14}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(0.78539816339745006, 0.0, \PYGZhy{}0.78539816339745006)} -\end{Verbatim} - -\end{fulllineitems} - - -\end{fulllineitems} - - - -\chapter{The distortion Module} -\label{distortion:module-rhealpix_dggs.distortion}\label{distortion::doc}\label{distortion:the-distortion-module}\index{rhealpix\_dggs.distortion (module)} -This Python 3.3 module computes linear and areal distortion statistics of -map projections. -It is used for analysis only and so is not essential to manipulating -the rHEALPix discrete global grid system. - -CHANGELOG: -\begin{itemize} -\item {} -Alexander Raichev (AR), 2012-10-01: Initial version. - -\item {} -AR, 2013-01-21: Wasn't working in degrees mode. Fixed that bug. - -\item {} -AR, 2013-07-23: Ported to Python 3.3. - -\end{itemize} -\index{distortion() (in module rhealpix\_dggs.distortion)} - -\begin{fulllineitems} -\phantomsection\label{distortion:rhealpix_dggs.distortion.distortion}\pysiglinewithargsret{\code{rhealpix\_dggs.distortion.}\bfcode{distortion}}{\emph{T}, \emph{lam}, \emph{phi}}{} -Return ((x, y), mad, ld, ad) -Here \emph{(x, y) = T(lam, phi)}, the image under the map projection \emph{T} -(an projection\_tools.Proj or projection\_tools.Proj4 instance) -of the longitude-latitude point \emph{(lam, phi)}; -mad = maximum angular distortion at (x, y) = 2*arcsin((A - B)/(A + B)) -ld = linear distortion at (x, y) = A/B; -ad = areal distortion at (x, y) = AB; -A and B are the major and minor radii, respectively, of the Tissot ellipse -at (x, y). - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.projection\PYGZus{}wrapper} \PYG{k+kn}{import} \PYG{n}{Proj} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.ellipsoids} \PYG{k+kn}{import} \PYG{n}{WGS84\PYGZus{}ELLIPSOID\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{f} \PYG{o}{=} \PYG{n}{Proj}\PYG{p}{(}\PYG{n}{ellipsoid}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}ELLIPSOID\PYGZus{}RADIANS}\PYG{p}{,} \PYG{n}{proj}\PYG{o}{=}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{healpix}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{distortion}\PYG{p}{(}\PYG{n}{f}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{6}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{((0.0, 3748655.1150495014), 0.121755482930707, 1.1295629172526771, 1.1780969100283301)} -\end{Verbatim} - -\end{fulllineitems} - -\index{distortion\_stats() (in module rhealpix\_dggs.distortion)} - -\begin{fulllineitems} -\phantomsection\label{distortion:rhealpix_dggs.distortion.distortion_stats}\pysiglinewithargsret{\code{rhealpix\_dggs.distortion.}\bfcode{distortion\_stats}}{\emph{T}, \emph{sample}, \emph{my\_round\_numbers=3}}{} -Return the sample minimum, sample maximum, sample median, sample mean, -and sample standard deviation of the maximum angular distortion, linear -distortion, and area distortion functions -for the map projection \emph{T} -(an projection\_tools.Proj or projection\_tools.Proj4 instance) -of the list \emph{sample} of longitude-latitude -points chosen from the surface \emph{T.ellipsoid}. -Most likely you will want sample to comprise points sampled uniformly -at random from the surface of \emph{T.ellipsoid} (and not simply sampled -uniformly at random from the rectangle (-pi, pi) x (-pi/2, pi/2)). - -OUTPUT: - -(distortions, stats), where -distortions is a list of distortion() outputs for each longitude- -latitude point sampled; -stats is the list of lists {[}maximum angular distortion stats, -linear distortion stats, area distortion stats{]}, where each stats sublist -is of the form {[}sample mean, sample standard deviation, sample minimum, -sample maximum, sample median{]}. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.projection\PYGZus{}wrapper} \PYG{k+kn}{import} \PYG{n}{Proj} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.ellipsoids} \PYG{k+kn}{import} \PYG{n}{WGS84\PYGZus{}ELLIPSOID\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{E} \PYG{o}{=} \PYG{n}{WGS84\PYGZus{}ELLIPSOID\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{f} \PYG{o}{=} \PYG{n}{Proj}\PYG{p}{(}\PYG{n}{ellipsoid}\PYG{o}{=}\PYG{n}{E}\PYG{p}{,} \PYG{n}{proj}\PYG{o}{=}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{healpix}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{sample} \PYG{o}{=} \PYG{p}{[}\PYG{n}{E}\PYG{o}{.}\PYG{n}{random\PYGZus{}point}\PYG{p}{(}\PYG{p}{)} \PYG{k}{for} \PYG{n}{i} \PYG{o+ow}{in} \PYG{n+nb}{range}\PYG{p}{(}\PYG{l+m+mi}{100}\PYG{p}{)}\PYG{p}{]} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{distortion\PYGZus{}stats}\PYG{p}{(}\PYG{n}{f}\PYG{p}{,} \PYG{n}{sample}\PYG{p}{)}\PYG{p}{[}\PYG{l+m+mi}{1}\PYG{p}{]}\PYG{p}{)} -\PYG{g+go}{[[0.309, 0.238, 0.001, 0.838, 0.178], [1.41, 0.375, 1.001, 2.372, 1.195], [1.178, 0.0, 1.178, 1.178, 1.178]]} -\end{Verbatim} - -\end{fulllineitems} - -\index{fff\_coeffs() (in module rhealpix\_dggs.distortion)} - -\begin{fulllineitems} -\phantomsection\label{distortion:rhealpix_dggs.distortion.fff_coeffs}\pysiglinewithargsret{\code{rhealpix\_dggs.distortion.}\bfcode{fff\_coeffs}}{\emph{T}, \emph{lam}, \emph{phi}}{} -Return numerical approximations of the \href{http://en.wikipedia.org/wiki/First\_fundamental\_form}{first fundamental form} coefficients -E, F, and G (in that order) of map projection \emph{T} -(an projection\_tools.Proj or projection\_tools.Proj4 instance) at longitude \emph{lam} and -latitude \emph{phi}. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.projection\PYGZus{}wrapper} \PYG{k+kn}{import} \PYG{n}{Proj} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.ellipsoids} \PYG{k+kn}{import} \PYG{n}{WGS84\PYGZus{}ELLIPSOID\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{f} \PYG{o}{=} \PYG{n}{Proj}\PYG{p}{(}\PYG{n}{ellipsoid}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}ELLIPSOID\PYGZus{}RADIANS}\PYG{p}{,} \PYG{n}{proj}\PYG{o}{=}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{healpix}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{fff\PYGZus{}coeffs}\PYG{p}{(}\PYG{n}{f}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{6}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(40635288880650.484, 0.0, 42251277118793.328)} -\end{Verbatim} - -\end{fulllineitems} - -\index{scale\_factors() (in module rhealpix\_dggs.distortion)} - -\begin{fulllineitems} -\phantomsection\label{distortion:rhealpix_dggs.distortion.scale_factors}\pysiglinewithargsret{\code{rhealpix\_dggs.distortion.}\bfcode{scale\_factors}}{\emph{T}, \emph{lam}, \emph{phi}}{} -Return numerical approximations of the local scale factors s\_M, s\_P, and -s\_A of the map projection \emph{T} -(an projection\_tools.Proj or projection\_tools.Proj4 instance) -at longitude \emph{lam} and latitude \emph{phi}, where -s\_M is the local linear scale along meridians, -s\_P is the local linear scale along parallels, and -s\_A is the local area scale. -Also return theta (in radians), the angle between the vectors (delxdellam, delydellam) -and (delxdelphi, delydelphi). - -OUTPUT: - -(s\_M, s\_P, s\_A, theta) - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.projection\PYGZus{}wrapper} \PYG{k+kn}{import} \PYG{n}{Proj} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k+kn}{from} \PYG{n+nn}{rhealpix\PYGZus{}dggs.ellipsoids} \PYG{k+kn}{import} \PYG{n}{WGS84\PYGZus{}ELLIPSOID\PYGZus{}RADIANS} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{f} \PYG{o}{=} \PYG{n}{Proj}\PYG{p}{(}\PYG{n}{ellipsoid}\PYG{o}{=}\PYG{n}{WGS84\PYGZus{}ELLIPSOID\PYGZus{}RADIANS}\PYG{p}{,} \PYG{n}{proj}\PYG{o}{=}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{healpix}\PYG{l+s}{\PYGZsq{}}\PYG{p}{)} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{my\PYGZus{}round}\PYG{p}{(}\PYG{n}{scale\PYGZus{}factors}\PYG{p}{(}\PYG{n}{f}\PYG{p}{,} \PYG{l+m+mi}{0}\PYG{p}{,} \PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{6}\PYG{p}{)}\PYG{p}{,} \PYG{l+m+mi}{15}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{(1.0212575853790069, 1.1535746974071359, 1.1780969100283301, 1.5707963267948959)} -\end{Verbatim} - -\end{fulllineitems} - -\index{utm\_zone() (in module rhealpix\_dggs.distortion)} - -\begin{fulllineitems} -\phantomsection\label{distortion:rhealpix_dggs.distortion.utm_zone}\pysiglinewithargsret{\code{rhealpix\_dggs.distortion.}\bfcode{utm\_zone}}{\emph{lam}, \emph{phi}}{} -Return the Universal Transverse Mercator zone and hemisphere for longitude -\emph{lam} and latitude \emph{phi} given in radians. -Based on the WGS84 ellipsoid. -Return None if \emph{phi} is out of bounds, that is, if \emph{phi} is greater than -84 degrees or less than 80 degrees. - -EXAMPLES: - -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{utm\PYGZus{}zone}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{84}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{180}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{31} -\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{k}{print}\PYG{p}{(}\PYG{n}{utm\PYGZus{}zone}\PYG{p}{(}\PYG{l+m+mi}{0}\PYG{p}{,} \PYG{l+m+mi}{85}\PYG{o}{*}\PYG{n}{pi}\PYG{o}{/}\PYG{l+m+mi}{180}\PYG{p}{)}\PYG{p}{)} -\PYG{g+go}{None} -\end{Verbatim} - -\end{fulllineitems} - - - -\chapter{Indices and tables} -\label{index:indices-and-tables}\begin{itemize} -\item {} -\emph{genindex} - -\item {} -\emph{modindex} - -\item {} -\emph{search} - -\end{itemize} - -\begin{thebibliography}{CaRo2007} -\bibitem[GRS2013]{GRS2013}{\phantomsection\label{introduction:grs2013} -Robert Gibb, Alexander Raichev, Michael Speth, \href{http://code.scenzgrid.org/index.php/p/scenzgrid-py/source/tree/master/rHEALPixDGGS-0.5/docs/rhealpix\_dggs\_preprint.pdf}{The rHEALPix discrete global grid system}, in preparation, 2013. -} -\bibitem[CaRo2007]{CaRo2007}{\phantomsection\label{pj_healpix:caro2007} -Mark R. Calabretta and Boudewijn F. Roukema, Mapping on the healpix grid, Monthly Notices of the Royal Astronomical Society 381 (2007), no. 2, 865--872. -} -\end{thebibliography} - - -\renewcommand{\indexname}{Python Module Index} -\begin{theindex} -\def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}} -\bigletter{r} -\item {\texttt{rhealpix\_dggs.dggs}}, \pageref{dggs:module-rhealpix_dggs.dggs} -\item {\texttt{rhealpix\_dggs.distortion}}, \pageref{distortion:module-rhealpix_dggs.distortion} -\item {\texttt{rhealpix\_dggs.ellipsoids}}, \pageref{ellipsoids:module-rhealpix_dggs.ellipsoids} -\item {\texttt{rhealpix\_dggs.pj\_healpix}}, \pageref{pj_healpix:module-rhealpix_dggs.pj_healpix} -\item {\texttt{rhealpix\_dggs.pj\_rhealpix}}, \pageref{pj_rhealpix:module-rhealpix_dggs.pj_rhealpix} -\item {\texttt{rhealpix\_dggs.projection\_wrapper}}, \pageref{projection_wrapper:module-rhealpix_dggs.projection_wrapper} -\item {\texttt{rhealpix\_dggs.utils}}, \pageref{utils:module-rhealpix_dggs.utils} -\end{theindex} - -\renewcommand{\indexname}{Index} -\printindex -\end{document} diff --git a/docs/build/sphinx.sty b/docs/build/sphinx.sty deleted file mode 100644 index 08adec9..0000000 --- a/docs/build/sphinx.sty +++ /dev/null @@ -1,478 +0,0 @@ -% -% sphinx.sty -% -% Adapted from the old python.sty, mostly written by Fred Drake, -% by Georg Brandl. -% - -\NeedsTeXFormat{LaTeX2e}[1995/12/01] -\ProvidesPackage{sphinx}[2010/01/15 LaTeX package (Sphinx markup)] - -\RequirePackage{textcomp} -\RequirePackage{fancyhdr} -\RequirePackage{fancybox} -\RequirePackage{titlesec} -\RequirePackage{tabulary} -\RequirePackage{amsmath} % for \text -\RequirePackage{makeidx} -\RequirePackage{framed} -\RequirePackage{ifthen} -\RequirePackage{color} -% For highlighted code. -\RequirePackage{fancyvrb} -% For table captions. -\RequirePackage{threeparttable} -% Handle footnotes in tables. -\RequirePackage{footnote} -\makesavenoteenv{tabulary} -% For floating figures in the text. -\RequirePackage{wrapfig} -% Separate paragraphs by space by default. -\RequirePackage{parskip} - -% Redefine these colors to your liking in the preamble. -\definecolor{TitleColor}{rgb}{0.126,0.263,0.361} -\definecolor{InnerLinkColor}{rgb}{0.208,0.374,0.486} -\definecolor{OuterLinkColor}{rgb}{0.216,0.439,0.388} -% Redefine these colors to something not white if you want to have colored -% background and border for code examples. -\definecolor{VerbatimColor}{rgb}{1,1,1} -\definecolor{VerbatimBorderColor}{rgb}{1,1,1} - -% Uncomment these two lines to ignore the paper size and make the page -% size more like a typical published manual. -%\renewcommand{\paperheight}{9in} -%\renewcommand{\paperwidth}{8.5in} % typical squarish manual -%\renewcommand{\paperwidth}{7in} % O'Reilly ``Programmming Python'' - -% For graphicx, check if we are compiling under latex or pdflatex. -\ifx\pdftexversion\undefined - \usepackage{graphicx} -\else - \usepackage[pdftex]{graphicx} -\fi - -% for PDF output, use colors and maximal compression -\newif\ifsphinxpdfoutput\sphinxpdfoutputfalse -\ifx\pdfoutput\undefined\else\ifcase\pdfoutput - \let\py@NormalColor\relax - \let\py@TitleColor\relax -\else - \sphinxpdfoutputtrue - \input{pdfcolor} - \def\py@NormalColor{\color[rgb]{0.0,0.0,0.0}} - \def\py@TitleColor{\color{TitleColor}} - \pdfcompresslevel=9 -\fi\fi - -% XeLaTeX can do colors, too -\ifx\XeTeXrevision\undefined\else - \def\py@NormalColor{\color[rgb]{0.0,0.0,0.0}} - \def\py@TitleColor{\color{TitleColor}} -\fi - -% Increase printable page size (copied from fullpage.sty) -\topmargin 0pt -\advance \topmargin by -\headheight -\advance \topmargin by -\headsep - -% attempt to work a little better for A4 users -\textheight \paperheight -\advance\textheight by -2in - -\oddsidemargin 0pt -\evensidemargin 0pt -%\evensidemargin -.25in % for ``manual size'' documents -\marginparwidth 0.5in - -\textwidth \paperwidth -\advance\textwidth by -2in - - -% Style parameters and macros used by most documents here -\raggedbottom -\sloppy -\hbadness = 5000 % don't print trivial gripes - -\pagestyle{empty} % start this way; change for -\pagenumbering{roman} % ToC & chapters - -% Use this to set the font family for headers and other decor: -\newcommand{\py@HeaderFamily}{\sffamily\bfseries} - -% Redefine the 'normal' header/footer style when using "fancyhdr" package: -\@ifundefined{fancyhf}{}{ - % Use \pagestyle{normal} as the primary pagestyle for text. - \fancypagestyle{normal}{ - \fancyhf{} - \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}} - \fancyfoot[LO]{{\py@HeaderFamily\nouppercase{\rightmark}}} - \fancyfoot[RE]{{\py@HeaderFamily\nouppercase{\leftmark}}} - \fancyhead[LE,RO]{{\py@HeaderFamily \@title, \py@release}} - \renewcommand{\headrulewidth}{0.4pt} - \renewcommand{\footrulewidth}{0.4pt} - } - % Update the plain style so we get the page number & footer line, - % but not a chapter or section title. This is to keep the first - % page of a chapter and the blank page between chapters `clean.' - \fancypagestyle{plain}{ - \fancyhf{} - \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}} - \renewcommand{\headrulewidth}{0pt} - \renewcommand{\footrulewidth}{0.4pt} - } -} - -% Some custom font markup commands. -% -\newcommand{\strong}[1]{{\bf #1}} -\newcommand{\code}[1]{\texttt{#1}} -\newcommand{\bfcode}[1]{\code{\bfseries#1}} -\newcommand{\email}[1]{\textsf{#1}} - -% Redefine the Verbatim environment to allow border and background colors. -% The original environment is still used for verbatims within tables. -\let\OriginalVerbatim=\Verbatim -\let\endOriginalVerbatim=\endVerbatim - -% Play with vspace to be able to keep the indentation. -\newlength\distancetoright -\def\mycolorbox#1{% - \setlength\distancetoright{\linewidth}% - \advance\distancetoright -\@totalleftmargin % - \fcolorbox{VerbatimBorderColor}{VerbatimColor}{% - \begin{minipage}{\distancetoright}% - #1 - \end{minipage}% - }% -} -\def\FrameCommand{\mycolorbox} - -\renewcommand{\Verbatim}[1][1]{% - % list starts new par, but we don't want it to be set apart vertically - \bgroup\parskip=0pt% - \smallskip% - % The list environement is needed to control perfectly the vertical - % space. - \list{}{% - \setlength\parskip{0pt}% - \setlength\itemsep{0ex}% - \setlength\topsep{0ex}% - \setlength\partopsep{0pt}% - \setlength\leftmargin{0pt}% - }% - \item\MakeFramed {\FrameRestore}% - \small% - \OriginalVerbatim[#1]% -} -\renewcommand{\endVerbatim}{% - \endOriginalVerbatim% - \endMakeFramed% - \endlist% - % close group to restore \parskip - \egroup% -} - - -% \moduleauthor{name}{email} -\newcommand{\moduleauthor}[2]{} - -% \sectionauthor{name}{email} -\newcommand{\sectionauthor}[2]{} - -% Augment the sectioning commands used to get our own font family in place, -% and reset some internal data items: -\titleformat{\section}{\Large\py@HeaderFamily}% - {\py@TitleColor\thesection}{0.5em}{\py@TitleColor}{\py@NormalColor} -\titleformat{\subsection}{\large\py@HeaderFamily}% - {\py@TitleColor\thesubsection}{0.5em}{\py@TitleColor}{\py@NormalColor} -\titleformat{\subsubsection}{\py@HeaderFamily}% - {\py@TitleColor\thesubsubsection}{0.5em}{\py@TitleColor}{\py@NormalColor} -\titleformat{\paragraph}{\small\py@HeaderFamily}% - {\py@TitleColor}{0em}{\py@TitleColor}{\py@NormalColor} - -% {fulllineitems} is the main environment for object descriptions. -% -\newcommand{\py@itemnewline}[1]{% - \@tempdima\linewidth% - \advance\@tempdima \leftmargin\makebox[\@tempdima][l]{#1}% -} - -\newenvironment{fulllineitems}{ - \begin{list}{}{\labelwidth \leftmargin \labelsep 0pt - \rightmargin 0pt \topsep -\parskip \partopsep \parskip - \itemsep -\parsep - \let\makelabel=\py@itemnewline} -}{\end{list}} - -% \optional is used for ``[, arg]``, i.e. desc_optional nodes. -\newcommand{\optional}[1]{% - {\textnormal{\Large[}}{#1}\hspace{0.5mm}{\textnormal{\Large]}}} - -\newlength{\py@argswidth} -\newcommand{\py@sigparams}[2]{% - \parbox[t]{\py@argswidth}{#1\code{)}#2}} -\newcommand{\pysigline}[1]{\item[#1]\nopagebreak} -\newcommand{\pysiglinewithargsret}[3]{% - \settowidth{\py@argswidth}{#1\code{(}}% - \addtolength{\py@argswidth}{-2\py@argswidth}% - \addtolength{\py@argswidth}{\linewidth}% - \item[#1\code{(}\py@sigparams{#2}{#3}]} - -% Production lists -% -\newenvironment{productionlist}{ -% \def\optional##1{{\Large[}##1{\Large]}} - \def\production##1##2{\\\code{##1}&::=&\code{##2}} - \def\productioncont##1{\\& &\code{##1}} - \parindent=2em - \indent - \begin{tabular}{lcl} -}{% - \end{tabular} -} - -% Notices / Admonitions -% -\newlength{\py@noticelength} - -\newcommand{\py@heavybox}{ - \setlength{\fboxrule}{1pt} - \setlength{\fboxsep}{6pt} - \setlength{\py@noticelength}{\linewidth} - \addtolength{\py@noticelength}{-2\fboxsep} - \addtolength{\py@noticelength}{-2\fboxrule} - %\setlength{\shadowsize}{3pt} - \Sbox - \minipage{\py@noticelength} -} -\newcommand{\py@endheavybox}{ - \endminipage - \endSbox - \fbox{\TheSbox} -} - -\newcommand{\py@lightbox}{{% - \setlength\parskip{0pt}\par - \rule[0ex]{\linewidth}{0.5pt}% - \par\vspace{-0.5ex}% - }} -\newcommand{\py@endlightbox}{{% - \setlength{\parskip}{0pt}% - \par\rule[0.5ex]{\linewidth}{0.5pt}% - \par\vspace{-0.5ex}% - }} - -% Some are quite plain: -\newcommand{\py@noticestart@note}{\py@lightbox} -\newcommand{\py@noticeend@note}{\py@endlightbox} -\newcommand{\py@noticestart@hint}{\py@lightbox} -\newcommand{\py@noticeend@hint}{\py@endlightbox} -\newcommand{\py@noticestart@important}{\py@lightbox} -\newcommand{\py@noticeend@important}{\py@endlightbox} -\newcommand{\py@noticestart@tip}{\py@lightbox} -\newcommand{\py@noticeend@tip}{\py@endlightbox} - -% Others gets more visible distinction: -\newcommand{\py@noticestart@warning}{\py@heavybox} -\newcommand{\py@noticeend@warning}{\py@endheavybox} -\newcommand{\py@noticestart@caution}{\py@heavybox} -\newcommand{\py@noticeend@caution}{\py@endheavybox} -\newcommand{\py@noticestart@attention}{\py@heavybox} -\newcommand{\py@noticeend@attention}{\py@endheavybox} -\newcommand{\py@noticestart@danger}{\py@heavybox} -\newcommand{\py@noticeend@danger}{\py@endheavybox} -\newcommand{\py@noticestart@error}{\py@heavybox} -\newcommand{\py@noticeend@error}{\py@endheavybox} - -\newenvironment{notice}[2]{ - \def\py@noticetype{#1} - \csname py@noticestart@#1\endcsname - \strong{#2} -}{\csname py@noticeend@\py@noticetype\endcsname} - -% Allow the release number to be specified independently of the -% \date{}. This allows the date to reflect the document's date and -% release to specify the release that is documented. -% -\newcommand{\py@release}{} -\newcommand{\version}{} -\newcommand{\shortversion}{} -\newcommand{\releaseinfo}{} -\newcommand{\releasename}{Release} -\newcommand{\release}[1]{% - \renewcommand{\py@release}{\releasename\space\version}% - \renewcommand{\version}{#1}} -\newcommand{\setshortversion}[1]{% - \renewcommand{\shortversion}{#1}} -\newcommand{\setreleaseinfo}[1]{% - \renewcommand{\releaseinfo}{#1}} - -% Allow specification of the author's address separately from the -% author's name. This can be used to format them differently, which -% is a good thing. -% -\newcommand{\py@authoraddress}{} -\newcommand{\authoraddress}[1]{\renewcommand{\py@authoraddress}{#1}} - -% This sets up the fancy chapter headings that make the documents look -% at least a little better than the usual LaTeX output. -% -\@ifundefined{ChTitleVar}{}{ - \ChNameVar{\raggedleft\normalsize\py@HeaderFamily} - \ChNumVar{\raggedleft \bfseries\Large\py@HeaderFamily} - \ChTitleVar{\raggedleft \rm\Huge\py@HeaderFamily} - % This creates chapter heads without the leading \vspace*{}: - \def\@makechapterhead#1{% - {\parindent \z@ \raggedright \normalfont - \ifnum \c@secnumdepth >\m@ne - \DOCH - \fi - \interlinepenalty\@M - \DOTI{#1} - } - } -} - -% Redefine description environment so that it is usable inside fulllineitems. -% -\renewcommand{\description}{% - \list{}{\labelwidth\z@% - \itemindent-\leftmargin% - \labelsep5pt% - \let\makelabel=\descriptionlabel}} - -% Definition lists; requested by AMK for HOWTO documents. Probably useful -% elsewhere as well, so keep in in the general style support. -% -\newenvironment{definitions}{% - \begin{description}% - \def\term##1{\item[##1]\mbox{}\\*[0mm]} -}{% - \end{description}% -} - -% Tell TeX about pathological hyphenation cases: -\hyphenation{Base-HTTP-Re-quest-Hand-ler} - - -% The following is stuff copied from docutils' latex writer. -% -\newcommand{\optionlistlabel}[1]{\bf #1 \hfill} -\newenvironment{optionlist}[1] -{\begin{list}{} - {\setlength{\labelwidth}{#1} - \setlength{\rightmargin}{1cm} - \setlength{\leftmargin}{\rightmargin} - \addtolength{\leftmargin}{\labelwidth} - \addtolength{\leftmargin}{\labelsep} - \renewcommand{\makelabel}{\optionlistlabel}} -}{\end{list}} - -\newlength{\lineblockindentation} -\setlength{\lineblockindentation}{2.5em} -\newenvironment{lineblock}[1] -{\begin{list}{} - {\setlength{\partopsep}{\parskip} - \addtolength{\partopsep}{\baselineskip} - \topsep0pt\itemsep0.15\baselineskip\parsep0pt - \leftmargin#1} - \raggedright} -{\end{list}} - -% Redefine includgraphics for avoiding images larger than the screen size -% If the size is not specified. -\let\py@Oldincludegraphics\includegraphics - -\newbox\image@box% -\newdimen\image@width% -\renewcommand\includegraphics[2][\@empty]{% - \ifx#1\@empty% - \setbox\image@box=\hbox{\py@Oldincludegraphics{#2}}% - \image@width\wd\image@box% - \ifdim \image@width>\linewidth% - \setbox\image@box=\hbox{\py@Oldincludegraphics[width=\linewidth]{#2}}% - \box\image@box% - \else% - \py@Oldincludegraphics{#2}% - \fi% - \else% - \py@Oldincludegraphics[#1]{#2}% - \fi% -} - - -% Fix the index environment to add an entry to the Table of -% Contents; this is much nicer than just having to jump to the end of the book -% and flip around, especially with multiple indexes. -% -% A similiar fix must be done to the bibliography environment, although -% dependant on document class. In particular, the '\addcontentsline' command -% should use 'chapter' for a report and 'section' for an article. -% See sphinxmanual.cls and sphinxhowto.cls for specific fixes. -% -\let\py@OldTheindex=\theindex -\renewcommand{\theindex}{ - \cleardoublepage - \phantomsection - \py@OldTheindex - \addcontentsline{toc}{chapter}{\indexname} -} - -% Include hyperref last. -\RequirePackage[colorlinks,breaklinks, - linkcolor=InnerLinkColor,filecolor=OuterLinkColor, - menucolor=OuterLinkColor,urlcolor=OuterLinkColor, - citecolor=InnerLinkColor]{hyperref} -% Fix anchor placement for figures with captions. -% (Note: we don't use a package option here; instead, we give an explicit -% \capstart for figures that actually have a caption.) -\RequirePackage{hypcap} - -% From docutils.writers.latex2e -\providecommand{\DUspan}[2]{% - {% group ("span") to limit the scope of styling commands - \@for\node@class@name:=#1\do{% - \ifcsname docutilsrole\node@class@name\endcsname% - \csname docutilsrole\node@class@name\endcsname% - \fi% - }% - {#2}% node content - }% close "span" -} - -\providecommand*{\DUprovidelength}[2]{ - \ifthenelse{\isundefined{#1}}{\newlength{#1}\setlength{#1}{#2}}{} -} - -\DUprovidelength{\DUlineblockindent}{2.5em} -\ifthenelse{\isundefined{\DUlineblock}}{ - \newenvironment{DUlineblock}[1]{% - \list{}{\setlength{\partopsep}{\parskip} - \addtolength{\partopsep}{\baselineskip} - \setlength{\topsep}{0pt} - \setlength{\itemsep}{0.15\baselineskip} - \setlength{\parsep}{0pt} - \setlength{\leftmargin}{#1}} - \raggedright - } - {\endlist} -}{} - - -% From footmisc.sty: allows footnotes in titles -\let\FN@sf@@footnote\footnote -\def\footnote{\ifx\protect\@typeset@protect - \expandafter\FN@sf@@footnote - \else - \expandafter\FN@sf@gobble@opt - \fi -} -\edef\FN@sf@gobble@opt{\noexpand\protect - \expandafter\noexpand\csname FN@sf@gobble@opt \endcsname} -\expandafter\def\csname FN@sf@gobble@opt \endcsname{% - \@ifnextchar[%] - \FN@sf@gobble@twobracket - \@gobble -} -\def\FN@sf@gobble@twobracket[#1]#2{} diff --git a/docs/build/sphinxhowto.cls b/docs/build/sphinxhowto.cls deleted file mode 100644 index f4e3d2f..0000000 --- a/docs/build/sphinxhowto.cls +++ /dev/null @@ -1,92 +0,0 @@ -% -% sphinxhowto.cls for Sphinx (http://sphinx.pocoo.org/) -% - -\NeedsTeXFormat{LaTeX2e}[1995/12/01] -\ProvidesClass{sphinxhowto}[2009/06/02 Document class (Sphinx HOWTO)] - -% 'oneside' option overriding the 'twoside' default -\newif\if@oneside -\DeclareOption{oneside}{\@onesidetrue} -% Pass remaining document options to the parent class. -\DeclareOption*{\PassOptionsToClass{\CurrentOption}{\sphinxdocclass}} -\ProcessOptions\relax - -% Default to two-side document -\if@oneside -% nothing to do (oneside is the default) -\else -\PassOptionsToClass{twoside}{\sphinxdocclass} -\fi - -\LoadClass{\sphinxdocclass} - -% Set some sane defaults for section numbering depth and TOC depth. You can -% reset these counters in your preamble. -% -\setcounter{secnumdepth}{2} - -% Change the title page to look a bit better, and fit in with the fncychap -% ``Bjarne'' style a bit better. -% -\renewcommand{\maketitle}{ - \rule{\textwidth}{1pt} - \ifsphinxpdfoutput - \begingroup - % These \defs are required to deal with multi-line authors; it - % changes \\ to ', ' (comma-space), making it pass muster for - % generating document info in the PDF file. - \def\\{, } - \def\and{and } - \pdfinfo{ - /Author (\@author) - /Title (\@title) - } - \endgroup - \fi - \begin{flushright} - \sphinxlogo% - {\rm\Huge\py@HeaderFamily \@title} \par - {\em\large\py@HeaderFamily \py@release\releaseinfo} \par - \vspace{25pt} - {\Large\py@HeaderFamily - \begin{tabular}[t]{c} - \@author - \end{tabular}} \par - \vspace{25pt} - \@date \par - \py@authoraddress \par - \end{flushright} - \@thanks - \setcounter{footnote}{0} - \let\thanks\relax\let\maketitle\relax - %\gdef\@thanks{}\gdef\@author{}\gdef\@title{} -} - -\let\py@OldTableofcontents=\tableofcontents -\renewcommand{\tableofcontents}{ - \begingroup - \parskip = 0mm - \py@OldTableofcontents - \endgroup - \rule{\textwidth}{1pt} - \vspace{12pt} -} - -\@ifundefined{fancyhf}{ - \pagestyle{plain}}{ - \pagestyle{normal}} % start this way; change for -\pagenumbering{arabic} % ToC & chapters - -\thispagestyle{empty} - -% Fix the bibliography environment to add an entry to the Table of -% Contents. -% For an article document class this environment is a section, -% so no page break before it. -\let\py@OldThebibliography=\thebibliography -\renewcommand{\thebibliography}[1]{ - \phantomsection - \py@OldThebibliography{1} - \addcontentsline{toc}{section}{\bibname} -} diff --git a/docs/build/sphinxmanual.cls b/docs/build/sphinxmanual.cls deleted file mode 100644 index 57fad1a..0000000 --- a/docs/build/sphinxmanual.cls +++ /dev/null @@ -1,133 +0,0 @@ -% -% sphinxmanual.cls for Sphinx (http://sphinx.pocoo.org/) -% - -\NeedsTeXFormat{LaTeX2e}[1995/12/01] -\ProvidesClass{sphinxmanual}[2009/06/02 Document class (Sphinx manual)] - -% chapters starting at odd pages (overridden by 'openany' document option) -\PassOptionsToClass{openright}{\sphinxdocclass} - -% 'oneside' option overriding the 'twoside' default -\newif\if@oneside -\DeclareOption{oneside}{\@onesidetrue} -% Pass remaining document options to the parent class. -\DeclareOption*{\PassOptionsToClass{\CurrentOption}{\sphinxdocclass}} -\ProcessOptions\relax - -% Defaults two-side document -\if@oneside -% nothing to do (oneside is the default) -\else -\PassOptionsToClass{twoside}{\sphinxdocclass} -\fi - -\LoadClass{\sphinxdocclass} - -% Set some sane defaults for section numbering depth and TOC depth. You can -% reset these counters in your preamble. -% -\setcounter{secnumdepth}{2} -\setcounter{tocdepth}{1} - -% Change the title page to look a bit better, and fit in with the fncychap -% ``Bjarne'' style a bit better. -% -\renewcommand{\maketitle}{% - \begin{titlepage}% - \let\footnotesize\small - \let\footnoterule\relax - \rule{\textwidth}{1pt}% - \ifsphinxpdfoutput - \begingroup - % These \defs are required to deal with multi-line authors; it - % changes \\ to ', ' (comma-space), making it pass muster for - % generating document info in the PDF file. - \def\\{, } - \def\and{and } - \pdfinfo{ - /Author (\@author) - /Title (\@title) - } - \endgroup - \fi - \begin{flushright}% - \sphinxlogo% - {\rm\Huge\py@HeaderFamily \@title \par}% - {\em\LARGE\py@HeaderFamily \py@release\releaseinfo \par} - \vfill - {\LARGE\py@HeaderFamily - \begin{tabular}[t]{c} - \@author - \end{tabular} - \par} - \vfill\vfill - {\large - \@date \par - \vfill - \py@authoraddress \par - }% - \end{flushright}%\par - \@thanks - \end{titlepage}% - \cleardoublepage% - \setcounter{footnote}{0}% - \let\thanks\relax\let\maketitle\relax - %\gdef\@thanks{}\gdef\@author{}\gdef\@title{} -} - - -% Catch the end of the {abstract} environment, but here make sure the abstract -% is followed by a blank page if the 'openright' option is used. -% -\let\py@OldEndAbstract=\endabstract -\renewcommand{\endabstract}{ - \if@openright - \ifodd\value{page} - \typeout{Adding blank page after the abstract.} - \vfil\pagebreak - \fi - \fi - \py@OldEndAbstract -} - -% This wraps the \tableofcontents macro with all the magic to get the spacing -% right and have the right number of pages if the 'openright' option has been -% used. This eliminates a fair amount of crud in the individual document files. -% -\let\py@OldTableofcontents=\tableofcontents -\renewcommand{\tableofcontents}{% - \setcounter{page}{1}% - \pagebreak% - \pagestyle{plain}% - {% - \parskip = 0mm% - \py@OldTableofcontents% - \if@openright% - \ifodd\value{page}% - \typeout{Adding blank page after the table of contents.}% - \pagebreak\hspace{0pt}% - \fi% - \fi% - \cleardoublepage% - }% - \pagenumbering{arabic}% - \@ifundefined{fancyhf}{}{\pagestyle{normal}}% -} - -% This is needed to get the width of the section # area wide enough in the -% library reference. Doing it here keeps it the same for all the manuals. -% -\renewcommand*\l@section{\@dottedtocline{1}{1.5em}{2.6em}} -\renewcommand*\l@subsection{\@dottedtocline{2}{4.1em}{3.5em}} - -% Fix the bibliography environment to add an entry to the Table of -% Contents. -% For a report document class this environment is a chapter. -\let\py@OldThebibliography=\thebibliography -\renewcommand{\thebibliography}[1]{ - \cleardoublepage - \phantomsection - \py@OldThebibliography{1} - \addcontentsline{toc}{chapter}{\bibname} -} diff --git a/docs/build/tabulary.sty b/docs/build/tabulary.sty deleted file mode 100644 index ba83c0a..0000000 --- a/docs/build/tabulary.sty +++ /dev/null @@ -1,452 +0,0 @@ -%% -%% This is file `tabulary.sty', -%% generated with the docstrip utility. -%% -%% The original source files were: -%% -%% tabulary.dtx (with options: `package') -%% DRAFT VERSION -%% -%% File `tabulary.dtx'. -%% Copyright (C) 1995 1996 2003 David Carlisle -%% This file may be distributed under the terms of the LPPL. -%% See 00readme.txt for details. -%% -\NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{tabulary} - [2007/10/02 v0.9 tabulary package (DPC)] -\RequirePackage{array} -\catcode`\Z=14 -\DeclareOption{debugshow}{\catcode`\Z=9\relax} -\ProcessOptions -\def\arraybackslash{\let\\=\@arraycr} -\def\@finalstrut#1{% - \unskip\ifhmode\nobreak\fi\vrule\@width\z@\@height\z@\@depth\dp#1} -\newcount\TY@count -\def\tabulary{% - \let\TY@final\tabular - \let\endTY@final\endtabular - \TY@tabular} -\def\TY@tabular#1{% - \edef\TY@{\@currenvir}% - {\ifnum0=`}\fi - \@ovxx\TY@linewidth - \@ovyy\TY@tablewidth - \count@\z@ - \@tempswatrue - \@whilesw\if@tempswa\fi{% - \advance\count@\@ne - \expandafter\ifx\csname TY@F\the\count@\endcsname\relax - \@tempswafalse - \else - \expandafter\let\csname TY@SF\the\count@\expandafter\endcsname - \csname TY@F\the\count@\endcsname - \global\expandafter\let\csname TY@F\the\count@\endcsname\relax - \expandafter\let\csname TY@S\the\count@\expandafter\endcsname - \csname TY@\the\count@\endcsname - \fi}% - \global\TY@count\@ne - \TY@width\xdef{0pt}% - \global\TY@tablewidth\z@ - \global\TY@linewidth#1\relax -Z\message{^^J^^JTable^^J% -Z Target Width: \the\TY@linewidth^^J% -Z \string\tabcolsep: \the\tabcolsep\space -Z \string\arrayrulewidth: \the\arrayrulewidth\space -Z \string\doublerulesep: \the\doublerulesep^^J% -Z \string\tymin: \the\tymin\space -Z \string\tymax: \the\tymax^^J}% - \let\@classz\TY@classz - \let\verb\TX@verb - \toks@{}\TY@get@body} -\let\TY@@mkpream\@mkpream -\def\TY@mkpream{% - \def\@addamp{% - \if@firstamp \@firstampfalse \else - \global\advance\TY@count\@ne - \edef\@preamble{\@preamble &}\fi - \TY@width\xdef{0pt}}% - \def\@acol{% - \TY@subwidth\col@sep - \@addtopreamble{\hskip\col@sep}}% - \let\@arrayrule\TY@arrayrule - \let\@classvi\TY@classvi - \def\@classv{\save@decl - \expandafter\NC@ecs\@nextchar\extracolsep{}\extracolsep\@@@ - \sbox\z@{\d@llarbegin\@nextchar\d@llarend}% - \TY@subwidth{\wd\z@}% - \@addtopreamble{\d@llarbegin\the@toks\the\count@\relax\d@llarend}% - \prepnext@tok}% - \global\let\@mkpream\TY@@mkpream - \TY@@mkpream} -\def\TY@arrayrule{% - \TY@subwidth\arrayrulewidth - \@addtopreamble \vline} -\def\TY@classvi{\ifcase \@lastchclass - \@acol \or - \TY@subwidth\doublerulesep - \@addtopreamble{\hskip \doublerulesep}\or - \@acol \or - \@classvii - \fi} -\def\TY@tab{% - \setbox\z@\hbox\bgroup - \let\[$\let\]$% - \let\equation$\let\endequation$% - \col@sep\tabcolsep - \let\d@llarbegin\begingroup\let\d@llarend\endgroup - \let\@mkpream\TY@mkpream - \def\multicolumn##1##2##3{\multispan##1\relax}% - \CT@start\TY@tabarray} -\def\TY@tabarray{\@ifnextchar[{\TY@array}{\@array[t]}} -\def\TY@array[#1]{\@array[t]} -\def\TY@width#1{% - \expandafter#1\csname TY@\the\TY@count\endcsname} -\def\TY@subwidth#1{% - \TY@width\dimen@ - \advance\dimen@-#1\relax - \TY@width\xdef{\the\dimen@}% - \global\advance\TY@linewidth-#1\relax} -\def\endtabulary{% - \gdef\@halignto{}% - \let\TY@footnote\footnote% - \def\footnote{}% prevent footnotes from doing anything - \expandafter\TY@tab\the\toks@ - \crcr\omit - {\xdef\TY@save@row{}% - \loop - \advance\TY@count\m@ne - \ifnum\TY@count>\z@ - \xdef\TY@save@row{\TY@save@row&\omit}% - \repeat}\TY@save@row - \endarray\global\setbox1=\lastbox\setbox0=\vbox{\unvbox1 - \unskip\global\setbox1=\lastbox}\egroup - \dimen@\TY@linewidth - \divide\dimen@\TY@count - \ifdim\dimen@<\tymin - \TY@warn{tymin too large (\the\tymin), resetting to \the\dimen@}% - \tymin\dimen@ - \fi - \setbox\tw@=\hbox{\unhbox\@ne - \loop -\@tempdima=\lastskip -\ifdim\@tempdima>\z@ -Z \message{ecs=\the\@tempdima^^J}% - \global\advance\TY@linewidth-\@tempdima -\fi - \unskip - \setbox\tw@=\lastbox - \ifhbox\tw@ -Z \message{Col \the\TY@count: Initial=\the\wd\tw@\space}% - \ifdim\wd\tw@>\tymax - \wd\tw@\tymax -Z \message{> max\space}% -Z \else -Z \message{ \@spaces\space}% - \fi - \TY@width\dimen@ -Z \message{\the\dimen@\space}% - \advance\dimen@\wd\tw@ -Z \message{Final=\the\dimen@\space}% - \TY@width\xdef{\the\dimen@}% - \ifdim\dimen@<\tymin -Z \message{< tymin}% - \global\advance\TY@linewidth-\dimen@ - \expandafter\xdef\csname TY@F\the\TY@count\endcsname - {\the\dimen@}% - \else - \expandafter\ifx\csname TY@F\the\TY@count\endcsname\z@ -Z \message{***}% - \global\advance\TY@linewidth-\dimen@ - \expandafter\xdef\csname TY@F\the\TY@count\endcsname - {\the\dimen@}% - \else -Z \message{> tymin}% - \global\advance\TY@tablewidth\dimen@ - \global\expandafter\let\csname TY@F\the\TY@count\endcsname - \maxdimen - \fi\fi - \advance\TY@count\m@ne - \repeat}% - \TY@checkmin - \TY@checkmin - \TY@checkmin - \TY@checkmin - \TY@count\z@ - \let\TY@box\TY@box@v - \let\footnote\TY@footnote % restore footnotes - {\expandafter\TY@final\the\toks@\endTY@final}% - \count@\z@ - \@tempswatrue - \@whilesw\if@tempswa\fi{% - \advance\count@\@ne - \expandafter\ifx\csname TY@SF\the\count@\endcsname\relax - \@tempswafalse - \else - \global\expandafter\let\csname TY@F\the\count@\expandafter\endcsname - \csname TY@SF\the\count@\endcsname - \global\expandafter\let\csname TY@\the\count@\expandafter\endcsname - \csname TY@S\the\count@\endcsname - \fi}% - \TY@linewidth\@ovxx - \TY@tablewidth\@ovyy - \ifnum0=`{\fi}} -\def\TY@checkmin{% - \let\TY@checkmin\relax -\ifdim\TY@tablewidth>\z@ - \Gscale@div\TY@ratio\TY@linewidth\TY@tablewidth - \ifdim\TY@tablewidth <\linewidth - \def\TY@ratio{1}% - \fi -\else - \TY@warn{No suitable columns!}% - \def\TY@ratio{1}% -\fi -\count@\z@ -Z \message{^^JLine Width: \the\TY@linewidth, -Z Natural Width: \the\TY@tablewidth, -Z Ratio: \TY@ratio^^J}% -\@tempdima\z@ -\loop -\ifnum\count@<\TY@count -\advance\count@\@ne - \ifdim\csname TY@F\the\count@\endcsname>\tymin - \dimen@\csname TY@\the\count@\endcsname - \dimen@\TY@ratio\dimen@ - \ifdim\dimen@<\tymin -Z \message{Column \the\count@\space ->}% - \global\expandafter\let\csname TY@F\the\count@\endcsname\tymin - \global\advance\TY@linewidth-\tymin - \global\advance\TY@tablewidth-\csname TY@\the\count@\endcsname - \let\TY@checkmin\TY@@checkmin - \else - \expandafter\xdef\csname TY@F\the\count@\endcsname{\the\dimen@}% - \advance\@tempdima\csname TY@F\the\count@\endcsname - \fi - \fi -Z \dimen@\csname TY@F\the\count@\endcsname\message{\the\dimen@, }% -\repeat -Z \message{^^JTotal:\the\@tempdima^^J}% -} -\let\TY@@checkmin\TY@checkmin -\newdimen\TY@linewidth -\def\tyformat{\everypar{{\nobreak\hskip\z@skip}}} -\newdimen\tymin -\tymin=10pt -\newdimen\tymax -\tymax=2\textwidth -\def\@testpach{\@chclass - \ifnum \@lastchclass=6 \@ne \@chnum \@ne \else - \ifnum \@lastchclass=7 5 \else - \ifnum \@lastchclass=8 \tw@ \else - \ifnum \@lastchclass=9 \thr@@ - \else \z@ - \ifnum \@lastchclass = 10 \else - \edef\@nextchar{\expandafter\string\@nextchar}% - \@chnum - \if \@nextchar c\z@ \else - \if \@nextchar l\@ne \else - \if \@nextchar r\tw@ \else - \if \@nextchar C7 \else - \if \@nextchar L8 \else - \if \@nextchar R9 \else - \if \@nextchar J10 \else - \z@ \@chclass - \if\@nextchar |\@ne \else - \if \@nextchar !6 \else - \if \@nextchar @7 \else - \if \@nextchar <8 \else - \if \@nextchar >9 \else - 10 - \@chnum - \if \@nextchar m\thr@@\else - \if \@nextchar p4 \else - \if \@nextchar b5 \else - \z@ \@chclass \z@ \@preamerr \z@ \fi \fi \fi \fi\fi \fi \fi\fi \fi - \fi \fi \fi \fi \fi \fi \fi \fi \fi \fi \fi} -\def\TY@classz{% - \@classx - \@tempcnta\count@ - \ifx\TY@box\TY@box@v - \global\advance\TY@count\@ne - \fi - \let\centering c% - \let\raggedright\noindent - \let\raggedleft\indent - \let\arraybackslash\relax - \prepnext@tok - \ifnum\@chnum<4 - \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@ - \fi - \ifnum\@chnum=6 - \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@ - \fi - \@addtopreamble{% - \ifcase\@chnum - \hfil \d@llarbegin\insert@column\d@llarend \hfil \or - \kern\z@ - \d@llarbegin \insert@column \d@llarend \hfil \or - \hfil\kern\z@ \d@llarbegin \insert@column \d@llarend \or - $\vcenter\@startpbox{\@nextchar}\insert@column \@endpbox $\or - \vtop \@startpbox{\@nextchar}\insert@column \@endpbox \or - \vbox \@startpbox{\@nextchar}\insert@column \@endpbox \or - \d@llarbegin \insert@column \d@llarend \or% dubious "s" case - \TY@box\centering\or - \TY@box\raggedright\or - \TY@box\raggedleft\or - \TY@box\relax - \fi}\prepnext@tok} -\def\TY@box#1{% - \ifx\centering#1% - \hfil \d@llarbegin\insert@column\d@llarend \hfil \else - \ifx\raggedright#1% - \kern\z@%<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< - \d@llarbegin \insert@column \d@llarend \hfil \else - \ifx\raggedleft#1% - \hfil\kern\z@ \d@llarbegin \insert@column \d@llarend \else - \ifx\relax#1% - \d@llarbegin \insert@column \d@llarend - \fi \fi \fi \fi} -\def\TY@box@v#1{% - \vtop \@startpbox{\csname TY@F\the\TY@count\endcsname}% - #1\arraybackslash\tyformat - \insert@column\@endpbox} -\newdimen\TY@tablewidth -\def\Gscale@div#1#2#3{% - \setlength\dimen@{#3}% - \ifdim\dimen@=\z@ - \PackageError{graphics}{Division by 0}\@eha - \dimen@#2% - \fi - \edef\@tempd{\the\dimen@}% - \setlength\dimen@{#2}% - \count@65536\relax - \ifdim\dimen@<\z@ - \dimen@-\dimen@ - \count@-\count@ - \fi - \loop - \ifdim\dimen@<8192\p@ - \dimen@\tw@\dimen@ - \divide\count@\tw@ - \repeat - \dimen@ii=\@tempd\relax - \divide\dimen@ii\count@ - \divide\dimen@\dimen@ii - \edef#1{\strip@pt\dimen@}} -\long\def\TY@get@body#1\end - {\toks@\expandafter{\the\toks@#1}\TY@find@end} -\def\TY@find@end#1{% - \def\@tempa{#1}% - \ifx\@tempa\TY@\def\@tempa{\end{#1}}\expandafter\@tempa - \else\toks@\expandafter - {\the\toks@\end{#1}}\expandafter\TY@get@body\fi} -\def\TY@warn{% - \PackageWarning{tabulary}} -\catcode`\Z=11 -\AtBeginDocument{ -\@ifpackageloaded{colortbl}{% -\expandafter\def\expandafter\@mkpream\expandafter#\expandafter1% - \expandafter{% - \expandafter\let\expandafter\CT@setup\expandafter\relax - \expandafter\let\expandafter\CT@color\expandafter\relax - \expandafter\let\expandafter\CT@do@color\expandafter\relax - \expandafter\let\expandafter\color\expandafter\relax - \expandafter\let\expandafter\CT@column@color\expandafter\relax - \expandafter\let\expandafter\CT@row@color\expandafter\relax - \@mkpream{#1}} -\let\TY@@mkpream\@mkpream -\def\TY@classz{% - \@classx - \@tempcnta\count@ - \ifx\TY@box\TY@box@v - \global\advance\TY@count\@ne - \fi - \let\centering c% - \let\raggedright\noindent - \let\raggedleft\indent - \let\arraybackslash\relax - \prepnext@tok -\expandafter\CT@extract\the\toks\@tempcnta\columncolor!\@nil - \ifnum\@chnum<4 - \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@ - \fi - \ifnum\@chnum=6 - \global\expandafter\let\csname TY@F\the\TY@count\endcsname\z@ - \fi - \@addtopreamble{% - \setbox\z@\hbox\bgroup\bgroup - \ifcase\@chnum - \hskip\stretch{.5}\kern\z@ - \d@llarbegin\insert@column\d@llarend\hskip\stretch{.5}\or - \kern\z@%<<<<<<<<<<<<<<<<<<<<<<<<<<< - \d@llarbegin \insert@column \d@llarend \hfill \or - \hfill\kern\z@ \d@llarbegin \insert@column \d@llarend \or - $\vcenter\@startpbox{\@nextchar}\insert@column \@endpbox $\or - \vtop \@startpbox{\@nextchar}\insert@column \@endpbox \or - \vbox \@startpbox{\@nextchar}\insert@column \@endpbox \or - \d@llarbegin \insert@column \d@llarend \or% dubious s case - \TY@box\centering\or - \TY@box\raggedright\or - \TY@box\raggedleft\or - \TY@box\relax - \fi - \egroup\egroup -\begingroup - \CT@setup - \CT@column@color - \CT@row@color - \CT@do@color -\endgroup - \@tempdima\ht\z@ - \advance\@tempdima\minrowclearance - \vrule\@height\@tempdima\@width\z@ -\unhbox\z@ -}\prepnext@tok}% - \def\TY@arrayrule{% - \TY@subwidth\arrayrulewidth - \@addtopreamble{{\CT@arc@\vline}}}% - \def\TY@classvi{\ifcase \@lastchclass - \@acol \or - \TY@subwidth\doublerulesep - \ifx\CT@drsc@\relax - \@addtopreamble{\hskip\doublerulesep}% - \else - \@addtopreamble{{\CT@drsc@\vrule\@width\doublerulesep}}% - \fi\or - \@acol \or - \@classvii - \fi}% -}{% -\let\CT@start\relax -} -} -{\uccode`\*=`\ % -\uppercase{\gdef\TX@verb{% - \leavevmode\null\TX@vwarn - {\ifnum0=`}\fi\ttfamily\let\\\ignorespaces - \@ifstar{\let~*\TX@vb}{\TX@vb}}}} -\def\TX@vb#1{\def\@tempa##1#1{\toks@{##1}\edef\@tempa{\the\toks@}% - \expandafter\TX@v\meaning\@tempa\\ \\\ifnum0=`{\fi}}\@tempa!} -\def\TX@v#1!{\afterassignment\TX@vfirst\let\@tempa= } -\begingroup -\catcode`\*=\catcode`\# -\catcode`\#=12 -\gdef\TX@vfirst{% - \if\@tempa#% - \def\@tempb{\TX@v@#}% - \else - \let\@tempb\TX@v@ - \if\@tempa\space~\else\@tempa\fi - \fi - \@tempb} -\gdef\TX@v@*1 *2{% - \TX@v@hash*1##\relax\if*2\\\else~\expandafter\TX@v@\fi*2} -\gdef\TX@v@hash*1##*2{*1\ifx*2\relax\else#\expandafter\TX@v@hash\fi*2} -\endgroup -\def\TX@vwarn{% - \@warning{\noexpand\verb may be unreliable inside tabularx/y}% - \global\let\TX@vwarn\@empty} -\endinput -%% -%% End of file `tabulary.sty'. diff --git a/docs/rHEALPixDGGS.aux b/docs/rHEALPixDGGS.aux index bd866f9..84f7090 100644 --- a/docs/rHEALPixDGGS.aux +++ b/docs/rHEALPixDGGS.aux @@ -15,9 +15,9 @@ \newlabel{introduction:using-the-distortion-module}{{}{}} \newlabel{utils::doc}{{}{}} \newlabel{utils:the-utils-module}{{}{}} -\newlabel{utils:module-rhealpix_dggs.utils}{{}{}} -\newlabel{utils:rhealpix_dggs.utils.auth_lat}{{}{}} -\newlabel{utils:rhealpix_dggs.utils.auth_rad}{{}{}} -\newlabel{utils:rhealpix_dggs.utils.my_round}{{}{}} -\newlabel{utils:rhealpix_dggs.utils.wrap_latitude}{{}{}} -\newlabel{utils:rhealpix_dggs.utils.wrap_longitude}{{}{}} +\newlabel{utils:module-rhealpixdggs.utils}{{}{}} +\newlabel{utils:rhealpixdggs.utils.auth_lat}{{}{}} +\newlabel{utils:rhealpixdggs.utils.auth_rad}{{}{}} +\newlabel{utils:rhealpixdggs.utils.my_round}{{}{}} +\newlabel{utils:rhealpixdggs.utils.wrap_latitude}{{}{}} +\newlabel{utils:rhealpixdggs.utils.wrap_longitude}{{}{}} diff --git a/docs/source/_static/_sphinx_javascript_frameworks_compat.js b/docs/source/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 0000000..8549469 --- /dev/null +++ b/docs/source/_static/_sphinx_javascript_frameworks_compat.js @@ -0,0 +1,134 @@ +/* + * _sphinx_javascript_frameworks_compat.js + * ~~~~~~~~~~ + * + * Compatability shim for jQuery and underscores.js. + * + * WILL BE REMOVED IN Sphinx 6.0 + * xref RemovedInSphinx60Warning + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} diff --git a/docs/source/_static/ajax-loader.gif b/docs/source/_static/ajax-loader.gif new file mode 100644 index 0000000..61faf8c Binary files /dev/null and b/docs/source/_static/ajax-loader.gif differ diff --git a/docs/source/_static/basic.css b/docs/source/_static/basic.css new file mode 100644 index 0000000..4e9a9f1 --- /dev/null +++ b/docs/source/_static/basic.css @@ -0,0 +1,900 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/docs/source/_static/classic.css b/docs/source/_static/classic.css new file mode 100644 index 0000000..92cac9f --- /dev/null +++ b/docs/source/_static/classic.css @@ -0,0 +1,269 @@ +/* + * classic.css_t + * ~~~~~~~~~~~~~ + * + * Sphinx stylesheet -- classic theme. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +html { + /* CSS hack for macOS's scrollbar (see #1125) */ + background-color: #FFFFFF; +} + +body { + font-family: sans-serif; + font-size: 100%; + background-color: #11303d; + color: #000; + margin: 0; + padding: 0; +} + +div.document { + display: flex; + background-color: #1c4e63; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 230px; +} + +div.body { + background-color: #ffffff; + color: #000000; + padding: 0 20px 30px 20px; +} + +div.footer { + color: #ffffff; + width: 100%; + padding: 9px 0 9px 0; + text-align: center; + font-size: 75%; +} + +div.footer a { + color: #ffffff; + text-decoration: underline; +} + +div.related { + background-color: #133f52; + line-height: 30px; + color: #ffffff; +} + +div.related a { + color: #ffffff; +} + +div.sphinxsidebar { +} + +div.sphinxsidebar h3 { + font-family: 'Trebuchet MS', sans-serif; + color: #ffffff; + font-size: 1.4em; + font-weight: normal; + margin: 0; + padding: 0; +} + +div.sphinxsidebar h3 a { + color: #ffffff; +} + +div.sphinxsidebar h4 { + font-family: 'Trebuchet MS', sans-serif; + color: #ffffff; + font-size: 1.3em; + font-weight: normal; + margin: 5px 0 0 0; + padding: 0; +} + +div.sphinxsidebar p { + color: #ffffff; +} + +div.sphinxsidebar p.topless { + margin: 5px 10px 10px 10px; +} + +div.sphinxsidebar ul { + margin: 10px; + padding: 0; + color: #ffffff; +} + +div.sphinxsidebar a { + color: #98dbcc; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + + + +/* -- hyperlink styles ------------------------------------------------------ */ + +a { + color: #355f7c; + text-decoration: none; +} + +a:visited { + color: #355f7c; + text-decoration: none; +} + +a:hover { + text-decoration: underline; +} + + + +/* -- body styles ----------------------------------------------------------- */ + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: 'Trebuchet MS', sans-serif; + background-color: #f2f2f2; + font-weight: normal; + color: #20435c; + border-bottom: 1px solid #ccc; + margin: 20px -20px 10px -20px; + padding: 3px 0 3px 10px; +} + +div.body h1 { margin-top: 0; font-size: 200%; } +div.body h2 { font-size: 160%; } +div.body h3 { font-size: 140%; } +div.body h4 { font-size: 120%; } +div.body h5 { font-size: 110%; } +div.body h6 { font-size: 100%; } + +a.headerlink { + color: #c60f0f; + font-size: 0.8em; + padding: 0 4px 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + background-color: #c60f0f; + color: white; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + text-align: justify; + line-height: 130%; +} + +div.admonition p.admonition-title + p { + display: inline; +} + +div.admonition p { + margin-bottom: 5px; +} + +div.admonition pre { + margin-bottom: 5px; +} + +div.admonition ul, div.admonition ol { + margin-bottom: 5px; +} + +div.note { + background-color: #eee; + border: 1px solid #ccc; +} + +div.seealso { + background-color: #ffc; + border: 1px solid #ff6; +} +nav.contents, +aside.topic, + +div.topic { + background-color: #eee; +} + +div.warning { + background-color: #ffe4e4; + border: 1px solid #f66; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre { + padding: 5px; + background-color: unset; + color: unset; + line-height: 120%; + border: 1px solid #ac9; + border-left: none; + border-right: none; +} + +code { + background-color: #ecf0f3; + padding: 0 1px 0 1px; + font-size: 0.95em; +} + +th, dl.field-list > dt { + background-color: #ede; +} + +.warning code { + background: #efc2c2; +} + +.note code { + background: #d6d6d6; +} + +.viewcode-back { + font-family: sans-serif; +} + +div.viewcode-block:target { + background-color: #f4debf; + border-top: 1px solid #ac9; + border-bottom: 1px solid #ac9; +} + +div.code-block-caption { + color: #efefef; + background-color: #1c4e63; +} \ No newline at end of file diff --git a/docs/source/_static/comment-bright.png b/docs/source/_static/comment-bright.png new file mode 100644 index 0000000..551517b Binary files /dev/null and b/docs/source/_static/comment-bright.png differ diff --git a/docs/source/_static/comment-close.png b/docs/source/_static/comment-close.png new file mode 100644 index 0000000..09b54be Binary files /dev/null and b/docs/source/_static/comment-close.png differ diff --git a/docs/source/_static/comment.png b/docs/source/_static/comment.png new file mode 100644 index 0000000..92feb52 Binary files /dev/null and b/docs/source/_static/comment.png differ diff --git a/docs/source/_static/default.css b/docs/source/_static/default.css new file mode 100644 index 0000000..81b9363 --- /dev/null +++ b/docs/source/_static/default.css @@ -0,0 +1 @@ +@import url("classic.css"); diff --git a/docs/source/_static/doctools.js b/docs/source/_static/doctools.js new file mode 100644 index 0000000..527b876 --- /dev/null +++ b/docs/source/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/docs/source/_static/documentation_options.js b/docs/source/_static/documentation_options.js new file mode 100644 index 0000000..e296e16 --- /dev/null +++ b/docs/source/_static/documentation_options.js @@ -0,0 +1,14 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '0.5.4', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/docs/source/_static/down-pressed.png b/docs/source/_static/down-pressed.png new file mode 100644 index 0000000..6f7ad78 Binary files /dev/null and b/docs/source/_static/down-pressed.png differ diff --git a/docs/source/_static/down.png b/docs/source/_static/down.png new file mode 100644 index 0000000..3003a88 Binary files /dev/null and b/docs/source/_static/down.png differ diff --git a/docs/source/_static/file.png b/docs/source/_static/file.png new file mode 100644 index 0000000..a858a41 Binary files /dev/null and b/docs/source/_static/file.png differ diff --git a/docs/source/_static/jquery-3.6.0.js b/docs/source/_static/jquery-3.6.0.js new file mode 100644 index 0000000..fc6c299 --- /dev/null +++ b/docs/source/_static/jquery-3.6.0.js @@ -0,0 +1,10881 @@ +/*! + * jQuery JavaScript Library v3.6.0 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright OpenJS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2021-03-02T17:08Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + // Support: QtWeb <=3.8.5, WebKit <=534.34, wkhtmltopdf tool <=0.12.5 + // Plus for old WebKit, typeof returns "function" for HTML collections + // (e.g., `typeof document.getElementsByTagName("div") === "function"`). (gh-4756) + return typeof obj === "function" && typeof obj.nodeType !== "number" && + typeof obj.item !== "function"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.6.0", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), + function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); + } ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.6 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2021-02-16 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem && elem.namespaceURI, + docElem = elem && ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +} +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the primary Deferred + primary = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + primary.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, primary.done( updateFunc( i ) ).resolve, primary.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( primary.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return primary.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), primary.reject ); + } + + return primary.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
    " ], + col: [ 2, "", "
    " ], + tr: [ 2, "", "
    " ], + td: [ 3, "", "
    " ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + + // Support: Chrome 86+ + // In Chrome, if an element having a focusout handler is blurred by + // clicking outside of it, it invokes the handler synchronously. If + // that handler calls `.remove()` on the element, the data is cleared, + // leaving `result` undefined. We need to guard against this. + return result && result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + which: true +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + // Suppress native focus or blur as it's already being fired + // in leverageNative. + _default: function() { + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + // + // Support: Firefox 70+ + // Only Firefox includes border widths + // in computed dimensions. (gh-4529) + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px;border-collapse:separate"; + tr.style.cssText = "border:1px solid"; + + // Support: Chrome 86+ + // Height set through cssText does not get applied. + // Computed height then comes back as 0. + tr.style.height = "1px"; + trChild.style.height = "9px"; + + // Support: Android 8 Chrome 86+ + // In our bodyBackground.html iframe, + // display for all div elements is set to "inline", + // which causes a problem only in Android 8 Chrome 86. + // Ensuring the div is display: block + // gets around this issue. + trChild.style.display = "block"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = ( parseInt( trStyle.height, 10 ) + + parseInt( trStyle.borderTopWidth, 10 ) + + parseInt( trStyle.borderBottomWidth, 10 ) ) === tr.offsetHeight; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( dataPriv.get( cur, "events" ) || Object.create( null ) )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml, parserErrorElem; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) {} + + parserErrorElem = xml && xml.getElementsByTagName( "parsererror" )[ 0 ]; + if ( !xml || parserErrorElem ) { + jQuery.error( "Invalid XML: " + ( + parserErrorElem ? + jQuery.map( parserErrorElem.childNodes, function( el ) { + return el.textContent; + } ).join( "\n" ) : + data + ) ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ).filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ).map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + +originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script but not if jsonp + if ( !isSuccess && + jQuery.inArray( "script", s.dataTypes ) > -1 && + jQuery.inArray( "json", s.dataTypes ) < 0 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( "