:py:mod:`radar.components.element`
==================================

.. py:module:: radar.components.element

.. autodoc2-docstring:: radar.components.element
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`Element <radar.components.element.Element>`
     - .. autodoc2-docstring:: radar.components.element.Element
          :summary:

API
~~~

.. py:class:: Element(pattern: radar.utils.calculate.pattern.Pattern, az: radar.utils.typing.AngleBound, el: radar.utils.typing.AngleBound, frequency_response: radar.components.response.FrequencyResponse | radar.utils.typing.units.Frequency, over_sample_factor: int = 1)
   :canonical: radar.components.element.Element

   .. autodoc2-docstring:: radar.components.element.Element

   .. rubric:: Initialization

   .. autodoc2-docstring:: radar.components.element.Element.__init__

   .. py:method:: beam_pattern(freq: radar.utils.typing.units.Frequency) -> polars.DataFrame
      :canonical: radar.components.element.Element.beam_pattern

      .. autodoc2-docstring:: radar.components.element.Element.beam_pattern

   .. py:property:: azimuth_bound
      :canonical: radar.components.element.Element.azimuth_bound
      :type: radar.utils.typing.AngleBound

      .. autodoc2-docstring:: radar.components.element.Element.azimuth_bound

   .. py:property:: elevation_bound
      :canonical: radar.components.element.Element.elevation_bound
      :type: radar.utils.typing.AngleBound

      .. autodoc2-docstring:: radar.components.element.Element.elevation_bound

   .. py:method:: azimuth_domain(domain: radar.utils.typing.PhaseUnit) -> polars.DataFrame
      :canonical: radar.components.element.Element.azimuth_domain

      .. autodoc2-docstring:: radar.components.element.Element.azimuth_domain

   .. py:method:: elevation_domain(domain: radar.utils.typing.PhaseUnit) -> polars.DataFrame
      :canonical: radar.components.element.Element.elevation_domain

      .. autodoc2-docstring:: radar.components.element.Element.elevation_domain

   .. py:method:: _generate_beam_grid(az: radar.utils.typing.AngleBound, el: radar.utils.typing.AngleBound) -> polars.DataFrame
      :canonical: radar.components.element.Element._generate_beam_grid

      .. autodoc2-docstring:: radar.components.element.Element._generate_beam_grid

   .. py:class:: Plot(outer: radar.components.element.Element)
      :canonical: radar.components.element.Element.Plot

      Bases: :py:obj:`radar.utils.plotter.BeamInterface`

      .. autodoc2-docstring:: radar.components.element.Element.Plot

      .. rubric:: Initialization

      .. autodoc2-docstring:: radar.components.element.Element.Plot.__init__

      .. py:method:: beam(direction_domain: radar.utils.typing.DirectionDomain, phase_unit: radar.utils.typing.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.components.element.Element.Plot.beam

         .. autodoc2-docstring:: radar.components.element.Element.Plot.beam

      .. py:attribute:: __slots__
         :canonical: radar.components.element.Element.Plot.__slots__
         :value: ()

   .. py:class:: Animate(outer: radar.components.element.Element)
      :canonical: radar.components.element.Element.Animate

      Bases: :py:obj:`radar.utils.animate.BeamInterface`

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

      .. py:attribute:: __slots__
         :canonical: radar.components.element.Element.Animate.__slots__
         :value: ()