< Master index Index for mml >

Index for mml

Matlab files in this directory:

 ContentsThe user should write text describing the m-files found in this directory
 addaoprefixADDAOPREFIX - Adds prefix to all AcceleratorObjects PV names
 addmenuadADDMENUAD - Menu to tune AD parameters
 addmenuaoADDMENUAO - Menu to tune AO parameters
 addmenustructADDMENUSTRUCT - Adds a menu bar to view and edit a structure
 addmmlmenuADDMENUAO - Menu to tune AO parameters
 amp2mmAMPS2MM - Returns the maximum millimeter orbit change per change in corrector
 aokeepAOKEEP - Removes families from the Accelerator Families except those included in KEEPLIST
 bpmresp2locoBPMRESP2LOCO - Convert a MML response matrix to LOCO units
 builddevlistBUILDDEVLIST - Make a full device list from devices in one sector
 buildopsdatafilesBUILDOPSDATAFILES - Builds the files for the OpsData directory from the model
 calcetaCALCETA - Calculates the dispersion function in physics or hardware units
 calcphaseCALCPHASE - Calculate the betatron oscillation phase at the BPM using turn-by-turn data
 cddatarootCDDATAROOT - Change to the MML data directory
 cdopsdataCDOPSDATA - Change to the MML operational data directory
 channel2commonCHANNEL2COMMON - Convert a channel name to a common name
 channel2devCHANNEL2DEV - Converts a channel name list to a device list
 channel2familyCHANNEL2FAMILY - Convert a channel name to a Family, Field, DeviceList
 channel2handleCHANNEL2HANDLE - Returns the MCA handle (obsolete)
 checkforaoCHECKFORAO - Checks if Accelerator Object exists
 checklimitsCHECKLIMITS - Checks if the setpoint will exceed a limit
 cm2mmCM2MM - (Just an alias to amp2mm)
 common2channelCOMMON2CHANNEL - Convert a common name to a channel name
 common2devCOMMON2DEV - Converts a common name to a device list
 common2familyCOMMON2FAMILY - Convert a common name to a family name
 common2handleCOMMON2HANDLE - Converts a common name to a MCA handle (Obsolete function)
 copybpmrespfileCOPYBPMRESPFILE - Copies a BPM response matrix file to the golden file
 copybpmsigmafileCOPYBPMSIGMAFILE - Copies a BPM data file to the golden BPM sigma file
 copychrorespfileCOPYCHRORESPFILE - Copies a chromaticity response matrix file to the golden file
 copydispersionfileCOPYDISPERSIONFILE - Copies a dispersion file to golden file
 copydisprespfileCOPYDISPRESPFILE - Copies a dispersion response matrix file to the golden file
 copyinjectionconfigfileCOPYINJECTIONCONFIGFILE - Copies a lattice file to the golden injection file
 copymachineconfigfileCOPYMACHINECONFIGFILE - Copies a lattice file to the golden file
 copytunerespfileCOPYTUNERESPFILE - Copies a tune response matrix file to the golden file
 correctors2goldenCORRECTORS2GOLDEN - Sets the default corrector families to the golden configuration values
 dev2commonDEV2COMMON - Converts Device lists to common names
 dev2elemDEV2ELEM - Converts an element list to a device list
 elem2devELEM2DEV - Converts a device list to an element list
 family2channelFAMILY2CHANNEL - Converts the family name to a channel name
 family2commonFAMILY2COMMON - Convert a family name, device list to a common name list
 family2datastructFAMILY2DATASTRUCTURE - Returns a datastructure corresponding to a Family
 family2devFAMILY2DEV - Return the device list for a family
 family2handle[Handles, ErrorFlag] = family2handle(Family, Field, DeviceList)
 family2modeFAMILY2MODE - Returns the present family mode ('Online', 'Simulator', 'Manual', 'Special', etc)
 family2statusFAMILY2STATUS - Returns the device status
 family2tolFAMILY2TOL - Return the (SP-AM) tolerance for a family
 family2unitsFAMILY2UNITS - Return the present family units and units string
 field2cellFIELD2CELL - Converts a structure of MML data structures into a cell array
 finddispquadFINDDISPQUAD - Find the optimal setting for the dispersion correction quadrupole family
 findfreqFINDFREQ - Finds the tunes via an FFT of turn-by-turn data
 findmemberofFINDMEMBEROF - Finds all family members
 findrfFINDRF - Finds the RF frequency that minimizes the energy change due
 findrf1FINDRF1 - Finds the RF frequency that minimizes the horizonal dispersion
 gcr2locoLOCO2GCR - Converts the LOCO BPM output to gain, crunch, and roll parameterization
 getadGETAD - returns the Accelerator Data (AD) structure
 getamGETAM - Gets monitor channels
 getaoGETAO - returns the AcceleratorObject (AO)
 getbpmGETBPM - Returns the horizontal and vertical orbit
 getbpmrespGETBPMRESP - Returns the BPM response matrix in the horizontal and vertical planes
 getbrhoGETBRHO - Calculations of the beam rigidity
 getchroGETCHRO - Return the chromaticity function (from file)
 getchrorespGETCHRORESP - Loads the chromaticity response vector (or matrix) for multiple sextupole families
 getcircumferenceGETCIRCUMFERENCE - Returns the ring circumference
 getcrunchGETCRUNCH- Returns the crunch values for a family (radians)
 getdataGETDATA - Searches through a file (or group of files) for a data structure which matches the family name
 getdcctGETDCCT - returns the beam current
 getdispGETDISP - Returns the dispersion for a family (from file)
 getenergyGETENERGY - Returns the beam energy base on the bend magnet
 getfamilydataGETFAMILYDATA - Gets data associated with the accelerator control
 getfamilylistGETFAMILYLIST - Returns a list of all the family names
 getgainGETGAIN - Returns the gain for a family
 getgoldenGETGOLDEN - Returns the golden values for a family
 gethbpmfamilyGETHBPMFAMILY - Return the default horizontal BPM family
 gethcmfamilyGETHCMFAMILY - Returns the default horizontal corrector family
 getinjectionlatticeGETINJECTIONLATTICE - Get data from the production lattice file
 getlatticeGETLATTICE - Get data from a lattice file
 getlistGETLIST - Returns Device List for a Family
 getmachineconfigGETMACHINECONFIG - Returns or saves to file the present storage ring setpoints and monitors
 getmachinelistGETMACHINELIST - Returns a cell array list of accelerators available to the Accelerator Control Toolbox (ACT)
 getmachinenameGETMACHINENAME - Return name of the machine loaded in MML
 getmcfGETMCF - Returns the momentum compaction factor (MCF) stored in the AD or the model
 getmemberofGETMEMBEROF - Returns the membership information of a family (cell of strings)
 getmmlrootGETMMLROOT - Returns root directory of the Matlab Middle Layer
 getmodeGETMODE - Returns the present family mode ('Online', 'Simulator', 'Manual', 'Special', etc)
 getnumberofsectorsGETNUMBEROFSECTORS - Number of sectors in the lattice
 getoffsetGETOFFSET - Returns the offset values for a family
 getphysdataGETPHYSDATA - Gets physics data
 getproductionlatticeGETPRODUCTIONLATTICE - Read the Golden lattice from file GoldenLattice
 getpvGETPV - Returns a variable from the online system or the model
 getramprateGETRAMPRATE - Returns the ramp rate for a family
 getrespmatGETRESPMAT - Get response matrix data from a file
 getrfGETRF - Gets the RF frequency
 getrollGETROLL - Returns the roll values for a family (radians)
 getrunflagGETRUNFLAG - Returns position if the device is in the process of changing a setpoint
 getsigmaGETSIGMA - Return the standard deviation in the monitor for a family
 getspGETSP - Gets setpoint channels
 getsposGETSPOS - Returns the longitudinal position in meters
 getsubmachinenameGETMACHINENAME - Return name of the machine loaded in MML
 gettolGETTOL - Returns the tolerance between the setpoint and monitor
 gettuneGETTUNE - Returns the betatron tunes
 gettunerespGETTUNERESP - Loads the tune response vector (or matrix) for multiple quadrupole families
 getunitsGETUNITS - Return the present family units and units string
 getvbpmfamilyGETVBPMFAMILY - Return the default vertical BPM family
 getvcmfamilyGETVCMFAMILY - Returns the default vertical corrector family
 getxGETX - Returns the horizontal orbit
 getyGETY - Returns the vertical orbit
 golden2simGOLDEN2SIM - loads online machine configuration to AT configuration
 gotodatarootGOTODATAROOT - Change directory to the data root directory
 hcm2goldenHCM2GOLDEN - Set horizontal corrector strengths to golden values
 hcm2zeroHCM2ZERO - Set horizontal corrector strengths to zero
 hw2physicsHW2PHYSICS - Converts from 'Hardware' units to 'Physics' units
 inputparsingffdINPUTPARSINGFFD - Parses the typical input line of Family, Field, DeviceList
 isboosterISBOOSTER - Is this a booster ring?
 isepicsISEPICS - Return true if EPICS is the online method
 isfamilyISFAMILY - True for family names
 islabcaISLABCA - Is labca being used as the control connection?
 ismcaISMCA - Is MCA being used as the control connection?
 ismemberofISMEMBEROF - Returns turn if the membership information of a family (cell of strings)
 isstorageringISSTORAGERING - Is this a storage ring?
 istangoISTANGO - Return true if TANGO is the online method
 istransportISTRANSPORT - Is this a transport line?
 loadaoLOADAO - Loads the AO and AD from a .mat file
 loadmachineconfigLOADMACHINECONFIG - Sets the storage ring setpoints and monitors from a file
 loadorbitLOADORBIT - Loads orbit by file/directory specification - or - Golden %orbit by default
 loco2gcrLOCO2GCR - Converts the LOCO BPM output to gain, crunch, and roll parameterization
 machine2simMACHINE2SIM - loads online machine configuration to AT configuration
 magstepHCM Step
 makebumpMAKEBUMP - Creates and orbit correction structure (OCS) usable by setorbit
 makedoc_htmlMAKEDOC_HTML - Generate new MML, SOLEIL and AT HTML help files
 makephysdataMAKEPHYSDATA - Make a starting physics data file
 maxpvMAXPV - Maximum value of a process variable
 maxspMAXSP - Maximum value of the setpoint
 measbpmrespMEASBPMRESP - Measures the BPM response matrix in the horizontal and vertical planes
 measbpmresplinearityMEASBPMRESPLINEARITY - Compute BPMlinearity
 measchroMEASCHRO - measures the chromaticity function emperically
 measchrorespMEASCHRORESP - measures the response from sextupoles to chromaticity
 meascmhysteresisMEASCMHYSTERESIS - Measure corrector magnet hysteresis
 measdispMEASDISP - Measures the dispersion function
 measdisprespMEASDISPRESP - Measures Amman TERMs in response matrix
 measidfftableFFGETTBL - Measures an insertion device feed forward table for the vertical gap
 measlifetimeMEASLIFETIME - Measures the lifetime using an exponential or linear least squares fit to beam current
 measlocodataMEASLOCODATA - Measures a set of LOCO data
 measrespmatMEASRESPMAT - Measure a response matrix
 meastunerespMEASTUNERESP - Measures the response from quadrupole to tune
 minpvMinPV - Maximum value of a process variable
 minspMINSP - Minimum value of the setpoint
 mm2ampMM2AMPS - Returns the change in corrector need for a maximum orbit change
 mm2cmMM2CM - (Just an alias to mm2amp)
 monitorchannelsMONITORCHANNELS - Monitor a groups of families or channel names
 monitorpvMONITORPV -
 monmagsMONMAGS - Monitors all magnet power supplies and plots various statistics
 monrateMONRATE - Calculates the control system data rate of a noisy channel
 monratesMONRATES - Tests the analog monitor data rate for BPMs and corrector magnets
 orbitcorrectionmethodsORBITCORRECTIONMETHODS - Some the orbit correction methods used on light sources
 physics2hwPHYSICS2HW - Converts from 'Physics' units to 'Hardware' units
 plotbpmpsdPLOTBPMPSD - Plots data taken will getbpmpsd
 plotbpmrespPLOTBPMRESP - Plots the orbit response matrix in various ways
 plotbpmrespsymPLOTBPMRESPSYM - Looks for symmetry of the orbit response matrix
 plotchroPLOTCHRO - Plot the chromaticity function
 plotcmPLOTCM - Plots the horizontal and vertical corrector magnet families and
 plotdispPLOTDISP - Plots the dispersion function
 plotgoldenorbitPLOTGOLDENORBIT - Plots the golden orbit
 plotidfftablePLOTIDFFTABLE - Plots various information about the feed forward tables
 plotlatticePLOTLATTICE - Plot the lattice
 plotoffsetorbitPLOTOFFSETORBIT - Plots the offset orbit
 plotorbitPLOTORBIT - Plot the present orbit w.r.t. the golden or offset orbit
 plotorbitdataPLOTORBITDATA - Plots BPM statistics
 plotwaveformPJ BOussina waveform loader September 11, 2006
 quad2bpmQUAD2BPM - Returns the nearest BPM to the specified quadrupole
 quadcenterQUADCENTER - Measure the magnet center of a quadrupole magnet
 quadcenterfitBBASEARCH - Model search method to find a quarupole center
 quadcenterinitQMS = quadcenterinit(Family, Device, QuadPlane)
 quaderrorsQUADERRORS - Computes the error bars for quadrupole center measurement
 quadgetdataQUADGETDATA - Collect the date from a quadrupole center run.
 quadplotQUADPLOT - Plots quadrupole centering data
 quadplotallQUADPLOTALL - Collect the date from a quadrupole center run.
 quadplotphysicsQUADPLOTPHYSICS - Plots quadrupole centering data in physics units
 raw2realRAW2REAL - Converts raw control system data to calibrated values
 real2rawREAL2RAW - Converts "real" data (calibrated values) to control system data
 rf2manualRF2MANUAL - Sets the RF family to manual mode
 rmdispRMDISP - Removes the portion of the orbit that correlates with the dispersion
 rmgoldenRMGOLDEN - Remove the golden values for data set
 rmoffsetRMOFFSET - Remove the offset values for data set
 saveaoSAVEAO - Saves the AO and AD to a .mat file
 savegoldenorbitSAVEGOLDENORBIT - Save present orbit as golden orbit into a file
 savemachineconfigSAVEMACHINECONFIG - Saves the storage ring setpoints and monitors to a file
 saveoffsetorbitSAVEOFFSETORBIT - Save offset orbit into file
 scanorbitSCANORBIT - Scans 2 correctors 90 degrees out of phase
 sectorticksSECTORTICKS - Returns sector tick number for plotting purpose
 setadSETAD - Sets the MML AcceleratorData cell array to appdata
 setamSETAM - Sets analog monitor value
 setaoSETAO - Set Accelerator Object (AO)
 setchroSETCHRO - Measures then sets the chromaticity
 setenergySETENERGY - Sets the storage ring energy (GeV) by ramping all lattice magnets
 setfamilydataSETFAMILYDATA - Sets data associated with accelerator control
 setgoldenSETGOLDEN - Set the golden values
 setmachineconfigSETMACHINECONFIG - Sets the storage ring setpoints from a file or configuration data structure
 setmmldirectoriesSETMMLDIRECTORIES - Set the directory in the Matlab middle layer
 setoffsetSETOFFSET - Set the offset
 setorbitSETORBIT - Orbit correction function
 setorbitbumpSETORBITBUMP - Local bump program (uses setorbit)
 setorbitsetupSETORBITSETUP - BPM & CM setup function for setorbitgui
 setpathalbaSETPATHALBA - Initializes the Matlab Middle Layer (MML) for ALBA
 setpathalsSETPATHALS - Initializes the Matlab Middle Layer (MML) for ALS
 setpathaspSETPATHASP - Initializes the Matlab Middle Layer (MML) for ASP
 setpathatSETPATHAT - Sets the AT Toolbox path
 setpathbfactorySETPATHBFACTORY - Initializes the Matlab Middle Layer (MML) for the B-Factory
 setpathcamdSETPATHCAMD - Initializes the Matlab Middle Layer (MML) for CAMD
 setpathclsSETPATHCLS - Initializes the Matlab Middle Layer (MML) for CLS
 setpathdiamondSETPATHDIAMOND - Initializes the Matlab Middle Layer (MML) for DIAMOND
 setpathdsrSETPATHDSR - Initializes the Matlab Middle Layer (MML) for DSR
 setpathmmlSETPATHMML - Initialize the Matlab MiddleLayer (MML) path
 setpathnsrrcSETPATHNSRRC - Initializes the Matlab Middle Layer (MML) for NSRRC
 setpathplsSETPATHPLS - Initializes the Matlab Middle Layer (MML) for PLS
 setpathsoleilSETPATHSOLEIL - Initializes the Matlab Middle Layer (MML) for Soleil
 setpathspear3SETPATHSPEAR3 - Initializes the Matlab Middle Layer (MML) for Spear3
 setpathspsSETPATHSPS - Initializes the Matlab Middle Layer (MML) for SPS
 setpathssrfSETPATHSSRF - Initializes the Matlab Middle Layer (MML) for SSRF
 setpathvuvSETPATHVUV - Initializes the Matlab Middle Layer (MML) for the VUV ring at NSLS
 setpathxraySETPATHXRAY - Initializes the Matlab Middle Layer (MML) for the X-Ray ring at NSLS
 setphysdataSETPHYSDATA - Set physics data
 setpvSETPV - Setpoint change of the online system or model
 setrfSETRF - Sets the RF frequency
 setspSETSP - Makes an absolute setpoint change to the 'Setpoint' field
 settuneSETTUNE - Set the tune
 sext2bpmSEXT2BPM - Returns the nearest BPM to the specified sextupole
 showaoSHOWAO - Display the AcceleratorObjects fields containing Tango part
 showfamilySHOWFAMILY - Displays a list of all families
 showmachinedataSHOWMACHINEDATA - Display setpoints and readbacks for families in AcceleratorObjects
 sim2machineSIM2MACHINE - Sets the AT configuration to the online machine
 soundchordSOUNDCHORD - Makes a "chord" sound
 sounderrorSOUNDERROR - Makes a "error" sound
 soundquestionSOUNDQUESTION - Makes a "question" sound
 soundtadaSOUNDTADA - Makes a "tada" sound
 stepchroSTEPCHRO - Incremental change in the chromaticity (Delta Tune / Delta RF)
 steppvSTEPPV - Incremental setpoint change of a process variable or simulated value
 steprfSTEPRF - Increment change in the RF frequency
 stepspSTEPSP - Step the setpoint for family
 steptuneSTEPTUNE - Step the tune
 sweepenergySWEEPENERGY - Energy sweep of the storage ring
 switch2hardwareSWITCH2HARDWARE - Switch family to hardware units
 switch2hwSWITCH2HW - Switch a family to hardware units
 switch2manualSWITCH2MANUAL - Switch family to manual mode.
 switch2onlineSWITCH2ONLINE - Switch family to online mode
 switch2physicsSWITCH2PHYSICS - Switch family to physics units
 switch2simSWITCH2SIM - Switch family to simulator mode if the family is in online mode.
 switchmodeSWITCHMODE - Change the mode field for all families in the MML
 switchunitsSWITCHUNITS - Change the units field for all families in the MML
 tune2manualTUNE2MANUAL - Sets the TUNE family to manual mode
 tune2onlineTUNE2ONLINE - Sets the TUNE family to online mode
 tune2simTUNE2SIM - Sets the TUNE family to simulator mode
 vcm2goldenVCM2GOLDEN - Set vertical corrector strengths to golden values
 vcm2zeroVCM2ZERO - Set vertical corrector strengths to zero

Subsequent directories:


Generated on Mon 21-May-2007 15:29:11 by m2html © 2003