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

.. py:module:: radar.utils.animate.beam

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

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

Classes
~~~~~~~

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

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

API
~~~

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

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

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

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

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

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

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

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

   .. py:attribute:: X_RESOLUTION
      :canonical: radar.utils.animate.beam.Beam.X_RESOLUTION
      :type: int
      :value: 100

      .. autodoc2-docstring:: radar.utils.animate.beam.Beam.X_RESOLUTION

   .. py:attribute:: Y_RESOLUTION
      :canonical: radar.utils.animate.beam.Beam.Y_RESOLUTION
      :type: int
      :value: 100

      .. autodoc2-docstring:: radar.utils.animate.beam.Beam.Y_RESOLUTION

   .. py:method:: surface_3d(df: polars.DataFrame, position: numpy.typing.NDArray, direction_domain: radar.utils.typing.enums.DirectionDomain, phase_unit: radar.utils.typing.enums.PhaseUnit, amplitude_domain: radar.utils.typing.enums.AmplitudeDomain, amplitude_unit: radar.utils.typing.enums.AmplitudeUnit) -> manim.Surface
      :canonical: radar.utils.animate.beam.Beam.surface_3d
      :classmethod:

      .. autodoc2-docstring:: radar.utils.animate.beam.Beam.surface_3d

   .. py:method:: _df_to_surface(df: polars.DataFrame, position: numpy.typing.NDArray, direction_domain: radar.utils.typing.enums.DirectionDomain, phase_unit: radar.utils.typing.enums.PhaseUnit, amplitude_domain: radar.utils.typing.enums.AmplitudeDomain, amplitude_unit: radar.utils.typing.enums.AmplitudeUnit) -> manim.Surface
      :canonical: radar.utils.animate.beam.Beam._df_to_surface
      :classmethod:

      .. autodoc2-docstring:: radar.utils.animate.beam.Beam._df_to_surface

   .. py:method:: normalise(data: polars.DataFrame) -> polars.DataFrame
      :canonical: radar.utils.animate.beam.Beam.normalise
      :staticmethod:

      .. autodoc2-docstring:: radar.utils.animate.beam.Beam.normalise