Session.virtualfile_to_raster: let kind default to 'grid'

seisman · seisman · commit 97c3cc9f9a9f · 2024-04-16T08:44:56.000+08:00
diff --git a/pygmt/clib/session.py b/pygmt/clib/session.py
@@ -1954,7 +1954,7 @@ def virtualfile_to_dataset(
     def virtualfile_to_raster(
         self,
         vfname: str,
-        kind: Literal["grid", "image", "cube", None] = None,
+        kind: Literal["grid", "image", "cube", None] = "grid",
         outgrid: str | None = None,
     ) -> xr.DataArray | None:
         """
diff --git a/pygmt/src/binstats.py b/pygmt/src/binstats.py
@@ -111,6 +111,4 @@ def binstats(data, outgrid: str | None = None, **kwargs):
             lib.call_module(
                 module="binstats", args=build_arg_string(kwargs, infile=vintbl)
             )
-            return lib.virtualfile_to_raster(
-                vfname=voutgrd, kind="grid", outgrid=outgrid
-            )
+            return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)
diff --git a/pygmt/src/dimfilter.py b/pygmt/src/dimfilter.py
@@ -150,6 +150,4 @@ def dimfilter(grid, outgrid: str | None = None, **kwargs):
             lib.call_module(
                 module="dimfilter", args=build_arg_string(kwargs, infile=vingrd)
             )
-            return lib.virtualfile_to_raster(
-                vfname=voutgrd, kind="grid", outgrid=outgrid
-            )
+            return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)
diff --git a/pygmt/src/grdclip.py b/pygmt/src/grdclip.py
@@ -96,6 +96,4 @@ def grdclip(grid, outgrid: str | None = None, **kwargs):
             lib.call_module(
                 module="grdclip", args=build_arg_string(kwargs, infile=vingrd)
             )
-            return lib.virtualfile_to_raster(
-                vfname=voutgrd, kind="grid", outgrid=outgrid
-            )
+            return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)
diff --git a/pygmt/src/grdfill.py b/pygmt/src/grdfill.py
@@ -79,6 +79,4 @@ def grdfill(grid, outgrid: str | None = None, **kwargs):
             lib.call_module(
                 module="grdfill", args=build_arg_string(kwargs, infile=vingrd)
             )
-            return lib.virtualfile_to_raster(
-                vfname=voutgrd, kind="grid", outgrid=outgrid
-            )
+            return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)
diff --git a/pygmt/src/grdfilter.py b/pygmt/src/grdfilter.py
@@ -133,6 +133,4 @@ def grdfilter(grid, outgrid: str | None = None, **kwargs):
             lib.call_module(
                 module="grdfilter", args=build_arg_string(kwargs, infile=vingrd)
             )
-            return lib.virtualfile_to_raster(
-                vfname=voutgrd, kind="grid", outgrid=outgrid
-            )
+            return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)
diff --git a/pygmt/src/grdgradient.py b/pygmt/src/grdgradient.py
@@ -173,6 +173,4 @@ def grdgradient(grid, outgrid: str | None = None, **kwargs):
             lib.call_module(
                 module="grdgradient", args=build_arg_string(kwargs, infile=vingrd)
             )
-            return lib.virtualfile_to_raster(
-                vfname=voutgrd, kind="grid", outgrid=outgrid
-            )
+            return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)
diff --git a/pygmt/src/grdhisteq.py b/pygmt/src/grdhisteq.py
@@ -129,9 +129,7 @@ def equalize_grid(grid, outgrid: str | None = None, **kwargs):
                 lib.call_module(
                     module="grdhisteq", args=build_arg_string(kwargs, infile=vingrd)
                 )
-                return lib.virtualfile_to_raster(
-                    vfname=voutgrd, kind="grid", outgrid=outgrid
-                )
+                return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)
 
     @staticmethod
     @fmt_docstring
diff --git a/pygmt/src/grdlandmask.py b/pygmt/src/grdlandmask.py
@@ -101,6 +101,4 @@ def grdlandmask(outgrid: str | None = None, **kwargs):
         with lib.virtualfile_out(kind="grid", fname=outgrid) as voutgrd:
             kwargs["G"] = voutgrd
             lib.call_module(module="grdlandmask", args=build_arg_string(kwargs))
-            return lib.virtualfile_to_raster(
-                vfname=voutgrd, kind="grid", outgrid=outgrid
-            )
+            return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)
diff --git a/pygmt/src/grdproject.py b/pygmt/src/grdproject.py
@@ -113,6 +113,4 @@ def grdproject(grid, outgrid: str | None = None, **kwargs):
             lib.call_module(
                 module="grdproject", args=build_arg_string(kwargs, infile=vingrd)
             )
-            return lib.virtualfile_to_raster(
-                vfname=voutgrd, kind="grid", outgrid=outgrid
-            )
+            return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)
diff --git a/pygmt/src/grdsample.py b/pygmt/src/grdsample.py
@@ -88,6 +88,4 @@ def grdsample(grid, outgrid: str | None = None, **kwargs):
             lib.call_module(
                 module="grdsample", args=build_arg_string(kwargs, infile=vingrd)
             )
-            return lib.virtualfile_to_raster(
-                vfname=voutgrd, kind="grid", outgrid=outgrid
-            )
+            return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)
diff --git a/pygmt/src/nearneighbor.py b/pygmt/src/nearneighbor.py
@@ -148,6 +148,4 @@ def nearneighbor(
             lib.call_module(
                 module="nearneighbor", args=build_arg_string(kwargs, infile=vintbl)
             )
-            return lib.virtualfile_to_raster(
-                vfname=voutgrd, kind="grid", outgrid=outgrid
-            )
+            return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)
diff --git a/pygmt/src/sph2grd.py b/pygmt/src/sph2grd.py
@@ -73,6 +73,4 @@ def sph2grd(data, outgrid: str | None = None, **kwargs):
             lib.call_module(
                 module="sph2grd", args=build_arg_string(kwargs, infile=vintbl)
             )
-            return lib.virtualfile_to_raster(
-                vfname=voutgrd, kind="grid", outgrid=outgrid
-            )
+            return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)
diff --git a/pygmt/src/sphdistance.py b/pygmt/src/sphdistance.py
@@ -117,6 +117,4 @@ def sphdistance(data=None, x=None, y=None, outgrid: str | None = None, **kwargs)
             lib.call_module(
                 module="sphdistance", args=build_arg_string(kwargs, infile=vintbl)
             )
-            return lib.virtualfile_to_raster(
-                vfname=voutgrd, kind="grid", outgrid=outgrid
-            )
+            return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)
diff --git a/pygmt/src/sphinterpolate.py b/pygmt/src/sphinterpolate.py
@@ -67,6 +67,4 @@ def sphinterpolate(data, outgrid: str | None = None, **kwargs):
             lib.call_module(
                 module="sphinterpolate", args=build_arg_string(kwargs, infile=vintbl)
             )
-            return lib.virtualfile_to_raster(
-                vfname=voutgrd, kind="grid", outgrid=outgrid
-            )
+            return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)
diff --git a/pygmt/src/surface.py b/pygmt/src/surface.py
@@ -161,6 +161,4 @@ def surface(data=None, x=None, y=None, z=None, outgrid: str | None = None, **kwa
             lib.call_module(
                 module="surface", args=build_arg_string(kwargs, infile=vintbl)
             )
-            return lib.virtualfile_to_raster(
-                vfname=voutgrd, kind="grid", outgrid=outgrid
-            )
+            return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)
diff --git a/pygmt/src/triangulate.py b/pygmt/src/triangulate.py
@@ -146,9 +146,7 @@ def regular_grid(
                 lib.call_module(
                     module="triangulate", args=build_arg_string(kwargs, infile=vintbl)
                 )
-                return lib.virtualfile_to_raster(
-                    vfname=voutgrd, kind="grid", outgrid=outgrid
-                )
+                return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)
 
     @staticmethod
     @fmt_docstring
diff --git a/pygmt/src/xyz2grd.py b/pygmt/src/xyz2grd.py
@@ -153,6 +153,4 @@ def xyz2grd(data=None, x=None, y=None, z=None, outgrid: str | None = None, **kwa
             lib.call_module(
                 module="xyz2grd", args=build_arg_string(kwargs, infile=vintbl)
             )
-            return lib.virtualfile_to_raster(
-                vfname=voutgrd, kind="grid", outgrid=outgrid
-            )
+            return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)

Original file line number	Diff line number	Diff line change
`@@ -111,6 +111,4 @@ def binstats(data, outgrid: str \| None = None, **kwargs):`
`111`	`111`	`lib.call_module(`
`112`	`112`	`module="binstats", args=build_arg_string(kwargs, infile=vintbl)`
`113`	`113`	`)`
`114`		`- return lib.virtualfile_to_raster(`
`115`		`- vfname=voutgrd, kind="grid", outgrid=outgrid`
`116`		`- )`
	`114`	`+ return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)`
Original file line number	Diff line number	Diff line change
`@@ -150,6 +150,4 @@ def dimfilter(grid, outgrid: str \| None = None, **kwargs):`
`150`	`150`	`lib.call_module(`
`151`	`151`	`module="dimfilter", args=build_arg_string(kwargs, infile=vingrd)`
`152`	`152`	`)`
`153`		`- return lib.virtualfile_to_raster(`
`154`		`- vfname=voutgrd, kind="grid", outgrid=outgrid`
`155`		`- )`
	`153`	`+ return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)`
Original file line number	Diff line number	Diff line change
`@@ -96,6 +96,4 @@ def grdclip(grid, outgrid: str \| None = None, **kwargs):`
`96`	`96`	`lib.call_module(`
`97`	`97`	`module="grdclip", args=build_arg_string(kwargs, infile=vingrd)`
`98`	`98`	`)`
`99`		`- return lib.virtualfile_to_raster(`
`100`		`- vfname=voutgrd, kind="grid", outgrid=outgrid`
`101`		`- )`
	`99`	`+ return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)`
Original file line number	Diff line number	Diff line change
`@@ -79,6 +79,4 @@ def grdfill(grid, outgrid: str \| None = None, **kwargs):`
`79`	`79`	`lib.call_module(`
`80`	`80`	`module="grdfill", args=build_arg_string(kwargs, infile=vingrd)`
`81`	`81`	`)`
`82`		`- return lib.virtualfile_to_raster(`
`83`		`- vfname=voutgrd, kind="grid", outgrid=outgrid`
`84`		`- )`
	`82`	`+ return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)`
Original file line number	Diff line number	Diff line change
`@@ -133,6 +133,4 @@ def grdfilter(grid, outgrid: str \| None = None, **kwargs):`
`133`	`133`	`lib.call_module(`
`134`	`134`	`module="grdfilter", args=build_arg_string(kwargs, infile=vingrd)`
`135`	`135`	`)`
`136`		`- return lib.virtualfile_to_raster(`
`137`		`- vfname=voutgrd, kind="grid", outgrid=outgrid`
`138`		`- )`
	`136`	`+ return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)`
Original file line number	Diff line number	Diff line change
`@@ -173,6 +173,4 @@ def grdgradient(grid, outgrid: str \| None = None, **kwargs):`
`173`	`173`	`lib.call_module(`
`174`	`174`	`module="grdgradient", args=build_arg_string(kwargs, infile=vingrd)`
`175`	`175`	`)`
`176`		`- return lib.virtualfile_to_raster(`
`177`		`- vfname=voutgrd, kind="grid", outgrid=outgrid`
`178`		`- )`
	`176`	`+ return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)`
Original file line number	Diff line number	Diff line change
`@@ -113,6 +113,4 @@ def grdproject(grid, outgrid: str \| None = None, **kwargs):`
`113`	`113`	`lib.call_module(`
`114`	`114`	`module="grdproject", args=build_arg_string(kwargs, infile=vingrd)`
`115`	`115`	`)`
`116`		`- return lib.virtualfile_to_raster(`
`117`		`- vfname=voutgrd, kind="grid", outgrid=outgrid`
`118`		`- )`
	`116`	`+ return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)`
Original file line number	Diff line number	Diff line change
`@@ -88,6 +88,4 @@ def grdsample(grid, outgrid: str \| None = None, **kwargs):`
`88`	`88`	`lib.call_module(`
`89`	`89`	`module="grdsample", args=build_arg_string(kwargs, infile=vingrd)`
`90`	`90`	`)`
`91`		`- return lib.virtualfile_to_raster(`
`92`		`- vfname=voutgrd, kind="grid", outgrid=outgrid`
`93`		`- )`
	`91`	`+ return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)`
Original file line number	Diff line number	Diff line change
`@@ -148,6 +148,4 @@ def nearneighbor(`
`148`	`148`	`lib.call_module(`
`149`	`149`	`module="nearneighbor", args=build_arg_string(kwargs, infile=vintbl)`
`150`	`150`	`)`
`151`		`- return lib.virtualfile_to_raster(`
`152`		`- vfname=voutgrd, kind="grid", outgrid=outgrid`
`153`		`- )`
	`151`	`+ return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)`
Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,4 @@ def sph2grd(data, outgrid: str \| None = None, **kwargs):`
`73`	`73`	`lib.call_module(`
`74`	`74`	`module="sph2grd", args=build_arg_string(kwargs, infile=vintbl)`
`75`	`75`	`)`
`76`		`- return lib.virtualfile_to_raster(`
`77`		`- vfname=voutgrd, kind="grid", outgrid=outgrid`
`78`		`- )`
	`76`	`+ return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)`