Skip to content
Snippets Groups Projects
Unverified Commit 9df59150 authored by Michiel Cottaar's avatar Michiel Cottaar
Browse files

Update get_* docs

parent 4be5f0ca
No related branches found
No related tags found
1 merge request!2Define variables through new @defvar macro
...@@ -270,38 +270,46 @@ function get_free_variable(::Val{:max}; kwargs...) ...@@ -270,38 +270,46 @@ function get_free_variable(::Val{:max}; kwargs...)
end end
""" """
get_pulse(building_block) get_pulse(sequence)
Get the pulse played out during the building block. Get the main pulses played out during the sequence.
Any `pulse` variables not explicitly defined for this building block will be passed on to the pulse. This has to be defined for individual sequences to work.
Any `pulse` variables not explicitly defined for this sequence will be passed on to the pulse.
""" """
function get_pulse end function get_pulse end
""" """
get_gradient(building_block) get_gradient(sequence)
Get the main gradients played out during the sequence.
Get the gradient played out during the building block. This has to be defined for individual sequences to work.
Any `gradient` variables not explicitly defined for this building block will be passed on to the gradient. Any `gradient` variables not explicitly defined for this sequence will be passed on to the gradient.
""" """
function get_gradient end function get_gradient end
""" """
get_readout(building_block) get_readout(sequence)
Get the readout played out during the building block. Get the main readout events played out during the sequence.
Any `readout` variables not explicitly defined for this building block will be passed on to the readout. This has to be defined for individual sequences to work.
Any `readout` variables not explicitly defined for this sequence will be passed on to the readout.
""" """
function get_readout end function get_readout end
""" """
get_pathway(sequence) get_pathway(sequence)
Get the default spin pathway for the sequence. Get the default spin pathway(s) for the sequence.
This has to be defined for individual sequences to work.
Any `pathway` variables not explicitly defined for this building block will be passed on to the pathway. Any `pathway` variables not explicitly defined for this sequence will be passed on to the pathway.
""" """
function get_pathway end function get_pathway 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