msl::CartesianReadout Class Reference

Cartesian read-out along the X gradient, comprising the ADC, NCO manipulation, and read-out gradient. More...

#include <CartesianReadout.h>

Inheritance diagram for msl::CartesianReadout:

Public Member Functions
	CartesianReadout ()
virtual	~CartesianReadout () override=default
	CartesianReadout (CartesianReadout const &)=default
	CartesianReadout (CartesianReadout &&)=default
CartesianReadout &	operator= (CartesianReadout const &)=default
CartesianReadout &	operator= (CartesianReadout &&)=default
double	phase () const
	Return the phase of the NCO during the readout.
CartesianReadout &	setPhase (double phase)
	Set the phase of the NCO during the readout.
msl::Vector2l	index () const
	Return the index of the current point in the discrete ky-kz space.
CartesianReadout &	setIndex (msl::Vector2l const &index)
	Set the index of the current point in the discrete ky-kz space.
double	adcStartPosition () const
	Return the position on the x-axis the k-space at the start of the ADC.
CartesianReadout &	setADCStartPosition (double k)
	Set the position on the x-axis of the k-space at the start of the ADC.
CartesianReadout &	setADCStartPosition (double x, msl::KSpace const &kspace)
	Return the position on the x-axis the k-space at the start of the ADC, as a fraction of the k-space extent.
double	adcEndPosition () const
	Return the position on the x-axis the k-space at the end of the ADC.
CartesianReadout &	setADCEndPosition (double k)
	Set the position on the x-axis of the k-space at the end of the ADC.
CartesianReadout &	setADCEndPosition (double x, msl::KSpace const &kspace)
	Return the position on the x-axis the k-space at the end of the ADC, as a fraction of the k-space extent.
CartesianReadout &	setADCPosition (double kStart, double kEnd)
	Set the position on the x-axis of the k-space at the start and the end of the ADC.
CartesianReadout &	setADCPosition (double xStart, double xEnd, msl::KSpace const &kSpace)
	Return the position on the x-axis the k-space at the start and the end of the ADC, as a fraction of the k-space extent.
long	echoTime () const
	Return the effective echo time.
CartesianReadout &	setEchoTime (long echoTime)
	Set the effective echo time.
msl::Vector3d	startPosition () const
	Return the position in the k-space at the start of the gradient lobe.
msl::Vector3d	endPosition () const
	Return the position in the k-space at the end of the gradient lobe.
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.
MrProtocolData::SeqExpoRFInfo	rfInfo () const override
	Return the RF information for SAR computation.
long	startTime () const override
	Return the start time of the events.
long	endTime () const override
	Return the end time of the events.
msl::GradientPulse const &	gradient () const
	Return the read-out gradient.
msl::Vector3d	areaBeforeADC () const
	Return the area of the read-out gradient before the start of the ADC.
msl::Vector3d	areaBeforeEcho () const
	Return the area of the read-out gradient before the effective echo time.
msl::Vector3d	areaAfterEcho () const
	Return the area of the read-out gradient after the effective echo time.
msl::Vector3d	areaAfterADC () const
	Return the area of the read-out gradient after the end of the ADC.
sREADOUT &	adc ()
	Return a reference to the ADC real-time object, e.g. for updating its meta-data.
Public Member Functions inherited from msl::RealTimeEvents
	RealTimeEvents ()
	RealTimeEvents (RealTimeEvents const &)=default
	RealTimeEvents (RealTimeEvents &&)=default
RealTimeEvents &	operator= (RealTimeEvents const &)=default
RealTimeEvents &	operator= (RealTimeEvents &&)=default
virtual	~RealTimeEvents ()=default
sSLICE_POS const &	slice () const
	Return the slice used in prepare and run.
RealTimeEvents &	setSlice (sSLICE_POS const &slice)
	Set the slice used in prepare and run.

Additional Inherited Members
Protected Attributes inherited from msl::RealTimeEvents
sSLICE_POS	_slice

Detailed Description

Cartesian read-out along the X gradient, comprising the ADC, NCO manipulation, and read-out gradient.

Constructor & Destructor Documentation

CartesianReadout() [1/3]

msl::CartesianReadout::CartesianReadout

(

)

~CartesianReadout()

virtual msl::CartesianReadout::~CartesianReadout ( )

overridevirtualdefault

CartesianReadout() [2/3]

msl::CartesianReadout::CartesianReadout ( CartesianReadout const & )

default

CartesianReadout() [3/3]

msl::CartesianReadout::CartesianReadout ( CartesianReadout && )

default

Member Function Documentation

operator=() [1/2]

