Detailed Description

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

Deprecated

#include <CartesianReadout.h>

Public Member Functions
	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)
	Set 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 (i.e. at the end of the last column).
CartesianReadout &	setADCEndPosition (double x, msl::KSpace const &kspace)
	Set the position on the x-axis the k-space at the end of the ADC (i.e. at the end of the last column), 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	contrast () const
	Return the contrast number.
CartesianReadout &	setContrast (long contrast)
	Set the contrast number.
long	timeOffset () const
	Return the time offset to get the effective echo time, accounting e.g. for the time of the excitation pulse peak.
CartesianReadout &	setTimeOffset (long timeOffset)
	Set the time offset to get the effective echo time, accounting e.g. for the time of the excitation pulse peak.
bool	reverted () const
	Return whether the readout is reverted with respect to its nominal direction. This is handled in run, not in prepare.
CartesianReadout &	setReverted (bool reverted)
	Set whether the readout is reverted with respect to its nominal direction. This is handled in run, not in prepare.
long	echoTime () const
	Return the effective echo time (requires preparation).
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.
long	adcStartTime () const
	Return the start time of the ADC.
long	adcEndTime () const
	Return the start time of the ADC.
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 const &	adc () const
	Return a reference to the ADC real-time object, e.g. for updating its meta-data.
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 ()
	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::RealTimeEvents
sSLICE_POS	_slice
	Slice specifications attached to this real time object.