msl::rf_pulses::External Class Reference

Detailed Description

External RF pulse.

#include <External.h>

Public Member Functions
	External ()=default
	External (External const &)=default
	External (External &&)=default
External &	operator= (External const &)=default
External &	operator= (External &&)=default
	~External () override=default
long	peakTime () const override
	Return the time of the RF peak amplitude (µs)
double	thickness () const
	Return the thickness.
External &	setThickness (double thickness)
	Set the thickness.
std::string	familyName () const
	Return the family name.
External &	setFamilyName (std::string const &familyName)
	Set the family name.
NLSStatus	prepare (MrProt &protocol, SeqLim &limits, SeqExpo &exports) override
	Prepare the RF pulse and NCO.
Public Member Functions inherited from msl::rf_pulses::SimpleRFPulse< sRF_PULSE_EXT >
	SimpleRFPulse ()
	SimpleRFPulse (SimpleRFPulse< sRF_PULSE_EXT > const &)=default
	SimpleRFPulse (SimpleRFPulse< sRF_PULSE_EXT > &&)=default
SimpleRFPulse< sRF_PULSE_EXT > &	operator= (SimpleRFPulse< sRF_PULSE_EXT > const &)=default
SimpleRFPulse< sRF_PULSE_EXT > &	operator= (SimpleRFPulse< sRF_PULSE_EXT > &&)=default
virtual	~SimpleRFPulse ()=default
Type	type () const override
	Return the type of the RF pulse.
SimpleRFPulse< sRF_PULSE_EXT > &	setType (Type type) override
	Set the type of the RF pulse.
double	flipAngle () const override
	Return the flip angle (deg)
SimpleRFPulse< sRF_PULSE_EXT > &	setFlipAngle (double flipAngle) override
	Set the flip angle (deg)
double	initialPhase () const override
	Return the initial phase of the RF pulse (deg)
SimpleRFPulse< sRF_PULSE_EXT > &	setInitialPhase (double initialPhase) override
	Set the initial phase of the RF pulse (deg)
double	additionalPhase () const override
	Return the additional phase of the RF pulse (deg)
SimpleRFPulse< sRF_PULSE_EXT > &	setAdditionalPhase (double additionalPhase) override
	Set the additional phase of the RF pulse (deg)
long	startTime () const override
	Return the start time of the RF pulse (µs)
SimpleRFPulse< sRF_PULSE_EXT > &	setStartTime (long startTime) override
	Set the start time of the RF pulse (µs)
long	duration () const override
	Return the duration of the RF pulse (µs)
SimpleRFPulse< sRF_PULSE_EXT > &	setDuration (long duration) override
	Set the duration of the RF pulse (µs)
long	samples () const override
	Return the number of discrete samples of the RF pulse.
SimpleRFPulse< sRF_PULSE_EXT > &	setSamples (long samples) override
	Set the number of discrete samples of the RF pulse.
std::string	ident () const override
	Return the user-defined name of the RF pulse.
SimpleRFPulse< sRF_PULSE_EXT > &	setIdent (std::string const &ident) override
	Set the user-defined name of the RF pulse.
double	gamma () const override
	Return the gyromagnetic ratio of the current nucleus (MHz/T)
MrProtocolData::SeqExpoRFInfo	rfInfo () const override
	Return the RF information for SAR computation.
NLSStatus	run (MrProt &protocol, SeqLim &limits, SeqExpo &exports) override
	Run the RF pulse and the NCO.
Public Member Functions inherited from msl::RFPulse
	RFPulse ()=default
	RFPulse (RFPulse const &)=default
	RFPulse (RFPulse &&)=default
RFPulse &	operator= (RFPulse const &)=default
RFPulse &	operator= (RFPulse &&)=default
virtual	~RFPulse ()=default
long	endTime () const override
	Return the end time of the RF pulse (µs)
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.
virtual RealTimeEvents &	setSlice (sSLICE_POS const &slice)
	Set the slice used in prepare and run.

Additional Inherited Members
Public Types inherited from msl::RFPulse
enum	Type { Undefined , Excitation , Refocussing , Store }
	Type of pulse, i.e. its role in the sequence. More...

Constructor & Destructor Documentation

External() [1/3]

msl::rf_pulses::External::External ( )

default

External() [2/3]

msl::rf_pulses::External::External ( External const &  )

default

External() [3/3]

msl::rf_pulses::External::External ( External &&  )

default

~External()

msl::rf_pulses::External::~External ( )

overridedefault

Member Function Documentation

operator=() [1/2]

External & msl::rf_pulses::External::operator= ( External const &  )

default

operator=() [2/2]

External & msl::rf_pulses::External::operator= ( External &&  )

default

peakTime()

long msl::rf_pulses::External::peakTime ( ) const

overridevirtual

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

Implements msl::RFPulse.

thickness()

double msl::rf_pulses::External::thickness

(

)

const

Return the thickness.

setThickness()

External & msl::rf_pulses::External::setThickness

(

double

thickness

)

Set the thickness.

Note

This field must be non-0 for prepare() to succeed

familyName()

std::string msl::rf_pulses::External::familyName

(

)

const

Return the family name.

setFamilyName()

External & msl::rf_pulses::External::setFamilyName

(

std::string const &

familyName

)

Set the family name.

prepare()

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

overridevirtual

Prepare the RF pulse and NCO.

Implements msl::RealTimeEvents.

---

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

• msl/rf_pulses/External.h