pyinterp.core.geodetic.Box

class pyinterp.core.geodetic.Box

Bases: pybind11_builtins.pybind11_object

Defines a box made of two describing points.

__init__(*args, **kwargs)

Overloaded function.

  1. __init__(self: pyinterp.core.geodetic.Box) -> None

  2. __init__(self: pyinterp.core.geodetic.Box, min_corner: pyinterp.core.geodetic.Point, max_corner: pyinterp.core.geodetic.Point) -> None

Constructor taking the minimum corner point and the maximum corner point.

Parameters
  • min_corner (pyinterp.core.geodetic.Point2D) – the minimum corner point (lower left) of the box.

  • max_corner (pyinterp.core.geodetic.Point2D) – the maximum corner point (upper right) of the box.

Methods

Box.area(self[, wgs])

Calculates the area.

Box.covered_by(*args, **kwargs)

Overloaded function.

Box.distance(*args, **kwargs)

Overloaded function.

Box.read_wkt(wkt)

Parses OGC Well-Known Text (WKT) into a box.

Box.whole_earth()

Returns the box covering the whole earth.

Box.wkt(self)

Gets the OGC Well-Known Text (WKT) representation of this instance.

Box.__eq__(self, other)

Overrides the default behavior of the == operator.

Box.__getstate__(self)

Box.__hash__

Box.__ne__(self, other)

Overrides the default behavior of the != operator.

Box.__repr__(self)

Called by the repr() built-in function to compute the string representation of a box.

Box.__setstate__(self, arg0)

Attributes

Box.max_corner

The maximal corner (upper right) of the box.

Box.min_corner

The minimal corner (lower left) of the box.