↑ TOP
A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, Misc.
Lumerical's scripting language allows you to automate tasks and analysis such as manipulating simulation objects, launching simulations and analyzing results. Script commands can be entered directly into the script prompt, be run from a saved script file (.lsf), or used within some simulation objects. Script commands such as "?" and "+" are at the end (see Misc).
You can also take the introductory Scripting courses in the AIC to learn more.
A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, Misc.
A
abs
acos
add2dpoly
add2drect
add2visualizer
addabsorbing
addanalysisgroup
addanalysisprop
addanalysisresult
addassemblygroup
addattribute
addbandstructuremonitor
addbc (deprecated, see other add boundary conditions command, such as addvoltagebc)
addbulkgen
addchargemesh
addchargemonitor
addchargesolver
addcircle
addcontact (deprecated, see addelectricalcontact)
addconvectionbc
addctmaterialproperty
addcustom
addcustomdoping (deprecated, see addimportdoping)
adddeltachargesource
adddevice
adddgtdmesh
adddgtdsolver
adddiffusion
adddipole
adddope
adddopinglayer
addeffectiveindex
addefieldmonitor
addeigenmode (deprecated, see addfde)
addelectricalcontact
addelement
addemabsorptionmonitor
addeme
addemeindex
addemeport
addemeprofile
addemfieldmonitor
addemfieldtimemonitor
addemmaterialproperty
addfde
addfdtd
addfeemmesh
addfeemsolver
addgaussian
addgridattribute
addgroup
addheatfluxbc
addheatfluxmonitor
addheatmesh
addheatsolver
addhtmaterialproperty
addimplant
addimport
addimportdope
addimportedsource
addimportgen
addimportheat
addimportnk
addimporttemperature
addindex
addjfluxmonitor
addjob
addlayer
addlayerbuilder
addmaterial
addmaterialproperties
addmesh
addmeshconstraint (deprecated)
addmode
addmodeexpansion
addmodelmaterial
addmodesource
addmovie
addobject
addparameter
addpath
addpec
addperiodic
addplanarsolid
addplane
addpmc
addpml
addpoly
addport (FDTD)
addport (INTERCONNECT)
addpower
addprofile
addpropagator (deprecated, see addvarfdtd)
addproperty
addpyramid
addradiationbc
addrcwa
addrect
addresource
addring
addsimulationregion
addsphere
addstructuregroup
addsurface
addsurfacechargebc
addsurfacerecombinationbc
addsweep
addsweepparameter
addsweepresult
addtemperaturebc
addtemperaturemonitor
addtfsf
addthermalinsulatingbc
addthermalpowerbc
addtime
addtogroup
addtolibrary
addtriangle
adduniformheat
adduserprop
addvarfdtd
addvoltagebc
addwaveguide
all
almostequal
amax
amin
analysis
and
angle
annotateproperty
any
arrayperiodicdata
asapexport
asapimport
asapload
asin
assert (deprecated)
atan
atan2
atp
autoarrange
autosaveoff
autosaveon
B
bar
besseli
besselj
besselk
bessely
bestoverlap
bestoverlap2
break
buildmqwmaterial
C
cadtostreamlayer
cd
ceil
cell
centroid
chebin
chebpol
chebpol1
checkout
chol
chpts
cls/clc
clear
clearanalysis
cleardataset
cleardcard
clearexcept
clearfunctions
clearjobs
clearlogwindow
clearmodedata
clearpath
clearportmodedata
clearsourcedata
closeall
closesession
colormatch
colormatchfunction
colormatchuv
colormatchxy
conj
connect
constructgeneratormatrix
conv2
convertnportsparametersweep
copy
copydcard
copymaterial
copysweep
copytoclipboard
corrcoef
corrtransf
cos
coupling
cov
cp
createbeam
createcompound
createpropertydependency (deprecated)
createsphericalsurface
cross
crosscorrelation
ctranspose
currentfilename
currentscriptname
customlibrary
cwnorm
czt
D
dcht
debug
decompose (deprecated)
del
delete
deleteall
deleteattribute
deleteallbc (deprecated, see delete)
deletebc (deprecated, see delete)
deletematerial
deleteresource
deletesweep
designmode
dipolepower
dir
disabledesignkit
disconnect
dot
E
eig
emepropagate
emesweep
enabledesignkit
encryptscript
end
endl
erf
erfc
erfcinv
erfinv
eval
evalremote
exist
exit
exp
expand
expand2
exportcsvresults
exportemesweep
exportfigure
exporthtml
exportimage
exportlib
exportmaterialdb
exportnetlist
exportsweep
exportview
extractstructure
eye
F
farfield2d
farfield2dintegrate
farfield3d
farfield3dintegrate
farfieldangle
farfieldexact
farfieldexact2d
farfieldexact3d
farfieldfilter
farfieldpolar2d
farfieldpolar3d
farfieldsettings
farfieldspherical
farfieldux
farfielduy
farfieldvector2d
farfieldvector3d
feval
fft
fftk
fftw
filebasename
filedirectory
fileexists
fileexpand
fileextension
fileopendialog
filesavedialog
find
findmodes
findpeaks
findproperty
findpropertyvalue
findresonances
findstring
finite
fitlorentzpdf
fitnormpdf
fitpearson4pdf
flip
flipelement
floor
for
framerate
frequencysweep
function
G
gdsaddcircle
gdsaddpath
gdsaddpoly
gdsaddrect
gdsaddref
gdsaddtext
gdsbegincell
gdsclose
gdsendcell
gdsimport
gdsmultipoly
gdsopen
get
getactivesolver
getanalysis
getasapdata (deprecated)
getattribute
getbc (deprecated, see get)
getcelllist
getcommands
getcompositionfraction (deprecated, see get)
getcontact (deprecated, see get)
getcontour
getdata
getdgtdindex
geteigensolver
getelectric
getemeanalysis
getemesweep
getfdtdindex
getfdtdsurfaceconductivity
getfield
getglobal (deprecated)
getglobalmonitor
getglobalsource
getindex
getlayer
getlayerlist
getmagnetic
getmaterial
getmeshcontours
getmodeindex
getname
getnamed
getnamednumber
getnumber
getnumericalpermittivity
getparameter
getpath
getperiodicity
getports
getposition
getrectangle
getremotedata
getresource
getresult
getresultdata
getsetting
getsolver
getsourceangle
getsourcedirection
getsurfaceconductivity
getsweep
getsweepdata
getsweepresult
getvalue
getvariable
getview
grating
gratingangle
gratingbloch1
gratingbloch2
gratingm
gratingn
gratingordercount
gratingorders
gratingperiod1
gratingperiod2
gratingpolar
gratingprojection
gratingu1
gratingu2
gratingvector
groupscope
H
h5info
h5read
h5readattr
h5write
h5writeattr
havedata
haveproperty
haveresult
havesweepdata
havesweepresult
help
hide
hidecategory
hideproperty
histc
histogram
history
historyoff
historyon
holdoff
holdon
I
icht
if
imag
image
implantkurtosis
implantlateralscatter
implantrange
implantskewness
implantstraggle
importbinary
importbinary2
importbinaryobfuscated
importcsvlc
importdataset
importdoping (deprecated, see tecplotread)
importlib
importmaterialdb
importnetlist
importnk
importnk2
importnkobfuscated
importsparameter
importsurface
importsurface2
importtemperaturemap
inpoly
insert
insertsweep
installdesignkit
integrate
integrate2
interp
interptet
interptri
inv
invfft
iscell
isfield
ispropertyactive
isstruct
issweep
itkdbgetgeometry
itkdbgetparams
J
jsonload
jsonloads
jsonread
jsonreads
jsonsave
jsonsaves
jsonvalidate
jsonwrite
jsonwrites
K
killwizard
L
layoutmode
legend
length
library
linecross
lineintersect
linspace
listjobs
load
loadcustom
loaddata
loaddesignkit
loadelement
loadgdsfile
loadprocessfile
loadsweep
log
log10
logmessage
lognrnd
lookupappend
lookupclose
lookupopen
lookupread
lookupreadnportsparameter
lookupreadtable
lookupreadvalue
lookupwrite
lorentzpdf
lower
ls
lswmexport
lum2mat (deprecated)
M
mapfind
materialexists
matlab
matlabget
matlabload
matlabput
matlabsave
matrix
matrixdataset
max
mcfit
mczfit
mean
median
mesh
meshgrid3dx
meshgrid3dy
meshgrid3dz
meshgrid4d
meshgridx
meshgridy
message
mie3d
mie3ds12
min
mod
modeexpansion
modeoverlap
monitors (deprecated)
move
mqwgain
mqwindex
mult
mv
N
near2far
new
new2d (deprecated)
new3d (deprecated)
newmode (deprecated, see newproject)
newproject
newwizard
newwizardpage
nonorm
norm
normpdf
now
num2str
nummodes
O
ones
opensession
operatingsystem
optimizeposition
or
orbit
outeroma
overlap
P
packagedesignkit
parsebackannotation
parsewaveguidebackannotation
partitionvolume
pastefromclipboard
pastesweep
pause
pearson4pdf
permute
pinch
plot
plotxy
polar
polar2
polarimage
polyand
polyarea
polyclean
polydft
polydiff
polyfit
polygrow
polyintersect
polyor
polypieces
polystencil
polyxor
precision
print
probe
prod
propagate
protectproperty
putremotedata
pwd
python
Q
quadtet
quadtri
queryanalysisprop
queryanalysisresult
querynamed
queryuserprop
R
rand
randmatrix
randn
randnmatrix
randpearson4
randreset
rcwa
rcwasweeppropagation
read
readdata
readnportsparameterat
readstltriangles
real
rectilineardataset
redo
redraw
redrawmode
redrawoff
redrawon
refresh
reloaddesignkit
removecustom
removedesignkit
removeexpansion
removeport
removepropertydependency (deprecated)
removesweepparameter
removesweepresult
renameport
replace
replacelibrary
replacestring
reportmeshstatistics
reshape
resume
resumejobs
rm
rotateelement
round
run
runanalysis
runfinalize
runinitialize
runjobs
runoptimization
runparallel
runsetup
runstartupscripts
runstep
runsweep
runsystemcheck
runwizard
S
save
savedata
savedcard
saveelement
savegdsfile
saveprocessfile
savesweep
scorrcoef
scriptautorun
select
selectall
selectfigure
selectmode
selectpartial
set
setactivesolver
setanalysis
setbc (deprecated, see set)
setcompositionfraction (deprecated, see set)
setconnectionrouting
setcontact (deprecated, see set)
seteigensolver
setemeanalysis
setexpansion
setexpression
setfield
setglobal (deprecated)
setglobalmonitor
setglobalsource
seticon
setlayer
setmaterial
setname
setnamed
setparallel (deprecated)
setplot
setposition
setpsfoutput
setrectangle
setresource
setresult
setsetting
setsourcesignal
setsparameter
setsweep
setvalue
setview
shiftselect
shiftselectpartial
show
showdata (deprecated)
showmenubar
sign
simulation
simulationdiverged
sin
size
skewness (deprecated)
smithchart
solar
solve
sort
sortmap
sourceintensity
sourceintensity_avg
sourceintensity_pavg
sourcenorm
sourcenorm2_avg
sourcenorm2_pavg
sourcepower
sourcepower_avg
sourcepower_pavg
sources (deprecated)
spline
splitstring
sqrt
sroughness
stackdipole
stackfield
stackpurcell
stackrt
std
stepimport
stlimport
str2num
struct
structures (deprecated)
substring
sum
svd
switchtodesign
switchtolayout
system
T
tan
tdecq
tecplotread
toscript
touchstoneload
transmission
transmission_avg
transmission_pavg
transpose
try
U
undo
unfoldsymmetricdata
uninstalldesignkit
unique
uniquevertices
unselectall
unstructureddataset
unwrap
updatemodes
updateportmodes
updatesourcemode
upper
V
validate
validateall
var
vectorplot
version
versionfile
visualize
vtksave
W
waituntildone
which
wizarddata
wizardgetdata
wizardoption
wizardwidget
workspace
write
X
Y
Z
zbfexport
zbfload
zbfread
zbfwrite
zeros
Non alphanumeric script commands
!
!=
"
#
%
&
'
*
+
-
.
/
:
<
<=
=
==
>
>=
?
[]
^
|
~
\