Detailed Description

Base class for RF pulses.

#include <RFPulse.h>

Public Types
enum	Type { Undefined , Excitation , Refocussing , Store }
	Type of pulse, i.e. its role in the sequence.

Public Member Functions
	RFPulse (RFPulse const &)=default
	RFPulse (RFPulse &&)=default
RFPulse &	operator= (RFPulse const &)=default
RFPulse &	operator= (RFPulse &&)=default
virtual Type	type () const =0
	Return the type of the RF pulse.
virtual RFPulse &	setType (Type type)=0
	Set the type of the RF pulse.
virtual double	flipAngle () const =0
	Return the flip angle (deg).
virtual RFPulse &	setFlipAngle (double flipAngle)=0
	Set the flip angle (deg).
virtual double	initialPhase () const =0
	Return the initial phase of the RF pulse (deg).
virtual RFPulse &	setInitialPhase (double initialPhase)=0
	Set the initial phase of the RF pulse (deg).
virtual double	additionalPhase () const =0
	Return the additional phase of the RF pulse (deg).
virtual RFPulse &	setAdditionalPhase (double additionalPhase)=0
	Set the additional phase of the RF pulse (deg).
virtual RFPulse &	setStartTime (long startTime)=0
	Set the start time of the RF pulse (µs).
virtual long	duration () const =0
	Return the duration of the RF pulse (µs).
virtual RFPulse &	setDuration (long duration)=0
	Set the duration of the RF pulse (µs).
long	endTime () const override
	Return the end time of the RF pulse (µs).
virtual long	samples () const =0
	Return the number of discrete samples of the RF pulse.
virtual RFPulse &	setSamples (long samples)=0
	Set the number of discrete samples of the RF pulse.
virtual std::string	ident () const =0
	Return the user-defined name of the RF pulse.
virtual RFPulse &	setIdent (std::string const &ident)=0
	Set the user-defined name of the RF pulse.
virtual double	gamma () const =0
	Return the gyromagnetic ratio of the current nucleus (MHz/T).
virtual long	peakTime () const =0
	Return the time of the RF peak amplitude (µs).
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 MrProtocolData::SeqExpoRFInfo	rfInfo () const =0
	Return the RF information for SAR computation.

Additional Inherited Members
Protected Attributes inherited from msl::RealTimeEvents
sSLICE_POS	_slice
	Slice specifications attached to this real time object.

Member Function Documentation

◆ type()

virtual Type msl::RFPulse::type ( ) const

pure virtual

Return the type of the RF pulse.

Implemented in msl::rf_pulses::Selective< TPulse >, msl::rf_pulses::SimpleRFPulse< TPulse >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_EXT >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_RECT >, and msl::rf_pulses::SimpleRFPulse< sRF_PULSE_SINC >.

◆ setType()

virtual RFPulse & msl::RFPulse::setType ( Type type )

pure virtual

Set the type of the RF pulse.

Implemented in msl::rf_pulses::Selective< TPulse >, msl::rf_pulses::SimpleRFPulse< TPulse >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_EXT >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_RECT >, and msl::rf_pulses::SimpleRFPulse< sRF_PULSE_SINC >.

◆ flipAngle()

virtual double msl::RFPulse::flipAngle ( ) const

pure virtual

Return the flip angle (deg).

Implemented in msl::rf_pulses::Selective< TPulse >, msl::rf_pulses::SimpleRFPulse< TPulse >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_EXT >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_RECT >, and msl::rf_pulses::SimpleRFPulse< sRF_PULSE_SINC >.

◆ setFlipAngle()

virtual RFPulse & msl::RFPulse::setFlipAngle ( double flipAngle )

pure virtual

Set the flip angle (deg).

Implemented in msl::rf_pulses::Selective< TPulse >, msl::rf_pulses::SimpleRFPulse< TPulse >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_EXT >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_RECT >, and msl::rf_pulses::SimpleRFPulse< sRF_PULSE_SINC >.

◆ initialPhase()

virtual double msl::RFPulse::initialPhase ( ) const

pure virtual

Return the initial phase of the RF pulse (deg).

Implemented in msl::rf_pulses::Selective< TPulse >, msl::rf_pulses::SimpleRFPulse< TPulse >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_EXT >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_RECT >, and msl::rf_pulses::SimpleRFPulse< sRF_PULSE_SINC >.

◆ setInitialPhase()

virtual RFPulse & msl::RFPulse::setInitialPhase ( double initialPhase )

pure virtual

Set the initial phase of the RF pulse (deg).

Implemented in msl::rf_pulses::Selective< TPulse >, msl::rf_pulses::SimpleRFPulse< TPulse >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_EXT >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_RECT >, and msl::rf_pulses::SimpleRFPulse< sRF_PULSE_SINC >.

◆ additionalPhase()

virtual double msl::RFPulse::additionalPhase ( ) const

pure virtual

Return the additional phase of the RF pulse (deg).