CartesianReadout & msl::CartesianReadout::operator= ( CartesianReadout const & )

default

operator=() [2/2]

CartesianReadout & msl::CartesianReadout::operator= ( CartesianReadout && )

default

phase()

double msl::CartesianReadout::phase

(

)

const

Return the phase of the NCO during the readout.

setPhase()

CartesianReadout & msl::CartesianReadout::setPhase

(

double

phase

)

Set the phase of the NCO during the readout.

index()

msl::Vector2l msl::CartesianReadout::index

(

)

const

Return the index of the current point in the discrete ky-kz space.

setIndex()

CartesianReadout & msl::CartesianReadout::setIndex

(

msl::Vector2l const &

index

)

Set the index of the current point in the discrete ky-kz space.

adcStartPosition()

double msl::CartesianReadout::adcStartPosition

(

)

const

Return the position on the x-axis the k-space at the start of the ADC.

setADCStartPosition() [1/2]

CartesianReadout & msl::CartesianReadout::setADCStartPosition

(

double

k

)

Set the position on the x-axis of the k-space at the start of the ADC.

setADCStartPosition() [2/2]

CartesianReadout & msl::CartesianReadout::setADCStartPosition	(	double	x,
		msl::KSpace const &	kspace )

Return the position on the x-axis the k-space at the start of the ADC, as a fraction of the k-space extent.

adcEndPosition()

double msl::CartesianReadout::adcEndPosition

(

)

const

Return the position on the x-axis the k-space at the end of the ADC.

setADCEndPosition() [1/2]

CartesianReadout & msl::CartesianReadout::setADCEndPosition

(

double

k

)

Set the position on the x-axis of the k-space at the end of the ADC.

setADCEndPosition() [2/2]

CartesianReadout & msl::CartesianReadout::setADCEndPosition	(	double	x,
		msl::KSpace const &	kspace )

Return the position on the x-axis the k-space at the end of the ADC, as a fraction of the k-space extent.

setADCPosition() [1/2]

CartesianReadout & msl::CartesianReadout::setADCPosition	(	double	kStart,
		double	kEnd )

Set the position on the x-axis of the k-space at the start and the end of the ADC.

setADCPosition() [2/2]

CartesianReadout & msl::CartesianReadout::setADCPosition	(	double	xStart,
		double	xEnd,
		msl::KSpace const &	kSpace )

Return the position on the x-axis the k-space at the start and the end of the ADC, as a fraction of the k-space extent.

echoTime()

long msl::CartesianReadout::echoTime

(

)

const

Return the effective echo time.

setEchoTime()

CartesianReadout & msl::CartesianReadout::setEchoTime

(

long

echoTime

)

Set the effective echo time.

startPosition()

msl::Vector3d msl::CartesianReadout::startPosition

(

)

const

Return the position in the k-space at the start of the gradient lobe.

endPosition()

msl::Vector3d msl::CartesianReadout::endPosition

(

)

const

Return the position in the k-space at the end of the gradient lobe.

prepare()

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

overridevirtual

Prepare the real-time events.

Implements msl::RealTimeEvents.

run()

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

overridevirtual

Run the real-time events.

Implements msl::RealTimeEvents.

rfInfo()

MrProtocolData::SeqExpoRFInfo msl::CartesianReadout::rfInfo ( ) const

overridevirtual

Return the RF information for SAR computation.

Implements msl::RealTimeEvents.

startTime()

long msl::CartesianReadout::startTime ( ) const

overridevirtual

Return the start time of the events.

Implements msl::RealTimeEvents.

endTime()

long msl::CartesianReadout::endTime ( ) const

overridevirtual

Return the end time of the events.

Implements msl::RealTimeEvents.

gradient()

msl::GradientPulse const & msl::CartesianReadout::gradient

(

)

const

Return the read-out gradient.

areaBeforeADC()

msl::Vector3d msl::CartesianReadout::areaBeforeADC

(

)

const

Return the area of the read-out gradient before the start of the ADC.

areaBeforeEcho()

msl::Vector3d msl::CartesianReadout::areaBeforeEcho

(

)

const

Return the area of the read-out gradient before the effective echo time.

areaAfterEcho()

msl::Vector3d msl::CartesianReadout::areaAfterEcho

(

)

const

Return the area of the read-out gradient after the effective echo time.

areaAfterADC()

msl::Vector3d msl::CartesianReadout::areaAfterADC

(

)

const

Return the area of the read-out gradient after the end of the ADC.

adc()

sREADOUT & msl::CartesianReadout::adc

(

)

Return a reference to the ADC real-time object, e.g. for updating its meta-data.

---

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

• msl/CartesianReadout.h