SeqDecoupling Class Reference
[Classes for sequence design (odinseq library)]
Decoupling period.
More...
#include <seqdec.h>
Public Member Functions | |
| SeqDecoupling (const STD_string &object_label, const STD_string &nucleus, float decpower, const dvector &freqlist=0, const STD_string decprog="", float decpulsduration=0.0) | |
| SeqDecoupling (const SeqDecoupling &sd) | |
| SeqDecoupling (const STD_string &object_label="unnamedSeqDecoupling") | |
| SeqDecoupling & | operator() (const SeqObjBase &so) |
| float | get_decpower () const |
| void | set_decpower (float p) |
| STD_string | get_program () const |
| void | set_program (const STD_string &p) |
| double | get_pulsduration () const |
| void | set_pulsduration (float d) |
| SeqDecoupling & | operator= (const SeqDecoupling &sd) |
| double | get_duration () const |
| unsigned int | event (eventContext &context) const |
| STD_string | get_program (programContext &context) const |
| double | get_freqchan_duration () const |
| unsigned int | get_freqlistindex () const |
| const SeqVector & | get_freqlist_vector () const |
| void | clear_container () |
Detailed Description
Decoupling period.This class represents a decoupling container which can hold a part of the sequence where decoupling is switched on.
Definition at line 70 of file seqdec.h.
Constructor & Destructor Documentation
| SeqDecoupling::SeqDecoupling | ( | const STD_string & | object_label, | |
| const STD_string & | nucleus, | |||
| float | decpower, | |||
| const dvector & | freqlist = 0, |
|||
| const STD_string | decprog = "", |
|||
| float | decpulsduration = 0.0 | |||
| ) |
Constructs a container for a sequence part at which decoupling will be switched on with the following properties:
- nucleus: The nucleus for which the decoupling should be performed.
- decpower: The maximum power for the decoupling program.
- freqlist: Frequency list for the decoupler.
- decprog: The file name of the decoupling program which will be used. If none is specified, continuous wave decouling will be used.
- decpulsduration: If a decoupling program is given, this parameter determines the pulse duration of each single pulse in a composite pulse decoupling scheme.
| SeqDecoupling::SeqDecoupling | ( | const SeqDecoupling & | sd | ) |
Constructs a decoupling container which is a copy of 'sd'
| SeqDecoupling::SeqDecoupling | ( | const STD_string & | object_label = "unnamedSeqDecoupling" |
) |
Constructs an empty decoupling container with the given label.
Member Function Documentation
| SeqDecoupling& SeqDecoupling::operator() | ( | const SeqObjBase & | so | ) |
This function specifies that during the sequence part 'so' decoupling will be switched on.
| float SeqDecoupling::get_decpower | ( | ) | const [inline] |
| void SeqDecoupling::set_decpower | ( | float | p | ) | [inline] |
| STD_string SeqDecoupling::get_program | ( | ) | const |
Returns the decoupling program
| void SeqDecoupling::set_program | ( | const STD_string & | p | ) |
Sets the decoupling program
| double SeqDecoupling::get_pulsduration | ( | ) | const |
Returns the decoupling pulse duration for Composite Pulse Decoupling
| void SeqDecoupling::set_pulsduration | ( | float | d | ) |
Sets the decoupling pulse duration for Composite Pulse Decoupling
| SeqDecoupling& SeqDecoupling::operator= | ( | const SeqDecoupling & | sd | ) |
This assignment operator will make this object become an exact copy of 'sd'.
Reimplemented from SeqObjList.
| double SeqDecoupling::get_duration | ( | ) | const [virtual] |
Returns the duration of the sequence object.
Reimplemented from SeqObjList.
| unsigned int SeqDecoupling::event | ( | eventContext & | context | ) | const [virtual] |
Queries the sequence tree for events, returns the number of events executed
Reimplemented from SeqObjList.
| STD_string SeqDecoupling::get_program | ( | programContext & | context | ) | const [virtual] |
Returns the part in the pulse/gradient program of this sequence object. 'context' holds data about how the program should be generated, e.g. type of program and formatting.
Reimplemented from SeqObjList.
| double SeqDecoupling::get_freqchan_duration | ( | ) | const [inline, virtual] |
Overload this function to return the duration of the object while it effectively occupies the RF channel
Reimplemented from SeqFreqChan.
| unsigned int SeqDecoupling::get_freqlistindex | ( | ) | const [inline, virtual] |
Return the index for the frequency list
Reimplemented from SeqFreqChan.
| const SeqVector& SeqDecoupling::get_freqlist_vector | ( | ) | const [virtual] |
Returns the frequency list vector (for loop insertion)
Reimplemented from SeqFreqChan.
| void SeqDecoupling::clear_container | ( | ) | [virtual] |
Overload this function in case the class is a container object, i.e. it contains other sequence objects. The function should clear all references to other sequence objects, i.e. to thos it contains.
Reimplemented from SeqObjList.
The documentation for this class was generated from the following file:
