Skip to content

Commit

Permalink
DOC: fixup of documentation for Cube.compute_attributes_in_window() m…
Browse files Browse the repository at this point in the history
…ethod
  • Loading branch information
jcrivenaes committed Sep 13, 2024
1 parent f7f9613 commit 175ae07
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions src/xtgeo/cube/cube1.py
Original file line number Diff line number Diff line change
Expand Up @@ -670,7 +670,7 @@ def compute_attributes_in_window(
The attributes are computed vertically (per column) within a window defined by
the two input surfaces and/or levels.
The statistical can be min, max, mean, variance etc. A complete list of
The statistical measures can be min, max, mean, variance etc. A complete list of
supported attributes is given below.
* 'max' for maximum
Expand Down Expand Up @@ -711,8 +711,7 @@ def compute_attributes_in_window(
using 0.1 of cube Z increment as basis. A higher ndiv will increase
CPU time and memory usage, but also increase the precision of the
result.
interpolation: 'linear', 'cubic' or other interpolators given in
:meth:`scipy.interpolate.interp1d()` ``kind`` for interpolation of the
interpolation: 'cubic' or 'linear' for interpolation of the
seismic signal, default here is 'cubic'.
minimum_thickness: Minimum thickness (isochore or isochron) between the
two surfaces. If the thickness is less or equal than this value,
Expand All @@ -724,7 +723,7 @@ def compute_attributes_in_window(
>>> cube = xtgeo.cube_from_file("mycube.segy")
>>> surf = xtgeo.surface_from_file("topreek.gri")
>>> # sample in a total range of 30 m, 15 units above and 15 units below:
>>> attrs = cube.attributes_between surfaces((surf-15), (surf + 15))
>>> attrs = cube.compute_attributes_in_window((surf-15), (surf + 15))
>>> attrs["max"].to_file("max.gri") # save the 'max' attribute to file
Note:
Expand Down

0 comments on commit 175ae07

Please sign in to comment.