Prep sequence module: MT (ksmt.[h,cc,e])

Data Structures
struct	KSMT_DESIGN
struct	KSMT_MODULE

Macros
#define	KSMT_DEFAULT_FLIP   670
#define	KSMT_DEFAULT_RFOFFSET   1200
#define	KSMT_DEFAULT_BW   150
#define	KSMT_DEFAULT_SPOILERAREA   5000
#define	KSMT_DEFAULT_RFDURATION   8000
#define	KSMT_DEFAULT_SSITIME   1000 /* try to reduce this value */
#define	KSMT_MODULE_LOADED
#define	KSMT_INIT_DESIGN   {KSMT_OFF, KSMT_RF_FERMI, KSMT_DEFAULT_FLIP, KSMT_DEFAULT_RFOFFSET, KSMT_DEFAULT_BW, KSMT_DEFAULT_RFDURATION, KSMT_DEFAULT_SPOILERAREA, KSMT_DEFAULT_SSITIME}
#define	KSMT_INIT_MODULE   {KS_INIT_BASE(KSMT_MODULE), KS_INIT_SEQ_CONTROL, KSMT_INIT_DESIGN, KS_INIT_RF, KS_INIT_TRAP, KS_NOTSET, 0, 0}

Enumerations
enum	{ KSMT_OFF, KSMT_ON }
enum	{ KSMT_RF_FERMI, KSMT_RF_BINO }

Functions
void	ksmt_init_design (KSMT_DESIGN *design)
STATUS	ksmt_eval_design (KSMT_MODULE *mt)
STATUS	ksmt_pg (KSMT_MODULE *mt, int start_time, KS_SEQ_CONTROL *seqctrl_p)
void	ksmt_set_design_from_UI (KSMT_DESIGN *design)

Variables
KSMT_MODULE	ksmt = KSMT_INIT_MODULE
float	ksmt_flip = KSMT_DEFAULT_FLIP with {0, 20000, KSMT_DEFAULT_FLIP, VIS, "RF flip angle [deg]",}
int	ksmt_rftype = KSMT_RF_FERMI with {KSMT_RF_FERMI, KSMT_RF_BINO, KSMT_RF_FERMI, VIS, "RF type (0:fermi 1:bino)",}
int	ksmt_bw = KSMT_DEFAULT_BW with {2, 100000, 300, VIS, "RF BW",}
int	ksmt_rfduration = KSMT_DEFAULT_RFDURATION with {2, 10000, KSMT_DEFAULT_RFDURATION, VIS, "RF duration",}
int	ksmt_rfoffset = KSMT_DEFAULT_RFOFFSET with {-10000, 10000, KSMT_DEFAULT_RFOFFSET, VIS, "RF freq offset [Hz]",}
float	ksmt_spoilerarea = KSMT_DEFAULT_SPOILERAREA with {0, 10000, KSMT_DEFAULT_SPOILERAREA, VIS, "Spoiler area",}
int	ksmt_ssi_time = KSMT_DEFAULT_SSITIME with {10, 20000, KSMT_DEFAULT_SSITIME, VIS, "Time from eos to ssi in intern trig",}

Detailed Description

Macro Definition Documentation

KSMT_DEFAULT_FLIP

#define KSMT_DEFAULT_FLIP   670

KSMT_DEFAULT_RFOFFSET

#define KSMT_DEFAULT_RFOFFSET   1200

KSMT_DEFAULT_BW

#define KSMT_DEFAULT_BW   150

KSMT_DEFAULT_SPOILERAREA

#define KSMT_DEFAULT_SPOILERAREA   5000

KSMT_DEFAULT_RFDURATION

#define KSMT_DEFAULT_RFDURATION   8000

KSMT_DEFAULT_SSITIME

#define KSMT_DEFAULT_SSITIME   1000 /* try to reduce this value */

KSMT_MODULE_LOADED

#define KSMT_MODULE_LOADED

can be used to check whether the mt module has been included in a main psd

KSMT_INIT_DESIGN

#define KSMT_INIT_DESIGN   {KSMT_OFF, KSMT_RF_FERMI, KSMT_DEFAULT_FLIP, KSMT_DEFAULT_RFOFFSET, KSMT_DEFAULT_BW, KSMT_DEFAULT_RFDURATION, KSMT_DEFAULT_SPOILERAREA, KSMT_DEFAULT_SSITIME}

