Kamus functions

The PhoeniX script functions in the Kamus order

Keywords: Function library , Kamus

---

The Kamus Xtree:

Standard / math
	Conversion
			degree	(*)Radian -> degree
			rad	(*)Degree -> radian
			loss2im	(*)Calculate the imaginary part of the refractive index for some loss
			im2loss	(*)Calculate the loss for some imaginary refractive index (dB/cm)
			im2bendloss	(*)Calculate the bend loss for some imaginary refractive index (dB/90 deg)
			RaithDoseFactor	(*)Convert a dose factor into a datatype value
	Goniometrics
			cos	(*)cos
			sin	(*)sin
			tan	(*)tan
			acos	(*)acos
			asin	(*)asin
			atan	(*)atan
			cosh	(*)cosh
			acosh	(*)acosh
			sinh	(*)sinh
			asinh	(*)asinh
			tanh	(*)tanh
			atanh	(*)atanh
			atan2	(*)atan2
	Standard functions
			exp	(*)exp
			log10	(*)10 log
			log	(*)log(x,base=e)
			ln	(*)natural log
			abs	(*)Absolute value
			fac	(*)Factorial
			frac	(*)Fraction
			hypot	(*)Hypothenusa
			min	(*)Min
			max	(*)Max
			minimum	(*)Minimum
			maximum	(*)Maximum
			Concat	(*)Concat into an array
			mod	(*)Modulo
			round	(*)Round(x,precision=0)
			trunc	(*)Truncate(x,precision=0)
			sign	(*)Sign (-1, 0, 1)
			sqr	(*)Square
			sqrt	(*)Square root
			polynom	(*)Polynom in first argument
	Statistical functions
			sum	(*)sum
			mean	(*)mean
			median	(*)median
			quantiles	(*)quantiles
			variance	(*)variance
			stddev	(*)stddev
			shuffle	(*)random shuffle
			sample	(*)sample
	Geometrical bend functions
			bendOL2R	(*)Bend: Offset + length -> radius
			bendOL2A	(*)Bend: Offset + length -> angle
			bendRA2L	(*)Bend: Radius + angle -> length
			bendRA2O	(*)Bend: Radius + angle -> offset
			bendOA2L	(*)Bend: Offset + angle -> length
			bendOA2R	(*)Bend: Offset + angle -> radius
			bendLA2O	(*)Bend: Length + angle -> offset
			bendLA2R	(*)Bend: Length + angle -> radius
			bendLR2O	(*)Bend: Length + radius -> offset
			bendLR2A	(*)Bend: Length + radius -> angle
			bendOR2L	(*)Bend: Offset + radius -> length
			bendOR2A	(*)Bend: Offset + radius -> angle
	Special functions
			besseli	(*)Bessel-i
				besseli0	(*)i0
				besseli1	(*)i1
			besselj	(*)Bessel-j
				besselj0	(*)j0
				besselj1	(*)j1
			besselk	(*)Bessel-k
				besselk0	(*)k0
				besselk1	(*)k1
			bessely	(*)Bessel-y
				bessely0	(*)y0
				bessely1	(*)y1
			ZBesselJ	(*)BesselJ
			BesselJPrime	(*)BesselJ'
			ZBesselY	(*)BesselY
			BesselYPrime	(*)BesselY'
			Hankel1	(*)Hankel1
			Hankel1Prime	(*)Hankel1'
			Hankel2	(*)Hankel2
			Hankel2Prime	(*)Hankel2'
			AiryAi	(*)AiryAi
			AirydAi	(*)AiryAi'
			AiryBi	(*)AiryBi
			AirydBi	(*)AiryBi'
			ScaledAiryAi	(*)scaled AiryAi
			ScaledAirydAi	(*)scaled AiryAi'
			ScaledAiryBi	(*)scaled AiryBi
			ScaledAirydBi	(*)scaled AiryBi'
			erf	(*)Error function
				erfc	(*)Compl. err.function
				InvFP_1_2_approx	(*)Approx. inverse of Fermi Dirac 1/2
		Gamma functions
				gammln	(*)gammln
				gammp	(*)gammp
				gammq	(*)gammq
	Misc
			shift	(*)x<a ? 0.0 : x-a
			MySQL	(*)start SQL command
			random	(*)random number
			rseed	(*)random number seed
	Constants
			physics::e0	Permitivity (e0)
			physics::c	Speed of light (c)
			physics::h	Planck constant (h)
			physics::hr	Reduced Planck Constant (hr)
			physics::kB	Boltzmann constant (kB)
			physics::kT	Thermal Energy (kT)
			physics::me	Free electron mass (me)
			physics::mn	Free neutron mass (mn)
			physics::mp	Free proton mass (mp)
			physics::NA	Avogadro number (NA)
			physics::PI	PI
			physics::q	Elementary charge (q)
			physics::eV	Electron Volt (eV)
			physics::Ry	Ryberg energy (Ry)
			physics::u0	Permeability (u0)
			physics::PHI	PHI
