Package pygeodesy :: Module rhumbx :: Class RhumbLine
[frames] | no frames]

Class RhumbLine

  object --+                    
           |                    
named._Named --+                
               |                
named._NamedBase --+            
                   |            
    karney._CapsBase --+        
                       |        
     rhumbBase.RhumbBase --+    
                           |    
     rhumbBase.RhumbLineBase --+
                               |
                              RhumbLine

Compute one or several points on a single rhumb line.

Class RhumbLine facilitates the determination of points on a single rhumb line. The starting point (lat1, lon1) and the azimuth azi12 are specified once.

Method RhumbLine.Position returns the location of an other point at distance s12 along and the area S12 under the rhumb line.

Method RhumbLine.intersection2 finds the intersection between two rhumb lines.

Method RhumbLine.nearestOn4 computes the nearest point on and the distance to a rhumb line in different ways.

Instance Methods
 
__init__(self, rhumb, lat1=0, lon1=0, azi12=None, **caps_name)
New rhumbx.RhumbLine.
 
Position(self, s12, outmask=384)
Compute a point at a given distance on this rhumb line.

Inherited from rhumbBase.RhumbLineBase: __del__, distance2, intersection2, nearestOn4, toStr

Inherited from rhumbBase.RhumbBase: Direct, Direct8, DirectLine, Inverse, Inverse8, InverseLine, Line

Inherited from karney._CapsBase: caps_

Inherited from named._NamedBase: __repr__, __str__, others, toRepr

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

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Class Variables

Inherited from karney._CapsBase: ALL, AREA, AZIMUTH, DISTANCE, DISTANCE_IN, EMPTY, GEODESICSCALE, LATITUDE, LINE_OFF, LONGITUDE, LONG_UNROLL, REDUCEDLENGTH, STANDARD

Properties
  RAorder
Get this rhumb line's Rhumb Area order (int, 4, 5, 6, 7 or 8).

Inherited from rhumbBase.RhumbLineBase: TMorder, azi12, azi12_sincos2, ellipsoid, exact, isLoxodrome, lat1, latlon1, lon1, rhumb, xTM

Inherited from rhumbBase.RhumbBase: a, b, equatoradius, f, f_max, flattening, polaradius

Inherited from karney._CapsBase: caps, debug

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

Inherited from object: __class__

Method Details

__init__ (self, rhumb, lat1=0, lon1=0, azi12=None, **caps_name)
(Constructor)

 

New rhumbx.RhumbLine.

Arguments:
  • rhumb - The rhumb reference (rhumbx.Rhumb).
  • lat1 - Latitude of the start point (degrees90).
  • lon1 - Longitude of the start point (degrees180).
  • azi12 - Azimuth of this rhumb line (compass degrees).
  • caps_name - Optional keyword arguments name=NN and caps=0, a bit-or'ed combination of Caps values specifying the required capabilities. Include Caps.LINE_OFF if updates to the rhumb should not be reflected in this rhumb line.
Overrides: object.__init__

Position (self, s12, outmask=384)

 

Compute a point at a given distance on this rhumb line.

Arguments:
  • s12 - The distance along this rhumb between its point and the other point (meters), can be negative.
  • outmask - Bit-or'ed combination of Caps values specifying the quantities to be returned.
Returns:
GDict with 4 to 8 items azi12, a12, s12, S12, lat2, lon2, lat1, lon1 with latitude lat2 and longitude lon2 of the point in degrees, the rhumb angle a12 in degrees from the start point of and the area S12 under this rhumb line in meter squared.
Overrides: rhumbBase.RhumbLineBase.Position

Note: If s12 is large enough that the rhumb line crosses a pole, the longitude of the second point is indeterminate and NAN is returned for lon2 and area S12.

If the first point is a pole, the cosine of its latitude is taken to be sqrt(EPS). This position is extremely close to the actual pole and allows the calculation to be carried out in finite terms.


Property Details

RAorder

Get this rhumb line's Rhumb Area order (int, 4, 5, 6, 7 or 8).

Get method:
RAorder(self) - Get this rhumb line's Rhumb Area order (int, 4, 5, 6, 7 or 8).
Set method:
_fset_error(inst, val) - Throws an AttributeError, always.
Delete Method:
_fdel(inst) - Zap the cached/memoized property value.