Sample Class Reference
[MR Parameters (odinpara library)]

Virtual Sample for Simulation. More...

#include <sample.h>

Inheritance diagram for Sample:

[legend]Collaboration diagram for Sample:

[legend]List of all members.

Public Member Functions
	Sample (const STD_string &label="unnamedSample", bool uniformFOV=true, bool uniformT1T2=false)
	Sample (const Sample &ss)
Sample &	operator= (const Sample &ss)
Sample &	set_FOV (float fov)
Sample &	set_FOV (axis direction, float fov)
float	get_FOV (axis direction) const
Sample &	set_spatial_offset (axis direction, float offs)
float	get_spatial_offset (axis direction) const
Sample &	set_freqrange (float range)
float	get_freqrange () const
Sample &	set_freqoffset (float offs)
float	get_freqoffset () const
Sample &	resize (unsigned int xsize, unsigned int ysize, unsigned int zsize, unsigned int freqsize=1)
const ndim &	get_extent () const
Sample &	set_T1 (float relaxation_time)
Sample &	set_T2 (float relaxation_time)
Sample &	set_T1map (const farray &t1map)
const farray &	get_T1map () const
Sample &	set_T2map (const farray &t2map)
const farray &	get_T2map () const
Sample &	set_ppmMap (const farray &ppmmap)
const farray &	get_ppmMap () const
Sample &	set_spinDensity (const farray &sd)
const farray &	get_spinDensity () const
Sample &	set_B1map (const carray &b1map)
const carray &	get_B1map () const
Sample &	set_DcoeffMap (const farray &dmap)
const farray &	get_DcoeffMap () const
Sample &	update ()
int	load (const STD_string &filename)
Friends
class	SeqSimMagsi

---

Detailed Description

Virtual Sample for Simulation.

Class to store properties of a virtual sample which is used as input to simulation. The arrays are 4-dimensional: one frequency dimension and 3 spatial dimensions. Coordinates are in the laboratory frame of reference.

Definition at line 51 of file sample.h.

---

Constructor & Destructor Documentation

Sample::Sample	(	const STD_string &	label = "unnamedSample",
		bool	uniformFOV = true,
		bool	uniformT1T2 = false
	)

Constructs a sample consisting of single voxel with the given label and the parameters:

• uniformFOV: A uniform FOV is used in each spatial dimension
• uniformT1T2: Uniform relaxation constants T1 and T2 are used, set_T1/2map has no effect

Sample::Sample

(

const Sample &

ss

)

Constructs a copy of 'ss'

---

Member Function Documentation

Sample& Sample::operator=

(

const Sample &

ss

)

Assignment operator that makes this Sample become a copy of 'ss'

Sample& Sample::set_FOV

(

float

fov

)

Sets the uniform FOV of the sample

Sample& Sample::set_FOV	(	axis	direction,
		float	fov
	)

Sets the FOV of the sample in the given direction

float Sample::get_FOV

(

axis

direction

)

const

Returns the FOV of the sample in the given direction

Sample& Sample::set_spatial_offset	(	axis	direction,
		float	offs
	)			[inline]

Sets the spatial offset in the given direction

Definition at line 90 of file sample.h.

float Sample::get_spatial_offset

(

axis

direction

)

const [inline]

Returns the spatial offset in the given direction

Definition at line 95 of file sample.h.

Sample& Sample::set_freqrange

(

float

range

)

[inline]

Sets the frequency range

Definition at line 100 of file sample.h.

float Sample::get_freqrange

(

)

const [inline]

Returns the frequency range

Definition at line 105 of file sample.h.

Sample& Sample::set_freqoffset

(

float

offs

)

[inline]

Sets the frequency offset

Definition at line 110 of file sample.h.

float Sample::get_freqoffset

(

)

const [inline]

Returns the frequency offset

Definition at line 115 of file sample.h.

Sample& Sample::resize	(	unsigned int	xsize,
		unsigned int	ysize,
		unsigned int	zsize,
		unsigned int	freqsize = 1
	)

Resize the sample in the four dimensions according to the given sizes:

• xsize: Spatial extent in x-direction
• ysize: Spatial extent in y-direction
• zsize: Spatial extent in z-direction
• freqsize: Number of frequency intervals

const ndim& Sample::get_extent

(

)

const

Returns the extent vector

Sample& Sample::set_T1

(

float

relaxation_time

)

[inline]

Sets a uniform longitudinal relaxation time

Definition at line 136 of file sample.h.

Sample& Sample::set_T2

(

float

relaxation_time

)

[inline]

Sets a uniform transverse relaxation time

Definition at line 141 of file sample.h.

Sample& Sample::set_T1map

(

const farray &

t1map

)

Sets an array for the longitudinal relaxation time

const farray& Sample::get_T1map

(

)

const

Returns the array for the longitudinal relaxation time

Sample& Sample::set_T2map

(

const farray &

t2map

)

Sets an array for the transverse relaxation time

const farray& Sample::get_T2map

(

)

const

Returns the array for the transverse relaxation time

Sample& Sample::set_ppmMap

(

const farray &

ppmmap

)

Sets an array for the relative frequency offset (in ppm)

const farray& Sample::get_ppmMap

(

)

const

Returns an array for the relative frequency offset (in ppm)

Sample& Sample::set_spinDensity

(

const farray &

sd

)

Sets an array for the spin density of each voxel

const farray& Sample::get_spinDensity

(

)

const

Returns an array for the spin density of each voxel

Sample& Sample::set_B1map

(

const carray &

b1map

)

Sets an array for the complex modulation of the RF field at each voxel

const carray& Sample::get_B1map

(

)

const

Returns an array for the complex modulation of the RF field at each voxel

Sample& Sample::set_DcoeffMap

(

const farray &

dmap

)

Sets the diffusion coefficient map

const farray& Sample::get_DcoeffMap

(

)

const

Returns the diffusion coefficient map

Sample& Sample::update

(

)

Updates all parameter relations

int Sample::load

(

const STD_string &

filename

)

[virtual]

Loads the parameter(s) from a JCAMP-DX file. In case of calling this function of a single paramter, the file is searched for this parameter and the value is assigned. In case of a parameter block, all parameter values are taken from the file. The return value is the number of parameters which are successfully parsed. If an error occurs, -1 is returned.

Reimplemented from JcampDxBlock.

---

The documentation for this class was generated from the following file:

• sample.h

---