Numerical library
	Matrix processing
			num::fillMatrix	Fill a matrix with some data
			num::LinSolve	Solve Ax=b with matrix 'A' and vector 'b' given
			num::Eigs	Get eigenvalues and eigenvectors of matrix 'A'
			num::SVD	Singular value decomposition
	Statistics
			num::Rcall	Call R using a file
Result processing
	Data
			res::Clear	Clear result database
			res::QueryCount	How much results are available
			res::findName	Find by name
			res::findUnit	Find by unit
			res::reference	Select via result path
			res::SetAxisUnit	Set axis unit
			res::SetVariableUnit	Set result unit
			res::SetAxisValue	Set axis value
			res::SetAxis	Set axis values
			res::GetAxisValue	Get axis value
			res::OpenGroup	Create new group
			res::CloseGroup	Close current group
			res::Store	Add item
			res::RegressionAnalysis	Perform regression analysis
			res::Convert	Convert data into double
			res::MultWithComplex	Multiply the result with a complex value
			res::GetValue	Get value at some point
	File
			res::SaveItem	Save a result/variable to a file
			res::ReadItem	Read a result/variable from a file
			res::SaveDB	Save result database to a result file
			res::ReadDB	Read result file into the result database
			res::Import	Import data from file
			res::Export	Export data to file
			res::SetAccuracy	Set print mode as C++ printf string
Graph handling
		res::findName	Find result by name
		res::findUnit	Find result by unit
		res::reference	Select via result path
		res::plotCreate	Create a new graph
		res::plotGraph	Plot current graph
		res::plotClose	End a graph
		res::plotCloseAll	Close all graphs
	Add curves as...
			res::plotDataSquareContour	2D contour
			res::plotDataSquareWire	2D wire
			res::plotDataSquareIntensity	2D intensity
			res::plotDataCubeWire	3D wire
			res::plotDataCubeIntensity	3D intensity
	Annotate plot with...
			res::plotLine	Line or plane depending on Cube / Square plot
	SPC graphs via R
			res::R_Open	Create a R-SPC plot
			res::R_Show	Show the plot
			res::R_setPlotType	Set global plottype
			res::R_setPlotFeature	Sets extra features for the lattice plot
			res::R_setLevelPlotLevels	How many plot levels
			res::R_setLegend	Set legend
			res::R_setXLabel	Set X-axis label
			res::R_setYLabel	Set Y-axis label
			res::R_setTitle	Set Plot title
			res::R_setType	Set type information
			res::R_setShowStats	Show statistics
			res::R_setCenter	Define the center value
			res::R_setLimits	Set limit values of the data
			res::R_setTarget	Set target values of the data
			res::R_setLayout	Set layout of the plot
			res::R_setPanel	Set panel properties
			res::R_setPrePanel	Set prepanel properties
			res::R_setStrip	Set strip properties
			res::R_setAxis	Set axis info
			res::R_setStack	Set stack
			res::R_setExclude	Exlucde data
			res::R_setKey	Set key info
			res::R_setScales	Set scales
			res::R_setSubSet	Define subset
			res::R_setColorKey	Use color key
			res::R_setAspect	set Aspect
			res::R_DataSetNA	Set NA
		Data properties
				res::R_DataOpen	Open a data file
				res::R_DataMode	Specify data columns
				res::R_DataResponse	Define a respons variable
				res::R_DataGroup	Define a grouping variable
				res::R_DataIndependent	Define an independent variable
				res::R_DataConditioning	Define a conditioning variable
				res::R_dumpDataFile	Dump data to file
