JEMRIS  2.8.1
open-source MRI simulations
List of all members | Public Member Functions | Static Public Member Functions | Private Attributes
CoilArray Class Reference

Coil configuration and sensitivities. More...

#include <CoilArray.h>

+ Collaboration diagram for CoilArray:

Public Member Functions

 CoilArray ()
 Default constructor. More...
 
void Initialize (string uri)
 Initialize the array and its elements. More...
 
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. More...
 
unsigned int GetSize ()
 Get the number of channels. More...
 
void InitializeSignals (long lADCs)
 Create the signal structures of given size for all my coils. More...
 
void Receive (long lADC)
 Recieve a signal from the World singleton with my coils for a given event. More...
 
IO::Status DumpSignals (string tmp_prefix="", bool normalize=true)
 Dump all signals Dump the signals from all coils to discrete files.
 
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. More...
 
string GetSignalPrefix ()
 
void SetSenMaplPrefix (string val)
 
string GetSenMaplPrefix ()
 
void SetSenMapOutputDir (string dir)
 Set SensMap output directory Directory the SensMap is saved to. More...
 
string GetSenMapOutputDir ()
 
void SetSignalOutputDir (string dir)
 Set signals output directory Directory the signal binary is saved to. More...
 
string GetSignalOutputDir ()
 
CoilGetCoil (unsigned channel)
 Get a particular coil. More...
 
bool Prepare (const PrepareMode mode)
 Prepare my coils. More...
 
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. More...
 

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
 
CoilPrototypeFactorym_cpf
 Coil factory.
 
DOMDocument * m_dom_doc
 DOM document containing configuration.
 
Parametersm_params
 My parameters.
 
XMLIOm_xio
 My XML IO module.
 

Detailed Description

Coil configuration and sensitivities.

Constructor & Destructor Documentation

CoilArray::CoilArray ( )

Default constructor.

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

Member Function Documentation

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

Clone a coil.

Parameters
ptrPointer to myself
nodeDOMNode with coil configuation
Returns
Created coil

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Coil * CoilArray::GetCoil ( unsigned  channel)

Get a particular coil.

Parameters
channelThe number of the particular channel.
Returns
The requested coil.

+ Here is the caller graph for this function:

unsigned int CoilArray::GetSize ( )
inline

Get the number of channels.

Returns
The number of my channels

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void CoilArray::Initialize ( string  uri)

Initialize the array and its elements.

Parameters
uriConfiguration file. (Assigned to Simulation in simu.xml)

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void CoilArray::InitializeSignals ( long  lADCs)

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

Parameters
lADCsNumber of ADC events.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool CoilArray::Prepare ( const PrepareMode  mode)

Prepare my coils.

Parameters
modePrepare mode
Returns
Success

+ Here is the caller graph for this function:

void CoilArray::Receive ( long  lADC)

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

Parameters
lADCposition of this ADC event within all ADC events.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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 caller graph for this function:

void CoilArray::SetSenMapOutputDir ( string  dir)
inline

Set SensMap output directory Directory the SensMap is saved to.

Parameters
dirthe directory (it is assumed that it exists)

+ Here is the caller graph for this function:

void CoilArray::SetSignalOutputDir ( string  dir)
inline

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

Parameters
dirthe directory (it is assumed that it exists)

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void CoilArray::SetSignalPrefix ( string  val)
inline

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

Parameters
valthe prefix

+ Here is the caller graph for this function:


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

-- last change 17.06.2016 | Tony Stoecker | Imprint --