From ad79bd25e5a6b6f1cebe87b2320c42fc22c713d3 Mon Sep 17 00:00:00 2001
From: Michiel Cottaar <michiel.cottaar@ndcn.ox.ac.uk>
Date: Fri, 12 Apr 2024 10:25:23 +0100
Subject: [PATCH] Document edge_times flag
---
src/containers/abstract.jl | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/src/containers/abstract.jl b/src/containers/abstract.jl
index 4532b9d..e12bfa4 100644
--- a/src/containers/abstract.jl
+++ b/src/containers/abstract.jl
@@ -48,7 +48,7 @@ effective_time(block::Tuple{<:VariableType, <:AbstractBlock}) = block[1] + effec
"""
- edge_times(container)
+ edge_times(container; tol=1e-6)
Returns all the edge times during a sequence in ms.
@@ -56,6 +56,8 @@ Edges are defined as any time, when:
- the edge of a building block
- the slope of the gradient profile changes suddenly
- an RF pulse starts or ends
+
+Edges that are within `tol` ms of each other are considered to be one edge (default: 1 ns).
"""
function edge_times end
--
GitLab