API documentation
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. | |
| void | DumpSignals (string tmp_prefix="", bool normalize=true) |
| Dump all signals Dump the signals from all coils to discrete files. | |
| void | 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. | |
| Coil * | GetCoil (unsigned channel) |
| Get a particular coil. | |
| bool | Prepare (PrepareMode mode) |
| Prepare my coils. | |
| int | ReadRestartSignal () |
| reads restart signal. | |
Static Public Member Functions | |
| static unsigned int | CreateCoil (void *ptr, DOMNode *node) |
| Clone a coil. | |
Detailed Description
Coil configuration and sensitivities.
Definition at line 37 of file CoilArray.h.
Constructor & Destructor Documentation
| CoilArray::CoilArray | ( | ) |
Default constructor.
Empty constructor will create a single channel ideal coil with flat sensitivity map.
Definition at line 30 of file CoilArray.cpp.
Member Function Documentation
| 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
Definition at line 80 of file CoilArray.cpp.
References CoilPrototypeFactory::Clone(), and Coil::Initialize().
Referenced by Populate().
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:
-
channel The number of the particular channel.
- Returns:
- The requested coil.
Definition at line 181 of file CoilArray.cpp.
Referenced by RFPulse::GetValue(), and mpi_recieve_sample_paket().
Here is the caller graph for this function:| unsigned int CoilArray::GetSize | ( | ) | [inline] |
Get the number of channels.
- Returns:
- The number of my channels
Definition at line 90 of file CoilArray.h.
Referenced by Simulator::DeleteTmpFiles(), DumpSensMaps(), DumpSignals(), InitializeSignals(), mpi_recieve_sample_paket(), ReadRestartSignal(), and Receive().
Here is the caller graph for this function:| void CoilArray::Initialize | ( | string | uri | ) |
Initialize the array and its elements.
- Parameters:
-
uri Configuration file. (Assigned to Simulation in simu.xml)
Definition at line 120 of file CoilArray.cpp.
References XMLIO::Parse().
Referenced by Simulator::SetRxCoilArray(), and Simulator::SetTxCoilArray().
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:
-
lADCs Number of ADC events.
Definition at line 127 of file CoilArray.cpp.
References GetSize().
Referenced by Simulator::Simulate().
Here is the call graph for this function:
Here is the caller graph for this function:| bool CoilArray::Prepare | ( | PrepareMode | mode | ) |
Prepare my coils.
- Parameters:
-
mode Prepare mode
- Returns:
- Success
Definition at line 70 of file CoilArray.cpp.
Referenced by Populate().
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:
-
lADC position of this ADC event within all ADC events.
Definition at line 135 of file CoilArray.cpp.
References GetSize().
Referenced by Model::RunSequenceTree().
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.
Definition at line 93 of file CoilArray.cpp.
Referenced by Populate().
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:
-
val the prefix
Definition at line 124 of file CoilArray.h.
Referenced by Simulator::SetRxCoilArray().
Here is the caller graph for this function:The documentation for this class was generated from the following files:














