Figure.savefig: Add the 'worldfile' parameter to write a companion world file for raster images by seisman · Pull Request #2766 · GenericMappingTools/pygmt

seisman · 2023-10-24T16:06:22Z

Description of proposed changes

Fixes #

Reminders

Run make format and make check to make sure the code follows the style guide.
Add tests for new features or tests that would have caught the bug that you're fixing.
Add new public functions/methods/classes to doc/api/index.rst.
Write detailed docstrings for all functions/methods.
If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
If adding new functionality, add an example to docstrings or tutorials.
Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

/format: automatically format and lint the code
/test-gmt-dev: run full tests on the latest GMT development version

…rld file

pygmt/tests/test_figure.py

Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>

pygmt/figure.py

weiji14 · 2023-10-25T21:24:25Z

pygmt/figure.py

            kwargs["Qg"] = 2

+        if worldfile:
+            if ext in ["kml", "tiff"]:


Are worldfiles possible for other formats like pdf/bmp/eps?

Yes for PDF and BMP.

Aslo yes for EPS, but for unknown reasons, the current codes doesn't produce a .esw file correctly. Need some time to find out why.

Don't think I've ever heard of people create world files for PDF (pfw files?!), but ok then if it works. Have added another suggestion below to test that bmp/bpw files are created.

Are worldfiles possible for other formats like pdf/bmp/eps?

For EPS, see an upstream issue report GenericMappingTools/gmt#7976

See GenericMappingTools/gmt#7976, a world file is useless for vector images like EPS and PDF.

pygmt/figure.py

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

weiji14 · 2023-10-26T01:15:34Z

pygmt/figure.py

            kwargs["Qg"] = 2

+        if worldfile:
+            if ext in ["kml", "tiff"]:


Don't think I've ever heard of people create world files for PDF (pfw files?!), but ok then if it works. Have added another suggestion below to test that bmp/bpw files are created.

pygmt/tests/test_figure.py

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

pygmt/tests/test_figure.py

weiji14 · 2023-10-29T20:32:55Z

pygmt/tests/test_figure.py

    }


+def test_figure_savefig_worldfile():


Was there a reason to switch from the parametrized tests to a single test in a863132? It'll be harder to see which formats/extensions fail, if e.g. the first one in a list like ['.bmp', '.jpg', ...] raises an AssertionError, because the others in the list won't be tested.

The main idea is to reducing the number of tests and also testing times. Comparing https://github.com/GenericMappingTools/pygmt/actions/runs/6677102075/job/18146781350?pr=2766 and https://github.com/GenericMappingTools/pygmt/actions/runs/6648648090/job/18065964154?pr=2766, the old way (using parametrize) has 7 tests for worldfile, and the testing time is 0.5 * 5 + 0.25 * 2 = 3 seconds, while the new way (a single test) costs 1.5 s only.

Ah ok, I see that we avoid having to call fig.basemap multiple times, so it will be faster. All good then.

weiji14 · 2023-10-29T20:34:21Z

pygmt/figure.py

+            but with different extension (e.g. tfw for tif). See
+            https://en.wikipedia.org/wiki/World_file#Filename_extension
+            for the convention of world file extensions. This parameter only
+            works for raster image formats.


(Geo)TIFF is a raster file format, but a worldfile won't be produced. Also, maybe best to just list out the supported extensions.

Suggested change

works for raster image formats.

works for non-georeferenced raster image formats (e.g. '.bmp',

'.jpg', '.png', '.ppm', '.tif')

In PR #2771 (commit 0c81847), we have revised the function description to separate the list of raster and vector formats (preview: https://www.pygmt.org/dev/api/generated/pygmt.Figure.savefig.html#pygmt.Figure.savefig).

So I prefer to not list the formats again and prefer to revise the docstring to

works for raster image formats (except GeoTIFF).

Oh right, totally missed that. Your shorter suggestion sounds good.

pygmt/figure.py

Figure.savefig: Add the 'worldfile' parameter to write a companion wo…

797e5c6

…rld file

seisman added the feature Brand new feature label Oct 24, 2023

seisman added this to the 0.11.0 milestone Oct 24, 2023

Fix pylint issue

a36cef7

seisman added the needs review This PR has higher priority and needs review. label Oct 24, 2023

Merge branch 'main' into savefig/worldfile

0c4c9d3

yvonnefroehlich reviewed Oct 25, 2023

View reviewed changes

pygmt/tests/test_figure.py Outdated Show resolved Hide resolved

pygmt/tests/test_figure.py Outdated Show resolved Hide resolved

Apply suggestions from code review

184d5b1

Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>

weiji14 reviewed Oct 25, 2023

View reviewed changes

Apply suggestions from code review

3139130

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

weiji14 reviewed Oct 26, 2023

View reviewed changes

seisman and others added 6 commits October 26, 2023 10:03

Test bmp

20e79db

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

Fix formatting styles

6062666

Fix bmp to .bmp

57c020f

Merge branch 'main' into savefig/worldfile

e50ab6d

PDF and EPS is not supportd

da5c6d2

Combine two tests into a single one

a863132

seisman force-pushed the savefig/worldfile branch from 54e72e3 to a863132 Compare October 26, 2023 15:23

Fix the docstrings

316e5df

seisman commented Oct 26, 2023

View reviewed changes

pygmt/tests/test_figure.py Outdated Show resolved Hide resolved

seisman changed the title ~~Figure.savefig: Add the 'worldfile' parameter to write a companion world file~~ Figure.savefig: Add the 'worldfile' parameter to write a companion world file for raster images Oct 27, 2023

seisman added 2 commits October 28, 2023 21:04

Merge branch 'main' into savefig/worldfile

2c149bb

Update pygmt/tests/test_figure.py

1784a2f

weiji14 reviewed Oct 29, 2023

View reviewed changes

seisman commented Oct 30, 2023

View reviewed changes

pygmt/figure.py Outdated Show resolved Hide resolved

Update pygmt/figure.py

9dc40fc

weiji14 approved these changes Oct 30, 2023

View reviewed changes

weiji14 added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Oct 30, 2023

seisman removed the final review call This PR requires final review and approval from a second reviewer label Oct 31, 2023

seisman merged commit a9bd688 into main Oct 31, 2023

seisman deleted the savefig/worldfile branch October 31, 2023 04:57

	works for raster image formats.
	works for non-georeferenced raster image formats (e.g. '.bmp',
	'.jpg', '.png', '.ppm', '.tif')

		}


		def test_figure_savefig_worldfile():

Conversation

seisman commented Oct 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

seisman commented Oct 24, 2023 •

edited

Loading