Output
		dsp::clearInfoWin	Clear info window
		dsp::saveInfoWin	Save info window to file
		dsp::statbar	Output text to statusbar
		dsp::message	Output text to popup window
		dsp::TextAttr	Set text attributes like bold
	Progress window
			sys::PctInit	Open progress window
			sys::PctExit	Close progress window
			sys::PctSet	Set progress
		Advanced options
				sys::PctSetRange	Define the progress range
				sys::PctPushRange	Increase the progress-stack
				sys::PctPopRange	Decrease the progress-stack
				sys::PctSetText	Set text below progress
				sys::PctSetTitle	Set title of progress window
	Table
			dsp::tableOpen	Open
			dsp::tableClose	Close
			dsp::Row	Start new row
			dsp::Cell	Write cell
				dsp::CellOpen	Start cell
				dsp::CellClose	End cell
			dsp::Hdr	Write header cell
				dsp::HdrOpen	Start header cell
				dsp::HdrClose	End header cell
		dsp::Header	Generate a header
		dsp::Link	Embed a link in the output
		dsp::Line	Print a line in the output
		dsp::Button	Embed a button in the output
		dsp::Anchor	Embed an anchor in the output, can be used with dsp::Link()
	Menu in HTML
			dsp::MenuBarOpen	Open a horizontal menubar
			dsp::MenuBarClose	Close the menubar
			dsp::MenuSubOpen	Open the menu dropdown
			dsp::MenuSubClose	Close the menu dropdown
			dsp::MenuItem	Menu item
			dsp::MenuSubMenu	Create a submenu
	XML support
			dsp::xmlOpen	Open a XML tag
			dsp::xmlClose	Close last XML tag
Report
		mask::Report	Generate a report
		sim::ReportOption	Set option for a report
		mask::Region	Define a region
		sim::Info	Add info to a report
		sim::Arrow	Add arrow to a report
		sim::BezierArrow	Add a 'bezier' arrow to a report
		mask::DrawLine	Add line(s) to a report
		sim::Animate	Create an animation
Simulation
		sim::general	General options
		sim::clearCS	Clear structure
		sim::showCS	Show structure
	Process solver
		Material
			Wafer Handling
					sim::GetWafer	Get wafer
					sim::SetStructure	Set structure
					sim::BondWafer	Bond wafer
			Deposit
					sim::DirectionalDeposit	Directional deposit step
					sim::IsotropicDeposit	Isotropic deposit step
			Remove
					sim::Etch	Etching step
					sim::CMP	CMP
					sim::RemoveMaterial	Remove material
					sim::LiftOff	LiftOff
					sim::DriesoDoe	Get equipment settings(www.drieso.org)
				sim::SetResponse	Set Etch Properties
					sim::AddMaterial	Display settings
				sim::GetResponse	Get Etch Properties
			Advanced
					sim::ForceNextEtch	Force next etch step
		Mask handling
				sim::SetMask	Set a mask
				sim::EnableMask	Enable mask
				sim::DisableMask	Disable the mask
		Control
				sim::SetProcessOptions	Set options
				sim::StartProcessSimulation	Start
				sim::ClearStructure	Clear structure
				sim::GetCalcWindow	Get calculation window
				sim::GetHolesInSlice	Get Holes in Slice
				sim::AddToGraph	Add view to results
				sim::saveToCS	Save as cross-section definition
	Optics propagator
		option_display
			sim::propagate	Start 2D propagation simulation
			sim::propagate3D	Start 3D propagation simulation
		Finite Difference
				sim::bpm	Start BPM
				sim::fdtd	Start FDTD
		Mode based
				sim::bep	Start a BEP
				sim::quep	Start a QUEP
	Optics cross section
			sim::ScriptAsSideview	Use script as sideview type to handle FieldDesigner files in OptoDesigner
		Mode 1D
				sim::mode1dAtX	Mode(s) at some X position
				sim::mode1dAtY	Mode(s) at some Y position
				sim::mode_multilayer	Modes of scripted multilayer
				sim::mode1d	Mode(s) using effective index method
				sim::option_mode1d	Options
				sim::Gauss1D	Define a 1D Gaussian field
		Mode 2D
				sim::mode2d	Mode solver
				sim::stress	Stress solver
				sim::static_electric_field	Static Electric Field Solver
				sim::Temperature2D	Temperature Solver
				sim::option_mode2d	Options
		Field processing
				sim::postProcess	Standard post processing
				sim::GaussFit	Gauss fit
				sim::Overlap	Perform overlap calculation
				sim::Gauss	Define a Gaussian field distribution
				sim::PowerInRegion	Calculate the power in a given region
				sim::Perturbation	Calculate the effective refractive index change
				sim::ModeAnalysis	Calculate the polarization of a field
		Material
				sim::AddMaterial	Display settings
		Active Material model
				mat::addIon	Add ion
					mat::setIonConcentration	Set ion concentration
					mat::addMultiplet	Add multiplet
					mat::addStarkLevel	Add starklevel
					mat::setFluorescentLifetime	Set fluorescentlifetime
					mat::setNonRadiativeFraction	Set non-radiative fraction
				mat::addQuadraticProcess	Add quadraticprocess
				mat::setBranchingRatio	Set branching ratio
				mat::addPumpProcess	Add pumpprocess
				mat::addLaserProcess	Add signalprocess
				mat::CalcTemporalResponse	Temporal response
				mat::Amplifier	Amplifier response
		Semiconductor Amplifier
				sim::SOA	Calculate Soa steady-state response
		Coupled Mode Theory
				sim::CMT_Clear	Clear the CMT structure
				sim::CMT_AddStraightGuide	Add straight waveguide to CMT
				sim::CMT_AddBendGuide	Add bent waveguide to CMT
				sim::CMT_AddField	Add mode field to CMT
				sim::CMT_Calculate	Perform CMT calculations
