CoilArray Class Reference

Coil configuration and sensitivities. More...

#include <CoilArray.h>

Collaboration diagram for CoilArray:

Public Member Functions
	CoilArray ()
	Default constructor.
void	Initialize (string uri)
	Initialize the array and its elements.
unsigned int	Populate ()
	Populate coil array Run over coil array configuration tree and Populate the array.
virtual	~CoilArray ()
	Default destructor.
DOMNode *	RunTree (DOMNode *node, void *ptr, unsigned int(*fun)(void *, DOMNode *))
	Run over XML tree and return nodes.
unsigned int	GetSize ()
	Get the number of channels.
void	InitializeSignals (long lADCs)
	Create the signal structures of given size for all my coils.
void	Receive (long lADC)
	Recieve a signal from the World singleton with my coils for a given event.
IO::Status	DumpSignals (string tmp_prefix="", bool normalize=true)
	Dump all signals Dump the signals from all coils to discrete files.
IO::Status	DumpSignalsISMRMRD (string prefix="_ismrmrd", bool normalize=true)
	Dump all signals Dump the signals from all coils to ISMRMRD file.
IO::Status	DumpSensMaps (bool verbose=false)
	Dump all sensitivities Dump the sensitivities from all coils to discrete files.
void	SetSignalPrefix (string val)
	Set signal file-name prefix Set the prefix string for signal binary filenames.
string	GetSignalPrefix ()
void	SetSenMaplPrefix (string val)
string	GetSenMaplPrefix ()
void	SetSenMapOutputDir (string dir)
	Set SensMap output directory Directory the SensMap is saved to.
string	GetSenMapOutputDir ()
void	SetSignalOutputDir (string dir)
	Set signals output directory Directory the signal binary is saved to.
string	GetSignalOutputDir ()
Coil *	GetCoil (unsigned channel)
	Get a particular coil.
bool	Prepare (const PrepareMode mode)
	Prepare my coils.
void	setMode (unsigned short mode)
int	ReadRestartSignal ()
	reads restart signal.

Static Public Member Functions
static unsigned int	CreateCoil (void *ptr, DOMNode *node)
	Clone a coil.

Private Attributes
vector< Coil * >	m_coils
	My coils
double	m_radius
	My radius
unsigned short	m_mode
	My mode (RX/TX)
string	m_signal_prefix
	prefix string to signal binary filenames
string	m_senmap_prefix
	prefix string to sensitivity map filenames
string	m_signal_output_dir
	string to signal directory
string	m_senmap_output_dir
	string to sensitivity map directory
CoilPrototypeFactory *	m_cpf
	Coil factory
DOMDocument *	m_dom_doc
	DOM document containing configuration.
Parameters *	m_params
	My parameters
XMLIO *	m_xio
	My XML IO module
bool	m_normalized =false
	WIP parameter to check if data was already normalized by DumpSignals().

Detailed Description

Coil configuration and sensitivities.

Constructor & Destructor Documentation

CoilArray()

CoilArray::CoilArray

(

)

Default constructor.

Empty constructor will create a single channel ideal coil with flat sensitivity map.

Member Function Documentation

CreateCoil()

unsigned int CoilArray::CreateCoil ( void * ptr, DOMNode * node )

static

Clone a coil.

Parameters

ptr	Pointer to myself
node	DOMNode with coil configuation

Returns

Created coil

Here is the call graph for this function:

Here is the caller graph for this function:

GetCoil()

Coil * CoilArray::GetCoil

(

unsigned

channel

)

Get a particular coil.

Parameters

channel

The number of the particular channel.

Returns

The requested coil.

Here is the caller graph for this function:

GetSize()

unsigned int CoilArray::GetSize ( )

inline

Get the number of channels.

Returns

The number of my channels

Here is the caller graph for this function:

Initialize()

void CoilArray::Initialize

(

string

uri

)

Initialize the array and its elements.

Parameters

uri	Configuration file. (Assigned to Simulation in simu.xml)

Here is the call graph for this function:

Here is the caller graph for this function:

InitializeSignals()

void CoilArray::InitializeSignals

(

long

lADCs

)

Create the signal structures of given size for all my coils.

Parameters

lADCs

Number of ADC events.

Here is the call graph for this function:

Here is the caller graph for this function:

Prepare()

bool CoilArray::Prepare

(

const PrepareMode

mode

)

Prepare my coils.

Parameters

mode	Prepare mode

Returns

Success

Here is the caller graph for this function:

Receive()

void CoilArray::Receive

(

long

lADC

)

Recieve a signal from the World singleton with my coils for a given event.

Parameters

lADC	position of this ADC event within all ADC events.

Here is the call graph for this function:

Here is the caller graph for this function:

RunTree()

DOMNode * CoilArray::RunTree	(	DOMNode *	node,
		void *	ptr,
		unsigned int(*)(void *, DOMNode *)	fun )

Run over XML tree and return nodes.

Returns

All nodes in the tree.

Here is the call graph for this function:

Here is the caller graph for this function:

SetSenMapOutputDir()

void CoilArray::SetSenMapOutputDir ( string dir )

inline

Set SensMap output directory Directory the SensMap is saved to.

Parameters

dir	the directory (it is assumed that it exists)

SetSignalOutputDir()

void CoilArray::SetSignalOutputDir ( string dir )

inline

Set signals output directory Directory the signal binary is saved to.

Parameters

dir	the directory (it is assumed that it exists)

Here is the caller graph for this function:

SetSignalPrefix()

void CoilArray::SetSignalPrefix ( string val )

inline

Set signal file-name prefix Set the prefix string for signal binary filenames.

Parameters

val	the prefix

Here is the caller graph for this function:

---

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

• /Users/stoeckert/DZNE/workspace/jemris/src/CoilArray.h
• /Users/stoeckert/DZNE/workspace/jemris/src/CoilArray.cpp