msl::samplings::StackOfSpirals Class Reference

Detailed Description

Stack of spirals in the kx-ky plane, stacked on the kz axis.

#include <StackOfSpirals.h>

Public Types
using	Pointer = std::shared_ptr<StackOfSpirals>
	Reference-counted pointer to StackOfSpirals.
using	ConstPointer = std::shared_ptr<StackOfSpirals const>
	Reference-counted constant pointer to StackOfSpirals.
Public Types inherited from msl::Sampling
using	Pointer = std::shared_ptr<Sampling>
	Reference-counted pointer to Sampling.
using	ConstPointer = std::shared_ptr<Sampling const>
	Reference-counted constant pointer to Sampling.

Public Member Functions
	StackOfSpirals (StackOfSpirals const &)=default
	StackOfSpirals (StackOfSpirals &&)=default
StackOfSpirals &	operator= (StackOfSpirals const &)=default
StackOfSpirals &	operator= (StackOfSpirals &&)=default
double	phase () const override
	Return the phase of the NCO during the readout.
StackOfSpirals &	setPhase (double phase) override
	Set the phase of the NCO during the readout.
long	contrast () const override
	Return the contrast number.
StackOfSpirals &	setContrast (long contrast) override
	Set the contrast number.
long	timeOffset () const override
	Return the time offset to get the effective echo time, accounting e.g. for the time of the excitation pulse peak.
StackOfSpirals &	setTimeOffset (long timeOffset) override
	Set the time offset to get the effective echo time, accounting e.g. for the time of the excitation pulse peak.
GradientSpecs const &	gradientSpecs () const override
	Return the gradient specifications constraining the read-out duration.
StackOfSpirals &	setGradientSpecs (GradientSpecs const &gradientSpecs) override
	Set the gradient specifications constraining the read-out duration.
uint32_t	interleaves () const
	Return the number of interleaves per partition.
iPATMask const &	mask () const
	Return the iPAT mask.
StackOfSpirals &	setMask (iPATMask const &mask)
	Set the iPAT mask.
iPATMask::Points	enabledPoints () const
	Return the enabled points of the mask.
bool	runFirstInterleaveOnly () const
	Return whether to run the first interleave only (e.g. in check mode).
StackOfSpirals &	setRunFirstInterleaveOnly (bool runFirstInterleaveOnly)
	Set whether to run the first interleave only (e.g. in check mode).
NLSStatus	prepare (MrProt &protocol, SeqLim &limits, SeqExpo &exports) override
	Prepare the real-time events.
NLSStatus	run (MrProt &protocol, SeqLim &limits, SeqExpo &exports) override
	Run the real-time events.
long	startTime () const override
	Return the start time of the events.
long	endTime () const override
	Return the end time of the events.
MrProtocolData::SeqExpoRFInfo	rfInfo () const override
	Return the RF information for SAR computation.
NLSStatus	updateReadout (MrProt &protocol, SeqLim &limits, SeqExpo &exports) override
	Update the readout with respect to index so that a subsequent call to readout() returns a readout matching the index.
readouts::Spiral const &	readout () const override
	Return a reference to the concrete readout.
Public Member Functions inherited from msl::Sampling
	Sampling (Sampling const &)=default
	Sampling (Sampling &&)=default
Sampling &	operator= (Sampling const &)=default
Sampling &	operator= (Sampling &&)=default
std::size_t	index () const
	Return the index of the current trajectory.
Sampling &	setIndex (std::size_t index)
	Set the index of the current trajectory.
std::size_t	size () const
	Return the number of trajectories.
Public Member Functions inherited from msl::RealTimeEvents
	RealTimeEvents ()
	No-op constructor.
	RealTimeEvents (RealTimeEvents const &)=default
	RealTimeEvents (RealTimeEvents &&)=default
RealTimeEvents &	operator= (RealTimeEvents const &)=default
RealTimeEvents &	operator= (RealTimeEvents &&)=default
sSLICE_POS const &	slice () const
	Return the slice used in prepare and run.
