Added Antenna Array class to store element patterns.

LyceanEM · Jul 19, 2022 · b9f15f7 · b9f15f7
1 parent ce3f30b
commit b9f15f7
Show file tree

Hide file tree

Showing 10 changed files with 19 additions and 19 deletions.
diff --git a/docs/examples/07_aperture_farfield_polarisation.py b/docs/examples/07_aperture_farfield_polarisation.py
@@ -6,7 +6,7 @@
 
 This example uses the frequency domain :func:`lyceanem.models.frequency_domain.calculate_farfield` function to predict
 the farfield pattern for a linearly polarised aperture. This could represent an antenna array without any beamforming
-weights.
+weights. This example differs from 02 by using the antenna structure class as a container for both the antenna points and structure, and also by calling the calculate farfield function using the class.
 
 
 """

diff --git a/docs/source/auto_examples/07_aperture_farfield_polarisation.ipynb b/docs/source/auto_examples/07_aperture_farfield_polarisation.ipynb
@@ -15,7 +15,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "\n# Modelling a Coherently Polarised Aperture\n\nThis example uses the frequency domain :func:`lyceanem.models.frequency_domain.calculate_farfield` function to predict\nthe farfield pattern for a linearly polarised aperture. This could represent an antenna array without any beamforming\nweights.\n"
+        "\n# Modelling a Coherently Polarised Aperture using the Antenna Structure Class\n\nThis example uses the frequency domain :func:`lyceanem.models.frequency_domain.calculate_farfield` function to predict\nthe farfield pattern for a linearly polarised aperture. This could represent an antenna array without any beamforming\nweights. This example differs from 02 by using the antenna structure class as a container for both the antenna points and structure, and also by calling the calculate farfield function using the class.\n"
       ]
     },
     {

diff --git a/docs/source/auto_examples/07_aperture_farfield_polarisation.py b/docs/source/auto_examples/07_aperture_farfield_polarisation.py
@@ -1,12 +1,12 @@
 #!/usr/bin/env python
 # coding: utf-8
 """
-Modelling a Coherently Polarised Aperture
-======================================================
+Modelling a Coherently Polarised Aperture using the Antenna Structure Class
+============================================================================
 
 This example uses the frequency domain :func:`lyceanem.models.frequency_domain.calculate_farfield` function to predict
 the farfield pattern for a linearly polarised aperture. This could represent an antenna array without any beamforming
