Refactor all grid-related modules to use the Session.virtualfile_to_grid method, except grdcut

Author: seisman

pygmt/src/binstats.py

@@ -3,21 +3,13 @@
 """
 
 from pygmt.clib import Session
-from pygmt.helpers import (
-    GMTTempFile,
-    build_arg_string,
-    fmt_docstring,
-    kwargs_to_strings,
-    use_alias,
-)
-from pygmt.io import load_dataarray
+from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
 
 
 @fmt_docstring
 @use_alias(
     C="statistic",
     E="empty",
-    G="outgrid",
     I="spacing",
     N="normalize",
     R="region",
@@ -31,7 +23,7 @@
     r="registration",
 )
 @kwargs_to_strings(I="sequence", R="sequence", i="sequence_comma")
-def binstats(data, **kwargs):
+def binstats(data, outgrid: str | None = None, **kwargs):
     r"""
     Bin spatial data and determine statistics per bin.
 
@@ -110,13 +102,13 @@ def binstats(data, **kwargs):
         - None if ``outgrid`` is set (grid output will be stored in file set by
           ``outgrid``)
     """
-    with GMTTempFile(suffix=".nc") as tmpfile:
-        with Session() as lib:
-            with lib.virtualfile_in(check_kind="vector", data=data) as vintbl:
-                if (outgrid := kwargs.get("G")) is None:
-                    kwargs["G"] = outgrid = tmpfile.name  # output to tmpfile
-                lib.call_module(
-                    module="binstats", args=build_arg_string(kwargs, infile=vintbl)
-                )
-
-        return load_dataarray(outgrid) if outgrid == tmpfile.name else None
+    with Session() as lib:
+        with (
+            lib.virtualfile_in(check_kind="vector", data=data) as vintbl,
+            lib.virtualfile_out(kind="grid", fname=outgrid) as voutgrd,
+        ):
+            kwargs["G"] = voutgrd
+            lib.call_module(
+                module="binstats", args=build_arg_string(kwargs, infile=vintbl)
+            )
+            return lib.virtualfile_to_grid(vfname=voutgrd, outgrid=outgrid)

pygmt/src/dimfilter.py

@@ -4,14 +4,7 @@
 
 from pygmt.clib import Session
 from pygmt.exceptions import GMTInvalidInput
-from pygmt.helpers import (
-    GMTTempFile,
-    build_arg_string,
-    fmt_docstring,
-    kwargs_to_strings,
-    use_alias,
-)
-from pygmt.io import load_dataarray
+from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
 
 __doctest_skip__ = ["dimfilter"]
 
@@ -20,14 +13,13 @@
 @use_alias(
     D="distance",
     F="filter",
-    G="outgrid",
     I="spacing",
     N="sectors",
     R="region",
     V="verbose",
 )
 @kwargs_to_strings(I="sequence", R="sequence")
-def dimfilter(grid, **kwargs):
+def dimfilter(grid, outgrid: str | None = None, **kwargs):
     r"""
     Filter a grid by dividing the filter circle.
 
@@ -149,13 +141,13 @@ def dimfilter(grid, **kwargs):
             distance, filters, or sectors."""
         )
 
-    with GMTTempFile(suffix=".nc") as tmpfile:
-        with Session() as lib:
-            with lib.virtualfile_in(check_kind="raster", data=grid) as vingrd:
-                if (outgrid := kwargs.get("G")) is None:
-                    kwargs["G"] = outgrid = tmpfile.name  # output to tmpfile
-                lib.call_module(
-                    module="dimfilter", args=build_arg_string(kwargs, infile=vingrd)
-                )
-
-        return load_dataarray(outgrid) if outgrid == tmpfile.name else None
+    with Session() as lib:
+        with (
+            lib.virtualfile_in(check_kind="raster", data=grid) as vingrd,
+            lib.virtualfile_out(kind="grid", fname=outgrid) as voutgrd,
+        ):
+            kwargs["G"] = voutgrd
+            lib.call_module(
+                module="dimfilter", args=build_arg_string(kwargs, infile=vingrd)
+            )
+            return lib.virtualfile_to_grid(vfname=voutgrd, outgrid=outgrid)

pygmt/src/grdclip.py

@@ -3,21 +3,13 @@
 """
 
 from pygmt.clib import Session
