Prep sequence module: ChemSat (kschemsat.[h,cc,e])

Data Structures
struct	KSCHEMSAT_DESIGN
struct	KSCHEMSAT_MODULE

Macros
#define	KSCHEMSAT_MODULE_LOADED
#define	KSCHEMSAT_DEFAULT_FLIP   95
#define	KSCHEMSAT_DEFAULT_SINCRF_BW_15T   150 /* for 1.5T */
#define	KSCHEMSAT_DEFAULT_SINCRF_BW_3T   300 /* for 3T */
#define	KSCHEMSAT_DEFAULT_SINCRF_TBP   4
#define	KSCHEMSAT_DEFAULT_SPOILERAREA   5000
#define	KSCHEMSAT_DEFAULT_SSITIME   1000 /* try to reduce this value */
#define	KSCHEMSAT_INIT_DESIGN   {KSCHEMSAT_OFF, KSCHEMSAT_DEFAULT_FLIP, 0, KSCHEMSAT_RF_STD, KSCHEMSAT_DEFAULT_SINCRF_BW_3T, KSCHEMSAT_DEFAULT_SINCRF_TBP, KSCHEMSAT_DEFAULT_SPOILERAREA, KSCHEMSAT_DEFAULT_SSITIME}
#define	KSCHEMSAT_INIT_MODULE   {KS_INIT_BASE(KSCHEMSAT_MODULE), KS_INIT_SEQ_CONTROL, KSCHEMSAT_INIT_DESIGN, KS_INIT_RF, KS_INIT_TRAP, KS_NOTSET, 0, 0}

Enumerations
enum	{ KSCHEMSAT_OFF, KSCHEMSAT_FAT, KSCHEMSAT_WATER }
enum	{ KSCHEMSAT_RF_STD, KSCHEMSAT_RF_SINC }

Functions
void	kschemsat_init_design (KSCHEMSAT_DESIGN *design)
STATUS	kschemsat_eval_design (KSCHEMSAT_MODULE *chemsat)
STATUS	kschemsat_pg (KSCHEMSAT_MODULE *chemsat, int start_time, KS_SEQ_CONTROL *seqctrl_p)
void	kschemsat_set_design_from_UI (KSCHEMSAT_DESIGN *design)

Variables
KSCHEMSAT_MODULE	kschemsat = KSCHEMSAT_INIT_MODULE
int	kschemsat_flag = KSCHEMSAT_OFF with {KSCHEMSAT_OFF, KSCHEMSAT_WATER, KSCHEMSAT_OFF, VIS, "flag for kschemsat (0:Off 1:FatSat 2:WaterSat)",}
float	kschemsat_flip = KSCHEMSAT_DEFAULT_FLIP with {0, 360, KSCHEMSAT_DEFAULT_FLIP, VIS, "RF flip angle [deg]",}
int	kschemsat_rftype = KSCHEMSAT_RF_STD with {KSCHEMSAT_RF_STD, KSCHEMSAT_RF_SINC, KSCHEMSAT_RF_STD, VIS, "RF type (0:Std 1:Sinc)",}
int	kschemsat_sinc_bw = KSCHEMSAT_DEFAULT_SINCRF_BW_3T with {2, 100000, 300, VIS, "Sinc RF BW",}
int	kschemsat_sinc_tbp = KSCHEMSAT_DEFAULT_SINCRF_TBP with {2, 20, 2, VIS, "Sinc RF Time-Bandwidth-Product",}
int	kschemsat_rfoffset = 0 with {-1000, 1000, 0, VIS, "RF excitation freq offset [Hz]",}
float	kschemsat_spoilerarea = KSCHEMSAT_DEFAULT_SPOILERAREA with {0, 10000, KSCHEMSAT_DEFAULT_SPOILERAREA, VIS, "Spoiler area",}
int	kschemsat_ssi_time = KSCHEMSAT_DEFAULT_SSITIME with {10, 20000, KSCHEMSAT_DEFAULT_SSITIME, VIS, "Time from eos to ssi in intern trig",}

Detailed Description

Macro Definition Documentation

KSCHEMSAT_MODULE_LOADED

#define KSCHEMSAT_MODULE_LOADED

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

