|
26 | 26 | @kwargs_to_strings(C="sequence", R="sequence")
|
27 | 27 | def grdvolume(grid, output_type="pandas", outfile=None, **kwargs):
|
28 | 28 | r"""
|
29 |
| - Determine the volume between the surface of a grid and a plane. |
| 29 | + Determine the volume between the surface of a grid and a plane. |
30 | 30 |
|
31 |
| - Read a 2-D grid file and calculate the volume contained below the surface |
32 |
| - and above the plane specified by the given contour (or zero if not given) |
33 |
| - and return the contour, area, volume, and maximum mean height |
34 |
| - (volume/area). Alternatively, a range of contours can be specified to |
35 |
| - return the volume and area inside the contour for all contour values. |
36 |
| - Using **-T**, the contour that produced the maximum mean height |
37 |
| - (or maximum curvature of heights vs contour value) is returned as well. |
| 31 | + Read a 2-D grid file and calculate the volume contained below the surface |
| 32 | + and above the plane specified by the given contour (or zero if not given) |
| 33 | + and return the contour, area, volume, and maximum mean height |
| 34 | + (volume/area). Alternatively, a range of contours can be specified to |
| 35 | + return the volume and area inside the contour for all contour values. |
| 36 | + Using **-T**, the contour that produced the maximum mean height |
| 37 | + (or maximum curvature of heights vs contour value) is returned as well. |
38 | 38 |
|
39 |
| - {aliases} |
| 39 | + {aliases} |
40 | 40 |
|
41 |
| - Parameters |
42 |
| - ---------- |
43 |
| - grid : str or xarray.DataArray |
44 |
| - The file name of the input grid or the grid loaded as a DataArray. |
45 |
| - This is the only required parameter. |
46 |
| - output_type : str |
47 |
| - Determine the format the xyz data will be returned in [Default is |
48 |
| - ``pandas``]: |
49 |
| - - ``numpy`` - :class:`numpy.ndarray` |
50 |
| - - ``pandas``- :class:`pandas.DataFrame` |
51 |
| - - ``file`` - ASCII file (requires ``outfile``) |
52 |
| - outfile : str |
53 |
| - The file name for the output ASCII file. |
54 |
| - {R} |
55 |
| - {V} |
| 41 | + Parameters |
| 42 | + ---------- |
| 43 | + grid : str or xarray.DataArray |
| 44 | + The file name of the input grid or the grid loaded as a DataArray. |
| 45 | + This is the only required parameter. |
| 46 | + output_type : str |
| 47 | + Determine the format the xyz data will be returned in [Default is |
| 48 | + ``pandas``]: |
| 49 | + - ``numpy`` - :class:`numpy.ndarray` |
| 50 | + - ``pandas``- :class:`pandas.DataFrame` |
| 51 | + - ``file`` - ASCII file (requires ``outfile``) |
| 52 | + outfile : str |
| 53 | + The file name for the output ASCII file. |
| 54 | + {R} |
| 55 | + {V} |
56 | 56 |
|
57 |
| - Returns |
58 |
| - ------- |
59 |
| - ret : pandas.DataFrame or numpy.ndarray or None |
60 |
| - Return type depends on ``outfile`` and ``output_type``: |
61 |
| - - None if ``outfile`` is set (output will be stored in file set by |
62 |
| - ``outfile``) |
63 |
| - - :class:`pandas.DataFrame` or :class:`numpy.ndarray` if ``outfile`` is |
64 |
| - not set (depends on ``output_type`` [Default is |
65 |
| - :class:`pandas.DataFrame`]) |
| 57 | + Returns |
| 58 | + ------- |
| 59 | + ret : pandas.DataFrame or numpy.ndarray or None |
| 60 | + Return type depends on ``outfile`` and ``output_type``: |
| 61 | + - None if ``outfile`` is set (output will be stored in file set by |
| 62 | + ``outfile``) |
| 63 | + - :class:`pandas.DataFrame` or :class:`numpy.ndarray` if ``outfile`` |
| 64 | + is not set (depends on ``output_type`` [Default is |
| 65 | + :class:`pandas.DataFrame`]) |
66 | 66 |
|
67 | 67 | """
|
68 | 68 | if output_type not in ["numpy", "pandas", "file"]:
|
|
0 commit comments