Skip to content

[DOC]: Update userguide note on intersection #2933

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.

Sign up for GitHub

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

Merged
pelson merged 2 commits into from
Jan 11, 2018
Merged

[DOC]: Update userguide note on intersection #2933

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b7e146
Update userguide note on intersection
DPeterK Jan 11, 2018
2fc3646
Update with concrete boundary examples
DPeterK Jan 11, 2018
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: 6 additions & 5 deletions docs/iris/src/userguide/loading_iris_cubes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,12 +234,13 @@ then specific STASH codes can be filtered::
:class:`iris.Constraint` reference documentation.


Constraining across the dateline
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Constraining a circular coordinate across its boundary
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Occasionally you may need to constrain your cube with a region that crosses either
the dateline or the meridian. An example use-case of this is to extract the entire
Pacific Ocean from a cube whose longitudes are bounded by the dateline.
Occasionally you may need to constrain your cube with a region that crosses the
boundary of a circular coordinate (this is often the meridian or the dateline /
antimeridian). An example use-case of this is to extract the entire Pacific Ocean
from a cube whose longitudes are bounded by the dateline.

This functionality cannot be provided reliably using contraints. Instead you should use the
functionality provided by :meth:`cube.intersection <iris.cube.Cube.intersection>`
Expand Down