KSCHEMSAT_DEFAULT_FLIP

#define KSCHEMSAT_DEFAULT_FLIP   95

KSCHEMSAT_DEFAULT_SINCRF_BW_15T

#define KSCHEMSAT_DEFAULT_SINCRF_BW_15T   150 /* for 1.5T */

KSCHEMSAT_DEFAULT_SINCRF_BW_3T

#define KSCHEMSAT_DEFAULT_SINCRF_BW_3T   300 /* for 3T */

KSCHEMSAT_DEFAULT_SINCRF_TBP

#define KSCHEMSAT_DEFAULT_SINCRF_TBP   4

KSCHEMSAT_DEFAULT_SPOILERAREA

#define KSCHEMSAT_DEFAULT_SPOILERAREA   5000

KSCHEMSAT_DEFAULT_SSITIME

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

KSCHEMSAT_INIT_DESIGN

#define KSCHEMSAT_INIT_DESIGN   {KSCHEMSAT_OFF, KSCHEMSAT_DEFAULT_FLIP, 0, KSCHEMSAT_RF_STD, KSCHEMSAT_DEFAULT_SINCRF_BW_3T, KSCHEMSAT_DEFAULT_SINCRF_TBP, KSCHEMSAT_DEFAULT_SPOILERAREA, KSCHEMSAT_DEFAULT_SSITIME}

KSCHEMSAT_INIT_MODULE

#define KSCHEMSAT_INIT_MODULE   {KS_INIT_BASE(KSCHEMSAT_MODULE), KS_INIT_SEQ_CONTROL, KSCHEMSAT_INIT_DESIGN, KS_INIT_RF, KS_INIT_TRAP, KS_NOTSET, 0, 0}

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
KSCHEMSAT_OFF
KSCHEMSAT_FAT
KSCHEMSAT_WATER

{KSCHEMSAT_OFF, KSCHEMSAT_FAT, KSCHEMSAT_WATER}; 

anonymous enum

anonymous enum

Enumerator
KSCHEMSAT_RF_STD
KSCHEMSAT_RF_SINC

{KSCHEMSAT_RF_STD, KSCHEMSAT_RF_SINC}; 

Function Documentation

kschemsat_init_design()

void kschemsat_init_design

(

KSCHEMSAT_DESIGN *

design

)

Initialize a chemical sat design to off

Parameters

[out]

design

pointer to the chemical sat design

Return values

STATUS

SUCCESS or FAILURE

                                                     {
  design->satmode = KSCHEMSAT_OFF;

} /* kschemsat_init_design() */

kschemsat_eval_design()

STATUS kschemsat_eval_design

(

KSCHEMSAT_MODULE *

chemsat

)

Populate objects from design

Parameters

[in,out]

chemsat

pointer to the module to be processed

Return values

STATUS

SUCCESS or FAILURE

                                                        {
  STATUS status;

  chemsat->end_time = 0;

  if (chemsat->design.satmode == KSCHEMSAT_OFF) {
    return SUCCESS;
  }

  /* RF */
  if (chemsat->design.rftype == KSCHEMSAT_RF_SINC) {
    /* create a KS_RF using ks_eval_rf_sinc */
    status = ks_eval_rf_sinc(&chemsat->rf, "kschemsat_rf", chemsat->design.sincrf_bw, chemsat->design.sincrf_tbp, chemsat->design.flip, KS_RF_SINCWIN_HAMMING);
    KS_RAISE(status);
    chemsat->rf.role = KS_RF_ROLE_CHEMSAT;
  } else {
    if (cffield == 30000)
      chemsat->rf = chemsat_cs3t; /* KSFoundation_GERF.h */
    else
      chemsat->rf = chemsat_csm; /* KSFoundation_GERF.h */
    chemsat->rf.flip = chemsat->design.flip;
    status = ks_eval_rf(&chemsat->rf, "kschemsat_rf");
    KS_RAISE(status);
  }
  chemsat->rf.cf_offset = chemsat->design.rfoffset; /* Exciter offset in Hz */

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

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


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

  return SUCCESS;

} /* kschemsat_eval_design() */

kschemsat_pg()

