aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKristian Evers <kristianevers@gmail.com>2016-12-17 21:44:18 +0100
committerKristian Evers <kristianevers@gmail.com>2016-12-17 21:44:18 +0100
commit8793a3869c030e8c91aeca6ed901d4419a787893 (patch)
tree2ecf967e7775ef48af69bd03d9c2d107ade007b9 /docs
parent3a7852b7a4adc905aa66351f779afbed6a6bf9aa (diff)
downloadPROJ-8793a3869c030e8c91aeca6ed901d4419a787893.tar.gz
PROJ-8793a3869c030e8c91aeca6ed901d4419a787893.zip
Migrated rhealpix documentation from trac
Diffstat (limited to 'docs')
-rw-r--r--docs/source/projections/rhealpix.rst47
1 files changed, 44 insertions, 3 deletions
diff --git a/docs/source/projections/rhealpix.rst b/docs/source/projections/rhealpix.rst
index c00c5166..1701558e 100644
--- a/docs/source/projections/rhealpix.rst
+++ b/docs/source/projections/rhealpix.rst
@@ -3,8 +3,49 @@
********************************************************************************
rHEALPix
********************************************************************************
++---------------------+----------------------------------------------------------+
+| **Classification** | Mixed |
++---------------------+----------------------------------------------------------+
+| **Available forms** | Forward and inverse, spherical and elliptical projection |
++---------------------+----------------------------------------------------------+
+| **Defined area** | Global |
++---------------------+----------------------------------------------------------+
+| **Implemented by** | Alex Raichev and Michael Speth |
++---------------------+----------------------------------------------------------+
+| **Options** |
++---------------------+----------------------------------------------------------+
+| `+north_square` | Position of the north polar square. |
+| | Valid inputs are 0--3. Defaults to 0. |
++---------------------+----------------------------------------------------------+
+| `+south_square` | Position of the south polar square. |
+| | Valid inputs are 0--3. Defaults to 0. |
++---------------------+----------------------------------------------------------+
-.. image:: ./images/rhealpix.png
- :scale: 50%
- :alt: rHEALPix
+.. image:: ../../images/rhealpix.png
+ :scale: 75%
+ :alt: rHEALPix
+rHEALPix is a projection based on the HEALPix projection. The implementation of
+rHEALPix uses the HEALPix projection. The rHEALPix combines the peaks of the
+HEALPix into a square. The square's position can be translated and rotated across
+the x-axis which is a noval approach for the rHEALPix projection. The initial
+intention of using rHEALPix in the Spatial Computation Engine Science Collaboration
+Environment (SCENZGrid).
+
+Usage
+###############################################################################
+
+To run a rHEALPix projection on a WGS84 ellipsoidal model, use the following
+command::
+
+ proj +proj=rhealpix -f '%.2f' +ellps=WGS84 +south_square=0 +north_square=2 -E << EOF
+ > 55 12
+ > EOF
+ 55 12 6115727.86 1553840.13
+
+
+Further reading
+################################################################################
+
+#. `NASA <http://healpix.jpl.nasa.gov/>`_
+#. `Wikipedia <https://en.wikipedia.org/wiki/HEALPix>`_