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

.. py:module:: radar.components.array

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

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

Classes
~~~~~~~

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

   * - :py:obj:`Array <radar.components.array.Array>`
     - .. autodoc2-docstring:: radar.components.array.Array
          :summary:

API
~~~

.. py:class:: Array(element: radar.components.element.Element, geometry: radar.components.geometry.Geometry)
   :canonical: radar.components.array.Array

   .. autodoc2-docstring:: radar.components.array.Array

   .. rubric:: Initialization

   .. autodoc2-docstring:: radar.components.array.Array.__init__

   .. py:property:: element
      :canonical: radar.components.array.Array.element

      .. autodoc2-docstring:: radar.components.array.Array.element

   .. py:method:: beam_pattern(frequency: radar.utils.typing.Frequency, steer: tuple[radar.utils.typing.Angle, radar.utils.typing.Angle] | None = None) -> polars.DataFrame
      :canonical: radar.components.array.Array.beam_pattern

      .. autodoc2-docstring:: radar.components.array.Array.beam_pattern

   .. py:method:: _beam_pattern(steer: tuple[radar.utils.typing.Angle, radar.utils.typing.Angle] | None, frequency: radar.utils.typing.Frequency) -> polars.DataFrame
      :canonical: radar.components.array.Array._beam_pattern

      .. autodoc2-docstring:: radar.components.array.Array._beam_pattern

   .. py:method:: _calculate_beam_pattern(element: radar.components.element.Element, frequency: radar.utils.typing.Frequency, steer: tuple[radar.utils.typing.Angle, radar.utils.typing.Angle] | None)
      :canonical: radar.components.array.Array._calculate_beam_pattern

      .. autodoc2-docstring:: radar.components.array.Array._calculate_beam_pattern

   .. py:method:: _calculate_array_factor(frequency: radar.utils.typing.Frequency, steer: tuple[radar.utils.typing.Angle, radar.utils.typing.Angle] | None) -> polars.DataFrame
      :canonical: radar.components.array.Array._calculate_array_factor

      .. autodoc2-docstring:: radar.components.array.Array._calculate_array_factor

   .. py:method:: calculate_array_factor(frequency: radar.utils.typing.Frequency, steer: tuple[radar.utils.typing.Angle, radar.utils.typing.Angle] | None) -> polars.DataFrame
      :canonical: radar.components.array.Array.calculate_array_factor

      .. autodoc2-docstring:: radar.components.array.Array.calculate_array_factor

   .. py:class:: Plot(outer: radar.components.array.Array)
      :canonical: radar.components.array.Array.Plot

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

      .. 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.Frequency, steer: tuple[radar.utils.typing.Angle, radar.utils.typing.Angle] | None = None)
         :canonical: radar.components.array.Array.Plot.beam

      .. py:method:: geometry()
         :canonical: radar.components.array.Array.Plot.geometry

      .. py:attribute:: __slots__
         :canonical: radar.components.array.Array.Plot.__slots__
         :value: ()

   .. py:class:: Animate(outer: radar.components.array.Array)
      :canonical: radar.components.array.Array.Animate

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

      .. py:method:: beam(frequency: radar.utils.typing.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.Angle, radar.utils.typing.Angle] | None = None) -> manim.Surface
         :canonical: radar.components.array.Array.Animate.beam

      .. py:method:: geometry(position: numpy.typing.NDArray, colour: manim.ManimColor) -> manim.VGroup
         :canonical: radar.components.array.Array.Animate.geometry

         .. autodoc2-docstring:: radar.components.array.Array.Animate.geometry

      .. py:attribute:: __slots__
         :canonical: radar.components.array.Array.Animate.__slots__
         :value: ()