Skip to content
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.

Sign up for GitHub

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

Add enums GridRegistration and GridType for grid registration and type #3693

Merged
merged 7 commits into from
Dec 19, 2024
Merged

Add enums GridRegistration and GridType for grid registration and type #3693

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c6fec15
Add enums to the API documentation
seisman Dec 17, 2024
ec8a7e5
Merge branch 'main' into doc/enums
seisman Dec 18, 2024
12b549d
Merge branch 'main' into doc/enums
seisman Dec 19, 2024
640a01b
Add enums GridReg and GridType for grid registration and type
seisman Sep 24, 2024
6b112bb
Add GridReg and GridType to the API docs
seisman Dec 19, 2024
ba8773f
Rename GridReg to GridRegistration
seisman Dec 19, 2024
dcc30dc
Rename GridReg to GridRegistration in docs
seisman Dec 19, 2024
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
7 changes: 7 additions & 0 deletions doc/_templates/autosummary/enums.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{{ fullname | escape | underline }}

.. currentmodule:: {{ module }}

.. autoclass:: {{ objname }}
:members:
:member-order: bysource
16 changes: 14 additions & 2 deletions doc/api/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,20 @@ Getting metadata from tabular or grid data:
info
grdinfo

Enums
-----

.. currentmodule:: pygmt.enums

.. autosummary::
:toctree: generated
:nosignatures:
:template: autosummary/enums.rst

GridReg
GridType

.. currentmodule:: pygmt

Miscellaneous
-------------
Expand All @@ -205,8 +219,6 @@ Miscellaneous
which
show_versions

.. currentmodule:: pygmt

Datasets
--------

Expand Down
18 changes: 18 additions & 0 deletions pygmt/enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,21 @@ class GridFormat(IntEnum):
GD = 22 #: Import through GDAL
EI = 23 #: ESRI Arc/Info ASCII Grid Interchange format (ASCII integer)
EF = 24 #: ESRI Arc/Info ASCII Grid Interchange format (ASCII float)


class GridReg(IntEnum):
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GridReg or GridRegistration?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer GridRegistration

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, renamed to GridRegistration in this PR.

"""
Enum for the grid registration.
"""

GRIDLINE = 0 #: Gridline registration
PIXEL = 1 #: Pixel registration


class GridType(IntEnum):
"""
Enum for the grid type.
"""

CARTESIAN = 0 #: Cartesian grid
GEOGRAPHIC = 1 #: Geographic grid
Loading