Mask element
	Set element properties
			mask::RangeElement	Set T-range
			mask::GridElement	Grid element
	Get element properties
			mask::docElement	Document element
			mask::getRadius	Get radius of curvature at 't'
			mask::getWidth	Get element width at 't'
			mask::getStretching	Get local stretching at 't'
			mask::getPathLength	Get integrated path length 'o..t'
			mask::getOpticalPathLength	Get integrated optical path length 'o..t'
			mask::getVector	Get vector property at 't'
			mask::queryElementHasPort	Has element a port?
			mask::queryElementName	Get script name
			mask::findPortElement	Find elements connected to a port
			mask::saveCurve	Save a curve to file
	Element versus netlist
			mask::queryElementPorts	Query element (set) portnames?
			mask::querySubElements	Query sub elements
			mask::getDeltaVector	Get relative distance between elements
			mask::getCurveDistance	Query the minimum distance between two curves at (t,w) pairs
			mask::getElementDistance	Query the minimum distance between two element boundaries
			mask::delElement	Delete an element
			mask::UseElement	Use a specific element, so append to the 'use' list
			mask::UseAllElement	Use all elements, so reset the 'use' list
	Geometric calculations
			mask::calcCrossing	Calculate crossing point between straight lines
			mask::calcCurveCrossing	Calculate crossing point between curves
			mask::calcCircle	Convert 3 points into circle
Cross section
		mask::CScreate	Create
			mask::CSattr	Set specific attributes
		mask::CSadd	Add an effective material for 2D simulation
		mask::CSstore	Add a cross-section for 3D simulation
		mask::AddGrid	Specify a discretisation and mask layer
		mask::AddGridBoolean	Specify a discretisation and mask layer for CS boolean operations
		mask::CSBoolean	Apply a boolean operation on CS level
		mask::CSget	Get the current cross section
		mask::CSselect	Select a cross-section
		mask::Slicer	Send a slice to FlowDesigner
		mask::showCSinfo	Print cross-section info
