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

.. py:module:: radar.components.geometry

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

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

Classes
~~~~~~~

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

   * - :py:obj:`Geometry <radar.components.geometry.Geometry>`
     - .. autodoc2-docstring:: radar.components.geometry.Geometry
          :summary:
   * - :py:obj:`CustomGeometry <radar.components.geometry.CustomGeometry>`
     - .. autodoc2-docstring:: radar.components.geometry.CustomGeometry
          :summary:
   * - :py:obj:`Linear <radar.components.geometry.Linear>`
     - .. autodoc2-docstring:: radar.components.geometry.Linear
          :summary:
   * - :py:obj:`Cross <radar.components.geometry.Cross>`
     - .. autodoc2-docstring:: radar.components.geometry.Cross
          :summary:
   * - :py:obj:`Circular <radar.components.geometry.Circular>`
     - .. autodoc2-docstring:: radar.components.geometry.Circular
          :summary:
   * - :py:obj:`Grid <radar.components.geometry.Grid>`
     - .. autodoc2-docstring:: radar.components.geometry.Grid
          :summary:

API
~~~

.. py:class:: Geometry()
   :canonical: radar.components.geometry.Geometry

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

   .. autodoc2-docstring:: radar.components.geometry.Geometry

   .. rubric:: Initialization

   .. autodoc2-docstring:: radar.components.geometry.Geometry.__init__

   .. py:method:: _generate_positions_df() -> polars.DataFrame
      :canonical: radar.components.geometry.Geometry._generate_positions_df
      :abstractmethod:

      .. autodoc2-docstring:: radar.components.geometry.Geometry._generate_positions_df

   .. py:method:: _set_default_gain_phase() -> None
      :canonical: radar.components.geometry.Geometry._set_default_gain_phase

      .. autodoc2-docstring:: radar.components.geometry.Geometry._set_default_gain_phase

   .. py:property:: phases
      :canonical: radar.components.geometry.Geometry.phases

      .. autodoc2-docstring:: radar.components.geometry.Geometry.phases

   .. py:property:: gains
      :canonical: radar.components.geometry.Geometry.gains

      .. autodoc2-docstring:: radar.components.geometry.Geometry.gains

   .. py:method:: _validate_input_df(df: polars.DataFrame, required_column: str) -> None
      :canonical: radar.components.geometry.Geometry._validate_input_df

      .. autodoc2-docstring:: radar.components.geometry.Geometry._validate_input_df

   .. py:property:: geometry
      :canonical: radar.components.geometry.Geometry.geometry
      :type: polars.DataFrame

      .. autodoc2-docstring:: radar.components.geometry.Geometry.geometry

   .. py:class:: Plot(geometry: radar.components.geometry.Geometry)
      :canonical: radar.components.geometry.Geometry.Plot

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

      .. autodoc2-docstring:: radar.components.geometry.Geometry.Plot

      .. rubric:: Initialization

      .. autodoc2-docstring:: radar.components.geometry.Geometry.Plot.__init__

      .. py:method:: geometry() -> None
         :canonical: radar.components.geometry.Geometry.Plot.geometry

      .. py:attribute:: __slots__
         :canonical: radar.components.geometry.Geometry.Plot.__slots__
         :value: ()

   .. py:class:: Animate(geometry: radar.components.geometry.Geometry)
      :canonical: radar.components.geometry.Geometry.Animate

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

      .. autodoc2-docstring:: radar.components.geometry.Geometry.Animate

      .. rubric:: Initialization

      .. autodoc2-docstring:: radar.components.geometry.Geometry.Animate.__init__

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

      .. py:attribute:: __slots__
         :canonical: radar.components.geometry.Geometry.Animate.__slots__
         :value: ()

   .. py:attribute:: __slots__
      :canonical: radar.components.geometry.Geometry.__slots__
      :value: ()

