KS_SEQLOC Struct Reference

#include <KSFoundation.h>

Data Fields
int	board
int	pos
float	ampscale
float	ampscale2

Detailed Description

typedef struct used as argument to ks_pg_*** functions to control where and when to place a sequence object (e.g. KS_TRAP)

For most sequence objects, the field .board should be one of:

• XGRAD
• YGRAD
• ZGRAD
• RHO
• THETA
• OMEGA

For sequence objects operating on more than one gradient board at a time (like KS_EPI), the field .board denotes a combination of two axes:

• KS_FREQX_PHASEY
• KS_FREQY_PHASEX
• KS_FREQX_PHASEZ
• KS_FREQZ_PHASEX
• KS_FREQY_PHASEZ
• KS_FREQZ_PHASEY

The .ampscale field must be in range [-1.0, 1.0] and modifies the designed KS_*** object on a per-instance basis. A few sequence functions (e.g. ks_pg_phaser()) ignores this value, but in general it is used to modify all, or a part, of a given KS_*** object

Example

@pg (TGT)
  KS_SEQLOC tmploc = KS_INIT_SEQLOC; // board-time-ampscale entity to control where and when a sequence object should be placed
  tmploc.board = XGRAD;
  tmploc.pos = 20ms;
  tmploc.ampscale = -1.0; // negate the amplitude of the KS_TRAP 'mytrap' designed by ks_eval_trap()
  ks_pg_trap(&mytrap, tmploc, ...); // place an instance of mytrap at absolute position 20ms (beginning of attack ramp) on XGRAD

Field Documentation

board

int board

XGRAD, YGRAD, ZGRAD, RHO, OMEGA, THETA, KS_FREQX_PHASEY, KS_FREQY_PHASEX, KS_FREQX_PHASEZ, KS_FREQZ_PHASEX, KS_FREQY_PHASEZ, KS_FREQZ_PHASEY, KS_XYZ

pos

int pos

Absolute position in [us]

ampscale

float ampscale

Modifies the amplitude of the sequence object per instance (i.e. per ks_pg_***() call). Allowed range [-1.0, +1.0]. Ignored by e.g. ks_pg_phaser()

ampscale2

float ampscale2

Additional ampscale. Used in ks_pg_selrf() to ampscale the crushers as .ampscale is already used for RF amp scaling. Allowed range [-1.0, +1.0]

---

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

• KSFoundation.h