Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make extract_volume work with closed and mixed intervals and allow nearest value selection #1930

Merged
merged 19 commits into from
Mar 1, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions doc/recipe/preprocessor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1879,9 +1879,14 @@ The ``_volume.py`` module contains the following preprocessor functions:
------------------

Extract a specific range in the `z`-direction from a cube. The range is given as an interval
that can be open ``(z_min, z_max)``, closed ``[z_min, z_max]``, left closed ``[z_min, z_max)``
or right closed ``(z_min, z_max]``. The extraction is performed by applying a constraint on the
coordinate values, without any kind of interpolation.
that can be:

* open ``(z_min, z_max)``, in which the extracted range does not includes ``z_min`` nor ``z_max``.
* closed ``[z_min, z_max]``, in which the extracted includes both ``z_min`` and ``z_max``.
* left closed ``[z_min, z_max)``, in which the extracted range includes ``z_min`` but not ``z_max``.
* right closed ``(z_min, z_max]``, in which the extracted range includes ``z_max`` but not ``z_min``.

The extraction is performed by applying a constraint on the coordinate values, without any kind of interpolation.

This function takes four arguments:

Expand Down