MR Parameters (odinpara library)

Classes
class	RotMatrix
	Rotation Matrix. More...
class	Geometry
	Geometry Settings. More...
class	Para
class	Protocol
	Protcol proxy. More...
struct	kSpaceCoord
class	JDXkSpaceCoords
struct	RecoValList
class	JDXrecoValList
class	RecoPars
class	CoilSensitivity
class	Sample
	Virtual Sample for Simulation. More...
class	SeqPars
	Sequence Parameter proxy. More...
class	Study
	Study information. More...
class	Nuclei
class	System
	System proxy. More...
class	SystemInterface
Defines
#define	readDirection   readChannel
#define	phaseDirection   phaseChannel
#define	sliceDirection   sliceChannel
#define	ODIN_TIME_UNIT   "ms"
#define	ODIN_FREQ_UNIT   "kHz"
#define	ODIN_SPAT_UNIT   "mm"
#define	ODIN_FIELD_UNIT   "mT"
#define	ODIN_GRAD_UNIT   "mT/mm"
#define	ODIN_ANGLE_UNIT   "deg"
#define	ODIN_DEFAULT_FOV   220.0
#define	ODIN_MAX_NUMOF_SLICES   50
#define	ODIN_GEO_CHECK_LIMIT   1e-6
#define	MAX_NUMOF_READOUT_SHAPES   10
#define	MAX_NUMOF_KSPACE_TRAJS   10
#define	MAX_NUMOF_ADC_WEIGHTING_VECTORS   10
Enumerations
enum	sliceBoundary
enum	sliceOrientation
enum	geometryMode
enum	channelNo
enum	axis
enum	recoFlags
enum	recoDim
enum	templateType
enum	sampleDim
enum	odinPlatform
enum	objCategory

---

Detailed Description

This page describes the design guidelines of the module Protcol classes in ODIN (odinpara library)

Author:

Thies H. Jochimsen

---

Enumeration Type Documentation

enum axis

Enum for the direction of spatial axes in the laboratory system of reference:

• xAxis: The first spatial direction
• yAxis: The second spatial direction
• zAxis: The third spatial direction

Definition at line 46 of file odinpara.h.

enum channelNo

This enum is used to specify the gradient channel (which an object derived from SeqGradChan can occupy):

• readChannel: The first gradient channel
• phaseChannel: The second gradient channel
• sliceChannel: The third gradient channel

Definition at line 37 of file odinpara.h.

enum geometryMode

Enum for the mode to select the geometry

Definition at line 51 of file geometry.h.

enum objCategory

This enum is used to distinguish different properties of sequence objects according to their category. Examples are minimum duration or rastertime.

Definition at line 46 of file system.h.

enum odinPlatform

This enum is used to specify the scanner system type

Definition at line 39 of file system.h.

enum recoDim

Dimensions of acquired data, order is reversed for easy indexing of C-style arrays

• userdef: Extra dimension which can be used by the sequence programmer
• te: Echo-time index in a multi-echo acquistion, e.g. for field-map calculation
• average: Average index to add up ADCs
• cycle: Cycle index (for phase cycling and spiral imaging)
• slice: Slice index
• line3d: 3D phase encoding index
• line: 2D phase encoding index
• echo: Echo index in a multi-echo readout, e.g. an CPMG or EPI echo train
• templtype: Type of template scan
• freq: Frequency offset (will be used by multi-frequency reconstruction in odinreco)
• channel: Channel index of phased-array coil
• readout: Readout index
• repetition: Repetition dimension

Definition at line 73 of file reco.h.

enum recoFlags

Flags(bits) to mark ADCs:

• recoLastInChunkBit: last ADC in a collection of consecutive ADCs generated by the system, an undefined number of zeroes may follow
• recoReflectBit : reflect ADC

Definition at line 47 of file reco.h.

enum sampleDim

Dimension inidices of the 4-dim sample grid

Definition at line 37 of file sample.h.

enum sliceBoundary

Enum to specify which boundary of a slice to take for a given direction

Definition at line 39 of file geometry.h.

enum sliceOrientation

Enum for the slice direction in the anatomical system of reference

Definition at line 45 of file geometry.h.

enum templateType

Enum to distinguish between different types of template corrections of ADCs:

• no_template: Not a template ADC
• phasecorr_template: Template ADC for 1D phase correction
• fieldmap_template: Template to calculate fieldmap, the echo dimension will index the different TEs
• grappa_template: Training data to calculate GRAPPA weights
• epiprescan_template: Siemens EPI phase correction template

Definition at line 90 of file reco.h.

---