Skip to content

FIX: check whether -C and -E use different unit in grdtrack #8728

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

Merged
joa-quim merged 4 commits into from
May 16, 2025
Merged

FIX: check whether -C and -E use different unit in grdtrack #8728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
85694aa
FIX: check whether -C and -E use different unit
Dengda98 May 15, 2025
be065cb
DOC: update annotation of checking -C and -E units
Dengda98 May 16, 2025
bacc85c
DOC: update grdtrack.rst about -C and -E units
Dengda98 May 16, 2025
459889c
DOC: update grdtrack.rst, add PR reference
Dengda98 May 16, 2025
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
3 changes: 3 additions & 0 deletions doc/rst/source/grdtrack.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,9 @@ Optional Arguments
counter-clockwise. Finally, you can use **+f** to set a fixed azimuth
for all profiles. **Note**: If |-C| is set and *spacing* is given then
that sampling scheme overrules any modifier set in |-E|.
Currently, there is a bug when |-C| and |-E| use different units
(see PR `#8728 <https://github.com/GenericMappingTools/gmt/pull/8728>`_ ).
If you use both, please manually specify the same unit for each.

.. _-D:

Expand Down
10 changes: 10 additions & 0 deletions src/grdtrack.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -815,6 +815,16 @@ EXTERN_MSC int GMT_grdtrack (void *V_API, int mode, void *args) {
}
if (gmt_init_distaz (GMT, Ctrl->E.unit, Ctrl->E.mode, GMT_MAP_DIST) == GMT_NOT_A_VALID_TYPE) /* Initialize the distance unit and scaling */
Return (GMT_NOT_A_VALID_TYPE);

/* !!! TEMPORARY METHOD !!! */
/* Currently we cannot use different units in -C and -E, we have to prevent this bug first. See PR #8728 */
/* Check whether -C and -E use different unit */
if (Ctrl->C.active && Ctrl->C.unit != Ctrl->E.unit){
GMT_Report (API, GMT_MSG_ERROR,
"Option -C and -E shoule take the same unit, but received %c (-C) and %c (-E). "
Copy link
Member

@joa-quim joa-quim May 16, 2025

Choose a reason for hiding this comment

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

Can you please rephrase this to:
"Sorry but a current limitation obliges that options -C and -E must have the same unit, but received %c (-C) and %c (-E). "
"You must explicitly set the same unit for -C and -E.\n", Ctrl->C.unit, Ctrl->E.unit);

Copy link
Contributor Author

@Dengda98 Dengda98 May 16, 2025

Choose a reason for hiding this comment

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

Sorry for delay response. Maybe you can edit it later ?

"Recommend you explicitly set the same unit for -C and -E.\n", Ctrl->C.unit, Ctrl->E.unit);
Return (GMT_RUNTIME_ERROR);
}

/* Set default spacing to half the min grid spacing: */
Ctrl->E.step = 0.5 * MIN (GC[0].G->header->inc[GMT_X], GC[0].G->header->inc[GMT_Y]);
Expand Down
Loading