.. py:class:: CustomGeometry(x: numpy.typing.NDArray, y: numpy.typing.NDArray)
   :canonical: radar.components.geometry.CustomGeometry

   Bases: :py:obj:`radar.components.geometry.Geometry`

   .. autodoc2-docstring:: radar.components.geometry.CustomGeometry

   .. rubric:: Initialization

   .. autodoc2-docstring:: radar.components.geometry.CustomGeometry.__init__

   .. py:method:: _generate_positions_df() -> polars.DataFrame
      :canonical: radar.components.geometry.CustomGeometry._generate_positions_df

   .. py:method:: _set_default_gain_phase() -> None
      :canonical: radar.components.geometry.CustomGeometry._set_default_gain_phase

   .. py:property:: phases
      :canonical: radar.components.geometry.CustomGeometry.phases

   .. py:property:: gains
      :canonical: radar.components.geometry.CustomGeometry.gains

   .. py:method:: _validate_input_df(df: polars.DataFrame, required_column: str) -> None
      :canonical: radar.components.geometry.CustomGeometry._validate_input_df

   .. py:property:: geometry
      :canonical: radar.components.geometry.CustomGeometry.geometry
      :type: polars.DataFrame

   .. py:class:: Plot(geometry: radar.components.geometry.Geometry)
      :canonical: radar.components.geometry.CustomGeometry.Plot

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

      .. py:method:: geometry() -> None
         :canonical: radar.components.geometry.CustomGeometry.Plot.geometry

      .. py:attribute:: __slots__
         :canonical: radar.components.geometry.CustomGeometry.Plot.__slots__
         :value: ()

   .. py:class:: Animate(geometry: radar.components.geometry.Geometry)
      :canonical: radar.components.geometry.CustomGeometry.Animate

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

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

      .. py:attribute:: __slots__
         :canonical: radar.components.geometry.CustomGeometry.Animate.__slots__
         :value: ()

   .. py:attribute:: __slots__
      :canonical: radar.components.geometry.CustomGeometry.__slots__
      :value: ()

.. py:class:: Linear(elements: pydantic.PositiveInt, orientation: radar.utils.typing.ArrayOrientation, spacing: radar.utils.typing.Distance)
   :canonical: radar.components.geometry.Linear

   Bases: :py:obj:`radar.components.geometry.Geometry`

   .. autodoc2-docstring:: radar.components.geometry.Linear

   .. rubric:: Initialization

   .. autodoc2-docstring:: radar.components.geometry.Linear.__init__

   .. py:method:: _generate_positions_df() -> polars.DataFrame
      :canonical: radar.components.geometry.Linear._generate_positions_df

   .. py:method:: _set_default_gain_phase() -> None
      :canonical: radar.components.geometry.Linear._set_default_gain_phase

   .. py:property:: phases
      :canonical: radar.components.geometry.Linear.phases

   .. py:property:: gains
      :canonical: radar.components.geometry.Linear.gains

   .. py:method:: _validate_input_df(df: polars.DataFrame, required_column: str) -> None
      :canonical: radar.components.geometry.Linear._validate_input_df

   .. py:property:: geometry
      :canonical: radar.components.geometry.Linear.geometry
      :type: polars.DataFrame

   .. py:class:: Plot(geometry: radar.components.geometry.Geometry)
      :canonical: radar.components.geometry.Linear.Plot

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

      .. py:method:: geometry() -> None
         :canonical: radar.components.geometry.Linear.Plot.geometry

      .. py:attribute:: __slots__
         :canonical: radar.components.geometry.Linear.Plot.__slots__
         :value: ()

   .. py:class:: Animate(geometry: radar.components.geometry.Geometry)
      :canonical: radar.components.geometry.Linear.Animate

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

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

      .. py:attribute:: __slots__
         :canonical: radar.components.geometry.Linear.Animate.__slots__
         :value: ()

   .. py:attribute:: __slots__
      :canonical: radar.components.geometry.Linear.__slots__
      :value: ()

.. py:class:: Cross(azimuth_elements: pydantic.PositiveInt, elevation_elements: pydantic.PositiveInt, spacing: radar.utils.typing.Distance)
   :canonical: radar.components.geometry.Cross

   Bases: :py:obj:`radar.components.geometry.Geometry`

   .. autodoc2-docstring:: radar.components.geometry.Cross

   .. rubric:: Initialization

   .. autodoc2-docstring:: radar.components.geometry.Cross.__init__

   .. py:method:: _generate_positions_df() -> polars.DataFrame
      :canonical: radar.components.geometry.Cross._generate_positions_df

   .. py:method:: _set_default_gain_phase() -> None
      :canonical: radar.components.geometry.Cross._set_default_gain_phase

   .. py:property:: phases
      :canonical: radar.components.geometry.Cross.phases

   .. py:property:: gains
      :canonical: radar.components.geometry.Cross.gains

   .. py:method:: _validate_input_df(df: polars.DataFrame, required_column: str) -> None
      :canonical: radar.components.geometry.Cross._validate_input_df

   .. py:property:: geometry
      :canonical: radar.components.geometry.Cross.geometry
      :type: polars.DataFrame

   .. py:class:: Plot(geometry: radar.components.geometry.Geometry)
      :canonical: radar.components.geometry.Cross.Plot

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

      .. py:method:: geometry() -> None
         :canonical: radar.components.geometry.Cross.Plot.geometry

      .. py:attribute:: __slots__
         :canonical: radar.components.geometry.Cross.Plot.__slots__
         :value: ()

   .. py:class:: Animate(geometry: radar.components.geometry.Geometry)
      :canonical: radar.components.geometry.Cross.Animate

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

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

      .. py:attribute:: __slots__
         :canonical: radar.components.geometry.Cross.Animate.__slots__
         :value: ()

   .. py:attribute:: __slots__
      :canonical: radar.components.geometry.Cross.__slots__
      :value: ()

