SeqGradChanList Class Reference
[Internal Classes for sequence design (odinseq library)]
#include <seqgradchanlist.h>
Public Member Functions | |
| SeqGradChanList (const STD_string &object_label="unnamedSeqGradChanList") | |
| SeqGradChanList (const SeqGradChanList &sgcl) | |
| ~SeqGradChanList () | |
| SeqGradChanList & | operator= (const SeqGradChanList &sgcl) |
| double | get_duration () const |
| STD_string | get_properties () const |
| unsigned int | event (eventContext &context) const |
| void | query (queryContext &context) const |
| SeqGradInterface & | set_strength (float gradstrength) |
| SeqGradInterface & | invert_strength () |
| float | get_strength () const |
| fvector | get_gradintegral () const |
| double | get_gradduration () const |
| SeqGradInterface & | set_gradrotmatrix (const RotMatrix &matrix) |
| direction | get_channel () const |
| SeqGradChanList & | operator+= (SeqGradChanList &sgcl) |
| SeqGradChanList & | operator+= (SeqGradChan &sgc) |
Friends | |
| class | SeqGradChanParallel |
Detailed Description
This class represents a list of gradient channel objects (i.e. those derived from SeqGradChan) It is suitable to hold a gradient train for ONE gradient channelDefinition at line 33 of file seqgradchanlist.h.
Constructor & Destructor Documentation
| SeqGradChanList::SeqGradChanList | ( | const STD_string & | object_label = "unnamedSeqGradChanList" |
) |
Construct an empty gradient channel list with the given label
| SeqGradChanList::SeqGradChanList | ( | const SeqGradChanList & | sgcl | ) |
Constructs a copy of 'sgcl'
| SeqGradChanList::~SeqGradChanList | ( | ) |
Destructor
Member Function Documentation
| SeqGradChanList& SeqGradChanList::operator= | ( | const SeqGradChanList & | sgcl | ) |
Assignment operator that makes this gradient sequence object become a copy of 'sgcl'
| double SeqGradChanList::get_duration | ( | ) | const [virtual] |
Returns the duration of the sequence object.
Implements SeqTreeObj.
| STD_string SeqGradChanList::get_properties | ( | ) | const [virtual] |
Returns a string describing the object
Reimplemented from SeqTreeObj.
| unsigned int SeqGradChanList::event | ( | eventContext & | context | ) | const [virtual] |
Queries the sequence tree for events, returns the number of events executed
Reimplemented from SeqTreeObj.
| void SeqGradChanList::query | ( | queryContext & | context | ) | const [virtual] |
Query the sequence tree recursively
Reimplemented from SeqTreeObj.
| SeqGradInterface& SeqGradChanList::set_strength | ( | float | gradstrength | ) | [virtual] |
Changes the strength of the gradient object
Implements SeqGradInterface.
Reimplemented in SeqGradConstPulse, and SeqGradVectorPulse.
| SeqGradInterface& SeqGradChanList::invert_strength | ( | ) | [virtual] |
Changes the polarity of the gradient, i.e. inverts the sign of the gradient strength
Implements SeqGradInterface.
| float SeqGradChanList::get_strength | ( | ) | const [virtual] |
Returns the strength of the gradient object
Implements SeqGradInterface.
Reimplemented in SeqGradTrapez.
| fvector SeqGradChanList::get_gradintegral | ( | ) | const [virtual] |
Returns the integral vector of the gradient course
Implements SeqGradInterface.
| double SeqGradChanList::get_gradduration | ( | ) | const [virtual] |
Returns the duration of the gradient object. This function returns only the effective duration during whichthe gradient is active, any delays before and after the gradient are omitted.
Implements SeqGradInterface.
Reimplemented in SeqGradTrapez.
| SeqGradInterface& SeqGradChanList::set_gradrotmatrix | ( | const RotMatrix & | matrix | ) | [virtual] |
This function can be used to specify a rotation of the gradient object in the spatial domain, the rotation will be applied to this object only rather than to the whole sequence.
Implements SeqGradInterface.
| direction SeqGradChanList::get_channel | ( | ) | const |
Returns the occupied channel, declared virtual so that SeqGradChanList's that have a single IDEA objects can override it
| SeqGradChanList& SeqGradChanList::operator+= | ( | SeqGradChanList & | sgcl | ) |
Appends the elements of 'sgcl' to this
| SeqGradChanList& SeqGradChanList::operator+= | ( | SeqGradChan & | sgc | ) |
Appends 'sgc' to this
The documentation for this class was generated from the following file:
