Contents | The user should write text describing the m-files found in this directory |
addaoprefix | ADDAOPREFIX - Adds prefix to all AcceleratorObjects PV names |
addmenuad | ADDMENUAD - Menu to tune AD parameters |
addmenuao | ADDMENUAO - Menu to tune AO parameters |
addmenustruct | ADDMENUSTRUCT - Adds a menu bar to view and edit a structure |
addmmlmenu | ADDMENUAO - Menu to tune AO parameters |
amp2mm | AMPS2MM - Returns the maximum millimeter orbit change per change in corrector |
aokeep | AOKEEP - Removes families from the Accelerator Families except those included in KEEPLIST |
bpmresp2loco | BPMRESP2LOCO - Convert a MML response matrix to LOCO units |
builddevlist | BUILDDEVLIST - Make a full device list from devices in one sector |
buildopsdatafiles | BUILDOPSDATAFILES - Builds the files for the OpsData directory from the model |
calceta | CALCETA - Calculates the dispersion function in physics or hardware units |
calcphase | CALCPHASE - Calculate the betatron oscillation phase at the BPM using turn-by-turn data |
cddataroot | CDDATAROOT - Change to the MML data directory |
cdopsdata | CDOPSDATA - Change to the MML operational data directory |
channel2common | CHANNEL2COMMON - Convert a channel name to a common name |
channel2dev | CHANNEL2DEV - Converts a channel name list to a device list |
channel2family | CHANNEL2FAMILY - Convert a channel name to a Family, Field, DeviceList |
channel2handle | CHANNEL2HANDLE - Returns the MCA handle (obsolete) |
checkforao | CHECKFORAO - Checks if Accelerator Object exists |
checklimits | CHECKLIMITS - Checks if the setpoint will exceed a limit |
cm2mm | CM2MM - (Just an alias to amp2mm) |
common2channel | COMMON2CHANNEL - Convert a common name to a channel name |
common2dev | COMMON2DEV - Converts a common name to a device list |
common2family | COMMON2FAMILY - Convert a common name to a family name |
common2handle | COMMON2HANDLE - Converts a common name to a MCA handle (Obsolete function) |
copybpmrespfile | COPYBPMRESPFILE - Copies a BPM response matrix file to the golden file |
copybpmsigmafile | COPYBPMSIGMAFILE - Copies a BPM data file to the golden BPM sigma file |
copychrorespfile | COPYCHRORESPFILE - Copies a chromaticity response matrix file to the golden file |
copydispersionfile | COPYDISPERSIONFILE - Copies a dispersion file to golden file |
copydisprespfile | COPYDISPRESPFILE - Copies a dispersion response matrix file to the golden file |
copyinjectionconfigfile | COPYINJECTIONCONFIGFILE - Copies a lattice file to the golden injection file |
copymachineconfigfile | COPYMACHINECONFIGFILE - Copies a lattice file to the golden file |
copytunerespfile | COPYTUNERESPFILE - Copies a tune response matrix file to the golden file |
correctors2golden | CORRECTORS2GOLDEN - Sets the default corrector families to the golden configuration values |
dev2common | DEV2COMMON - Converts Device lists to common names |
dev2elem | DEV2ELEM - Converts an element list to a device list |
elem2dev | ELEM2DEV - Converts a device list to an element list |
family2channel | FAMILY2CHANNEL - Converts the family name to a channel name |
family2common | FAMILY2COMMON - Convert a family name, device list to a common name list |
family2datastruct | FAMILY2DATASTRUCTURE - Returns a datastructure corresponding to a Family |
family2dev | FAMILY2DEV - Return the device list for a family |
family2handle | [Handles, ErrorFlag] = family2handle(Family, Field, DeviceList) |
family2mode | FAMILY2MODE - Returns the present family mode ('Online', 'Simulator', 'Manual', 'Special', etc) |
family2status | FAMILY2STATUS - Returns the device status |
family2tol | FAMILY2TOL - Return the (SP-AM) tolerance for a family |
family2units | FAMILY2UNITS - Return the present family units and units string |
field2cell | FIELD2CELL - Converts a structure of MML data structures into a cell array |
finddispquad | FINDDISPQUAD - Find the optimal setting for the dispersion correction quadrupole family |
findfreq | FINDFREQ - Finds the tunes via an FFT of turn-by-turn data |
findmemberof | FINDMEMBEROF - Finds all family members |
findrf | FINDRF - Finds the RF frequency that minimizes the energy change due |
findrf1 | FINDRF1 - Finds the RF frequency that minimizes the horizonal dispersion |
gcr2loco | LOCO2GCR - Converts the LOCO BPM output to gain, crunch, and roll parameterization |
getad | GETAD - returns the Accelerator Data (AD) structure |
getam | GETAM - Gets monitor channels |
getao | GETAO - returns the AcceleratorObject (AO) |
getbpm | GETBPM - Returns the horizontal and vertical orbit |
getbpmresp | GETBPMRESP - Returns the BPM response matrix in the horizontal and vertical planes |
getbrho | GETBRHO - Calculations of the beam rigidity |
getchro | GETCHRO - Return the chromaticity function (from file) |
getchroresp | GETCHRORESP - Loads the chromaticity response vector (or matrix) for multiple sextupole families |
getcircumference | GETCIRCUMFERENCE - Returns the ring circumference |
getcrunch | GETCRUNCH- Returns the crunch values for a family (radians) |
getdata | GETDATA - Searches through a file (or group of files) for a data structure which matches the family name |
getdcct | GETDCCT - returns the beam current |
getdisp | GETDISP - Returns the dispersion for a family (from file) |
getenergy | GETENERGY - Returns the beam energy base on the bend magnet |
getfamilydata | GETFAMILYDATA - Gets data associated with the accelerator control |
getfamilylist | GETFAMILYLIST - Returns a list of all the family names |
getgain | GETGAIN - Returns the gain for a family |
getgolden | GETGOLDEN - Returns the golden values for a family |
gethbpmfamily | GETHBPMFAMILY - Return the default horizontal BPM family |
gethcmfamily | GETHCMFAMILY - Returns the default horizontal corrector family |
getinjectionlattice | GETINJECTIONLATTICE - Get data from the production lattice file |
getlattice | GETLATTICE - Get data from a lattice file |
getlist | GETLIST - Returns Device List for a Family |
getmachineconfig | GETMACHINECONFIG - Returns or saves to file the present storage ring setpoints and monitors |
getmachinelist | GETMACHINELIST - Returns a cell array list of accelerators available to the Accelerator Control Toolbox (ACT) |
getmachinename | GETMACHINENAME - Return name of the machine loaded in MML |
getmcf | GETMCF - Returns the momentum compaction factor (MCF) stored in the AD or the model |
getmemberof | GETMEMBEROF - Returns the membership information of a family (cell of strings) |
getmmlroot | GETMMLROOT - Returns root directory of the Matlab Middle Layer |
getmode | GETMODE - Returns the present family mode ('Online', 'Simulator', 'Manual', 'Special', etc) |
getnumberofsectors | GETNUMBEROFSECTORS - Number of sectors in the lattice |
getoffset | GETOFFSET - Returns the offset values for a family |
getphysdata | GETPHYSDATA - Gets physics data |
getproductionlattice | GETPRODUCTIONLATTICE - Read the Golden lattice from file GoldenLattice |
getpv | GETPV - Returns a variable from the online system or the model |
getramprate | GETRAMPRATE - Returns the ramp rate for a family |
getrespmat | GETRESPMAT - Get response matrix data from a file |
getrf | GETRF - Gets the RF frequency |
getroll | GETROLL - Returns the roll values for a family (radians) |
getrunflag | GETRUNFLAG - Returns position if the device is in the process of changing a setpoint |
getsigma | GETSIGMA - Return the standard deviation in the monitor for a family |
getsp | GETSP - Gets setpoint channels |
getspos | GETSPOS - Returns the longitudinal position in meters |
getsubmachinename | GETMACHINENAME - Return name of the machine loaded in MML |
gettol | GETTOL - Returns the tolerance between the setpoint and monitor |
gettune | GETTUNE - Returns the betatron tunes |
gettuneresp | GETTUNERESP - Loads the tune response vector (or matrix) for multiple quadrupole families |
getunits | GETUNITS - Return the present family units and units string |
getvbpmfamily | GETVBPMFAMILY - Return the default vertical BPM family |
getvcmfamily | GETVCMFAMILY - Returns the default vertical corrector family |
getx | GETX - Returns the horizontal orbit |
gety | GETY - Returns the vertical orbit |
golden2sim | GOLDEN2SIM - loads online machine configuration to AT configuration |
gotodataroot | GOTODATAROOT - Change directory to the data root directory |
hcm2golden | HCM2GOLDEN - Set horizontal corrector strengths to golden values |
hcm2zero | HCM2ZERO - Set horizontal corrector strengths to zero |
hw2physics | HW2PHYSICS - Converts from 'Hardware' units to 'Physics' units |
inputparsingffd | INPUTPARSINGFFD - Parses the typical input line of Family, Field, DeviceList |
isbooster | ISBOOSTER - Is this a booster ring? |
isepics | ISEPICS - Return true if EPICS is the online method |
isfamily | ISFAMILY - True for family names |
islabca | ISLABCA - Is labca being used as the control connection? |
ismca | ISMCA - Is MCA being used as the control connection? |
ismemberof | ISMEMBEROF - Returns turn if the membership information of a family (cell of strings) |
isstoragering | ISSTORAGERING - Is this a storage ring? |
istango | ISTANGO - Return true if TANGO is the online method |
istransport | ISTRANSPORT - Is this a transport line? |
loadao | LOADAO - Loads the AO and AD from a .mat file |
loadmachineconfig | LOADMACHINECONFIG - Sets the storage ring setpoints and monitors from a file |
loadorbit | LOADORBIT - Loads orbit by file/directory specification - or - Golden %orbit by default |
loco2gcr | LOCO2GCR - Converts the LOCO BPM output to gain, crunch, and roll parameterization |
machine2sim | MACHINE2SIM - loads online machine configuration to AT configuration |
magstep | HCM Step |
makebump | MAKEBUMP - Creates and orbit correction structure (OCS) usable by setorbit |
makedoc_html | MAKEDOC_HTML - Generate new MML, SOLEIL and AT HTML help files |
makephysdata | MAKEPHYSDATA - Make a starting physics data file |
maxpv | MAXPV - Maximum value of a process variable |
maxsp | MAXSP - Maximum value of the setpoint |
measbpmresp | MEASBPMRESP - Measures the BPM response matrix in the horizontal and vertical planes |
measbpmresplinearity | MEASBPMRESPLINEARITY - Compute BPMlinearity |
measchro | MEASCHRO - measures the chromaticity function emperically |
measchroresp | MEASCHRORESP - measures the response from sextupoles to chromaticity |
meascmhysteresis | MEASCMHYSTERESIS - Measure corrector magnet hysteresis |
measdisp | MEASDISP - Measures the dispersion function |
measdispresp | MEASDISPRESP - Measures Amman TERMs in response matrix |
measidfftable | FFGETTBL - Measures an insertion device feed forward table for the vertical gap |
measlifetime | MEASLIFETIME - Measures the lifetime using an exponential or linear least squares fit to beam current |
measlocodata | MEASLOCODATA - Measures a set of LOCO data |
measrespmat | MEASRESPMAT - Measure a response matrix |
meastuneresp | MEASTUNERESP - Measures the response from quadrupole to tune |
minpv | MinPV - Maximum value of a process variable |
minsp | MINSP - Minimum value of the setpoint |
mm2amp | MM2AMPS - Returns the change in corrector need for a maximum orbit change |
mm2cm | MM2CM - (Just an alias to mm2amp) |
monitorchannels | MONITORCHANNELS - Monitor a groups of families or channel names |
monitorpv | MONITORPV - |
monmags | MONMAGS - Monitors all magnet power supplies and plots various statistics |
monrate | MONRATE - Calculates the control system data rate of a noisy channel |
monrates | MONRATES - Tests the analog monitor data rate for BPMs and corrector magnets |
orbitcorrectionmethods | ORBITCORRECTIONMETHODS - Some the orbit correction methods used on light sources |
physics2hw | PHYSICS2HW - Converts from 'Physics' units to 'Hardware' units |
plotbpmpsd | PLOTBPMPSD - Plots data taken will getbpmpsd |
plotbpmresp | PLOTBPMRESP - Plots the orbit response matrix in various ways |
plotbpmrespsym | PLOTBPMRESPSYM - Looks for symmetry of the orbit response matrix |
plotchro | PLOTCHRO - Plot the chromaticity function |
plotcm | PLOTCM - Plots the horizontal and vertical corrector magnet families and |
plotdisp | PLOTDISP - Plots the dispersion function |
plotgoldenorbit | PLOTGOLDENORBIT - Plots the golden orbit |
plotidfftable | PLOTIDFFTABLE - Plots various information about the feed forward tables |
plotlattice | PLOTLATTICE - Plot the lattice |
plotoffsetorbit | PLOTOFFSETORBIT - Plots the offset orbit |
plotorbit | PLOTORBIT - Plot the present orbit w.r.t. the golden or offset orbit |
plotorbitdata | PLOTORBITDATA - Plots BPM statistics |
plotwaveform | PJ BOussina waveform loader September 11, 2006 |
quad2bpm | QUAD2BPM - Returns the nearest BPM to the specified quadrupole |
quadcenter | QUADCENTER - Measure the magnet center of a quadrupole magnet |
quadcenterfit | BBASEARCH - Model search method to find a quarupole center |
quadcenterinit | QMS = quadcenterinit(Family, Device, QuadPlane) |
quaderrors | QUADERRORS - Computes the error bars for quadrupole center measurement |
quadgetdata | QUADGETDATA - Collect the date from a quadrupole center run. |
quadplot | QUADPLOT - Plots quadrupole centering data |
quadplotall | QUADPLOTALL - Collect the date from a quadrupole center run. |
quadplotphysics | QUADPLOTPHYSICS - Plots quadrupole centering data in physics units |
raw2real | RAW2REAL - Converts raw control system data to calibrated values |
real2raw | REAL2RAW - Converts "real" data (calibrated values) to control system data |
rf2manual | RF2MANUAL - Sets the RF family to manual mode |
rmdisp | RMDISP - Removes the portion of the orbit that correlates with the dispersion |
rmgolden | RMGOLDEN - Remove the golden values for data set |
rmoffset | RMOFFSET - Remove the offset values for data set |
saveao | SAVEAO - Saves the AO and AD to a .mat file |
savegoldenorbit | SAVEGOLDENORBIT - Save present orbit as golden orbit into a file |
savemachineconfig | SAVEMACHINECONFIG - Saves the storage ring setpoints and monitors to a file |
saveoffsetorbit | SAVEOFFSETORBIT - Save offset orbit into file |
scanorbit | SCANORBIT - Scans 2 correctors 90 degrees out of phase |
sectorticks | SECTORTICKS - Returns sector tick number for plotting purpose |
setad | SETAD - Sets the MML AcceleratorData cell array to appdata |
setam | SETAM - Sets analog monitor value |
setao | SETAO - Set Accelerator Object (AO) |
setchro | SETCHRO - Measures then sets the chromaticity |
setenergy | SETENERGY - Sets the storage ring energy (GeV) by ramping all lattice magnets |
setfamilydata | SETFAMILYDATA - Sets data associated with accelerator control |
setgolden | SETGOLDEN - Set the golden values |
setmachineconfig | SETMACHINECONFIG - Sets the storage ring setpoints from a file or configuration data structure |
setmmldirectories | SETMMLDIRECTORIES - Set the directory in the Matlab middle layer |
setoffset | SETOFFSET - Set the offset |
setorbit | SETORBIT - Orbit correction function |
setorbitbump | SETORBITBUMP - Local bump program (uses setorbit) |
setorbitsetup | SETORBITSETUP - BPM & CM setup function for setorbitgui |
setpathalba | SETPATHALBA - Initializes the Matlab Middle Layer (MML) for ALBA |
setpathals | SETPATHALS - Initializes the Matlab Middle Layer (MML) for ALS |
setpathasp | SETPATHASP - Initializes the Matlab Middle Layer (MML) for ASP |
setpathat | SETPATHAT - Sets the AT Toolbox path |
setpathbfactory | SETPATHBFACTORY - Initializes the Matlab Middle Layer (MML) for the B-Factory |
setpathcamd | SETPATHCAMD - Initializes the Matlab Middle Layer (MML) for CAMD |
setpathcls | SETPATHCLS - Initializes the Matlab Middle Layer (MML) for CLS |
setpathdiamond | SETPATHDIAMOND - Initializes the Matlab Middle Layer (MML) for DIAMOND |
setpathdsr | SETPATHDSR - Initializes the Matlab Middle Layer (MML) for DSR |
setpathmml | SETPATHMML - Initialize the Matlab MiddleLayer (MML) path |
setpathnsrrc | SETPATHNSRRC - Initializes the Matlab Middle Layer (MML) for NSRRC |
setpathpls | SETPATHPLS - Initializes the Matlab Middle Layer (MML) for PLS |
setpathsoleil | SETPATHSOLEIL - Initializes the Matlab Middle Layer (MML) for Soleil |
setpathspear3 | SETPATHSPEAR3 - Initializes the Matlab Middle Layer (MML) for Spear3 |
setpathsps | SETPATHSPS - Initializes the Matlab Middle Layer (MML) for SPS |
setpathssrf | SETPATHSSRF - Initializes the Matlab Middle Layer (MML) for SSRF |
setpathvuv | SETPATHVUV - Initializes the Matlab Middle Layer (MML) for the VUV ring at NSLS |
setpathxray | SETPATHXRAY - Initializes the Matlab Middle Layer (MML) for the X-Ray ring at NSLS |
setphysdata | SETPHYSDATA - Set physics data |
setpv | SETPV - Setpoint change of the online system or model |
setrf | SETRF - Sets the RF frequency |
setsp | SETSP - Makes an absolute setpoint change to the 'Setpoint' field |
settune | SETTUNE - Set the tune |
sext2bpm | SEXT2BPM - Returns the nearest BPM to the specified sextupole |
showao | SHOWAO - Display the AcceleratorObjects fields containing Tango part |
showfamily | SHOWFAMILY - Displays a list of all families |
showmachinedata | SHOWMACHINEDATA - Display setpoints and readbacks for families in AcceleratorObjects |
sim2machine | SIM2MACHINE - Sets the AT configuration to the online machine |
soundchord | SOUNDCHORD - Makes a "chord" sound |
sounderror | SOUNDERROR - Makes a "error" sound |
soundquestion | SOUNDQUESTION - Makes a "question" sound |
soundtada | SOUNDTADA - Makes a "tada" sound |
stepchro | STEPCHRO - Incremental change in the chromaticity (Delta Tune / Delta RF) |
steppv | STEPPV - Incremental setpoint change of a process variable or simulated value |
steprf | STEPRF - Increment change in the RF frequency |
stepsp | STEPSP - Step the setpoint for family |
steptune | STEPTUNE - Step the tune |
sweepenergy | SWEEPENERGY - Energy sweep of the storage ring |
switch2hardware | SWITCH2HARDWARE - Switch family to hardware units |
switch2hw | SWITCH2HW - Switch a family to hardware units |
switch2manual | SWITCH2MANUAL - Switch family to manual mode. |
switch2online | SWITCH2ONLINE - Switch family to online mode |
switch2physics | SWITCH2PHYSICS - Switch family to physics units |
switch2sim | SWITCH2SIM - Switch family to simulator mode if the family is in online mode. |
switchmode | SWITCHMODE - Change the mode field for all families in the MML |
switchunits | SWITCHUNITS - Change the units field for all families in the MML |
tune2manual | TUNE2MANUAL - Sets the TUNE family to manual mode |
tune2online | TUNE2ONLINE - Sets the TUNE family to online mode |
tune2sim | TUNE2SIM - Sets the TUNE family to simulator mode |
vcm2golden | VCM2GOLDEN - Set vertical corrector strengths to golden values |
vcm2zero | VCM2ZERO - Set vertical corrector strengths to zero |