Design rule checking
	Cross section level tests
			drc::csMinimumWidth	DRC check minimum logical width
			drc::csMaximumWidth	DRC check maximum logical width
			drc::csMinimumRadius	DRC check minimum logical radius
			drc::csMaximumRadius	DRC check maximum logical radius
	Element tests
			drc::Fail	Report element for DRC reports
			drc::PortAngle	DRC test on port angle to be a value or set of values
			drc::PortMinimumX	DRC test on port minumum X-coordinate
			drc::PortMinimumY	DRC test on port minumum Y-coordinate
			drc::PortMaximumX	DRC test on port maxumum X-coordinate
			drc::PortMaximumY	DRC test on port maxumum Y-coordinate
	DRC reporting
			drc::hasFailure	Any DRC failure to report?
			drc::ViewerReport	Show DRC output in the viewer
			drc::PopupReport	Show DRC output in the popup window
			drc::TextReport	Write DRC report to text file
			drc::HtmlReport	Write DRC report to html file
Mask export
		mask::AddLayer	Define mask layer
		mask::view	Screen
		mask::gdsii	GDS-II (Stream format)
			mask::Raith	Export to Raith GDS
		mask::cif	CIF (Caltech)
		mask::msk	MSK (IntelliMask)
		mask::clewin	CleWin export, DLL use only
		mask::ExportFileCache	Export to filecache
		mask::netlist	PhoeniX Netlist
		mask::clearTV	Clear topview structure
		mask::ExportViewArea	Export a part of the current view
		mask::configExport	Configure detailed export settings
		mask::config	Fine tuning of netlist expansion
		mask::libMask_layer	Specify the libMask GDS layer
		mask::BooleanLayer	Define a layer or cross-section for design-boolean processing
		mask::BooleanTarget	Define the output for design-boolean processing
Mask import
		mask::clearFiles	Clear internal GDS/CIF file cache
		mask::loadFile	Load GDS/CIF file for use in elements
		mask::cacheSaveFile	Save cache file into GDS/CIF
		mask::printFileInfo	Show some key info of loaded masks
		mask::CheckFile	Check maskfile load state
		mask::ExpandMask	Expand / flatten a mask file
		mask::ClipMask	Clip (and flatten) a mask file
	Boolean mask operations
			+	mask::LayerAND
			mask::LayerOR	Perform the boolean "or" on the layers
			mask::LayerXOR	Perform the boolean "xor" on the layers
			mask::LayerBoolean	Perform a general boolean function on the layers
			mask::LayerUnique	Perform the boolean "unique" on a layer
			mask::LayerArea	Calculate the boolean "sum of polygon" area on a layer
	Mask file cursor
			mask::getCursor	Get a mask-file cursor through move through the data
			mask::moveCursor	Move a mask-file cursor through the definition tree
			mask::queryCursor	Get info about a mask element below the cursor
			mask::queryProperties	Get some properties about the shape below the cursor
Netlist tuning
		mask::configPortQueuing	Port queueing
		mask::threadMatchPortElement	Port / element match
		mask::threadFindLocatedPorts	Search ports which are known
		mask::threadUsePortsForElements	Use known port to set elements
		mask::threadPorts	Run through the ports in parallel
Database
		coredb::setScope	Set batch/wafer scope
		coredb::getValue	Get a value
		coredb::getState	Get the state of a batch step
		coredb::queryXY	Query data as XY matrix
		coredb::queryID	Query the ID of an element
		coredb::queryName	Query the name of an element
		coredb::query	Query an element on a property
		coredb::setViewerBackgroundImage	Set an image as the viewer background
		coredb::deleteViewerBackgroundImage	Delete the viewer background image
		coredb::dbEditCell	Edit some property
		coredb::wafer_action3	Display wafer identification cell
		coredb::generalLog_action3	Display general log status
