:py:mod:`radar.utils.typing.units`
==================================

.. py:module:: radar.utils.typing.units

.. autodoc2-docstring:: radar.utils.typing.units
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`Frequency <radar.utils.typing.units.Frequency>`
     - .. autodoc2-docstring:: radar.utils.typing.units.Frequency
          :summary:
   * - :py:obj:`Phase <radar.utils.typing.units.Phase>`
     - .. autodoc2-docstring:: radar.utils.typing.units.Phase
          :summary:
   * - :py:obj:`Distance <radar.utils.typing.units.Distance>`
     - .. autodoc2-docstring:: radar.utils.typing.units.Distance
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`Angle <radar.utils.typing.units.Angle>`
     - .. autodoc2-docstring:: radar.utils.typing.units.Angle
          :summary:
   * - :py:obj:`Length <radar.utils.typing.units.Length>`
     - .. autodoc2-docstring:: radar.utils.typing.units.Length
          :summary:

API
~~~

.. py:class:: Frequency(frequency: float, unit: radar.utils.typing.FrequencyUnit)
   :canonical: radar.utils.typing.units.Frequency

   .. autodoc2-docstring:: radar.utils.typing.units.Frequency

   .. rubric:: Initialization

   .. autodoc2-docstring:: radar.utils.typing.units.Frequency.__init__

   .. py:property:: Hz
      :canonical: radar.utils.typing.units.Frequency.Hz
      :type: float

      .. autodoc2-docstring:: radar.utils.typing.units.Frequency.Hz

   .. py:property:: KHz
      :canonical: radar.utils.typing.units.Frequency.KHz
      :type: float

      .. autodoc2-docstring:: radar.utils.typing.units.Frequency.KHz

   .. py:property:: MHz
      :canonical: radar.utils.typing.units.Frequency.MHz
      :type: float

      .. autodoc2-docstring:: radar.utils.typing.units.Frequency.MHz

   .. py:property:: GHz
      :canonical: radar.utils.typing.units.Frequency.GHz
      :type: float

      .. autodoc2-docstring:: radar.utils.typing.units.Frequency.GHz

   .. py:method:: __eq__(other: object) -> bool
      :canonical: radar.utils.typing.units.Frequency.__eq__

      .. autodoc2-docstring:: radar.utils.typing.units.Frequency.__eq__

   .. py:method:: __lt__(other: object) -> bool
      :canonical: radar.utils.typing.units.Frequency.__lt__

      .. autodoc2-docstring:: radar.utils.typing.units.Frequency.__lt__

.. py:class:: Phase(phase: float, unit: radar.utils.typing.PhaseUnit)
   :canonical: radar.utils.typing.units.Phase

   .. autodoc2-docstring:: radar.utils.typing.units.Phase

   .. rubric:: Initialization

   .. autodoc2-docstring:: radar.utils.typing.units.Phase.__init__

   .. py:property:: deg
      :canonical: radar.utils.typing.units.Phase.deg
      :type: float

      .. autodoc2-docstring:: radar.utils.typing.units.Phase.deg

   .. py:property:: rad
      :canonical: radar.utils.typing.units.Phase.rad
      :type: float

      .. autodoc2-docstring:: radar.utils.typing.units.Phase.rad

   .. py:method:: __eq__(other: object) -> bool
      :canonical: radar.utils.typing.units.Phase.__eq__

      .. autodoc2-docstring:: radar.utils.typing.units.Phase.__eq__

   .. py:method:: __lt__(other: object) -> bool
      :canonical: radar.utils.typing.units.Phase.__lt__

      .. autodoc2-docstring:: radar.utils.typing.units.Phase.__lt__

   .. py:method:: __hash__() -> int
      :canonical: radar.utils.typing.units.Phase.__hash__

      .. autodoc2-docstring:: radar.utils.typing.units.Phase.__hash__

.. py:data:: Angle
   :canonical: radar.utils.typing.units.Angle
   :value: None

   .. autodoc2-docstring:: radar.utils.typing.units.Angle

.. py:class:: Distance(value: float, unit: radar.utils.typing.DistanceUnit)
   :canonical: radar.utils.typing.units.Distance

   .. autodoc2-docstring:: radar.utils.typing.units.Distance

   .. rubric:: Initialization

   .. autodoc2-docstring:: radar.utils.typing.units.Distance.__init__

   .. py:property:: m
      :canonical: radar.utils.typing.units.Distance.m
      :type: float

      .. autodoc2-docstring:: radar.utils.typing.units.Distance.m

   .. py:property:: km
      :canonical: radar.utils.typing.units.Distance.km
      :type: float

      .. autodoc2-docstring:: radar.utils.typing.units.Distance.km

   .. py:property:: miles
      :canonical: radar.utils.typing.units.Distance.miles
      :type: float

      .. autodoc2-docstring:: radar.utils.typing.units.Distance.miles

   .. py:property:: ft
      :canonical: radar.utils.typing.units.Distance.ft
      :type: float

      .. autodoc2-docstring:: radar.utils.typing.units.Distance.ft

   .. py:method:: __eq__(other: object) -> bool
      :canonical: radar.utils.typing.units.Distance.__eq__

      .. autodoc2-docstring:: radar.utils.typing.units.Distance.__eq__

   .. py:method:: __lt__(other: object) -> bool
      :canonical: radar.utils.typing.units.Distance.__lt__

      .. autodoc2-docstring:: radar.utils.typing.units.Distance.__lt__

   .. py:method:: __repr__() -> str
      :canonical: radar.utils.typing.units.Distance.__repr__

      .. autodoc2-docstring:: radar.utils.typing.units.Distance.__repr__

.. py:data:: Length
   :canonical: radar.utils.typing.units.Length
   :value: None

   .. autodoc2-docstring:: radar.utils.typing.units.Length