Package pygeodesy :: Module units :: Class Radians |
[frames] | no frames]

# Class Radians

              object --+
                       |
                   float --+
                           |
          object --+       |
                   |       |
        named._Named --+   |
                       |   |
    unitsBase._NamedUnit --+
                           |
             unitsBase.Float --+
                               |
                              Radians

Known Subclasses:
  - Bearing_
  - , Lam
  - , Phi
  - , Radians_

Named `float` representing a coordinate in `radians`, optionally clipped.

Instance Methods
toDegrees(self) Convert `Radians` to `Degrees`. |
toRadians(self) Convert `Radians` to `Radians`. |
toRepr(self, std=False, **prec_fmt_ints) Return a representation of this `Radians`. |
toStr(self, prec=8, fmt=`'``f``'`, ints=False) Return this `Radians` as standard `str`. |
Inherited from `unitsBase.Float`: `__repr__`, `__str__` Inherited from `float`: `__abs__`, `__add__`, `__coerce__`, `__div__`, `__divmod__`, `__eq__`, `__float__`, `__floordiv__`, `__format__`, `__ge__`, `__getattribute__`, `__getformat__`, `__getnewargs__`, `__gt__`, `__hash__`, `__int__`, `__le__`, `__long__`, `__lt__`, `__mod__`, `__mul__`, `__ne__`, `__neg__`, `__nonzero__`, `__pos__`, `__pow__`, `__radd__`, `__rdiv__`, `__rdivmod__`, `__rfloordiv__`, `__rmod__`, `__rmul__`, `__rpow__`, `__rsub__`, `__rtruediv__`, `__setformat__`, `__sub__`, `__truediv__`, `__trunc__`, `as_integer_ratio`, `conjugate`, `fromhex`, `hex`, `is_integer` Inherited from `named._Named`: `__imatmul__`, `__matmul__`, `__rmatmul__`, `attrs`, `classof`, `copy`, `dup`, `methodname`, `rename`, `toStr2` Inherited from `object`: `__delattr__`, `__init__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__subclasshook__`

Static Methods
a new object with type S, a subtype of T |
__new__(cls, arg=None, name=`'``radians``'`, Error=<class 'pygeodesy.errors.UnitError'>, suffix=`'``NSEW``'`, clip=0, **name_arg) New `Radians` instance, see Float. |

Properties
Inherited from `float`: `imag`, `real` Inherited from `unitsBase._NamedUnit`: `std_repr`, `units` Inherited from `named._Named`: `classname`, `classnaming`, `iteration`, `name`, `named`, `named2`, `named3`, `named4` Inherited from `object`: `__class__`

Method Details

### __new__ (cls, arg=None, name=`'``radians``'`, Error=<class 'pygeodesy.errors.UnitError'>, suffix=`'``NSEW``'`, clip=0, **name_arg) Static Method |
New `Radians` instance, see Float. Arguments: `cls` - This class (`Radians` or sub-class). `arg` - The value (any `type` convertable to `float` or parsable by pygeodesy.parseRad). `name` - Optional instance name (`str`). `Error` - Optional error to raise, overriding the default UnitError. `suffix` - Optional, valid compass direction suffixes (`NSEW`). `clip` - Optional `arg` range `-clip..+clip` (`radians` or `0` or `None` for unclipped). `name_arg` - Optional `name=arg` keyword argument, inlieu of `name` and `arg`. Returns: a new object with type S, a subtype of T A `Radians` instance. Raises: `Error` - Invalid `arg` or `abs(arg)` outside the `clip` range and pygeodesy.rangerrors set to `True`. Overrides: object.__new__

### toRepr (self, std=False, **prec_fmt_ints) |
Return a representation of this `Radians`. Arguments: `std` - If `True` return the standard `repr`, otherwise the named representation (`bool`). Overrides: named._Named.toRepr See Also: Methods Radians.toStr, Float.toRepr and function pygeodesy.toDMS for more documentation.

### toStr (self, prec=8, fmt=`'``f``'`, ints=False) |
Return this `Radians` as standard `str`. Overrides: named._Named.toStr See Also: Function pygeodesy.fstr for keyword argument details.