virtual RealTimeEvents &	setSlice (sSLICE_POS const &slice)
	Set the slice used in prepare and run.

Additional Inherited Members
Protected Attributes inherited from msl::Sampling
std::size_t	_size
	Number of items in the Sampling.
std::size_t	_index
	Index of the current item.
Protected Attributes inherited from msl::RealTimeEvents
sSLICE_POS	_slice
	Slice specifications attached to this real time object.

Member Function Documentation

phase()

double msl::samplings::StackOfSpirals::phase ( ) const

overridevirtual

Return the phase of the NCO during the readout.

Implements msl::Sampling.

setPhase()

StackOfSpirals & msl::samplings::StackOfSpirals::setPhase ( double phase )

overridevirtual

Set the phase of the NCO during the readout.

Implements msl::Sampling.

contrast()

long msl::samplings::StackOfSpirals::contrast ( ) const

overridevirtual

Return the contrast number.

Implements msl::Sampling.

setContrast()

StackOfSpirals & msl::samplings::StackOfSpirals::setContrast ( long contrast )

overridevirtual

Set the contrast number.

Implements msl::Sampling.

timeOffset()

long msl::samplings::StackOfSpirals::timeOffset ( ) const

overridevirtual

Return the time offset to get the effective echo time, accounting e.g. for the time of the excitation pulse peak.

Implements msl::Sampling.

setTimeOffset()

StackOfSpirals & msl::samplings::StackOfSpirals::setTimeOffset ( long timeOffset )

overridevirtual

Set the time offset to get the effective echo time, accounting e.g. for the time of the excitation pulse peak.

Implements msl::Sampling.

gradientSpecs()

GradientSpecs const & msl::samplings::StackOfSpirals::gradientSpecs ( ) const

overridevirtual

Return the gradient specifications constraining the read-out duration.

Implements msl::Sampling.

setGradientSpecs()

StackOfSpirals & msl::samplings::StackOfSpirals::setGradientSpecs ( GradientSpecs const & gradientSpecs )

overridevirtual

Set the gradient specifications constraining the read-out duration.

Implements msl::Sampling.

interleaves()

uint32_t msl::samplings::StackOfSpirals::interleaves

(

)

const

Return the number of interleaves per partition.

Warning

Requires a previous call to prepare

prepare()

NLSStatus msl::samplings::StackOfSpirals::prepare ( MrProt & protocol, SeqLim & limits, SeqExpo & exports )

overridevirtual

Prepare the real-time events.

Implements msl::RealTimeEvents.

run()

NLSStatus msl::samplings::StackOfSpirals::run ( MrProt & protocol, SeqLim & limits, SeqExpo & exports )

overridevirtual

Run the real-time events.

Implements msl::RealTimeEvents.

startTime()

long msl::samplings::StackOfSpirals::startTime ( ) const

overridevirtual

Return the start time of the events.

Implements msl::RealTimeEvents.

endTime()

long msl::samplings::StackOfSpirals::endTime ( ) const

overridevirtual

Return the end time of the events.

Implements msl::RealTimeEvents.

rfInfo()

MrProtocolData::SeqExpoRFInfo msl::samplings::StackOfSpirals::rfInfo ( ) const

overridevirtual

Return the RF information for SAR computation.

Implements msl::RealTimeEvents.

updateReadout()

NLSStatus msl::samplings::StackOfSpirals::updateReadout ( MrProt & protocol, SeqLim & limits, SeqExpo & exports )

overridevirtual

Update the readout with respect to index so that a subsequent call to readout() returns a readout matching the index.

Implements msl::Sampling.

readout()

readouts::Spiral const & msl::samplings::StackOfSpirals::readout ( ) const

overridevirtual

Return a reference to the concrete readout.

Implements msl::Sampling.

---

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

• msl/samplings/StackOfSpirals.h