:py:mod:`radar.utils.calculate.pattern`
=======================================

.. py:module:: radar.utils.calculate.pattern

.. autodoc2-docstring:: radar.utils.calculate.pattern
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`Pattern <radar.utils.calculate.pattern.Pattern>`
     - .. autodoc2-docstring:: radar.utils.calculate.pattern.Pattern
          :summary:
   * - :py:obj:`CustomPattern <radar.utils.calculate.pattern.CustomPattern>`
     - .. autodoc2-docstring:: radar.utils.calculate.pattern.CustomPattern
          :summary:
   * - :py:obj:`Isotropic <radar.utils.calculate.pattern.Isotropic>`
     - .. autodoc2-docstring:: radar.utils.calculate.pattern.Isotropic
          :summary:
   * - :py:obj:`Cosine <radar.utils.calculate.pattern.Cosine>`
     - .. autodoc2-docstring:: radar.utils.calculate.pattern.Cosine
          :summary:
   * - :py:obj:`Gaussian <radar.utils.calculate.pattern.Gaussian>`
     - .. autodoc2-docstring:: radar.utils.calculate.pattern.Gaussian
          :summary:
   * - :py:obj:`Sinc <radar.utils.calculate.pattern.Sinc>`
     - .. autodoc2-docstring:: radar.utils.calculate.pattern.Sinc
          :summary:

API
~~~

.. py:class:: Pattern
   :canonical: radar.utils.calculate.pattern.Pattern

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

   .. autodoc2-docstring:: radar.utils.calculate.pattern.Pattern

   .. py:method:: calculate_pattern(df: polars.DataFrame) -> polars.DataFrame
      :canonical: radar.utils.calculate.pattern.Pattern.calculate_pattern
      :abstractmethod:

      .. autodoc2-docstring:: radar.utils.calculate.pattern.Pattern.calculate_pattern

   .. py:attribute:: __slots__
      :canonical: radar.utils.calculate.pattern.Pattern.__slots__
      :value: ()

.. py:class:: CustomPattern(df: polars.DataFrame)
   :canonical: radar.utils.calculate.pattern.CustomPattern

   Bases: :py:obj:`radar.utils.calculate.pattern.Pattern`

   .. autodoc2-docstring:: radar.utils.calculate.pattern.CustomPattern

   .. rubric:: Initialization

   .. autodoc2-docstring:: radar.utils.calculate.pattern.CustomPattern.__init__

   .. py:method:: _validate_presence(df: polars.DataFrame, columns: list[str]) -> None
      :canonical: radar.utils.calculate.pattern.CustomPattern._validate_presence

      .. autodoc2-docstring:: radar.utils.calculate.pattern.CustomPattern._validate_presence

   .. py:method:: calculate_pattern(df: polars.DataFrame) -> polars.DataFrame
      :canonical: radar.utils.calculate.pattern.CustomPattern.calculate_pattern

      .. autodoc2-docstring:: radar.utils.calculate.pattern.CustomPattern.calculate_pattern

   .. py:attribute:: __slots__
      :canonical: radar.utils.calculate.pattern.CustomPattern.__slots__
      :value: ()

.. py:class:: Isotropic
   :canonical: radar.utils.calculate.pattern.Isotropic

   Bases: :py:obj:`radar.utils.calculate.pattern.Pattern`

   .. autodoc2-docstring:: radar.utils.calculate.pattern.Isotropic

   .. py:method:: calculate_pattern(df: polars.DataFrame) -> polars.DataFrame
      :canonical: radar.utils.calculate.pattern.Isotropic.calculate_pattern

      .. autodoc2-docstring:: radar.utils.calculate.pattern.Isotropic.calculate_pattern

   .. py:attribute:: __slots__
      :canonical: radar.utils.calculate.pattern.Isotropic.__slots__
      :value: ()

.. py:class:: Cosine(order: int = 1)
   :canonical: radar.utils.calculate.pattern.Cosine

   Bases: :py:obj:`radar.utils.calculate.pattern.Pattern`

   .. autodoc2-docstring:: radar.utils.calculate.pattern.Cosine

   .. rubric:: Initialization

   .. autodoc2-docstring:: radar.utils.calculate.pattern.Cosine.__init__

   .. py:method:: calculate_pattern(df: polars.DataFrame) -> polars.DataFrame
      :canonical: radar.utils.calculate.pattern.Cosine.calculate_pattern

      .. autodoc2-docstring:: radar.utils.calculate.pattern.Cosine.calculate_pattern

   .. py:attribute:: __slots__
      :canonical: radar.utils.calculate.pattern.Cosine.__slots__
      :value: ()

.. py:class:: Gaussian(beam_width: typing.Tuple[radar.utils.typing.Angle, radar.utils.typing.Angle])
   :canonical: radar.utils.calculate.pattern.Gaussian

   Bases: :py:obj:`radar.utils.calculate.pattern.Pattern`

   .. autodoc2-docstring:: radar.utils.calculate.pattern.Gaussian

   .. rubric:: Initialization

   .. autodoc2-docstring:: radar.utils.calculate.pattern.Gaussian.__init__

   .. py:method:: calculate_pattern(df: polars.DataFrame) -> polars.DataFrame
      :canonical: radar.utils.calculate.pattern.Gaussian.calculate_pattern

      .. autodoc2-docstring:: radar.utils.calculate.pattern.Gaussian.calculate_pattern

   .. py:attribute:: __slots__
      :canonical: radar.utils.calculate.pattern.Gaussian.__slots__
      :value: ()

.. py:class:: Sinc(beam_width: typing.Tuple[radar.utils.typing.Angle, radar.utils.typing.Angle])
   :canonical: radar.utils.calculate.pattern.Sinc

   Bases: :py:obj:`radar.utils.calculate.pattern.Pattern`

   .. autodoc2-docstring:: radar.utils.calculate.pattern.Sinc

   .. rubric:: Initialization

   .. autodoc2-docstring:: radar.utils.calculate.pattern.Sinc.__init__

   .. py:method:: calculate_pattern(df: polars.DataFrame) -> polars.DataFrame
      :canonical: radar.utils.calculate.pattern.Sinc.calculate_pattern

      .. autodoc2-docstring:: radar.utils.calculate.pattern.Sinc.calculate_pattern

   .. py:attribute:: __slots__
      :canonical: radar.utils.calculate.pattern.Sinc.__slots__
      :value: ()