-weights.
+weights. This example differs from 02 by using the antenna structure class as a container for both the antenna points and structure, and also by calling the calculate farfield function using the class.
 
 
 """

diff --git a/docs/source/auto_examples/07_aperture_farfield_polarisation.py.md5 b/docs/source/auto_examples/07_aperture_farfield_polarisation.py.md5
@@ -1 +1 @@
-a2624b519e270d80bd98f8329e4a2b7b
+ab0efc9716658cb2e067997dd33b434b
diff --git a/docs/source/auto_examples/07_aperture_farfield_polarisation.rst b/docs/source/auto_examples/07_aperture_farfield_polarisation.rst
@@ -18,12 +18,12 @@
 .. _sphx_glr_auto_examples_07_aperture_farfield_polarisation.py:
 
 
-Modelling a Coherently Polarised Aperture
-======================================================
+Modelling a Coherently Polarised Aperture using the Antenna Structure Class
+============================================================================
 
 This example uses the frequency domain :func:`lyceanem.models.frequency_domain.calculate_farfield` function to predict
 the farfield pattern for a linearly polarised aperture. This could represent an antenna array without any beamforming
-weights.
+weights. This example differs from 02 by using the antenna structure class as a container for both the antenna points and structure, and also by calling the calculate farfield function using the class.
 
 .. GENERATED FROM PYTHON SOURCE LINES 13-17
 
@@ -397,7 +397,7 @@ Generate N-normal directed electric current source
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** ( 0 minutes  10.545 seconds)
+   **Total running time of the script:** ( 1 minutes  21.755 seconds)
 
 
 .. _sphx_glr_download_auto_examples_07_aperture_farfield_polarisation.py:

diff --git a/docs/source/auto_examples/07_aperture_farfield_polarisation_codeobj.pickle b/docs/source/auto_examples/07_aperture_farfield_polarisation_codeobj.pickle
diff --git a/docs/source/auto_examples/auto_examples_jupyter.zip b/docs/source/auto_examples/auto_examples_jupyter.zip
diff --git a/docs/source/auto_examples/auto_examples_python.zip b/docs/source/auto_examples/auto_examples_python.zip
diff --git a/docs/source/auto_examples/index.rst b/docs/source/auto_examples/index.rst
@@ -58,7 +58,7 @@ A selection of examples of LyceanEM features
 .. only:: html
 
  .. figure:: /auto_examples/images/thumb/sphx_glr_07_aperture_farfield_polarisation_thumb.png
-     :alt: Modelling a Coherently Polarised Aperture
+     :alt: Modelling a Coherently Polarised Aperture using the Antenna Structure Class
 
      :ref:`sphx_glr_auto_examples_07_aperture_farfield_polarisation.py`
 

diff --git a/docs/source/auto_examples/sg_execution_times.rst b/docs/source/auto_examples/sg_execution_times.rst
@@ -5,20 +5,20 @@
 
 Computation times
 =================
-**12:09.692** total execution time for **auto_examples** files:
+**01:21.755** total execution time for **auto_examples** files:
 
 +-----------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_auto_examples_04_time_domain_channel_modelling.py` (``04_time_domain_channel_modelling.py``)           | 04:43.360 | 0.0 MB |
+| :ref:`sphx_glr_auto_examples_07_aperture_farfield_polarisation.py` (``07_aperture_farfield_polarisation.py``)         | 01:21.755 | 0.0 MB |
 +-----------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_auto_examples_05_array_beamforming.py` (``05_array_beamforming.py``)                                   | 04:14.648 | 0.0 MB |
+| :ref:`sphx_glr_auto_examples_01_aperture_projection.py` (``01_aperture_projection.py``)                               | 00:00.000 | 0.0 MB |
 +-----------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_auto_examples_03_frequency_domain_channel_modelling.py` (``03_frequency_domain_channel_modelling.py``) | 02:10.079 | 0.0 MB |
+| :ref:`sphx_glr_auto_examples_02_coherently_polarised_array.py` (``02_coherently_polarised_array.py``)                 | 00:00.000 | 0.0 MB |
 +-----------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_auto_examples_01_aperture_projection.py` (``01_aperture_projection.py``)                               | 00:31.312 | 0.0 MB |
+| :ref:`sphx_glr_auto_examples_03_frequency_domain_channel_modelling.py` (``03_frequency_domain_channel_modelling.py``) | 00:00.000 | 0.0 MB |
 +-----------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_auto_examples_02_coherently_polarised_array.py` (``02_coherently_polarised_array.py``)                 | 00:17.759 | 0.0 MB |
+| :ref:`sphx_glr_auto_examples_04_time_domain_channel_modelling.py` (``04_time_domain_channel_modelling.py``)           | 00:00.000 | 0.0 MB |
 +-----------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_auto_examples_07_aperture_farfield_polarisation.py` (``07_aperture_farfield_polarisation.py``)         | 00:10.545 | 0.0 MB |
+| :ref:`sphx_glr_auto_examples_05_array_beamforming.py` (``05_array_beamforming.py``)                                   | 00:00.000 | 0.0 MB |
 +-----------------------------------------------------------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_auto_examples_06_farfield_polarisation.py` (``06_farfield_polarisation.py``)                           | 00:01.990 | 0.0 MB |
+| :ref:`sphx_glr_auto_examples_06_farfield_polarisation.py` (``06_farfield_polarisation.py``)                           | 00:00.000 | 0.0 MB |
 +-----------------------------------------------------------------------------------------------------------------------+-----------+--------+
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		a2624b519e270d80bd98f8329e4a2b7b
		ab0efc9716658cb2e067997dd33b434b