STATUS kschemsat_pg	(	KSCHEMSAT_MODULE *	chemsat,
		int	start_time,
		KS_SEQ_CONTROL *	seqctrl_p
	)

Generate the waveforms of a chemical sat module

If seqctrl_p is not NULL, it is assumed that the ChemSat 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]	chemsat	pointer to the module to be processed
[in]	start_time	time position for the start of the chemical sat 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 (!chemsat) {
    return KS_THROW("the first argument can not be NULL");
  }

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

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

  /* return early if sat mode is off */
  if (chemsat->design.satmode == KSCHEMSAT_OFF) {
    chemsat->end_time = start_time;
    return SUCCESS;
  }

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

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

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

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

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

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

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

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

  chemsat->end_time = loc.pos;

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

  return SUCCESS;

} /* kschemsat_pg() */

kschemsat_set_design_from_UI()

void kschemsat_set_design_from_UI

(

KSCHEMSAT_DESIGN *

design

)

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

Parameters

[out]

design

Pointer to a chamical sat's design

Return values

STATUS

SUCCESS or FAILURE

                                                            {

  kschemsat_rfoffset = 0;
  if (opfat) {
    kschemsat_flag = KSCHEMSAT_FAT;
    kschemsat_rfoffset = -(float) SDL_GetChemicalShift(cffield);
  } else if (opwater) {
    kschemsat_flag = KSCHEMSAT_WATER;
  } else {
    kschemsat_flag = KSCHEMSAT_OFF;
  }

  if (cffield == 30000) {
    kschemsat_sinc_bw = KSCHEMSAT_DEFAULT_SINCRF_BW_3T;
  } else {
    kschemsat_sinc_bw = KSCHEMSAT_DEFAULT_SINCRF_BW_15T;
  }

  design->satmode = kschemsat_flag;

  /* RF */
  design->flip = kschemsat_flip;
  design->rfoffset = kschemsat_rfoffset;
  design->rftype = kschemsat_rftype;
  if (design->rftype == KSCHEMSAT_RF_SINC) {
    design->sincrf_bw = kschemsat_sinc_bw;
    design->sincrf_tbp = kschemsat_sinc_tbp;
  } else {
    design->sincrf_bw = KS_NOTSET;
    design->sincrf_tbp = KS_NOTSET;
  }

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

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

} /* kschemsat_set_design_from_UI() */

Variable Documentation

kschemsat

KSCHEMSAT_MODULE kschemsat = KSCHEMSAT_INIT_MODULE

kschemsat_flag

int kschemsat_flag = KSCHEMSAT_OFF with {KSCHEMSAT_OFF, KSCHEMSAT_WATER, KSCHEMSAT_OFF, VIS, "flag for kschemsat (0:Off 1:FatSat 2:WaterSat)",}

kschemsat_flip

float kschemsat_flip = KSCHEMSAT_DEFAULT_FLIP with {0, 360, KSCHEMSAT_DEFAULT_FLIP, VIS, "RF flip angle [deg]",}

kschemsat_rftype

int kschemsat_rftype = KSCHEMSAT_RF_STD with {KSCHEMSAT_RF_STD, KSCHEMSAT_RF_SINC, KSCHEMSAT_RF_STD, VIS, "RF type (0:Std 1:Sinc)",}

kschemsat_sinc_bw

int kschemsat_sinc_bw = KSCHEMSAT_DEFAULT_SINCRF_BW_3T with {2, 100000, 300, VIS, "Sinc RF BW",}

kschemsat_sinc_tbp

int kschemsat_sinc_tbp = KSCHEMSAT_DEFAULT_SINCRF_TBP with {2, 20, 2, VIS, "Sinc RF Time-Bandwidth-Product",}

kschemsat_rfoffset

int kschemsat_rfoffset = 0 with {-1000, 1000, 0, VIS, "RF excitation freq offset [Hz]",}

kschemsat_spoilerarea

float kschemsat_spoilerarea = KSCHEMSAT_DEFAULT_SPOILERAREA with {0, 10000, KSCHEMSAT_DEFAULT_SPOILERAREA, VIS, "Spoiler area",}

kschemsat_ssi_time

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