Skip to content

DOC: Move description of distcal to the Technical Reference section #3868

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Mar 25, 2025
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions doc/techref/common_parameters.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
# Common Parameters

```{glossary}
``distcalc``
Determine how spherical distances are calculated. Valid values are:

- ``"g"``: Perform great circle distance calculations, with parameters such as
distance increments or radii compared against calculated great circle distances
[Default]
- ``"e"``: Select ellipsoidal (or geodesic) mode for the highest precision and
slowest calculation time.
- ``"f"``: Select Flat Earth mode, which gives a more approximate but faster result

**Note:** (1) All spherical distance calculations depend on the current ellipsoid
({gmt-term}`PROJ_ELLIPSOID`), the definition of the mean radius
({gmt-term}`PROJ_MEAN_RADIUS`), and the specification of latitude type
({gmt-term}`PROJ_AUX_LATITUDE`). Geodesic distance calculations is also controlled
by the algorithm to use for geodesic calculations ({gmt-term}`PROJ_GEODESIC`).
(2) Coordinate transformations that can use ellipsoidal or spherical forms will
first consult this parameter if given.

``verbose``
Select verbosity level, which modulates the messages written to stderr.

Expand Down
14 changes: 2 additions & 12 deletions pygmt/helpers/decorators.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,18 +81,8 @@
""",
"distcalc": r"""
distcalc : str
**e**\|\ **f**\|\ **g**.
Determine how spherical distances are calculated.

- **e**: Ellipsoidal (or geodesic) mode
- **f**: Flat Earth mode
- **g**: Great circle distance [Default]

All spherical distance calculations depend on the current ellipsoid
(:gmt-term:`PROJ_ELLIPSOID`), the definition of the mean radius
(:gmt-term:`PROJ_MEAN_RADIUS`), and the specification of latitude type
(:gmt-term:`PROJ_AUX_LATITUDE`). Geodesic distance calculations is also
controlled by method (:gmt-term:`PROJ_GEODESIC`).""",
Determine how spherical distances are calculated
[:term:`Full usage <distcalc>`].""",
"fill": r"""
fill : str
Set color or pattern for filling symbols or polygons
Expand Down