.. py:class:: Circular(elements: pydantic.PositiveInt, radius: radar.utils.typing.Length)
   :canonical: radar.components.geometry.Circular

   Bases: :py:obj:`radar.components.geometry.Geometry`

   .. autodoc2-docstring:: radar.components.geometry.Circular

   .. rubric:: Initialization

   .. autodoc2-docstring:: radar.components.geometry.Circular.__init__

   .. py:method:: _generate_positions_df() -> polars.DataFrame
      :canonical: radar.components.geometry.Circular._generate_positions_df

   .. py:method:: _set_default_gain_phase() -> None
      :canonical: radar.components.geometry.Circular._set_default_gain_phase

   .. py:property:: phases
      :canonical: radar.components.geometry.Circular.phases

   .. py:property:: gains
      :canonical: radar.components.geometry.Circular.gains

   .. py:method:: _validate_input_df(df: polars.DataFrame, required_column: str) -> None
      :canonical: radar.components.geometry.Circular._validate_input_df

   .. py:property:: geometry
      :canonical: radar.components.geometry.Circular.geometry
      :type: polars.DataFrame

   .. py:class:: Plot(geometry: radar.components.geometry.Geometry)
      :canonical: radar.components.geometry.Circular.Plot

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

      .. py:method:: geometry() -> None
         :canonical: radar.components.geometry.Circular.Plot.geometry

      .. py:attribute:: __slots__
         :canonical: radar.components.geometry.Circular.Plot.__slots__
         :value: ()

   .. py:class:: Animate(geometry: radar.components.geometry.Geometry)
      :canonical: radar.components.geometry.Circular.Animate

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

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

      .. py:attribute:: __slots__
         :canonical: radar.components.geometry.Circular.Animate.__slots__
         :value: ()

   .. py:attribute:: __slots__
      :canonical: radar.components.geometry.Circular.__slots__
      :value: ()

.. py:class:: Grid(azimuth_elements: pydantic.PositiveInt, elevation_elements: pydantic.PositiveInt, spacing: radar.utils.typing.Distance)
   :canonical: radar.components.geometry.Grid

   Bases: :py:obj:`radar.components.geometry.Geometry`

   .. autodoc2-docstring:: radar.components.geometry.Grid

   .. rubric:: Initialization

   .. autodoc2-docstring:: radar.components.geometry.Grid.__init__

   .. py:method:: _generate_positions_df() -> polars.DataFrame
      :canonical: radar.components.geometry.Grid._generate_positions_df

   .. py:method:: _set_default_gain_phase() -> None
      :canonical: radar.components.geometry.Grid._set_default_gain_phase

   .. py:property:: phases
      :canonical: radar.components.geometry.Grid.phases

   .. py:property:: gains
      :canonical: radar.components.geometry.Grid.gains

   .. py:method:: _validate_input_df(df: polars.DataFrame, required_column: str) -> None
      :canonical: radar.components.geometry.Grid._validate_input_df

   .. py:property:: geometry
      :canonical: radar.components.geometry.Grid.geometry
      :type: polars.DataFrame

   .. py:class:: Plot(geometry: radar.components.geometry.Geometry)
      :canonical: radar.components.geometry.Grid.Plot

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

      .. py:method:: geometry() -> None
         :canonical: radar.components.geometry.Grid.Plot.geometry

      .. py:attribute:: __slots__
         :canonical: radar.components.geometry.Grid.Plot.__slots__
         :value: ()

   .. py:class:: Animate(geometry: radar.components.geometry.Geometry)
      :canonical: radar.components.geometry.Grid.Animate

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

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

      .. py:attribute:: __slots__
         :canonical: radar.components.geometry.Grid.Animate.__slots__
         :value: ()

   .. py:attribute:: __slots__
      :canonical: radar.components.geometry.Grid.__slots__
      :value: ()