KSMT_INIT_MODULE

#define KSMT_INIT_MODULE   {KS_INIT_BASE(KSMT_MODULE), KS_INIT_SEQ_CONTROL, KSMT_INIT_DESIGN, KS_INIT_RF, KS_INIT_TRAP, KS_NOTSET, 0, 0}

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
KSMT_OFF
KSMT_ON

{KSMT_OFF, KSMT_ON}; 

anonymous enum

anonymous enum

Enumerator
KSMT_RF_FERMI
KSMT_RF_BINO

{KSMT_RF_FERMI, KSMT_RF_BINO}; 

Function Documentation

ksmt_init_design()

void ksmt_init_design

(

KSMT_DESIGN *

design

)

Initialize a MT design to off

Parameters

[out]

design

pointer to the MT design

Return values

STATUS

SUCCESS or FAILURE

                                           {
  design->satmode = KSMT_OFF;

} /* ksmt_init_design() */

ksmt_eval_design()

STATUS ksmt_eval_design

(

KSMT_MODULE *

mt

)

Populate objects from design

Parameters

[in,out]

mt

pointer to the module to be processed

Return values

STATUS

SUCCESS or FAILURE

                                         {
  STATUS status;

  mt->end_time = 0;

  if (mt->design.satmode == KSMT_OFF) {
    return SUCCESS;
  }

  /* RF */
  KS_DESCRIPTION tmpdesc;
  ks_create_suffixed_description(tmpdesc, mt->rf.rfwave.description, "_mt");
  if (mt->design.rftype == KSMT_RF_FERMI) {

    mt->rf = excnonsel_fermi100;
    mt->rf.flip = mt->design.flip;
    mt->rf.cf_offset = mt->design.rfoffset; /* Exciter offset in Hz */
    mt->rf.role = KS_RF_ROLE_CHEMSAT;

    status = ks_eval_rf(&mt->rf, tmpdesc);
    KS_RAISE(status);

    float rfstretchfactor = (float)(mt->design.rfduration) / (float)(mt->rf.rfwave.duration);
    status = ks_eval_stretch_rf(&mt->rf, rfstretchfactor);
    KS_RAISE(status);

  } else if (mt->design.rftype == KSMT_RF_BINO)  {

    int sub_pulse_dur = 100; 
    int nPulses = 20;
    int prp = 200;

    status = ks_eval_mt_rf_binomial(&mt->rf, tmpdesc, sub_pulse_dur, nPulses, prp);
    KS_RAISE(status);

    mt->rf.role = KS_RF_ROLE_CHEMSAT;
    status = ks_eval_rf(&mt->rf, tmpdesc);
    KS_RAISE(status);

  }
  /* ks_print_rf(mt->rf, stderr); fflush(stderr); */

  /* set up spoiler */
  mt->spoiler.area = mt->design.spoilerarea;
  status = ks_eval_trap_rotation_invariant_75_max_slewrate(&mt->spoiler, "ksmt_spoiler");
  KS_RAISE(status);


  /* setup seqctrl with desired SSI time and zero duration. .min_duration will be set in ksmt_pg() */
  ks_init_seqcontrol(&mt->seqctrl);
  strcpy(mt->seqctrl.description, "ksmt");

  return SUCCESS;

} /* ksmt_eval_design() */

ksmt_pg()

STATUS ksmt_pg	(	KSMT_MODULE *	mt,
		int	start_time,
		KS_SEQ_CONTROL *	seqctrl_p
	)

Generate the waveforms of a MT module

If seqctrl_p is not NULL, it is assumed that the MT is generated within another sequence module, use start_time to control the positioning. The end_time field is set to be able to continue the pulse generation.

Parameters

[in,out]	mt	pointer to the module to be processed
[in]	start_time	time position for the start of the MT waveforms
[in,out]	seqctrl_p	optional pointer to a sequence control for embedding

Return values

STATUS

