@@ -1741,7 +1741,7 @@ def read_virtualfile(
1741
1741
def return_table (
1742
1742
self ,
1743
1743
output_type : Literal ["pandas" , "numpy" , "file" ],
1744
- vfile : str ,
1744
+ vfile : str | None = None ,
1745
1745
column_names : list [str ] | None = None ,
1746
1746
) -> pd .DataFrame | np .ndarray | None :
1747
1747
"""
@@ -1750,16 +1750,21 @@ def return_table(
1750
1750
Parameters
1751
1751
----------
1752
1752
output_type
1753
- The output type. Valid values are ``"pandas"``, ``"numpy"``, or ``"file"``.
1753
+ Desired output type of the result data.
1754
+
1755
+ - ``"pandas"`` will return a :class:`pandas.DataFrame` object.
1756
+ - ``"numpy"`` will return a :class:`numpy.ndarray` object.
1757
+ - ``"file"`` means the result was saved to a file and will return ``None``.
1754
1758
vfile
1755
- The virtual file name.
1759
+ The virtual file name that stores the result data. Required for ``"pandas"``
1760
+ and ``"numpy"`` output type.
1756
1761
column_names
1757
1762
The column names for the :class:`pandas.DataFrame` output.
1758
1763
1759
1764
Returns
1760
1765
-------
1761
- :class:`pandas.DataFrame` or :class:`numpy.ndarray` or None
1762
- The output table. If ``output_type`` is `` "file"``, returns ``None``.
1766
+ table
1767
+ The output table. If ``output_type= "file"`` returns ``None``.
1763
1768
1764
1769
Examples
1765
1770
--------
@@ -1835,16 +1840,16 @@ def return_table(
1835
1840
"""
1836
1841
if output_type == "file" : # Already written to file, so return None
1837
1842
return None
1843
+
1838
1844
# Read the virtual file as a GMT dataset and convert to pandas.DataFrame
1839
1845
result = self .read_virtualfile (vfile , kind = "dataset" ).contents .to_dataframe ()
1846
+ if output_type == "numpy" : # numpy.ndarray output
1847
+ return result .to_numpy ()
1848
+
1840
1849
# Assign column names
1841
1850
if column_names is not None :
1842
1851
result .columns = column_names
1843
- # Pandas.DataFrame output
1844
- if output_type == "pandas" :
1845
- return result
1846
- # NumPy.ndarray output
1847
- return result .to_numpy ()
1852
+ return result # pandas.DataFrame output
1848
1853
1849
1854
def extract_region (self ):
1850
1855
"""
0 commit comments