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

.. py:module:: radar.utils.typing.constants

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

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

Classes
~~~~~~~

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

   * - :py:obj:`RadarConstants <radar.utils.typing.constants.RadarConstants>`
     - .. autodoc2-docstring:: radar.utils.typing.constants.RadarConstants
          :summary:
   * - :py:obj:`DataHeader <radar.utils.typing.constants.DataHeader>`
     - .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader
          :summary:

API
~~~

.. py:class:: RadarConstants
   :canonical: radar.utils.typing.constants.RadarConstants

   .. autodoc2-docstring:: radar.utils.typing.constants.RadarConstants

   .. py:attribute:: c
      :canonical: radar.utils.typing.constants.RadarConstants.c
      :value: 299792458

      .. autodoc2-docstring:: radar.utils.typing.constants.RadarConstants.c

   .. py:attribute:: to_rad
      :canonical: radar.utils.typing.constants.RadarConstants.to_rad
      :value: None

      .. autodoc2-docstring:: radar.utils.typing.constants.RadarConstants.to_rad

   .. py:attribute:: to_deg
      :canonical: radar.utils.typing.constants.RadarConstants.to_deg
      :value: None

      .. autodoc2-docstring:: radar.utils.typing.constants.RadarConstants.to_deg

.. py:class:: DataHeader
   :canonical: radar.utils.typing.constants.DataHeader

   .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader

   .. py:attribute:: AZIMUTH_RAD
      :canonical: radar.utils.typing.constants.DataHeader.AZIMUTH_RAD
      :value: 'az_rad'

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.AZIMUTH_RAD

   .. py:attribute:: AZIMUTH_DEG
      :canonical: radar.utils.typing.constants.DataHeader.AZIMUTH_DEG
      :value: 'az_deg'

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.AZIMUTH_DEG

   .. py:attribute:: ELEVATION_RAD
      :canonical: radar.utils.typing.constants.DataHeader.ELEVATION_RAD
      :value: 'el_rad'

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.ELEVATION_RAD

   .. py:attribute:: ELEVATION_DEG
      :canonical: radar.utils.typing.constants.DataHeader.ELEVATION_DEG
      :value: 'el_deg'

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.ELEVATION_DEG

   .. py:attribute:: BEAM_GAIN_DB
      :canonical: radar.utils.typing.constants.DataHeader.BEAM_GAIN_DB
      :value: 'beam_gain_db'

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.BEAM_GAIN_DB

   .. py:attribute:: BEAM_GAIN_LINEAR
      :canonical: radar.utils.typing.constants.DataHeader.BEAM_GAIN_LINEAR
      :value: 'beam_gain_lin'

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.BEAM_GAIN_LINEAR

   .. py:attribute:: X_POS_M
      :canonical: radar.utils.typing.constants.DataHeader.X_POS_M
      :value: 'x_m'

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.X_POS_M

   .. py:attribute:: Y_POS_M
      :canonical: radar.utils.typing.constants.DataHeader.Y_POS_M
      :value: 'y_m'

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.Y_POS_M

   .. py:attribute:: ANTENNA_FACTOR_DB
      :canonical: radar.utils.typing.constants.DataHeader.ANTENNA_FACTOR_DB
      :value: 'af_db'

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.ANTENNA_FACTOR_DB

   .. py:attribute:: ANTENNA_FACTOR_LINEAR
      :canonical: radar.utils.typing.constants.DataHeader.ANTENNA_FACTOR_LINEAR
      :value: 'af_lin'

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.ANTENNA_FACTOR_LINEAR

   .. py:attribute:: U
      :canonical: radar.utils.typing.constants.DataHeader.U
      :value: 'u'

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.U

   .. py:attribute:: V
      :canonical: radar.utils.typing.constants.DataHeader.V
      :value: 'v'

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.V

   .. py:attribute:: UV_MASK
      :canonical: radar.utils.typing.constants.DataHeader.UV_MASK
      :value: 'uv_mask'

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.UV_MASK

   .. py:attribute:: FREQ_GAIN_DB
      :canonical: radar.utils.typing.constants.DataHeader.FREQ_GAIN_DB
      :value: 'freq_gain_db'

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.FREQ_GAIN_DB

   .. py:attribute:: FREQ_GAIN_LINEAR
      :canonical: radar.utils.typing.constants.DataHeader.FREQ_GAIN_LINEAR
      :value: 'freq_gain_lin'

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.FREQ_GAIN_LINEAR

   .. py:attribute:: FREQ_FREQS
      :canonical: radar.utils.typing.constants.DataHeader.FREQ_FREQS
      :value: 'freq_freqs'

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.FREQ_FREQS

   .. py:attribute:: GEOM_AMP_GAIN_DB
      :canonical: radar.utils.typing.constants.DataHeader.GEOM_AMP_GAIN_DB
      :value: 'Element Amplifier Gain (Decibel)'

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.GEOM_AMP_GAIN_DB

   .. py:attribute:: GEOM_AMP_GAIN_LIN
      :canonical: radar.utils.typing.constants.DataHeader.GEOM_AMP_GAIN_LIN
      :value: 'Element Amplifier Gain (Linear)'

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.GEOM_AMP_GAIN_LIN

   .. py:attribute:: GEOM_PHASE_SHIFTER_PHASE_RAD
      :canonical: radar.utils.typing.constants.DataHeader.GEOM_PHASE_SHIFTER_PHASE_RAD
      :value: 'Element Phase Shifter Phase (Radian)'

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.GEOM_PHASE_SHIFTER_PHASE_RAD

   .. py:attribute:: GEOM_PHASE_SHIFTER_PHASE_DEG
      :canonical: radar.utils.typing.constants.DataHeader.GEOM_PHASE_SHIFTER_PHASE_DEG
      :value: 'Element Phase Shifter Phase (Degree)'

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.GEOM_PHASE_SHIFTER_PHASE_DEG

   .. py:method:: direction_domain_headers(domain: radar.utils.typing.enums.DirectionDomain, phase_unit: radar.utils.typing.enums.PhaseUnit) -> tuple[str, str]
      :canonical: radar.utils.typing.constants.DataHeader.direction_domain_headers
      :staticmethod:

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader.direction_domain_headers

   .. py:method:: _amplitude_domain_headers(domain: radar.utils.typing.enums.AmplitudeDomain, amplitude_unit: radar.utils.typing.enums.AmplitudeUnit) -> str
      :canonical: radar.utils.typing.constants.DataHeader._amplitude_domain_headers
      :staticmethod:

      .. autodoc2-docstring:: radar.utils.typing.constants.DataHeader._amplitude_domain_headers