:py:mod:`radar.utils.plotter.beam`
==================================

.. py:module:: radar.utils.plotter.beam

.. autodoc2-docstring:: radar.utils.plotter.beam
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`BeamInterface <radar.utils.plotter.beam.BeamInterface>`
     - .. autodoc2-docstring:: radar.utils.plotter.beam.BeamInterface
          :summary:
   * - :py:obj:`Beam <radar.utils.plotter.beam.Beam>`
     - .. autodoc2-docstring:: radar.utils.plotter.beam.Beam
          :summary:

API
~~~

.. py:class:: BeamInterface
   :canonical: radar.utils.plotter.beam.BeamInterface

   Bases: :py:obj:`abc.ABC`

   .. autodoc2-docstring:: radar.utils.plotter.beam.BeamInterface

   .. py:method:: beam(direction_domain: radar.utils.typing.DirectionDomain, phase_unit: radar.utils.typing.enums.PhaseUnit, amplitude_domain: radar.utils.typing.AmplitudeDomain, amplitude_unit: radar.utils.typing.AmplitudeUnit, figure_type: radar.utils.typing.FigureType, frequency: radar.utils.typing.units.Frequency, steer: tuple[radar.utils.typing.units.Angle, radar.utils.typing.units.Angle] | None = None) -> None
      :canonical: radar.utils.plotter.beam.BeamInterface.beam
      :abstractmethod:

      .. autodoc2-docstring:: radar.utils.plotter.beam.BeamInterface.beam

   .. py:attribute:: __slots__
      :canonical: radar.utils.plotter.beam.BeamInterface.__slots__
      :value: ()

.. py:class:: Beam
   :canonical: radar.utils.plotter.beam.Beam

   .. autodoc2-docstring:: radar.utils.plotter.beam.Beam

   .. py:attribute:: FIGURE_WIDTH
      :canonical: radar.utils.plotter.beam.Beam.FIGURE_WIDTH
      :value: 800

      .. autodoc2-docstring:: radar.utils.plotter.beam.Beam.FIGURE_WIDTH

   .. py:attribute:: FIGURE_HEIGHT
      :canonical: radar.utils.plotter.beam.Beam.FIGURE_HEIGHT
      :value: 800

      .. autodoc2-docstring:: radar.utils.plotter.beam.Beam.FIGURE_HEIGHT

   .. py:attribute:: DISPLAY_GRID_PIXELS
      :canonical: radar.utils.plotter.beam.Beam.DISPLAY_GRID_PIXELS
      :value: 100

      .. autodoc2-docstring:: radar.utils.plotter.beam.Beam.DISPLAY_GRID_PIXELS

   .. py:method:: _plot_beam(df: polars.DataFrame, direction_domain: radar.utils.typing.DirectionDomain, phase_unit: radar.utils.typing.enums.PhaseUnit, amplitude_domain: radar.utils.typing.AmplitudeDomain, amplitude_unit: radar.utils.typing.AmplitudeUnit, figure_type: radar.utils.typing.FigureType) -> None
      :canonical: radar.utils.plotter.beam.Beam._plot_beam
      :classmethod:

      .. autodoc2-docstring:: radar.utils.plotter.beam.Beam._plot_beam

   .. py:method:: _xy_units(direction_domain: radar.utils.typing.DirectionDomain, phase_unit: radar.utils.typing.enums.PhaseUnit) -> tuple[str, str]
      :canonical: radar.utils.plotter.beam.Beam._xy_units
      :staticmethod:

      .. autodoc2-docstring:: radar.utils.plotter.beam.Beam._xy_units

   .. py:method:: _beam_slice(df: polars.DataFrame, direction_domain: radar.utils.typing.DirectionDomain, phase_unit: radar.utils.typing.enums.PhaseUnit, amplitude_domain: radar.utils.typing.AmplitudeDomain, amplitude_unit: radar.utils.typing.AmplitudeUnit) -> None
      :canonical: radar.utils.plotter.beam.Beam._beam_slice
      :classmethod:

      .. autodoc2-docstring:: radar.utils.plotter.beam.Beam._beam_slice

   .. py:method:: _beam_image(df: polars.DataFrame, direction_domain: radar.utils.typing.DirectionDomain, phase_unit: radar.utils.typing.enums.PhaseUnit, amplitude_domain: radar.utils.typing.AmplitudeDomain, amplitude_unit: radar.utils.typing.AmplitudeUnit) -> None
      :canonical: radar.utils.plotter.beam.Beam._beam_image
      :classmethod:

      .. autodoc2-docstring:: radar.utils.plotter.beam.Beam._beam_image

   .. py:method:: _beam_surface(df: polars.DataFrame, direction_domain: radar.utils.typing.DirectionDomain, phase_unit: radar.utils.typing.enums.PhaseUnit, amplitude_domain: radar.utils.typing.AmplitudeDomain, amplitude_unit: radar.utils.typing.AmplitudeUnit) -> None
      :canonical: radar.utils.plotter.beam.Beam._beam_surface
      :classmethod:

      .. autodoc2-docstring:: radar.utils.plotter.beam.Beam._beam_surface