osbng.bng_reference.BNGReference.bng_is_neighbour

BNGReference.bng_is_neighbour(bng_ref2: BNGReference) → bool

Tests whether bng_ref2 is a neighbour of this BNGReference.

Neighbours are defined as grid squares that share an edge with this BNGReference object.

Parameters:

• bng_ref2 (BNGReference) – A BNGReference object

• .

Returns:

True if the two BNGReference objects are neighbours, otherwise False.

Return type:

bool

Raises:

• TypeError – If the bng_ref2 argument is not a

• BNGReference –

• BNGNeighbourError – If the BNGReference object

• is not at the same resolution. –

Examples

>>> BNGReference("SE1921").bng_is_neighbour(BNGReference("SE1821"))
True
>>> BNGReference("SE1922").bng_is_neighbour(BNGReference("SE1821"))
False
>>> BNGReference("SU1234").bng_is_neighbour(BNGReference("SU1234"))
False

See also

The equivalent osbng.traversal.bng_is_neighbour() function.