From f75cc3e44c5184bd88676bf261fda64b17e60a45 Mon Sep 17 00:00:00 2001
From: Michiel Cottaar <michiel.cottaar@ndcn.ox.ac.uk>
Date: Wed, 31 Jan 2024 17:21:16 +0000
Subject: [PATCH] Better document new gradients
---
src/gradients/gradients.jl | 9 +++------
1 file changed, 3 insertions(+), 6 deletions(-)
diff --git a/src/gradients/gradients.jl b/src/gradients/gradients.jl
index e9a980d..e5653e2 100644
--- a/src/gradients/gradients.jl
+++ b/src/gradients/gradients.jl
@@ -1,15 +1,12 @@
"""
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`]:
+There are only three types of [`GradientBlock`] objects:
- [`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)
-- [`GradientWaveform`](@ref)
+Combinations of these should sub-type from [`SpecificWaveform`](@ref).
"""
module Gradients
@@ -19,7 +16,7 @@ include("instant_gradients.jl")
import ..BuildingBlocks: GradientBlock
-import .ChangingGradientBlocks: ChangingGradientBlock
+import .ChangingGradientBlocks: ChangingGradientBlock, split_gradient
import .ConstantGradientBlocks: ConstantGradientBlock
import .InstantGradients: InstantGradientBlock
end
\ No newline at end of file
--
GitLab