msl::rf_pulses::Rect Class Reference

Detailed Description

Rectangular RF pulse.

#include <Rect.h>

Public Member Functions
	Rect (Rect const &)=default
	Rect (Rect &&)=default
Rect &	operator= (Rect const &)=default
Rect &	operator= (Rect &&)=default
long	peakTime () const override
	Return the time of the RF peak amplitude (µs).
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_RECT >
SimpleRFPulse< sRF_PULSE_RECT > &	operator= (SimpleRFPulse< sRF_PULSE_RECT > const &)=default
Type	type () const override
	Return the type of the RF pulse.
SimpleRFPulse< sRF_PULSE_RECT > &	setType (Type type) override
	Set the type of the RF pulse.
double	flipAngle () const override
	Return the flip angle (deg).
SimpleRFPulse< sRF_PULSE_RECT > &	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_RECT > &	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_RECT > &	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_RECT > &	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_RECT > &	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_RECT > &	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_RECT > &	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 (RFPulse const &)=default
	RFPulse (RFPulse &&)=default
RFPulse &	operator= (RFPulse const &)=default
RFPulse &	operator= (RFPulse &&)=default
long	endTime () const override
	Return the end time of the RF pulse (µ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.

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.
Protected Attributes inherited from msl::rf_pulses::SimpleRFPulse< sRF_PULSE_RECT >
sRF_PULSE_RECT	_rf
	sRF_PULSE-derived object
NCOPair	_nco
	NCO before and after this pulse.
double	_additionalPhase
	Additional phase for the NCO.
Protected Attributes inherited from msl::RealTimeEvents
sSLICE_POS	_slice
	Slice specifications attached to this real time object.

Member Function Documentation

peakTime()

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

overridevirtual

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

Implements msl::RFPulse.

prepare()

NLSStatus msl::rf_pulses::Rect::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/Rect.h