ExternalCoil Class Reference

Prototype of an ideal coil. More...

#include <ExternalCoil.h>

Inheritance diagram for ExternalCoil:

Collaboration diagram for ExternalCoil:

List of all members.

Public Member Functions
	ExternalCoil ()
	Default constructor.
	~ExternalCoil ()
	Default destructor.
virtual ExternalCoil *	Clone () const
	Prototype cloning mechanism.
virtual double	GetSensitivity (double *position)
	Get the B1+ magnitude at point (x,y,z).
virtual double	GetPhase (double *position)
	Get the B1+ phase at point (x,y,z).
virtual bool	Prepare (PrepareMode mode)
	Prepare a coil with provided sensitivity map. Called twice one for initialisation once for configuration.

---

Detailed Description

Prototype of an ideal coil.

Definition at line 32 of file ExternalCoil.h.

---

Member Function Documentation

ExternalCoil * ExternalCoil::Clone

(

)

const [virtual]

Prototype cloning mechanism.

Returns:

An unprepared clone

Implements Coil.

Definition at line 31 of file ExternalCoil.cpp.

References ExternalCoil().

Here is the call graph for this function:

double ExternalCoil::GetPhase

(

double *

position

)

[virtual]

Get the B1+ phase at point (x,y,z).

This method may be implemented by every derived coil. Otherwise phase is zero.

Important: the phase of Coils needs to be implemented with unit radians! (In contrast to the phase of RF pulses which has units degrees.)

Parameters:

position

At position.

Returns:

B1+ phase with respect to spin in World.

Reimplemented from Coil.

Definition at line 43 of file ExternalCoil.cpp.

References Coil::InterpolateSensitivity().

Here is the call graph for this function:

double ExternalCoil::GetSensitivity

(

double *

position

)

[virtual]

Get the B1+ magnitude at point (x,y,z).

This method must be implemented by every derived coil.

Parameters:

position

At position.

Returns:

Sensitivity with respect to spin in World.

Implements Coil.

Definition at line 36 of file ExternalCoil.cpp.

References Coil::InterpolateSensitivity().

Here is the call graph for this function:

bool ExternalCoil::Prepare

(

PrepareMode

mode

)

[virtual]

Prepare a coil with provided sensitivity map. Called twice one for initialisation once for configuration.

Parameters:

mode

Sets the preparation mode, one of enum PrepareMode {PREP_INIT,PREP_VERBOSE}.

Returns:

Success

Reimplemented from Coil.

Definition at line 50 of file ExternalCoil.cpp.

References Coil::m_complex, Coil::m_dim, and Coil::m_points.

---

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

• ExternalCoil.h
• ExternalCoil.cpp