SeqGradChanParallel Class Reference
[Internal Classes for sequence design (odinseq library)]
#include <seqgradchanparallel.h>
Public Member Functions | |
| SeqGradChanParallel (const STD_string &object_label="unnamedSeqGradChanParallel") | |
| SeqGradChanParallel (const SeqGradChanParallel &sgcp) | |
| ~SeqGradChanParallel () | |
| SeqGradChanParallel & | operator= (const SeqGradChanParallel &sgcp) |
| STD_string | get_program (programContext &context) 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) |
| SeqGradChanParallel & | operator+= (SeqGradChan &sgc) |
| SeqGradChanParallel & | operator+= (SeqGradChanList &sgcl) |
| SeqGradChanParallel & | operator+= (SeqGradChanParallel &sgcp) |
| void | clear () |
Friends | |
| class | SeqOperator |
| class | SeqGradChan |
| class | SeqGradChanList |
Detailed Description
This class is a container for three SeqGradChanList'sDefinition at line 60 of file seqgradchanparallel.h.
Constructor & Destructor Documentation
| SeqGradChanParallel::SeqGradChanParallel | ( | const STD_string & | object_label = "unnamedSeqGradChanParallel" |
) |
Construct an empty gradient channel list with the given label
| SeqGradChanParallel::SeqGradChanParallel | ( | const SeqGradChanParallel & | sgcp | ) |
Constructs a copy of 'sgcp'
| SeqGradChanParallel::~SeqGradChanParallel | ( | ) |
Destructor
Member Function Documentation
| SeqGradChanParallel& SeqGradChanParallel::operator= | ( | const SeqGradChanParallel & | sgcp | ) |
Assignment operator that makes this gradient sequence object become a copy of 'sgcp'
| STD_string SeqGradChanParallel::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 SeqTreeObj.
| STD_string SeqGradChanParallel::get_properties | ( | ) | const [virtual] |
Returns a string describing the object
Reimplemented from SeqTreeObj.
| unsigned int SeqGradChanParallel::event | ( | eventContext & | context | ) | const [virtual] |
Queries the sequence tree for events, returns the number of events executed
Reimplemented from SeqTreeObj.
| void SeqGradChanParallel::query | ( | queryContext & | context | ) | const [virtual] |
Query the sequence tree recursively
Reimplemented from SeqTreeObj.
| SeqGradInterface& SeqGradChanParallel::set_strength | ( | float | gradstrength | ) | [virtual] |
Changes the strength of the gradient object
Implements SeqGradInterface.
| SeqGradInterface& SeqGradChanParallel::invert_strength | ( | ) | [virtual] |
Changes the polarity of the gradient, i.e. inverts the sign of the gradient strength
Implements SeqGradInterface.
| float SeqGradChanParallel::get_strength | ( | ) | const [virtual] |
Returns the strength of the gradient object
Implements SeqGradInterface.
| fvector SeqGradChanParallel::get_gradintegral | ( | ) | const [virtual] |
Returns the integral vector of the gradient course
Implements SeqGradInterface.
| double SeqGradChanParallel::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.
| SeqGradInterface& SeqGradChanParallel::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.
| SeqGradChanParallel& SeqGradChanParallel::operator+= | ( | SeqGradChan & | sgc | ) |
Appends 'sgc' to this
| SeqGradChanParallel& SeqGradChanParallel::operator+= | ( | SeqGradChanList & | sgcl | ) |
Appends 'sgcl' to this
| SeqGradChanParallel& SeqGradChanParallel::operator+= | ( | SeqGradChanParallel & | sgcp | ) |
Appends 'sgcp' to this
| void SeqGradChanParallel::clear | ( | ) |
Clear all sublists
The documentation for this class was generated from the following file:
