Classes for sequence design (odinseq library)

Classes
class	OdinPulse
	Advandced RF pulses. More...
class	SeqAcq
	Acquisition. More...
class	SeqAcqDeph
	Pre-read dephasing. More...
class	SeqAcqEPI
	Acquisition + echo-planar imaging readout. More...
class	SeqAcqRead
	Acquisition + readout gradient. More...
class	SeqAcqSpiral
	Acquisition + spiral gradient. More...
class	SeqDecoupling
	Decoupling period. More...
class	SeqDelay
	Timing delay. More...
class	SeqDelayVector
	Vector of variable timing delays. More...
class	SeqDiffWeight
	Diffusion Weighting. More...
class	SeqGradConst
	Constant gradient. More...
class	SeqGradDelay
	Gradient delay. More...
class	SeqGradEcho
	Gradient echo module. More...
class	SeqGradPhaseEnc
	Phase Encoding. More...
class	SeqGradPhaseEncFlowComp
	Flow-Compensated Phase Encoding. More...
class	SeqGradConstPulse
	Constant gradient pulse. More...
class	SeqGradVectorPulse
	Vector of gradient pulses. More...
class	SeqGradRamp
	Gradient Ramp. More...
class	SeqGradTrapez
	Trapezoidal gradient. More...
class	SeqGradTrapezParallel
	3 trapezoidal gradients More...
class	SeqGradVector
	Vector of constant gradients. More...
class	SeqGradWave
	Gradient Waveform. More...
class	SeqObjList
	Container for sequence objects. More...
class	SeqObjLoop
	Sequence Loop. More...
class	SeqMethod
	Base class for methods (sequences). More...
class	SeqObjVector
	Vector to loop over sequence objects. More...
class	SeqPuls
	RF pulse. More...
class	SeqPulsar
	Pulsar pulses, combines OdinPulse and SeqPulsNdim. More...
class	SeqPulsarReph
	Post-pulse rephaser. More...
class	SeqPulsarSinc
	Sinc pulse. More...
class	SeqPulsarGauss
	Gauss pulse. More...
class	SeqPulsarBP
	Const pulse. More...
class	SeqPulsarPinWheel
	Pinwheel pulse. More...
class	SeqPulsNdim
	RF Pulse + gradients. More...
class	SeqRotMatrixVector
	Vector of SeqRotMatrix's. More...
class	SeqPulsarSat
	Saturation pulse. More...
class	SeqSat
	Saturation pulse + spoilers. More...
struct	SeqSimInterval
	Time interval for simulation. More...
class	SeqSimMagsi
	MAGSI-based Magnetization Simulator. More...
class	SeqSimMonteCarlo
	Monte-Carlo-based Magnetization Simulator. More...
class	SeqFieldMap
	Multi-echo module for field-map pre-scan. More...
class	SeqTrigger
	External trigger. More...
class	SeqSnapshot
	Magnetization snapshot. More...
class	SeqVecIter
	Iterator for vectors. More...
Enumerations
enum	dephaseMode
enum	rampType
enum	pulseType
enum	satNucleus
enum	encodingScheme
enum	reorderScheme

---

Detailed Description

ODIN sequence modelling framework (odinseq library)

---

Enumeration Type Documentation

enum dephaseMode

This enum is used to specify the type of the pre-dephasing or post-rephasing gradient:

• FID: It will have opposite polarity
• spinEcho: It will have the same polarity
• rephase: Gradient pulse to rephase acquisition gradients

Definition at line 42 of file seqacqdeph.h.

enum encodingScheme

This enum can be used to determine the encoding scheme of a list of values:

• linearEncoding : values are played out in the same order as specified
• reverseEncoding : values are played out in the reverse order as specified
• centerOutEncoding : encoding start in the center of values and moves outwards alternatingly in positive/negative direction
• centerInEncoding : encoding starts outwards and moves inwards alternatingly in positive/negative direction
• maxDistEncoding : Maximum distance between consecutive elements

Definition at line 37 of file seqvec.h.

enum pulseType

Enum to specify the type of a pulse.It is essential for the calculation of k-space trajectories and other stuff to specify this correctly for each object derived from 'SeqPulsInterface'

• excitation: An excitation pulse.
• refocusing: A refocusing pulse.
• storeMagn: Stores the magnetization in longitudinal direction (stimulated echo)
• recallMagn: Recalls the magnetization from the longitudinal direction (stimulated echo)
• inversion: An inversion pulse
• saturation: A saturation pulse

Definition at line 42 of file seqpuls.h.

enum rampType

This enum is used to specify the shape of gradient ramp:

• linear: A ramp that linearly increases/decreases the gradient field. The first ramp point has the initial gradient strength, the last point the final gradient strength. With this selection, the integral over the ramp is the same as that over a continuous triangular function, i.e Integral = 1/2 * strength_difference * duration.
• sinusoidal: The sinus between -pi/2 and pi/2 is used for the gradient shape
• half_sinusoidal: The sinus between 0 and pi/2 is used for the gradient shape

Definition at line 34 of file seqgradramp.h.

enum reorderScheme

This enum can be used to determine the reordering scheme of a list of values:

• noReorder : No reordering is performed, the number of reorderings is then equal one
• rotateReorder : The values will be rotated, the number of reorderings is then the number of values
• blockedSegmented : The values will be divided into segments, preserving their order
• interleavedSegmented : The values will be divided into segments like distributing game cards

Definition at line 48 of file seqvec.h.

enum satNucleus

Enum to specifiy saturation component:

• fat: lipid protons will be saturated
• water: water protons will be saturated

Definition at line 37 of file seqsat.h.

---