Skip to content

Commit

Permalink
Update GMT argument in the azimuthal projections gallery to doc stand…
Browse files Browse the repository at this point in the history
  • Loading branch information
willschlitzer authored and Josh Sixsmith committed Dec 21, 2022
1 parent 1046107 commit 8fb1408
Show file tree
Hide file tree
Showing 6 changed files with 44 additions and 35 deletions.
12 changes: 7 additions & 5 deletions examples/projections/azim/azim_equidistant.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""
r"""
Azimuthal Equidistant
=====================
Expand All @@ -8,11 +8,13 @@
that lie within a certain distance or for comparing distances of different
locations relative to the projection center.
``elon0/lat0[/horizon]/scale`` or ``Elon0/lat0[/horizon]/width``
**e**\ *lon0/lat0*\ [*/horizon*]\ */scale* or
**E**\ *lon0/lat0*\ [*/horizon*]\ */width*
``lon0/lat0`` specifies the projection center. The optional parameter
``horizon`` specifies the max distance to the projection center (i.e. the
visibile portion of the rest of the world map) in degrees <= 180° (default 180°).
The projection type is set with **e** or **E**, *lon0/lat0* specifies the projection
center, and the optional parameter *horizon* specifies the max distance to the
projection center (i.e. the visibile portion of the rest of the world map) in
degrees <= 180° (default 180°). The size of the figure is set by *scale* or *width*.
"""
import pygmt

Expand Down
17 changes: 10 additions & 7 deletions examples/projections/azim/azim_general_perspective.py
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
"""
r"""
General Perspective
===================
The general perspective projection imitates the view of the Earth from a finite
point in space. In a full view of the earth one third of its surface area can
be seen.
``lon0/lat0/altitude/azimuth/tilt/twist/Width/Height/scale`` or ``width``
**g**\ *lon0/lat0*\ */altitude*\ */azimuth*\ */tilt*\ */twist*\ */Width*\ */Height*\ */scale*
or **G**\ *lon0/lat0*\ */altitude*\ */azimuth*\ */tilt*\ */twist*\ */Width*\ */Height*\ */width*
``lon0/lat0`` specifies the projection center, ``altitude`` the height
The projection type is set with **g** or **G**.
*lon0/lat0* specifies the projection center and *altitude* sets the height
in km of the viewpoint above local sea level (If altitude is less than 10,
then it is the distance from the center of the earth to the viewpoint in earth
radii). With ``azimuth`` the direction (in degrees) in which you are looking is
specified, measured clockwise from north. ``tilt`` is given in degrees and is the
radii). With *azimuth* the direction (in degrees) in which you are looking is
specified, measured clockwise from north. *tilt* is given in degrees and is the
viewing angle relative to zenith. A tilt of 0° is looking straight down, 60° is
looking 30° above horizon. ``twist`` is the clockwise rotation of the image (in
degrees). ``Width`` and ``Height`` describe the viewport angle in degrees.
looking 30° above horizon. *twist* is the clockwise rotation of the image (in
degrees). *Width* and *Height* describe the viewport angle in degrees, and *scale*
or *width* determine the size of the figure.
The example shows the coast of northern europe viewed from 250 km above sea
level looking 30° from north at a tilt of 45°. The height and width of the
Expand Down
18 changes: 7 additions & 11 deletions examples/projections/azim/azim_general_stereographic.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""
r"""
General Stereographic
=====================
Expand All @@ -9,17 +9,13 @@
It is often used as a hemisphere map like the Lambert Azimuthal Equal Area
projection.
``slon0/lat0[/horizon]/scale`` or ``Slon0/lat0[/horizon]/width``
``lon0/lat0`` specifies the projection center, the optional ``horizon`` parameter
specifies the max distance from projection center (in degrees, < 180, default 90).
This projection can be displayed:
**s**\ *lon0/lat0*\ [*/horizon*]\ */scale*
or **S**\ *lon0/lat0*\ [*/horizon*\]\ */width*
* With map boundaries coinciding with longitude and latitude:
``region`` specified via ``xmin/xmax/ymin/ymax``
* As a map with rectangular boundaries: ``region`` specified as lower left and
upper right corner ``xlleft/ylleft/xuright/yurightr``. Note the appended ``r``.
The projection type is set with **s** or **S**. *lon0/lat0* specifies the
projection center, the optional *horizon* parameter specifies the max distance from
projection center (in degrees, < 180, default 90), and the *scale* or *width* sets the
size of the figure.
"""
import pygmt

Expand Down
11 changes: 7 additions & 4 deletions examples/projections/azim/azim_gnomonic.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""
r"""
Gnomonic
========
Expand All @@ -10,10 +10,13 @@
that the scope of application is restricted to a small area around the
projection center (at a maximum of 60°).
``flon0/lat0[/horizon]/scale`` or ``Flon0/lat0[/horizon]/width``
**f**\ *lon0/lat0*\ [*/horizon*\ ]\ */scale*
or **F**\ *lon0/lat0*\ [*/horizon*\ ]\ */width*
``lon0/lat0`` specify the projection center, the optional parameter ``horizon``
specifies the max distance from projection center (in degrees, < 90, default 60).
**f** or **F** specifies the projection type, *lon0/lat0* specifies the projection
center, the optional parameter *horizon* specifies the max distance from projection
center (in degrees, < 90, default 60), and *scale* or *width* sets the size of the
figure.
"""
import pygmt

Expand Down
11 changes: 7 additions & 4 deletions examples/projections/azim/azim_lambert.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""
r"""
Lambert Azimuthal Equal Area
============================
Expand All @@ -7,9 +7,12 @@
equal-area projection, but is not perspective. Distortion is zero at the center of the
projection, and increases radially away from this point.
``Alon0/lat0[/horizon]/width``: ``lon0`` and ``lat0`` specifies the projection center.
``horizon`` specifies the max distance from projection center (in degrees, <= 180,
default 90).
**a**\ *lon0/lat0*\ [*/horizon*\ ]\ */scale*
or **A**\ *lon0/lat0*\ [*/horizon*\ ]\ */width*
**a** or **A** specifies the projection type, and *lon0/lat0* specifies the projection
center, *horizon* specifies the max distance from projection center (in degrees,
<= 180, default 90), and *scale* or *width* sets the size of the figure.
"""
import pygmt

Expand Down
10 changes: 6 additions & 4 deletions examples/projections/azim/azim_orthographic.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""
r"""
Orthographic
============
Expand All @@ -8,10 +8,12 @@
space, were one hemisphere can be seen as a whole. It is neither conformal nor
equal-area and the distortion increases near the edges.
``glon0/lat0[/horizon]/scale`` or ``Glon0/lat0[/horizon]/width``
**g**\ *lon0/lat0*\ [*/horizon*\ ]\ */scale*
or **G**\ *lon0/lat0*\ [*/horizon*\ ]\ */width*
``lon0/lat0`` specifies the projection center, the optional parameter ``horizon``
specifies the max distance from projection center (in degrees, <= 90, default 90)
**g** or **G** specifies the projection type, *lon0/lat0* specifies the projection
center, the optional parameter *horizon* specifies the max distance from projection
center (in degrees, <= 90, default 90), and *scale* and *width* set the figure size.
"""
import pygmt

Expand Down

0 comments on commit 8fb1408

Please sign in to comment.