-from pygmt.helpers import (
-    GMTTempFile,
-    build_arg_string,
-    fmt_docstring,
-    kwargs_to_strings,
-    use_alias,
-)
-from pygmt.io import load_dataarray
+from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
 
 __doctest_skip__ = ["grdclip"]
 
 
 @fmt_docstring
 @use_alias(
-    G="outgrid",
     R="region",
     Sa="above",
     Sb="below",
@@ -32,7 +24,7 @@
     Si="sequence",
     Sr="sequence",
 )
-def grdclip(grid, **kwargs):
+def grdclip(grid, outgrid: str | None = None, **kwargs):
     r"""
     Set values in a grid that meet certain criteria to a new value.
 
@@ -95,13 +87,13 @@ def grdclip(grid, **kwargs):
     >>> [new_grid.data.min(), new_grid.data.max()]
     [0.0, 10000.0]
     """
-    with GMTTempFile(suffix=".nc") as tmpfile:
-        with Session() as lib:
-            with lib.virtualfile_in(check_kind="raster", data=grid) as vingrd:
-                if (outgrid := kwargs.get("G")) is None:
-                    kwargs["G"] = outgrid = tmpfile.name  # output to tmpfile
-                lib.call_module(
-                    module="grdclip", args=build_arg_string(kwargs, infile=vingrd)
-                )
-
-        return load_dataarray(outgrid) if outgrid == tmpfile.name else None
+    with Session() as lib:
+        with (
+            lib.virtualfile_in(check_kind="raster", data=grid) as vingrd,
+            lib.virtualfile_out(kind="grid", fname=outgrid) as voutgrd,
+        ):
+            kwargs["G"] = voutgrd
+            lib.call_module(
+                module="grdclip", args=build_arg_string(kwargs, infile=vingrd)
+            )
+            return lib.virtualfile_to_grid(vfname=voutgrd, outgrid=outgrid)

pygmt/src/grdfill.py

@@ -4,28 +4,20 @@
 
 from pygmt.clib import Session
 from pygmt.exceptions import GMTInvalidInput
-from pygmt.helpers import (
-    GMTTempFile,
-    build_arg_string,
-    fmt_docstring,
-    kwargs_to_strings,
-    use_alias,
-)
-from pygmt.io import load_dataarray
+from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
 
 __doctest_skip__ = ["grdfill"]
 
 
 @fmt_docstring
 @use_alias(
     A="mode",
-    G="outgrid",
     N="no_data",
     R="region",
     V="verbose",
 )
 @kwargs_to_strings(R="sequence")
-def grdfill(grid, **kwargs):
+def grdfill(grid, outgrid: str | None = None, **kwargs):
     r"""
     Fill blank areas from a grid file.
 
@@ -77,13 +69,14 @@ def grdfill(grid, **kwargs):
     """
     if kwargs.get("A") is None and kwargs.get("L") is None:
         raise GMTInvalidInput("At least parameter 'mode' or 'L' must be specified.")
-    with GMTTempFile(suffix=".nc") as tmpfile:
-        with Session() as lib:
-            with lib.virtualfile_in(check_kind="raster", data=grid) as vingrd:
-                if (outgrid := kwargs.get("G")) is None:
-                    kwargs["G"] = outgrid = tmpfile.name  # output to tmpfile
-                lib.call_module(
-                    module="grdfill", args=build_arg_string(kwargs, infile=vingrd)
-                )
 
-        return load_dataarray(outgrid) if outgrid == tmpfile.name else None
+    with Session() as lib:
+        with (
+            lib.virtualfile_in(check_kind="raster", data=grid) as vingrd,
+            lib.virtualfile_out(kind="grid", fname=outgrid) as voutgrd,
+        ):
+            kwargs["G"] = voutgrd
+            lib.call_module(
+                module="grdfill", args=build_arg_string(kwargs, infile=vingrd)
+            )
+            return lib.virtualfile_to_grid(vfname=voutgrd, outgrid=outgrid)

pygmt/src/grdfilter.py

@@ -3,21 +3,13 @@
 """
 
 from pygmt.clib import Session
-from pygmt.helpers import (
-    GMTTempFile,
-    build_arg_string,
-    fmt_docstring,
-    kwargs_to_strings,
-    use_alias,
-)
-from pygmt.io import load_dataarray
+from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
 
 
 @fmt_docstring
 @use_alias(
     D="distance",
     F="filter",
-    G="outgrid",
     I="spacing",
     N="nans",
     R="region",
@@ -28,7 +20,7 @@
     x="cores",
 )
 @kwargs_to_strings(I="sequence", R="sequence")
-def grdfilter(grid, **kwargs):
+def grdfilter(grid, outgrid: str | None = None, **kwargs):
     r"""
     Filter a grid in the space (or time) domain.
 
