Table of Contents

Within

a.Within(b) is true if a lies in b and the two share at least one interior point. It is the mirror of Contains: a.Within(b) equals b.Contains(a).

DE-9IM

T*F**F***: the interiors meet, and no part of a lies in the exterior of b.

In words: the interiors share something (T at II), and the interior and the boundary of a share nothing with the exterior of b (F at IE and BE): nothing of a lies outside b.

How to read a pattern: see Reading a pattern. The nine positions are II IB IE BI BB BE EI EB EE (interior, boundary and exterior of a against those of b); T = shares something, F = shares nothing, * = anything, 0/1/2 = shares exactly points, lines or areas.

Situations

a is the first and b the second geometry. Each row is a situation; the exact geometries are in Predicates.

Situation (a, b) a.Within(b) b.Within(a)
A point inside an area true false
A point on the edge of an area false false
A point outside an area false false
A point in a hole of an area false false
A point on a line (not at its end) true false
A point at the end of a line false false
A point at a bend (a vertex) inside a line true false
A point beside a line false false
Two equal points true true
Two lines that cross false false
Two lines that meet end to end false false
A line that ends on another line (a T) false false
Two lines that run together for a stretch false false
Two equal lines (one reversed) true true
A line inside an area true false
A line that crosses the edge of an area false false
A line along the edge of an area false false
A line outside an area that ends on its edge false false
A line outside an area false false
A small area inside a large one true false
An area inside another, touching its edge from inside true false
Two areas that share an edge false false
Two areas that touch at a corner false false
Two areas that overlap false false
Two equal areas (other start point and direction) true true
Two areas apart false false
An area inside a hole of another false false

Details

  • A point on the edge is not within an area. It lies on the boundary, not in the interior; CoveredBy says "inside or on the edge".
  • A point on a line is within it if it is not at an end: the ends are the boundary of the line ("A point on a line", "A point at the end of a line").
  • Equal geometries are within each other.
  • Empty geometries are within nothing.

With a tolerance

The predicate is exact to the last bit. To ask "close enough", with a tolerance t in the unit of your coordinates (for survey data 0.01 for 1 cm):

bool result = b.Buffer(t).Contains(a);

Buffer(t) grows the container by t on all sides. It is the expensive part; for many tests against the same geometry compute the buffer once and keep it.

The library has no global tolerance; see Exactness in practice.

See also

Contains, CoveredBy, Predicates and DE-9IM.