Misc
		sys::include	Set include directory
		sys::SysInfo	Query some info
		sys::sysGetLevel	Get script run level
		sys::sysSetLevel	Set script run level
		sys::system	Run a command via the command line interface (cli/batch)
	Time Operations
			sys::delay	Wait a while
			sys::DateTime	Query some time
			sys::time2amount	Covert time to amount of minutes / seconds / ...
			sys::hour	Amount of hours to time equivalent
			sys::minute	Amount of minutes to time equivalent
			sys::second	Amount of minutes to time equivalent
			sys::day	Amount of days to time equivalent
			sys::month	Amount of months to time equivalent
			sys::year	Amount of years to time equivalent
	File and directory handling
			sys::fscan	Scan file into variable via regex
			sys::file_mkdir	Make new directory
			sys::file_dir_exist	Test if directory exists
			sys::file_rmdir	Remove directory
			sys::file_delete	Delete a file
			sys::file_copy	Copy a file
			sys::file_rename	Rename a file
			sys::file_exist	Test for existance of file
			sys::file_length	Return the length of a file
			sys::file_compare	Compare two files
	File menu
			sys::fileNew	New
			sys::fileOpen	Open
			sys::fileSave	Save
			sys::fileSaveAs	SaveAs
			sys::fileExit	Exit
	Variable attributes
			sys::varValueSet	Set the value of the var
			sys::varAttrSet	Set an attribute
			sys::varAttrFind	Test attribute
			sys::varAttrFindValue	Get attribute value
			sys::varAttrCount	How many attributes
			sys::varAttrName	Get the n'th attribute name
			sys::varAttrValue	Get the n'th attribute value
			sys::varAttrStrip	Strip the var of it attributes
			sys::varQueryEmpty	Is the variable empty?
	String handling
			sys::scan	Scan string into variable via regex
			sys::leftString	Compare the strings and (if matching) return the substring
			sys::rightString	Compare the strings
			sys::inString	Search the string (case insensitive) and (if available) return true
			sys::midString	Get part of the string
			sys::replaceString	Replace text in a string
			sys::strLower	Convert string to lower case
			sys::strUpper	Convert string to upper case
			sys::stringLength	Length of the string
			sys::truncLeft	Get the left n characters of the string
			sys::truncRight	Get the right n characters of the string
			sys::stringAsFile	Convert the string into a file/path name with @ replacement
			sys::toHTML	Convert special characters to HTML characters, e.g. ">" becomes "&gt"
	Document generation
			sys::showMaterialTable	Export material table
			sys::showFunctionTable	Export function table
			mask::showElementTable	Export element table
	Ini-file
			sys::IniFileGet	Get a value from the ini file
			sys::iniBool	Get/set a boolean value from the ini file (cache)
			sys::iniInt	Get/set a integer value from the ini file (cache)
			sys::iniString	Get/set a string value from the ini file (cache)
			sys::iniColor	Get/set a color value from the ini file (cache)
	Script
			sys::ParserInfo	Get (or initialize) a property of a class/material/layout/function
			sys::DynamicCall	Dynamically call a script function or layout
			sys::sptLocation	Return the location in the script file
Sub-system
	Netlist definition
			pda::makeNetlist	Create a PhoeniX netlist
			pda::setInputNode	Set the input node of the netlist
			pda::setOutputNode	Set the output node of the netlist
			pda::createNode	Create a node in the netlist
			pda::findNode	Search for a node netlist
			pda::saveAsMaskEngineer	Save netlist to MaskEngineer's layout framework
			pda::saveAsOptoDesigner	Save netlist to OptoDesigner's topview framework
		File IO
				pda::saveAtPdaflow	Save generated '@pdaflow' include to file
				pda::saveAsXml	Save netlist to XML
				pda::readAsXml	Read netlist from XML
	Foundry
			pda::listFoundry	List the available foundries
			pda::makeFoundry	Use a foundry
			pda::listFlows	List the process flows
			pda::createFlow	Use a flow
			pda::createFlowCrossSection	Use a flow to make a cross-section
			pda::listCrossSection	List the cross-sections
			pda::createCrossSection	Use a cross-section
			pda::setCrossSection	Set active cross-section
			pda::setFlow	Set active flow
	Properties
			pda::listValues	What values/properties does this have
			pda::addValue	Add a value/property
			pda::setValue	Set a value/property
	Building blocks
			pda::listBB	List available building blocks
			pda::createBB	Define a building block
			pda::addBB	Add the building block to the netlist
			pda::addNode	Add a node to a building block
			pda::getNode	Find a node of a building block
			pda::makeOpticalSignal	Create a optical signal
			pda::getOpticalSignalRange	Specify wavelenght range
			pda::makePortMode	Define the port-mode combination
			pda::createSpectrum	Create a spectrum
			pda::addFrequency	Define spectral respons for a wavelength
			pda::addSpectrum	Add spectral response to optical signal

Other topics

Sep 10, 2010

Kamus functions