msl::Sampling Class Reference

Detailed Description

Abstract sampling scheme of the k-space.

#include <Sampling.h>

Public Types
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
	Sampling (Sampling const &)=default
	Sampling (Sampling &&)=default
Sampling &	operator= (Sampling const &)=default
Sampling &	operator= (Sampling &&)=default
virtual double	phase () const =0
	Return the phase of the NCO during the readout.
virtual Sampling &	setPhase (double phase)=0
	Set the phase of the NCO during the readout.
virtual long	contrast () const =0
	Return the contrast number.
virtual Sampling &	setContrast (long contrast)=0
	Set the contrast number.
virtual long	timeOffset () const =0
	Return the time offset to get the effective echo time, accounting e.g. for the time of the excitation pulse peak.
virtual Sampling &	setTimeOffset (long timeOffset)=0
	Set the time offset to get the effective echo time, accounting e.g. for the time of the excitation pulse peak.
virtual GradientSpecs const &	gradientSpecs () const =0
	Return the gradient specifications constraining the read-out duration.
virtual Sampling &	setGradientSpecs (GradientSpecs const &gradientSpecs)=0
	Set the gradient specifications constraining the read-out duration.
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.
virtual NLSStatus	updateReadout (MrProt &protocol, SeqLim &limits, SeqExpo &exports)=0
	Update the readout with respect to index so that a subsequent call to readout() returns a readout matching the index.
virtual Readout const &	readout () const =0
	Return a reference to the concrete readout.
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.
virtual NLSStatus	prepare (MrProt &protocol, SeqLim &limits, SeqExpo &exports)=0
	Prepare the real-time events.
virtual NLSStatus	run (MrProt &protocol, SeqLim &limits, SeqExpo &exports)=0
	Run the real-time events.
virtual long	startTime () const =0
	Return the start time of the events.
virtual long	endTime () const =0
	Return the end time of the events.
virtual MrProtocolData::SeqExpoRFInfo	rfInfo () const =0
	Return the RF information for SAR computation.

Protected Attributes
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()

virtual double msl::Sampling::phase ( ) const

pure virtual

Return the phase of the NCO during the readout.

Implemented in msl::samplings::Cartesian, msl::samplings::StackOfSpirals, and msl::samplings::StackOfStars.

setPhase()

virtual Sampling & msl::Sampling::setPhase ( double phase )

pure virtual

Set the phase of the NCO during the readout.

Implemented in msl::samplings::Cartesian, msl::samplings::StackOfSpirals, and msl::samplings::StackOfStars.

contrast()

virtual long msl::Sampling::contrast ( ) const

pure virtual

Return the contrast number.

Implemented in msl::samplings::Cartesian, msl::samplings::StackOfSpirals, and msl::samplings::StackOfStars.

setContrast()

virtual Sampling & msl::Sampling::setContrast ( long contrast )

pure virtual

Set the contrast number.

Implemented in msl::samplings::Cartesian, msl::samplings::StackOfSpirals, and msl::samplings::StackOfStars.

timeOffset()

virtual long msl::Sampling::timeOffset ( ) const

pure virtual

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

Implemented in msl::samplings::Cartesian, msl::samplings::StackOfSpirals, and msl::samplings::StackOfStars.

setTimeOffset()

virtual Sampling & msl::Sampling::setTimeOffset ( long timeOffset )

pure virtual

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

Implemented in msl::samplings::Cartesian, msl::samplings::StackOfSpirals, and msl::samplings::StackOfStars.

gradientSpecs()

virtual GradientSpecs const & msl::Sampling::gradientSpecs ( ) const

pure virtual

Return the gradient specifications constraining the read-out duration.

Implemented in msl::samplings::Cartesian, msl::samplings::StackOfSpirals, and msl::samplings::StackOfStars.

setGradientSpecs()

virtual Sampling & msl::Sampling::setGradientSpecs ( GradientSpecs const & gradientSpecs )

pure virtual

Set the gradient specifications constraining the read-out duration.

Implemented in msl::samplings::Cartesian, msl::samplings::StackOfSpirals, and msl::samplings::StackOfStars.

size()

std::size_t msl::Sampling::size

(

)

const

Return the number of trajectories.

Note

Requires preparation

updateReadout()

virtual NLSStatus msl::Sampling::updateReadout ( MrProt & protocol, SeqLim & limits, SeqExpo & exports )

pure virtual

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

Implemented in msl::samplings::Cartesian, msl::samplings::StackOfSpirals, and msl::samplings::StackOfStars.

readout()

virtual Readout const & msl::Sampling::readout ( ) const

pure virtual

Return a reference to the concrete readout.

Implemented in msl::samplings::Cartesian, msl::samplings::StackOfSpirals, and msl::samplings::StackOfStars.

---

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

• msl/Sampling.h