Package pygeodesy :: Module namedTuples :: Class NearestOn6Tuple
[frames] | no frames]

Class NearestOn6Tuple

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

6-Tuple (closest, distance, fi, j, start, end) with the closest point, the distance in meter, conventionally and the start and end point of the path or polygon edge. Fractional index fi (an FIx instance) and index j indicate the path or polygon edge and the fraction along that edge with the closest point. The start and end points may differ from the given path or polygon points at indices fi respectively j, when unrolled (wrap is True). Also, the start and/or end point may be the same instance as the closest point, for example when the very first path or polygon point is the nearest.

Instance Methods

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

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

Inherited from named._Named: _DOT_, attrs, classof, copy, rename, toStr2

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

Static Methods

Inherited from named._NamedTuple: __new__

Class Variables
  _Names_ = ('closest', 'distance', 'fi', 'j', 'start', 'end')
Tuple specifying the name of each Named-Tuple item.
  _Units_ = _Pass, Meter, FIx, Number_, _Pass, _Pass
Tuple defining the units of the value of each Named-Tuple item.
Properties

Inherited from named._NamedTuple: iteration

Inherited from named._Named: classname, classnaming, name, named, named2, named3, named4

Inherited from object: __class__

Class Variable Details

_Names_

Tuple specifying the name of each Named-Tuple item.

Note: Specify at least 2 item names.

Value:
('closest', 'distance', 'fi', 'j', 'start', 'end')

_Units_

Tuple defining the units of the value of each Named-Tuple item.

Note: The len(_Units_) must match len(_Names_).

Value:
_Pass, Meter, FIx, Number_, _Pass, _Pass