Implemented in msl::rf_pulses::Selective< TPulse >, msl::rf_pulses::SimpleRFPulse< TPulse >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_EXT >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_RECT >, and msl::rf_pulses::SimpleRFPulse< sRF_PULSE_SINC >.

◆ setAdditionalPhase()

virtual RFPulse & msl::RFPulse::setAdditionalPhase ( double additionalPhase )

pure virtual

Set the additional phase of the RF pulse (deg).

Implemented in msl::rf_pulses::Selective< TPulse >, msl::rf_pulses::SimpleRFPulse< TPulse >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_EXT >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_RECT >, and msl::rf_pulses::SimpleRFPulse< sRF_PULSE_SINC >.

◆ setStartTime()

virtual RFPulse & msl::RFPulse::setStartTime ( long startTime )

pure virtual

Set the start time of the RF pulse (µs).

Implemented in msl::rf_pulses::Selective< TPulse >, msl::rf_pulses::SimpleRFPulse< TPulse >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_EXT >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_RECT >, and msl::rf_pulses::SimpleRFPulse< sRF_PULSE_SINC >.

◆ duration()

virtual long msl::RFPulse::duration ( ) const

pure virtual

Return the duration of the RF pulse (µs).

Implemented in msl::rf_pulses::Selective< TPulse >, msl::rf_pulses::SimpleRFPulse< TPulse >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_EXT >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_RECT >, and msl::rf_pulses::SimpleRFPulse< sRF_PULSE_SINC >.

◆ setDuration()

virtual RFPulse & msl::RFPulse::setDuration ( long duration )

pure virtual

Set the duration of the RF pulse (µs).

Implemented in msl::rf_pulses::Selective< TPulse >, msl::rf_pulses::SimpleRFPulse< TPulse >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_EXT >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_RECT >, and msl::rf_pulses::SimpleRFPulse< sRF_PULSE_SINC >.

◆ endTime()

long msl::RFPulse::endTime ( ) const

overridevirtual

Return the end time of the RF pulse (µs).

Implements msl::RealTimeEvents.

◆ samples()

virtual long msl::RFPulse::samples ( ) const

pure virtual

Return the number of discrete samples of the RF pulse.

Implemented in msl::rf_pulses::Selective< TPulse >, msl::rf_pulses::SimpleRFPulse< TPulse >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_EXT >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_RECT >, and msl::rf_pulses::SimpleRFPulse< sRF_PULSE_SINC >.

◆ setSamples()

virtual RFPulse & msl::RFPulse::setSamples ( long samples )

pure virtual

Set the number of discrete samples of the RF pulse.

Implemented in msl::rf_pulses::Selective< TPulse >, msl::rf_pulses::SimpleRFPulse< TPulse >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_EXT >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_RECT >, and msl::rf_pulses::SimpleRFPulse< sRF_PULSE_SINC >.

◆ ident()

virtual std::string msl::RFPulse::ident ( ) const

pure virtual

Return the user-defined name of the RF pulse.

Implemented in msl::rf_pulses::Selective< TPulse >, msl::rf_pulses::SimpleRFPulse< TPulse >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_EXT >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_RECT >, and msl::rf_pulses::SimpleRFPulse< sRF_PULSE_SINC >.

◆ setIdent()

virtual RFPulse & msl::RFPulse::setIdent ( std::string const & ident )

pure virtual

Set the user-defined name of the RF pulse.

Implemented in msl::rf_pulses::Selective< TPulse >, msl::rf_pulses::SimpleRFPulse< TPulse >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_EXT >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_RECT >, and msl::rf_pulses::SimpleRFPulse< sRF_PULSE_SINC >.

◆ gamma()

virtual double msl::RFPulse::gamma ( ) const

pure virtual

Return the gyromagnetic ratio of the current nucleus (MHz/T).

Implemented in msl::rf_pulses::Selective< TPulse >, msl::rf_pulses::SimpleRFPulse< TPulse >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_EXT >, msl::rf_pulses::SimpleRFPulse< sRF_PULSE_RECT >, and msl::rf_pulses::SimpleRFPulse< sRF_PULSE_SINC >.

◆ peakTime()

virtual long msl::RFPulse::peakTime ( ) const

pure virtual

Return the time of the RF peak amplitude (µs).

Implemented in msl::rf_pulses::External, msl::rf_pulses::Rect, msl::rf_pulses::Selective< TPulse >, and msl::rf_pulses::Sinc.

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

msl/RFPulse.h

Detailed Description

Public Types

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ type()

◆ setType()

◆ flipAngle()

◆ setFlipAngle()

◆ initialPhase()

◆ setInitialPhase()

◆ additionalPhase()

◆ setAdditionalPhase()

◆ setStartTime()

◆ duration()

◆ setDuration()

◆ endTime()

◆ samples()

◆ setSamples()

◆ ident()

◆ setIdent()

◆ gamma()

◆ peakTime()