@@ -132,13 +124,13 @@ def grdfilter(grid, **kwargs):
     >>> grid = pygmt.datasets.load_earth_relief()
     >>> smooth_field = pygmt.grdfilter(grid=grid, filter="g600", distance="4")
     """
-    with GMTTempFile(suffix=".nc") as tmpfile:
-        with Session() as lib:
-            with lib.virtualfile_in(check_kind="raster", data=grid) as vingrd:
-                if (outgrid := kwargs.get("G")) is None:
-                    kwargs["G"] = outgrid = tmpfile.name  # output to tmpfile
-                lib.call_module(
-                    module="grdfilter", args=build_arg_string(kwargs, infile=vingrd)
-                )
-
-        return load_dataarray(outgrid) if outgrid == tmpfile.name else None
+    with Session() as lib:
+        with (
+            lib.virtualfile_in(check_kind="raster", data=grid) as vingrd,
+            lib.virtualfile_out(kind="grid", fname=outgrid) as voutgrd,
+        ):
+            kwargs["G"] = voutgrd
+            lib.call_module(
+                module="grdfilter", args=build_arg_string(kwargs, infile=vingrd)
+            )
+            return lib.virtualfile_to_grid(vfname=voutgrd, outgrid=outgrid)

pygmt/src/grdgradient.py

@@ -5,14 +5,12 @@
 from pygmt.clib import Session
 from pygmt.exceptions import GMTInvalidInput
 from pygmt.helpers import (
-    GMTTempFile,
     args_in_kwargs,
     build_arg_string,
     fmt_docstring,
     kwargs_to_strings,
     use_alias,
 )
-from pygmt.io import load_dataarray
 
 __doctest_skip__ = ["grdgradient"]
 
@@ -22,7 +20,6 @@
     A="azimuth",
     D="direction",
     E="radiance",
-    G="outgrid",
     N="normalize",
     Q="tiles",
     R="region",
@@ -32,7 +29,7 @@
     n="interpolation",
 )
 @kwargs_to_strings(A="sequence", E="sequence", R="sequence")
-def grdgradient(grid, **kwargs):
+def grdgradient(grid, outgrid: str | None = None, **kwargs):
     r"""
     Compute the directional derivative of the vector gradient of the data.
 
@@ -160,20 +157,20 @@ def grdgradient(grid, **kwargs):
     >>> # Create a new grid from an input grid, set the azimuth to 10 degrees,
     >>> new_grid = pygmt.grdgradient(grid=grid, azimuth=10)
     """
-    with GMTTempFile(suffix=".nc") as tmpfile:
-        if kwargs.get("Q") is not None and kwargs.get("N") is None:
-            raise GMTInvalidInput("""Must specify normalize if tiles is specified.""")
-        if not args_in_kwargs(args=["A", "D", "E"], kwargs=kwargs):
-            raise GMTInvalidInput(
-                """At least one of the following parameters must be specified:
-                azimuth, direction, or radiance"""
+    if kwargs.get("Q") is not None and kwargs.get("N") is None:
+        raise GMTInvalidInput("""Must specify normalize if tiles is specified.""")
+    if not args_in_kwargs(args=["A", "D", "E"], kwargs=kwargs):
+        raise GMTInvalidInput(
+            "At least one of the following parameters must be specified: "
+            "azimuth, direction, or radiance."
+        )
+    with Session() as lib:
+        with (
+            lib.virtualfile_in(check_kind="raster", data=grid) as vingrd,
+            lib.virtualfile_out(kind="grid", fname=outgrid) as voutgrd,
+        ):
+            kwargs["G"] = voutgrd
+            lib.call_module(
+                module="grdgradient", args=build_arg_string(kwargs, infile=vingrd)
             )
-        with Session() as lib:
-            with lib.virtualfile_in(check_kind="raster", data=grid) as vingrd:
-                if (outgrid := kwargs.get("G")) is None:
-                    kwargs["G"] = outgrid = tmpfile.name  # output to tmpfile
-                lib.call_module(
-                    module="grdgradient", args=build_arg_string(kwargs, infile=vingrd)
-                )
-
-        return load_dataarray(outgrid) if outgrid == tmpfile.name else None
+            return lib.virtualfile_to_grid(vfname=voutgrd, outgrid=outgrid)