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

Clarify type hierarchy

parent 5cb63bad
No related branches found
No related tags found
No related merge requests found
......@@ -9,10 +9,16 @@ import ...Variables: flip_angle, amplitude, phase, frequency, bandwidth, inverse
"""
Parent type for all objects, where gradients, RF pulses, and/or readouts might overlap with each other.
All children need to be at least convertable into [`GenericWaveform`](@ref).
They might also override specific functions that can be computed more efficiently
Do not sub-type from this type directly, use [`SpecificWaveform`](@ref) instead.
"""
abstract type AbstractWaveform <: ContainerBlock end
"""
Parent type for any specific gradient waveform that might overlap with RF pulses and/or readouts.
New waveforms should sub-type from this one.
At the very least they should implement a conversion to [`GenericWaveform`](@ref).
"""
abstract type SpecificWaveform <: AbstractWaveform end
......
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