From 8473e1d21d7a7c1cb67eb202d568fe35af335720 Mon Sep 17 00:00:00 2001
From: Michiel Cottaar <michiel.cottaar@ndcn.ox.ac.uk>
Date: Sun, 28 Jan 2024 20:50:40 +0000
Subject: [PATCH] Update general docstring
---
src/gradients/gradients.jl | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/src/gradients/gradients.jl b/src/gradients/gradients.jl
index 81147b8..abc666d 100644
--- a/src/gradients/gradients.jl
+++ b/src/gradients/gradients.jl
@@ -1,12 +1,23 @@
"""
Module defining sub-types of the [`GradientBlock`](@ref), i.e., any [`BuildingBlock`](@ref) that only defines a gradient profile.
+In principle, there are only three types of [`GradientBlock`]:
+- [`ChangingGradientBlock`](@ref): any gradient changing linearly in strength.
+- [`ConstantGradientBlock`](@ref): any gradient staying constant in strength. These can overlap with a pulse (`SliceSelectPulse`).
+- [`InstantGradientBlock`](@ref): an infinitely short gradient pulse.
+
+All other gradient profiles are made up of [`ChangingGradientBlock`](@ref) and [`ConstantGradientBlock`](@ref) and hence are technically sequences.
+They are still included here for clarity:
- [`PulsedGradient`](@ref)
-- [`InstantGradientBlock`](@ref)
+- [`GradientWaveform`](@ref)
- [`FixedGradient`](@ref)
"""
module Gradients
+include("constant_gradient_blocks.jl")
+include("changing_gradient_blocks.jl")
+include("slice_selects.jl")
+
#include("integrate_gradients.jl")
include("fixed_gradients.jl")
include("pulsed_gradients.jl")
--
GitLab