ODIN
Public Member Functions | Friends | List of all members

#include <seqparallel.h>

Inheritance diagram for SeqParallel:
Inheritance graph
[legend]

Public Member Functions

 SeqParallel (const STD_string &object_label="unnamedSeqParallel")
 
 SeqParallel (const SeqParallel &sgp)
 
SeqParalleloperator= (const SeqParallel &sgp)
 
SeqParalleloperator/= (SeqGradChan &sgc)
 
SeqParalleloperator/= (SeqGradChanList &sgcl)
 
SeqParalleloperator/= (SeqGradChanParallel &sgcp)
 
SeqParalleloperator/= (SeqGradObjInterface &sgoa)
 
SeqParalleloperator/= (const SeqObjBase &soa)
 
STD_string get_program (programContext &context) const
 
double get_duration () const
 
STD_string get_properties () const
 
unsigned int event (eventContext &context) const
 
SeqValList get_freqvallist (freqlistAction action) const
 
SeqValList get_delayvallist () const
 
void query (queryContext &context) const
 
RecoValList get_recovallist (unsigned int reptimes, LDRkSpaceCoords &coords) const
 
double get_rf_energy () const
 
SeqGradInterfaceset_strength (float gradstrength)
 
SeqGradInterfaceinvert_strength ()
 
float get_strength () const
 
fvector get_gradintegral () const
 
double get_gradduration () const
 
SeqGradInterfaceset_gradrotmatrix (const RotMatrix &matrix)
 
double get_pulprogduration () const
 
void clear ()
 
- Public Member Functions inherited from SeqTreeObj
bool contains (const SeqTreeObj *sto) const
 
void tree (SeqTreeCallbackAbstract *display) const
 
- Public Member Functions inherited from SeqClass
SeqClassset_temporary ()
 
- Public Member Functions inherited from Labeled
 Labeled (const STD_string &label="unnamed")
 
Labeledset_label (const STD_string &label)
 
const STD_string & get_label () const
 
Labeledoperator= (const Labeled &l)
 
- Public Member Functions inherited from SeqGradInterface
float get_gradintegral_norm () const
 

Friends

class SeqOperator
 
class SeqObjList
 
class SeqObjVector
 
class SeqGradObjInterface
 
class SeqGradChanList
 

Additional Inherited Members

- Protected Member Functions inherited from SeqClass
void marshall_error () const
 
virtual bool prep ()
 
- Static Protected Member Functions inherited from SeqClass
static void clear_temporary ()
 
static void clear_containers ()
 

Detailed Description

This container class is used to play out a sequence object (RF pulse, acquisition) and a gradient object in parallel

Definition at line 58 of file seqparallel.h.

Constructor & Destructor Documentation

◆ SeqParallel() [1/2]

SeqParallel::SeqParallel ( const STD_string &  object_label = "unnamedSeqParallel")

Construct an empty gradient channel list with the given label

◆ SeqParallel() [2/2]

SeqParallel::SeqParallel ( const SeqParallel sgp)

Constructs a copy of 'sgp'

Member Function Documentation

◆ clear()

void SeqParallel::clear ( )

Clears the RF anf gradient part

◆ event()

unsigned int SeqParallel::event ( eventContext context) const
virtual

Queries the sequence tree for events, returns the number of events executed

Reimplemented from SeqTreeObj.

◆ get_delayvallist()

SeqValList SeqParallel::get_delayvallist ( ) const
virtual

Returns the list of delay values in the objects branch of the sequence tree

Reimplemented from SeqTreeObj.

◆ get_duration()

double SeqParallel::get_duration ( ) const
virtual

Returns the duration of the sequence object.

Implements SeqTreeObj.

◆ get_freqvallist()

SeqValList SeqParallel::get_freqvallist ( freqlistAction  action) const
virtual

Returns the list of frequency values in the objects branch of the sequence tree

Reimplemented from SeqTreeObj.

◆ get_gradduration()

double SeqParallel::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.

◆ get_gradintegral()

fvector SeqParallel::get_gradintegral ( ) const
virtual

Returns the integral vector of the gradient course

Implements SeqGradInterface.

◆ get_program()

STD_string SeqParallel::get_program ( programContext context) const
inlinevirtual

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.

Definition at line 113 of file seqparallel.h.

◆ get_properties()

STD_string SeqParallel::get_properties ( ) const
virtual

Returns a string describing the object

Reimplemented from SeqTreeObj.

Reimplemented in SeqPulsar.

◆ get_pulprogduration()

double SeqParallel::get_pulprogduration ( ) const

Returns the duration for the gradient commands in the pulse programm

◆ get_recovallist()

RecoValList SeqParallel::get_recovallist ( unsigned int  reptimes,
LDRkSpaceCoords coords 
) const
virtual

Appends the k-space coordinates in this branch of the sequence tree to 'coords' and returns their ordering

Reimplemented from SeqTreeObj.

◆ get_rf_energy()

double SeqParallel::get_rf_energy ( ) const
virtual

Returns the RF power deposition in the objects branch of the sequence tree. The physical unit is unspecified, it depends on the current platform.

Reimplemented from SeqTreeObj.

◆ get_strength()

float SeqParallel::get_strength ( ) const
virtual

Returns the strength of the gradient object

Implements SeqGradInterface.

Reimplemented in SeqPulsar.

◆ invert_strength()

SeqGradInterface& SeqParallel::invert_strength ( )
virtual

Changes the polarity of the gradient, i.e. inverts the sign of the gradient strength

Implements SeqGradInterface.

◆ operator/=() [1/5]

SeqParallel& SeqParallel::operator/= ( const SeqObjBase soa)

Makes 'soa' become the RF part

◆ operator/=() [2/5]

SeqParallel& SeqParallel::operator/= ( SeqGradChan sgc)

Makes 'sgc' become the gradient part

◆ operator/=() [3/5]

SeqParallel& SeqParallel::operator/= ( SeqGradChanList sgcl)

Makes 'sgcl' become the gradient part

◆ operator/=() [4/5]

SeqParallel& SeqParallel::operator/= ( SeqGradChanParallel sgcp)

Makes 'sgcp' become the gradient part

◆ operator/=() [5/5]

SeqParallel& SeqParallel::operator/= ( SeqGradObjInterface sgoa)

Makes 'sgoa' become the gradient part

◆ operator=()

SeqParallel& SeqParallel::operator= ( const SeqParallel sgp)

Assignment operator

◆ query()

void SeqParallel::query ( queryContext context) const
virtual

Query the sequence tree recursively

Reimplemented from SeqTreeObj.

◆ set_gradrotmatrix()

SeqGradInterface& SeqParallel::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.

◆ set_strength()

SeqGradInterface& SeqParallel::set_strength ( float  gradstrength)
virtual

Changes the strength of the gradient object

Implements SeqGradInterface.


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