SUCCESS or FAILURE

                                                                           {
  STATUS status;
  KS_SEQLOC loc = KS_INIT_SEQLOC;

  if (!mt) {
    return KS_THROW("the first argument can not be NULL");
  }

  #ifdef HOST_TGT
  ks_eval_seqctrl_setminduration(&mt->seqctrl, 0);
  mt->seqctrl.duration = 0;
  #endif

  /* Initialize critical fields */
  mt->embedded = 1;
  mt->spoiling_counter = 0;

  /* return early if sat mode is off */
  if (mt->design.satmode == KSMT_OFF) {
    return SUCCESS;
  }

  if (!seqctrl_p) {
    /* If seqctrl_p is NULL we assume an independent sequence module will be generated */
    seqctrl_p = &mt->seqctrl;
    mt->embedded = 0;
  }

  loc.pos = RUP_GRD(IMax(2, KS_RFSSP_PRETIME + 32, start_time));

  /* RF */
  status = ks_pg_rf(&mt->rf, loc, seqctrl_p);
  KS_RAISE(status);

  loc.pos += mt->rf.rfwave.duration;

  /* Y spoiler */
  loc.board = YGRAD;
  status = ks_pg_trap(&mt->spoiler, loc, seqctrl_p);
  KS_RAISE(status);

  /* Z spoiler */
  loc.board = ZGRAD;
  status = ks_pg_trap(&mt->spoiler, loc, seqctrl_p);
  KS_RAISE(status);

  loc.pos += mt->spoiler.duration;

  /* make sure we are divisible by GRAD_UPDATE_TIME (4us) */
  loc.pos = RUP_GRD(loc.pos);

  mt->end_time = loc.pos;

#ifdef HOST_TGT
  /************************************************************************************************
   *  Set the minimal sequence duration
   ***********************************************************************************************/
  mt->seqctrl.ssi_time = mt->design.ssi_time;
  ks_eval_seqctrl_setminduration(seqctrl_p, mt->end_time);
#endif

  return SUCCESS;

} /* ksmt_pg() */

ksmt_set_design_from_UI()

void ksmt_set_design_from_UI

(

KSMT_DESIGN *

design

)

Set the design values of a MT module according to the scanner's UI

Parameters

[out]

design

Pointer to a MT design

Return values

STATUS

SUCCESS or FAILURE

                                                  {

  if (opmt) {
    design->satmode = KSMT_ON;
  } else {
    design->satmode = KSMT_OFF;
  }

  /* RF */
  design->flip = ksmt_flip;
  design->rfoffset = ksmt_rfoffset;
  design->rftype = ksmt_rftype;
  design->rfduration = ksmt_rfduration;
  if (design->rftype == KSMT_RF_FERMI) {
    design->bw = ksmt_bw;
  } else if (KSMT_RF_BINO) {
    /*design->bw = ksmt_bw;*/
  }

  /* Spoiler */
  design->spoilerarea = ksmt_spoilerarea;

  /* SSI time */
  design->ssi_time = ksmt_ssi_time;

} /* ksmt_set_design_from_UI() */

Variable Documentation

ksmt

KSMT_MODULE ksmt = KSMT_INIT_MODULE

ksmt_flip

float ksmt_flip = KSMT_DEFAULT_FLIP with {0, 20000, KSMT_DEFAULT_FLIP, VIS, "RF flip angle [deg]",}

ksmt_rftype

int ksmt_rftype = KSMT_RF_FERMI with {KSMT_RF_FERMI, KSMT_RF_BINO, KSMT_RF_FERMI, VIS, "RF type (0:fermi 1:bino)",}

ksmt_bw

int ksmt_bw = KSMT_DEFAULT_BW with {2, 100000, 300, VIS, "RF BW",}

ksmt_rfduration

int ksmt_rfduration = KSMT_DEFAULT_RFDURATION with {2, 10000, KSMT_DEFAULT_RFDURATION, VIS, "RF duration",}

ksmt_rfoffset

int ksmt_rfoffset = KSMT_DEFAULT_RFOFFSET with {-10000, 10000, KSMT_DEFAULT_RFOFFSET, VIS, "RF freq offset [Hz]",}

ksmt_spoilerarea

float ksmt_spoilerarea = KSMT_DEFAULT_SPOILERAREA with {0, 10000, KSMT_DEFAULT_SPOILERAREA, VIS, "Spoiler area",}

ksmt_ssi_time

int ksmt_ssi_time = KSMT_DEFAULT_SSITIME with {10, 20000, KSMT_DEFAULT_SSITIME, VIS, "Time from eos to ssi in intern trig",}