From 03db4c2433579a3bb756bf47fc071361a4927963 Mon Sep 17 00:00:00 2001 From: gabuzi <15203081+gabuzi@users.noreply.github.com> Date: Mon, 4 Dec 2023 13:57:06 +0000 Subject: [PATCH] Further refined documentation for calc_duration.py --- pypulseq/calc_duration.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/pypulseq/calc_duration.py b/pypulseq/calc_duration.py index e5bdc52..6ccddb6 100755 --- a/pypulseq/calc_duration.py +++ b/pypulseq/calc_duration.py @@ -7,7 +7,14 @@ def calc_duration(*args: SimpleNamespace) -> float: """ - Calculate the duration of an event or block. The duration of a block is given by the maximum duration of its events. + Calculate the duration of an event or block. + The duration of an event is the + time taken by the actual event itself plus its delay. + If multiple events are provided, the calculated duration is for a block + comprised of these events, which is given by the maximum duration of the events. + + Although it is possible to provide events that can't be actually be combined into a block + (e.g. multiple events of the same type), the result is still the maximum duration of all events. Parameters ----------