From 2f427a7067bff3291abb1c97b3ef18238bb33306 Mon Sep 17 00:00:00 2001 From: tf17270 Date: Wed, 28 Jun 2023 12:33:52 +0100 Subject: [PATCH] changed comment for maxdirectivitymapdiscrete to reflect 4d array return value --- lyceanem/electromagnetics/beamforming.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lyceanem/electromagnetics/beamforming.py b/lyceanem/electromagnetics/beamforming.py index 6bf8633..2cf5e54 100644 --- a/lyceanem/electromagnetics/beamforming.py +++ b/lyceanem/electromagnetics/beamforming.py @@ -570,8 +570,8 @@ def MaximumDirectivityMapDiscrete( Returns ------- - directivity_map : 3D numpy array of float - The achieved maximum directivity map. At each point the directivity corresponds to the achieved directivity at + directivity_map : 4D numpy array of float + The achieved maximum directivity map (a 3D numpy array for each phase resolution) . For each phase resolution for each point the directivity corresponds to the achieved directivity at that command angle. """