Package pygeodesy :: Module namedTuples :: Class Bounds4Tuple

Class Bounds4Tuple

   object --+        
            |        
        tuple --+    
                |    
   object --+   |    
            |   |    
 named._Named --+    
                |    
named._NamedTuple --+
                    |
                   Bounds4Tuple

4-Tuple (latS, lonW, latN, lonE) with the bounds' lower-left (LatS, LonW) and upper-right (latN, lonE) corner lat- and longitudes.

Instance Methods

enclosures(self, S_other, *W_N_E, **name)
Get the enclosures of this around an other Bounds4Tuple.

isinside(self, lat, lon, eps=0)
Are lat and lon both inside these bounds?

overlap(self, S_other, *W_N_E, **name)
Intersect this with an other Bounds4Tuple.

resize(self, eps)
Get these bounds, over- or undersize by eps.

union(self, S_other, *W_N_E, **name)
Union of this and an other Bounds4Tuple.

Inherited from named._NamedTuple: __delattr__, __getattr__, __hash__, __repr__, __setattr__, __str__, dup, items, iteritems, iterunits, reUnit, toRepr, toStr, toUnits, units

Inherited from tuple: __add__, __contains__, __eq__, __ge__, __getattribute__, __getitem__, __getnewargs__, __getslice__, __gt__, __iter__, __le__, __len__, __lt__, __mul__, __ne__, __rmul__, count, index

Inherited from named._Named: __format__, __imatmul__, __matmul__, __rmatmul__, attrs, classof, copy, methodname, rename, renamed, toStr2

Inherited from object: __init__, __reduce__, __reduce_ex__, __sizeof__, __subclasshook__

Static Methods
Inherited from `named._NamedTuple`: `__new__`

Properties
	latC Get the center latitude (`degrees`).
	latZ Get the latitudinal size (`degrees`).
	lonC Get the center longitude (`degrees`).
	lonZ Get the longitudinal size (`degrees`).
Inherited from `named._Named`: `classname`, `classnaming`, `iteration`, `name`, `named`, `named2`, `named3`, `named4`, `sizeof`, `typename` Inherited from `object`: `__class__`

Method Details

enclosures (self, S_other, *W_N_E, **name)

Get the enclosures of this around an other Bounds4Tuple.

Arguments:

S_other - Bottom latS (scalar) or an other Bounds4Tuple instance.
W_N_E - Left lonW, top latN and right lonE, each a (scalar) for scalar S_other.

Returns:

A Bounds4Tuple with the margin at each of the 4 sides, positive if this side encloses (is on the outside of) the other, negative if not or zero if abutting.

isinside (self, lat, lon, eps=0)

Are lat and lon both inside these bounds?

Arguments:

lat - Latitude (degrees, scalar or str).
lon - Longitude (degrees, scalar or str).
eps - Over-/undersize the RD bounds (degrees).

Returns:

None if lat or lon is NAN, False if outside these bounds, True otherwise.

overlap (self, S_other, *W_N_E, **name)

Intersect this with an other Bounds4Tuple.

Arguments:

S_other - Bottom latS (scalar) or an other Bounds4Tuple instance.
W_N_E - Left lonW, top latN and right lonE, each a (scalar) for scalar S_other.

Returns:

None if the bounds do not overlap, otherwise the intersection of both as a Bounds4Tuple.

resize (self, eps)

Get these bounds, over- or undersize by eps.

Arguments:

eps - In- or decrease (degrees).

Returns:

A Bounds4Tuple

(latS, lonW, latN, 
          lonE)

with all 4 bounds resized.

union (self, S_other, *W_N_E, **name)

Union of this and an other Bounds4Tuple.

Arguments:

S_other - Bottom latS (scalar) or an other Bounds4Tuple instance.
W_N_E - Left lonW, top latN and right lonE, each a (scalar) for scalar S_other.

Returns:

The union a Bounds4Tuple.

Property Details

latC

Get the center latitude (degrees).

Get method:: latC(self) - Get the center latitude (degrees).
Set method:: _fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:: _fdel(inst) - Zap the cached/memoized property value.

latZ

Get the latitudinal size (degrees).

Get method:: latZ(self) - Get the latitudinal size (degrees).
Set method:: _fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:: _fdel(inst) - Zap the cached/memoized property value.

lonC

Get the center longitude (degrees).

Get method:: lonC(self) - Get the center longitude (degrees).
Set method:: _fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:: _fdel(inst) - Zap the cached/memoized property value.

lonZ

Get the longitudinal size (degrees).

Get method:: lonZ(self) - Get the longitudinal size (degrees).
Set method:: _fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:: _fdel(inst) - Zap the cached/memoized property value.