Skip to content
Snippets Groups Projects
Verified Commit f75cc3e4 authored by Michiel Cottaar's avatar Michiel Cottaar
Browse files

Better document new gradients

parent 8fcfee74
No related branches found
No related tags found
No related merge requests found
"""
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
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment