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

Add docstrings

parent b6adda30
No related branches found
No related tags found
No related merge requests found
"""
Defines [`ContainerBlock`](@ref) sub-types, i.e., [`BuildingBlocks`](@ref) objects that contain other BuildingBlocks.
The most important of these is [`Sequence`](@ref).
To get the children blocks use [`get_children_blocks`](@ref).
"""
module Containers module Containers
include("sequences.jl") include("sequences.jl")
import ..BuildingBlocks: ContainerBlock, get_children_blocks
import .Sequences: Sequence import .Sequences: Sequence
end end
\ No newline at end of file
"""
Define the [`Sequence`](@ref) building block.
"""
module Sequences module Sequences
import JuMP: Model, @constraint import JuMP: Model, @constraint
import ...BuildSequences: @global_model_constructor import ...BuildSequences: @global_model_constructor
...@@ -12,6 +15,9 @@ Represents a series of [`BuildingBlock`](@ref) objects run in turn. ...@@ -12,6 +15,9 @@ Represents a series of [`BuildingBlock`](@ref) objects run in turn.
Providing a [`Scanner`](@ref) will lead to [`scanner_constraints!`](@ref) to be called on all building blocks. Providing a [`Scanner`](@ref) will lead to [`scanner_constraints!`](@ref) to be called on all building blocks.
This can be used as a top-level NMR/MRI sequence (in which case the [`TR`](@ref) variable is relevant)
or be embedded as a [`BuildingBlock`](@ref) into higher-order `Sequence` or other [`ContainerBlock`](@ref) objects.
## Variables ## Variables
- [`TR`](@ref): repetition time of sequence in ms. - [`TR`](@ref): repetition time of sequence in ms.
""" """
......
"""
Module defining sub-types of the [`GradientBlock`](@ref), i.e., any [`BuildingBlock`](@ref) that only defines a gradient profile.
- [`PulsedGradient`](@ref)
- [`InstantGradientBlock`](@ref)
Arbitrary gradient waveforms can be store din a [`ConcreteBlock`](@ref)
"""
module Gradients module Gradients
include("integrate_gradients.jl") include("integrate_gradients.jl")
include("pulsed_gradients.jl") include("pulsed_gradients.jl")
include("instant_gradients.jl") include("instant_gradients.jl")
import ..BuildingBlock: GradientBlock
import .PulsedGradients: PulsedGradient import .PulsedGradients: PulsedGradient
import .InstantGradients: InstantGradientBlock import .InstantGradients: InstantGradientBlock
end 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