Glossary of EM.Cube's Python Functions

From Emagtech Wiki
Revision as of 16:46, 10 April 2017 by Kazem Sabet (Talk | contribs)

Jump to: navigation, search

Contents

Standard Python Functions

Syntax Type Description Notes
abs(x) Std. Python function Absolute value function x if x>0, -x if x<0
pow(x,y) Std. Python function Power function x**y
sqrt(x) Std. Python function Square root function pow(x,0.5)
exp(x) Std. Python function Exponential function pow(e,x)
log(x) Std. Python function Natural logarithm function -
log10(x) Std. Python function Base 10 logarithm function ln(x)/ln(10)
factorial(x) Std. Python function Factorial for integer values of x: n! = n(n-1)(n-2)...3.2.1
max(x,y) Std. Python function Maximum of x and y -
min(x,y) Std. Python function Minimum of x and y -
sin(x) Std. Python function Sine function -
cos(x) Std. Python function Cosine function -
tan(x) Std. Python function Tangent function -
asin(x) Std. Python function Inverse sine function -
acos(x) Std. Python function Inverse cosine function -
atan(x) Std. Python function Inverse tangent function -
atan2(x,y) Std. Python function Inverse tangent function -
sinh(x) Std. Python function Hyperbolic sine function -
cosh(x) Std. Python function Hyperbolic cosine function -
tanh(x) Std. Python function Hyperbolic tangent function -
np.floor(x) Std. Python function Floor function nearest integer <= x
np.arcsinh(x) Std. Python function Inverse hyperbolic sine function -
np.arccosh(x) Std. Python function Inverse hyperbolic cosine function -
np.arctanh(x) Std. Python function Inverse hyperbolic tangent function -

Advanced Mathematical Python Functions

Syntax Type Description Notes
sp.sici(x) Std. Python function Sine and cosine integral functions see Trigonometric Integrals on Wikipedia.
sp.fresnel(x) Std. Python function Sine and cosine Fresnel integral functions see Fresnel Integrals on Wikipedia.
sp.ellipe(x) Std. Python function Elliptic function of the first kind see Elliptic Integrals on Wikipedia.
sp.ellipk(x) Std. Python function Elliptic function of the second kind see Elliptic Integrals on Wikipedia.
sp.expi(x) Std. Python function Exponential integral function see Exponential Integrals on Wikipedia.
sp.expn(n,x) Std. Python function Generalized exponential integral function of order n see Exponential Integrals on Wikipedia.
sp.erf(x) Std. Python function Error function see Error Function on Wikipedia.
sp.erfc(x) Std. Python function Complementary error function see Error Function on Wikipedia.
sp.gamma(x) Std. Python function Gamma function see Gamma Function on Wikipedia.
sp.airy(x) Std. Python function Airy function of the first (Ai) and second (Bi) kind and their derivatives see Airy Functions on Wikipedia.
sp.j0(x) Std. Python function Bessel function of the first kind and order 0 see Bessel Functions on Wikipedia.
sp.j1(x) Std. Python function Bessel function of the first kind and order 1 see Bessel Functions on Wikipedia.
sp.jv(n,x) Std. Python function Bessel function of the first kind and order n see Bessel Functions on Wikipedia.
sp.y0(x) Std. Python function Bessel function of the second kind and order 0 see Bessel Functions on Wikipedia.
sp.y1(x) Std. Python function Bessel function of the second kind and order 1 see Bessel Functions on Wikipedia.
sp.yv(n,x) Std. Python function Bessel function of the second kind and order n see Bessel Functions on Wikipedia.
sp.i0(x) Std. Python function Modified Bessel function of the first kind and order 0 see Bessel Functions on Wikipedia.
sp.i1(x) Std. Python function Modified Bessel function of the first kind and order 1 see Bessel Functions on Wikipedia.
sp.iv(n,x) Std. Python function Modified Bessel function of the first kind and order n see Bessel Functions on Wikipedia.
sp.k0(x) Std. Python function Modified Bessel function of the second kind and order 0 see Bessel Functions on Wikipedia.
sp.k1(x) Std. Python function Modified Bessel function of the second kind and order 1 see Bessel Functions on Wikipedia.
sp.kv(n,x) Std. Python function Modified Bessel function of the second kind and order n see Bessel Functions on Wikipedia.
sp.sph_jn(n,x) Std. Python function Spherical Bessel function of the first kind and order n see Bessel Functions on Wikipedia.
sp.sph_yn(n,x) Std. Python function Spherical Bessel function of the second kind and order n see Bessel Functions on Wikipedia.
sp.sph_in(n,x) Std. Python function Modified spherical Bessel function of the first kind and order n see Bessel Functions on Wikipedia.
sp.sph_kn(n,x) Std. Python function Modified spherical Bessel function of the second kind and order n see Bessel Functions on Wikipedia.
sp.lpn(n,x) Std. Python function Legendre function of the first kind and order n see Legendre Polynomials on Wikipedia.
sp.lqn(n,x) Std. Python function Legendre function of the second kind and order n see Legendre Polynomials on Wikipedia.
sp.lpmn(m,n,x) Std. Python function Associated Legendre function of the first kind and order n see Legendre Polynomials on Wikipedia.
sp.lqmn(m,n,x) Std. Python function Associated Legendre function of the second kind and order n see Legendre Polynomials on Wikipedia.
sp.eval_chebyt(n,x) Std. Python function Chebyshev polynomial of the first kind and order n see Chebyshev Polynomials on Wikipedia.
sp.eval_chebyu(n,x) Std. Python function Chebyshev polynomial of the second kind and order n see Chebyshev Polynomials on Wikipedia.
sp.eval_legendre(n,x) Std. Python function Legendre polynomial of order n see Legendre Polynomials on Wikipedia.
sp.eval_laguerre(n,x) Std. Python function Laguerre polynomial of order n see Laguerre Polynomials on Wikipedia.
sp.eval_hermite(n,x) Std. Python function Hermite polynomial of order n see Hermite Polynomials on Wikipedia.
sp.mathieu_cem(n,q,x) Std. Python function Even Mathieu function of order n and its derivative see Mathieu Functions on Wikipedia.
sp.mathieu_sem(n,q,x) Std. Python function Odd Mathieu function of order n and its derivative see Mathieu Functions on Wikipedia.

EM.Cube's Miscellaneous Python Functions

Syntax Type Description Notes
rect(x) EMAG Python function Rectangle function 1 if |x|≤0.5, 0 elsewhere
tri(x) EMAG Python function Triangle function 1-x|≤1, 0 elsewhere
spline2(x) EMAG Python function Quadratic spline function -
spline3(x) EMAG Python function Cubic spline function -
step(x) EMAG Python function Step function 1 if x>0, 0 if x<0
sgn(x) Std. Python function Sign function 1 if x>0, -1 if x<0
ramp(x) EMAG Python function Ramp function x if x>0, 0 if x<0
sqr_wave(x) EMAG Python function Square wave function -
tri_wave(x) EMAG Python function Triangle wave function -
sawtooth(x) EMAG Python function Sawtooth wave function -
sinc(x) EMAG Python function Sinc function sin(pi*x)/(pi*x)
gauss(x,mu,sigma) EMAG Python function Gaussian function of mean mu and standard deviation sigma exp(-0.5*((x-mu)/sigma)**2)/sigma/sqrt(2*pi)
msin(x,r) EMAG Python function super-quadratic sine function of order r -
mcos(x,r) EMAG Python function super-quadratic cosine function of order r -
sigmoid(x,a) EMAG Python function Sigmoid function of slope a 2/(1 + exp(-a*x)) - 1
bh_window(x,T) EMAG Python function Blackman-Harris window function -
bh_step(x,T) EMAG Python function Blackman-Harris step function -
rand(x,y) EMAG Python function Random function -
rosen(x,y,a,b) EMAG Python function Rosenbrock function (a-x)**2 + b*(y-x**2)**2
mean(x,y) EMAG Python function arithmetic mean of x and y 0.5*(x+y)
geo(x,y) EMAG Python function geometric mean of x and y sqrt(x*y)
harm(x,y) EMAG Python function harmonic mean of x and y 2/(1/x+1/y)
sqr2(x,y) EMAG Python function sum of squares of x and y x**2 + y**2
sqr3(x,y,z) EMAG Python function sum of squares of x and y and z x**2 + y**2 + z**3
sqrt2(x,y) EMAG Python function radius of 2D point (x,y) sqrt(x**2 + y**2)
sqrt3(x,y,z) EMAG Python function radius of 3D point (x,y,z) sqrt(x**2 + y**2 + z**3)

EM.Cube's Design Python Functions

Syntax Type Description Notes
microstrip_design(z0,er) EMAG Python function Returns the width-to-height ratio of a microstrip transmission line z0: characteristic impedance in Ohms, er: substrate permittivity
microstrip_z0(w,h,er) EMAG Python function Returns the characteristic impedance of a microstrip transmission line in Ohms w: microstrip width, h: substrate height, er: substrate permittivity
microstrip_eps_eff(w,h,er) EMAG Python function Returns the effective permittivity of a microstrip transmission line w: microstrip width, h: substrate height, er: substrate permittivity
microstrip_lambda_g(w,h,er,freq_hertz) EMAG Python function Returns the guide wavelength of a microstrip transmission line in meters w: microstrip width, h: substrate height, er: substrate permittivity, freq_hertz: frequency in Hz
cpw_design_w(z0,s,h,er) EMAG Python function Returns the slot width of a coplanar waveguide (CPW) transmission line z0: characteristic impedance in Ohms, s: center strip width (or slot spacing), h: substrate height, er: substrate permittivity
cpw_design_s(z0,w,h,er) EMAG Python function Returns the center strip width (or slot spacing) of a coplanar waveguide (CPW) transmission line z0: characteristic impedance in Ohms, w: slot width, h: substrate height, er: substrate permittivity
coaxial_design(z0,er) EMAG Python function Returns the ratio of radius of the outer conductor to the radius of the inner conductor of a coaxial transmission line z0: characteristic impedance in Ohms, er: core permittivity
waveguide_design(er,freq_hertz) EMAG Python function Returns the minimum larger dimension in meter of the cross section of a hollow rectangular waveguide above cutoff er: filling permittivity, freq_hertz: frequency in Hz
horn_design_a(D0_dB,a_lambda,b_lambda) EMAG Python function Returns the wavelength-normalized larger dimension of the aperture of an optimal pyramidal horn antenna D0_dB: directivity d, a_lambda: wavelength-normalized larger dimension of the feed waveguide, b_lambda: wavelength-normalized smaller dimension of the feed waveguide
horn_design_b(D0_dB,a_lambda,b_lambda) EMAG Python function Returns the wavelength-normalized smaller dimension of the aperture of an optimal pyramidal horn antenna D0_dB: directivity d, a_lambda: wavelength-normalized larger dimension of the feed waveguide, b_lambda: wavelength-normalized smaller dimension of the feed waveguide
horn_design_l(D0_dB,a_lambda,b_lambda) EMAG Python function Returns the wavelength-normalized length of an optimal pyramidal horn antenna D0_dB: directivity d, a_lambda: wavelength-normalized larger dimension of the feed waveguide, b_lambda: wavelength-normalized smaller dimension of the feed waveguide

EM.Cube's Python Functions for Geometric Object Creation

box

SYNTAX: box(string label, any x0, any y0, any z0, any base_x, any base_y, any height[, any cap_top, any cap_bottom])

EXAMPLE: box("Box_1",0,0,0,50,50,100)

DESCRIPTION: Draws a box object in the project workspace under the currently activated material group node, or modifies the box named 'label' if it already exists.

cylinder

SYNTAX: cylinder(string label, any x0, any y0, any z0, any radius, any height[, any start_angle, any end_angle, any cap_top, any cap_bottom])

EXAMPLE: cylinder("Cylinder_1",0,0,0,10,100)

DESCRIPTION: Draws a cylinder object in the project workspace under the currently activated material group node, or modifies the cylinder named 'label' if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the cylinder's azimuth axis.

cone

SYNTAX: cone(string label, any x0, any y0, any z0, any base_radius, any height[, any top_radius, any start_angle, any end_angle, any cap_top, any cap_bottom])

EXAMPLE: cone("Cone_1",0,0,0,30,40,20,0,180)

DESCRIPTION: Draws a cone object in the project workspace under the currently activated material group node, or modifies the cone named 'label' if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the cone's azimuth axis.

pyramid

SYNTAX: pyramid(string label, any x0, any y0, any z0, any base_x, any base_y, any height)

EXAMPLE: pyramid("Pyramid_1",0,0,0,10,10,100)

DESCRIPTION: Draws a pyramid object in the project workspace under the currently activated material group node, or modifies the pyramid named 'label' if it already exists.

sphere

SYNTAX: sphere(string label, any x0, any y0, any z0, any radius[, any start_angle, any end_angle])

EXAMPLE: sphere("Sphere_1",0,0,0,10,0,180)

DESCRIPTION: Draws a sphere object in the project workspace under the currently activated Material Group node, or modifies the sphere named 'label' if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the sphere's azimuth axis.

ellipsoid

SYNTAX: ellipsoid(string label, any x0, any y0, any z0, any radius_x, any radius_y, any radius_z[, any start_angle, any end_angle])

EXAMPLE: ellipsoid("Ellipsoid_1",0,0,0,100,100,50,0,360)

DESCRIPTION: Draws an ellipsoid object in the project workspace under the currently activated material group node, or modifies the ellipsoid named 'label' if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the ellipsoid's azimuth axis.

torus

SYNTAX: torus(string label, any x0, any y0, any z0, any radius_major, any radius_minor[, any start_angle, any end_angle])

EXAMPLE: torus("Torus_1",0,0,0,50,20)

DESCRIPTION: Draws an torus object in the project workspace under the currently activated material group node, or modifies the torus named 'label' if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the torus's azimuth axis.

rect_strip

SYNTAX: rect_strip(string label, any x0, any y0, any z0, any side_x, any side_y)

EXAMPLE: rect_strip("my_rectangle",0,0,0,50,20)

DESCRIPTION: Draws a rectangle Strip object in the project workspace under the currently activated material group node, or modifies the rectangle strip object named 'label' if it already exists.

circ_strip

SYNTAX: circ_strip(string label, any x0, any y0, any z0, any inner_radius, any outer_radius[, any start_angle, any end_angle])

EXAMPLE: circ_strip("cs_1",0,0,0,50,0)

DESCRIPTION: Draws a circle strip object in the project workspace under the currently activated material group node, or modifies the circle strip object named 'label' if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the circle strip's azimuth axis.

radial_strip

SYNTAX: radial_strip(string label, any x0, any y0, any z0, any radius, any base_length, any angle)

EXAMPLE: radial_strip("Radial_1",0,0,0,50,0,90)

DESCRIPTION: Draws a radial strip object in the project workspace under the currently activated material group node, or modifies the radial strip object named 'label' if it already exists.

ellipse_strip

SYNTAX: ellipse_strip(string label, any x0, any y0, any z0, any radius_x, any radius_y[, any start_angle, any end_angle])

EXAMPLE: ellipse_strip("es_1",0,0,0,50,0)

DESCRIPTION: Draws a ellipse strip object in the project workspace under the currently activated material group node, or modifies the ellipse strip object named 'label' if it already exists. The arguments start_angle and end_angle are in degrees and specify a sweep about the ellipse strip's azimuth axis.

triangle_strip

SYNTAX: triangle_strip(string label, any x0, any y0, any z0, any side1, any side2, any angle)

EXAMPLE: triangle_strip("ts_1",0,0,0,50,100,90)

DESCRIPTION: Draws a triangle strip object in the project workspace under the currently activated material group node, or modifies the triangle strip object named 'label' if it already exists.

taper_strip

SYNTAX: taper_strip(string label, any x0, any y0, any z0, any base_width, any top_width, any length, any is_expo)

EXAMPLE: taper_strip("ts_1",0,0,0,50,100,80,1)

DESCRIPTION: Draws a taper strip object in the project workspace under the currently activated material group node, or modifies the taper strip object named 'label' if it already exists. If the Boolean parameters "is_expo" is 1, an exponential taper will be drawn.

polygon_reg

SYNTAX: polygon_reg(string label, any x0, any y0, any z0, any radius, any n_sides)

EXAMPLE: polygon_reg("ts_1",0,0,0,50,100,80,1)

DESCRIPTION: Draws a regular polygon object in the project workspace under the currently activated material group node, or modifies the regular polygon object named 'label' if it already exists.

spiral_strip

SYNTAX: spiral_strip(string label, any x0, any y0, any z0, any width, any radius_inner, any radius_outer, any nturns, any spiral_dir, any is_dual)

EXAMPLE: spiral_strip("Spiral _1",0,0,0,10,50,5,0,0)

DESCRIPTION: Draws a spiral strip object in the project workspace under the currently activated material group node, or modifies the spiral strip named 'label' if it already exists. If the Boolean parameter "spiral_dir" is 1, the spiral curve will be drawn counter-clockwise. If the Boolean parameter "is_dual" is 1, a dual-arm spiral curve will be drawn.

polystrip

SYNTAX: polystrip(string label, 3x1 Python tuple p0, 3x1 Python tuple p1, ... 3x1 Python tuple pn)

EXAMPLE: polystrip("ps_1",(0,0,0),(1,0,0),(1,0,0))

DESCRIPTION: Creates or modifies a Polystrip object in the project workspace. Each point is represented with a Python tuple type. The poly_strip function is 'self-closing' -- there is no need to supply the first point again at the end of the point list.

nurbs_strip

SYNTAX: nurbs_strip(string label, 3x1 Python tuple p0, 3x1 Python tuple p1, ... 3x1 Python tuple pn)

EXAMPLE: nurbs_strip("ns_1",(0,0,0),(1,0,0),(1,0,0))

DESCRIPTION: Creates or modifies a NURBS Strip object in the project workspace. Each point is represented with a Python tuple type. The nurbs_strip function is 'self-closing' -- there is no need to supply the first point again at the end of the point list.

line

SYNTAX: line(string label, any x0, any y0, any z0, any length[, any dir])

EXAMPLE: line("my_line",0,0,0,100,"x")

DESCRIPTION: Draws a Line object in the project workspace under the currently activated material group node, or modifies the line named 'label' if it already exists. Without the argument "dir", a vertical line is drawn by default.

circle

SYNTAX: circle(string label, any x0, any y0, any z0, any radius, any start_angle, any end_angle)

EXAMPLE: circle("pyramid_1",0,0,0,10,10,100)

DESCRIPTION: Draws a circular curve object in the project workspace under the currently activated material group node, or modifies the circle named 'label' if it already exists. The parameters start_angle and end_angle are in degrees.

superquad

SYNTAX: superquad(string label, any x0, any y0, any z0, any diam_x, any diam_y, any order)

EXAMPLE: superquad("SuperQuad_1",0,0,0,50,20,4)

DESCRIPTION: Draws a super-quadratic curve object in the project workspace under the currently activated material group node, or modifies the super-quadratic curve named 'label' if it already exists. If order = 2, the curve reduces to an ellipse. Higher order makes the round edges sharper. An infinite order reduces the curve to a rectangle.

parabola

SYNTAX: parabola(string label, any x0, any y0, any z0, any focal_length, any axial_length, any half_only)

EXAMPLE: parabola("Parabola _1",0,0,0,50,20,0)

DESCRIPTION: Draws a parabola object in the project workspace under the currently activated material group node, or modifies the parabola named 'label' if it already exists. If the Boolean parameter "half_only" is 1, only half of the parabola will be drawn.

hyperbola

SYNTAX: hyperbola(string label, any x0, any y0, any z0, any diam_x, any diam_y, any axial_length, any half_only)

EXAMPLE: hyperbola("Hyperbola _1",0,0,0,50,40,20,0)

DESCRIPTION: Draws a hyperbola object in the project workspace under the currently activated material group node, or modifies the hyperbola named 'label' if it already exists. If the Boolean parameter "half_only" is 1, only half of the hyperbola will be drawn.

spiral_curve

SYNTAX: spiral_curve(string label, any x0, any y0, any z0, any radius_inner, any radius_outer, any nturns, any spiral_dir, any is_dual)

EXAMPLE: spiral_curve("Spiral _1",0,0,0,10,50,5,0,0)

DESCRIPTION: Draws a spiral curve object in the project workspace under the currently activated material group node, or modifies the spiral curve named 'label' if it already exists. If the Boolean parameter "spiral_dir" is 1, the spiral curve will be drawn counter-clockwise. If the Boolean parameter "is_dual" is 1, a dual-arm spiral curve will be drawn.

helix

SYNTAX: helix(string label, any x0, any y0, any z0, any radius_inner, any radius_outer, any nturns, any helix_dir)

EXAMPLE: helix("Helix_1",0,0,0,15,15,10,0)

DESCRIPTION: Draws a helical curve in the project workspace under the currently activated material group node, or modifies the helix named 'label' if it already exists. The parameter "radius_inner" specifies the helix's radius at the beginning of the helix, and radius_outer specifies the radius at the end of the helix. If the Boolean parameter "helixl_dir" is 1, the helical curve will be drawn counter-clockwise.

polyline

SYNTAX: polyline(string label, 3x1 Python tuple p0, 3x1 Python tuple p1, ... 3x1 Python tuple pn)

EXAMPLE: polyline("pl_1",(0,0,0),(1,0,0),(1,0,0))

DESCRIPTION: Creates or modifies a PolyLine object in the project workspace. Each point is represented with a Python tuple type. The poly_line is closed if p0 is specified again as pn, otherwise, it is open.

nurbs_curve

SYNTAX: nurbs_curve(string label, 3x1 Python tuple p0, 3x1 Python tuple p1, ... 3x1 Python tuple pn)

EXAMPLE: nurbs_curve("nc_1",(0,0,0),(1,0,0),(1,0,0))

DESCRIPTION: Creates or modifies a NURBS Curve object in the project workspace. Each point is represented with a Python tuple type. The curve is closed if p0 is specified again as pn, otherwise, it is open.

point

SYNTAX: point(string label, any x0, any y0, any z0)

EXAMPLE: point("Point_1",0,0,10)

DESCRIPTION: Draws a point in the project workspace under the currently activated material group node, or modifies the point named 'label' if it already exists.

fractal_tree

SYNTAX: fractal_tree(string label, any x0, any y0, any z0, any key_type, any key_size, any n_level, any sep_angle, any n_gen, any prune_factor, any thickness, any thick_factor)

EXAMPLE: fractal_tree("Fractal_1",0,0,0,"line",10,3,30,3,0,0,0)

DESCRIPTION: Generates a fractal tree in the project workspace under the currently activated material group node, or modifies the fractal tree named 'label' if it already exists.

param_curve

SYNTAX: param_curve(string label, any x0, any y0, any z0, any model, any orientation, any start, any stop, any step, any function[, any y(t), any z(t)])

EXAMPLE: param_curve("Curve_1",0,0,0,"parametric","xy",0,10,0.1,"cos(t)","sin(t)","t")

DESCRIPTION: Generates a parametric curve in the project workspace under the currently activated material group node, or modifies the parametric curve named 'label' if it already exists.

param_surface

SYNTAX: param_surface(string label, any x0, any y0, any z0, any orientation, any start1, any stop1, any step1, , any start2, any stop2, any step2, any function)

EXAMPLE: param_surface("Surf_1",0,0,0,"xy",0,10,0.1,0,10,0.1,"sin(x)*sin(y)")

DESCRIPTION: Generates a parametric surface in the project workspace under the currently activated material group node, or modifies the parametric surface named 'label' if it already exists.

import_stl

SYNTAX: import_stl(string file_name)

EXAMPLE: import_stl("MySTLModel.STL")

DESCRIPTION: Imports an external STL model file to the project workspace. If the file path is not specified, the current project folder is assumed as the path.

import_dxf

SYNTAX: import_dxf(string file_name)

EXAMPLE: import_dxf("MyDXFModel.DXF")

DESCRIPTION: Imports an external DXF model file to the project workspace. If the file path is not specified, the current project folder is assumed as the path.

import_stp

SYNTAX: import_stp(string file_name)

EXAMPLE: import_stp("MySTPModel.STP")

DESCRIPTION: Imports an external STEP model file to the project workspace. If the file path is not specified, the current project folder is assumed as the path.

import_igs

SYNTAX: import_igs(string file_name)

EXAMPLE: import_igs("MyIGSModel.IGS")

DESCRIPTION: Imports an external IGES model file to the project workspace. If the file path is not specified, the current project folder is assumed as the path.

import_py

SYNTAX: import_py(string file_name)

EXAMPLE: import_py("MyPYModel.PY")

DESCRIPTION: Imports a Python geometry file to the project workspace. The default path is the Python subfolder under "Documents → EMAG".

export_stl

SYNTAX: export_stl(string file_name)

EXAMPLE: export_stl("MySTLModel.STL")

DESCRIPTION: Exports the physical structure of the project workspacean to an STL model file. If the file path is not specified, the current project folder is assumed as the path.

export_dxf

SYNTAX: export_dxf(string file_name)

EXAMPLE: export_dxf("MyDXFModel.DXF")

DESCRIPTION: Exports the physical structure of the project workspacean to a DXF model file. If the file path is not specified, the current project folder is assumed as the path.

export_py

SYNTAX: export_py(string file_name)

EXAMPLE: export_py("MyPYModel.PY")

DESCRIPTION: Exports the physical structure of the project workspace or the current object selection to a Python geometry file. The default path is the Python subfolder under "Documents → EMAG".

EM.Cube's Python Functions for Geometric Object Transformation

freeze

SYNTAX: freeze(string object, real freeze_state)

EXAMPLE: freeze("MyObj",1)

DESCRIPTION: Sets the freeze state of an object (0/1).

move_to

SYNTAX: move_to(string object, string group_node_label[, string module_name])

EXAMPLE: move_to("NewObj","MyObj",10,10,0)

DESCRIPTION: Transfers an object from its current material/object group node in the navigation tree to another node or optionally to another EM.Cube module.

clone

SYNTAX: clone(string label, string object, real x0, real y0, real z0)

EXAMPLE: clone("NewObj","MyObj",10,10,0)

DESCRIPTION: Creates a copy of the specified object and repositions it at the given coordinates.

translate_by

SYNTAX: translate_by(string object, real x_dist, real y_dist, real z_dist)

EXAMPLE: translate_by("MyObj",10,10,x)

DESCRIPTION: Translates an object by the specified distances in each direction.

translate_to

SYNTAX: translate_to(string object, real x_dest, real y_dest, real z_dest)

EXAMPLE: translate_to("MyObj",20,20,x2)

DESCRIPTION: Translates an object to the specified destination.

rotate

SYNTAX: rotate(string object, any rot_angle_degree, any rot_axis_x, any rot_axis_y, any rot_axis_z)

EXAMPLE: rotate("pyramid_1",45,1,1,0)

DESCRIPTION: Rotates an object about a line passing through its LCS center and aligned along the specified direction vector (rot_axis) by the specified angle.

scale

SYNTAX: scale(string object, any scale_factor)

EXAMPLE: scale("pyramid_1",2)

DESCRIPTION: Scales an object by the specified scale factor.

get_length

SYNTAX: get_length(string object)

EXAMPLE: get_length("helix_1")

DESCRIPTION: Returns the length of a curve object.

get_area

SYNTAX: get_area(string object)

EXAMPLE: get_area("ellipse_1")

DESCRIPTION: Returns the area of a surface object or the total surface area of a solid object.

get_volume

SYNTAX: get_volume(string object)

EXAMPLE: get_volume("pyramid_1")

DESCRIPTION: Returns the volume of a solid object.

get_lcs

SYNTAX: get_lcs(string object, string coordinate)

EXAMPLE: get_lcs("pyramid_1","x")

DESCRIPTION: Returns the specified coordinate of the LCS of an object.

get_rot

SYNTAX: get_rot(string object, string coordinate)

EXAMPLE: get_rot("pyramid_1","x")

DESCRIPTION: Returns the specified rotation angle of an object.

get_axis

SYNTAX: get_axis(string object, string axis, string coordinate)

EXAMPLE: get_axis("pyramid_1","x","y")

DESCRIPTION: Returns the specified coordinate of the unit vector along the specified local axis of an object.

get_lcs_offset

SYNTAX: get_lcs_offset(string object, any x_off, any y_off, any z_off, string coordinate)

EXAMPLE: get_lcs_offset("box_1",50,50,0,"x")

DESCRIPTION: Returns the specified coordinate of the LCS of an object after being translated by the specified offset values along the three principal axes.

get_extent

SYNTAX: get_extent(string object, string coordinate)

EXAMPLE: get_extent("pyramid_1","x")

DESCRIPTION: Returns the size of the bounding box of an object along the specified direction.

get_vertex

SYNTAX: get_vertex(string object, any node_index, string coordinate)

EXAMPLE: get_vertex("pyramid_1",0,"x")

DESCRIPTION: Returns the specified coordinate of the specified vertex of the bounding box of an object. The vertices are specified by node indices. The lower front left corner has an index of 0, while the upper back right corner has an index of 7. The indices are numbered counterclockwise, with the bottom face first and top face next.

set_rot

SYNTAX: set_rot(string object, any rot_x, any rot_y, any rot_z)

EXAMPLE: set_rot("pyramid_1",0,0,45)

DESCRIPTION: Sets the three rotation angles of an object.

set_lcs_link

SYNTAX: set_lcs_link(string object, string lcs_obj, any x_off, any y_off, any z_off)

EXAMPLE: set_lcs_link("pyramid_1","box_1",50,50,0)

DESCRIPTION: Links the LCS of the first object to the LCS of the second object by the specified offset values along the three axes.

set_rot_link

SYNTAX: set_rot_link(string object, string lcs_obj, any x_off_deg, any y_off_deg, any z_off_deg)

EXAMPLE: set_rot_link("pyramid_1","box_1",0,0,45)

DESCRIPTION: Links the rotation angles of the LCS of the first object to the rotation angles of the LCS of the second object by the specified angle offset values in degrees along the three axes.

mirror

SYNTAX: mirror(string object, any x0, any y0, any z0, any uX, any uY, any uZ)

EXAMPLE: mirror("pyramid_1",0,0,0,1,0,0)

DESCRIPTION: Mirrors an object in a plane defined by the specified point coordinates and specified normal vector components.

group

SYNTAX: group(string label, string object_1, string object_2, ...)

EXAMPLE: group("Composite_1","Box_1","Box_2","Box_3")

DESCRIPTION: Groups a number of objects into a composite object with the given label.

array

SYNTAX: array(string label, string object, any x_count, any y_count, any z_count, any x_spacing, any y_spacing, any z_spacing)

EXAMPLE: array("Array_1","Rect_Strip_1",4,4,1,50,50,0)

DESCRIPTION: Creates or modifies an array object.

array_custom

SYNTAX: array_custom(string label, string object, any x_count, any y_count, any z_count, any x_spacing, any y_spacing, any z_spacing, any x0, any y0, any z0, any rot_x, any rot_y, any rot_z)

EXAMPLE: array_custom("Array_1","Rect_Strip_1",4,4,1,50,50,0,100,100,20,0,0,45)

DESCRIPTION: Creates or modifies an array object and sets its local coordinate system and rotation angles.

explode

SYNTAX: explode(string object)

EXAMPLE: explode("MyArray")

DESCRIPTION: Explodes an object into its basic primitives.

subtract

SYNTAX: subtract(string label, string object_1, string object_2)

EXAMPLE: subtract("Subtract_Object","Rect_Strip1","Rect_Strip2")

DESCRIPTION: Creates a Boolean object named 'label' by subtracting object_2 from object_1. An error will be thrown if a Boolean object named 'label' already exists.

union

SYNTAX: union(string label, string object_1, string object_2)

EXAMPLE: union("Union_Object","Rect_Strip1","Rect_Strip2")

DESCRIPTION: Creates a Boolean object named 'label' by unioning object_1 and object_2. An error will be thrown if a Boolean object named 'label' already exists.

intersect

SYNTAX: intersect(string label, string object_1, string object_2)

EXAMPLE: intersect("Intersection_Object","Rect_Strip1","Rect_Strip2")

DESCRIPTION: Creates a Boolean object named 'label' by intersecting object_1 and object_2. An error will be thrown if a Boolean object named 'label' already exists.

extrude

SYNTAX: extrude(string label, string object, any extrude_height, any cap_ends)

EXAMPLE: extrude("Extrude_1","Rect_Strip1",50)

DESCRIPTION: Creates or modifies an extrusion object from a specified object by the specified height. If modifying an existing extrusion object, the pre-existing primitive is used. This command can only extrude objects that have a single face and will extrude along the face's normal.

loft

SYNTAX: loft(string label, string object, any loft_height, any cap_base)

EXAMPLE: loft("Loft_1","Rect_Strip1",50)

DESCRIPTION: Creates or modifies a loft object from a specified object by the specified height. If modifying an existing loft object, the pre-existing primitive is used. This command can only loft objects that have a single face and will loft along the face's normal.

revolve

SYNTAX: revolve(string label, string object, any x0, any y0, any z0, any uX, any uY, any uZ, any rot_angle)

EXAMPLE: revolve("Rev1","Line_1",0,0,0,0,0,1,360)

DESCRIPTION: Creates or modifies a revolution object from a specified object. If modifying an existing revolution object, the pre-existing primitive object is used. (x0,y0,z0) specifies the center of revolution, and (uX,uY,uZ) specifies the revolution axis. The revolution angle "rot_angle" is given in degrees.

consolidate

SYNTAX: consolidate(string object)

EXAMPLE: consolidate("Poly_1")

DESCRIPTION: Consolidates a specified object.

spline_fit

SYNTAX: spline_fit(string object)

EXAMPLE: spline_fit("Poly_1")

DESCRIPTION: Applies spline fit transformation on a specified polymesh, polyline or polystrip object.

fill_curve

SYNTAX: fill_curve(string object)

EXAMPLE: fill_curve("Curve_1")

DESCRIPTION: Fill the interior of the specified closed curve object.

merge_curve

SYNTAX: merge_curve(string object_1, string object_2)

EXAMPLE: merge_curve("Curve_1","Curve_2")

DESCRIPTION: Merges two specified curve objects into a single curve.

close_curve

SYNTAX: close_curve(string label, string close_state)

EXAMPLE: close_curve("Curve_1",1)

DESCRIPTION: Sets the open/close state of a polyline or NURBS curve. Use 0 for open curve and 1 for close curve.

polygonize

SYNTAX: polygonize(string object, any side_length)

EXAMPLE: polygonize("Cric_1",2)

DESCRIPTION: Polygonizes the specified surface or curve object by the specified side length. The results is a polystrip or a polyline.

polymesh

SYNTAX: polymesh(string label, string object, any edge_length)

EXAMPLE: polymesh("Poly_1","Cric_1",2)

DESCRIPTION: Discretizes the specified solid or surface object by the specified edge length. The results is a polymesh object.

fillet

fillet(string object, any radius)

EXAMPLE: fillet("Rect_1",5)

DESCRIPTION: Fillets the corners of the specified surface or curve object by the specified radius.

slice

SYNTAX: slice(string object, any x0, any y0, any z0, any uX, any uY, any uZ)

EXAMPLE: slice("Rect_1",5)

DESCRIPTION: Slices the specified object into two parts using the specified plane given by the point coordinates and normal vector coordinates.

roughen

SYNTAX: roughen(string label, string object, any rms_height, any correl_length)

EXAMPLE: roughen("Rect_1",1,5)

DESCRIPTION: Roughens the surface of the specified object based on the specified RMS height and correlation length.

random_group

SYNTAX: random_group(string label, string key_object, string container_object, any element_count)

EXAMPLE: random_group("Rand_1","Rect_1","Box_1",100)

DESCRIPTION: Creates a random group using the specified key object and confines them in the specified container object.

strip_sweep

SYNTAX: strip_sweep(string object, any width)

EXAMPLE: strip_sweep("Curve_1",5)

DESCRIPTION: Creates a strip version of a given curve object.

pipe_sweep

SYNTAX: pipe_sweep(string object, any radius)

EXAMPLE: pipe_sweep("Curve_1",5)

DESCRIPTION: Creates a pipe version of a given curve object.

rail_sweep

SYNTAX: rail_sweep(string rail_object, string sweep_object)

EXAMPLE: rail_sweep("Curve_1","Curve_2")

DESCRIPTION: Rail-sweeps the specified sweep object along the specified curve object.

EM.Cube's Python Functions for Material or Object Group Creation

activate

SYNTAX: activate(string group_node_label)

EXAMPLE: activate("Color_1")

DESCRIPTION: Activates a color, material or object group in the current active EM.Cube module.

color_group

SYNTAX: color_group(string label)

EXAMPLE: color_group("Color_1")

DESCRIPTION: Creates a color group in CubeCAD module. If the color group 'label' already exists, the group is activated.

pec_group

SYNTAX: pec_group(string label)

EXAMPLE: pec_group("PEC_1")

DESCRIPTION: Creates a PEC material group in the current module. If the PEC group 'label' already exists, the group is activated.

pec_voltage_group

SYNTAX: pec_voltage_group(string label, any voltage)

EXAMPLE: pec_voltage_group("PEC_1",10)

DESCRIPTION: Creates a fixed-potential PEC object group in the current module. If the PEC group 'label' already exists, the group is activated.

pec_via_group

SYNTAX: pec_via_group(string label, any host_layer)

EXAMPLE: pec_via_group("PEC_1",10)

DESCRIPTION: Creates an embedded PEC via set group in the current module. If the PEC via group 'label' already exists, the group is activated.

thinwire_group

SYNTAX: thinwire_group(string label, any radius)

EXAMPLE: thinwire_group("Thinwire_1",4)

DESCRIPTION: Creates a Thinwire material group in the current module. If the thin wire group 'label' already exists, the group is activated.

pmc_group

SYNTAX: pmc_group(string label)

EXAMPLE: pmc_group("PMC_1")

DESCRIPTION: Creates a PMC material group in the current module. If the PMC group 'label' already exists, the group is activated.

slot_group

SYNTAX: slot_group(string label)

EXAMPLE: slot_group("PMC_1")

DESCRIPTION: Creates a slot trace group in the current module. If the slot trace group 'label' already exists, the group is activated.

dielectric_group

SYNTAX: dielectric_group(string label, any eps, any sigma, any mu, any rho)

EXAMPLE: dielectric_group("Dielectric_1","my_eps",0,1,0)

DESCRIPTION: Creates a dielectric material group in the current module with the specified material properties. If the dielectric group 'label' already exists, the group is activated.

impenetrable_surface_group

SYNTAX: impenetrable_surface_group(string label, any eps, any sigma)

EXAMPLE: impenetrable_surface_group("Impenet_1",2.2,0.0001)

DESCRIPTION: Creates an impenetrable surface group in EM.Terrano. If the impenetrable surface group 'label' already exists, the group is activated.

penetrable_surface_group

SYNTAX: penetrable_surface_group(string label, any eps, any sigma, any thickness)

EXAMPLE: penetrable_surface_group("Penet_1",2.2,0.0001, 1)

DESCRIPTION: Creates a penetrable surface group in EM.Terrano. If the penetrable surface group 'label' already exists, the group is activated.

penetrable_volume_group

SYNTAX: penetrable_volume_group(string label, any eps, any sigma)

EXAMPLE: penetrable_volume_group("Vol_Penet_1",2.2,0.0001)

DESCRIPTION: Creates a penetrable volume group in EM.Terrano. If the penetrable volume group 'label' already exists, the group is activated.

terrain_group

SYNTAX: terrain_group(string label, any eps, any sigma)

EXAMPLE: terrain_group("Terrain_1",5.0,0.0001)

DESCRIPTION: Creates an terrain surface group in EM.Terrano. If the terrain surface group 'label' already exists, the group is activated.

base_point_group

SYNTAX: base_point_group(string label)

EXAMPLE: base_point_set("BP_Set_1")

DESCRIPTION: Creates a base point set in EM.Terrano. If the base point set group 'label' already exists, the group is activated.

virtual_group

SYNTAX: virtual_group(string label)

EXAMPLE: virtual_group("VIR_1")

DESCRIPTION: Creates a virtual object group in EM.Terrano. If the virtual group 'label' already exists, the group is activated.

impedance_surface_group

SYNTAX: impedance_surface_group(string label, any z_real, any z_imag)

EXAMPLE: impedance_surface_group("IMP_1",100,-100)

DESCRIPTION: Creates a impedance_surface group in EM.Illumina. If the impedance surface group 'label' already exists, the group is activated.

conductive_sheet_group

SYNTAX: conductive_sheet_group(string label, any sigma, any thickness)

EXAMPLE: conductive_sheet_group("Cond_1",100, 0.01)

DESCRIPTION: Creates a conductive sheet group in EM.Picasso. If the conductive sheet group 'label' already exists, the group is activated.

charge_group

SYNTAX: charge_group(string label, any density)

EXAMPLE: charge_group("Charge_1",-1e-5)

DESCRIPTION: Creates a volume charge source group in EM.Ferma. If the charge group 'label' already exists, the group is activated.

magnet_group

SYNTAX: magnet_group(string label, any mu, any Mx, any My, any Mz)

EXAMPLE: magnet_group("Magnet_1",1,0,0,100)

DESCRIPTION: Creates a permanent magnet source group in EM.Ferma. If the magnet group 'label' already exists, the group is activated.

volume_current_group

SYNTAX: volume_current_group(string label, any Jx, any Jy, any Jz)

EXAMPLE: volume_current_group("Magnet_1",0,0,1e6)

DESCRIPTION: Creates a volume current source group in EM.Ferma. If the volume current group 'label' already exists, the group is activated.

wire_current_group

SYNTAX: wire_current_group(string label, any current, any wire_radius)

EXAMPLE: wire_current_group("Magnet_1",1,0.5)

DESCRIPTION: Creates a wire current source group in EM.Ferma. If the wire current group 'label' already exists, the group is activated.

EM.Cube's Python Functions for Source & Lumped Device Definition

lumped_src

SYNTAX: lumped_src(string label, any line_object, any offset, any polarity[, any amplitude, any phase, any resistance])

EXAMPLE: lumped_src("LS_1","Line_1",50,0)

DESCRIPTION: Creates a lumped source in EM.Tempo. If the lumped source 'label' already exists, its properties are modified.

distributed_src

SYNTAX: distributed_src(string label, any rect_object, any field_dir, any profile[, any amplitude, any phase, any resistance])

EXAMPLE: distributed_src("DS_1","Rect_1","+y","uniform")

DESCRIPTION: Creates a distributed source in EM.Tempo. If the distributed source 'label' already exists, its properties are modified.

microstrip_src

SYNTAX: microstrip_src(string label, any rect_object, any height, any edge[, any amplitude, any phase, any resistance])

EXAMPLE: microstrip_src("MS_1","Rect_1",1.5,"+x")

DESCRIPTION: Creates a microstrip port source in EM.Tempo. If the microstrip port 'label' already exists, its properties are modified.

cpw_src

SYNTAX: cpw_src(string label, any rect_object, any spacing, any edge[, any amplitude, any phase, any resistance])

EXAMPLE: cpw_src("CPW_1","Rect_1",1.5,"+x")

DESCRIPTION: Creates a CPW port source in EM.Tempo. If the CPW port 'label' already exists, its properties are modified.

coaxial_src

SYNTAX: coaxial_src(string label, any cylinder_object, any outer_radius, any edge[, any amplitude, any phase, any resistance])

EXAMPLE: coaxial_src("COAX_1","Cyl_1",1.5,"+z")

DESCRIPTION: Creates a coaxial port source in EM.Tempo. If the coaxial port 'label' already exists, its properties are modified.

waveguide_src

SYNTAX: waveguide_src(string label, any box_object, any offset, any is_negative[, any amplitude, any phase, any resistance])

EXAMPLE: waveguide_src("WG_1","Box_1",50,0)

DESCRIPTION: Creates a waveguide port source in EM.Tempo. If the waveguide port 'label' already exists, its properties are modified.

wire_gap_src

SYNTAX: wire_gap_src(string label, any line_object, any offset, any polarity[, any amplitude, any phase, any resistance])

EXAMPLE: wire_gap_src("WIG_1","Line_1",50,0)

DESCRIPTION: Creates a wire gap circuit source in EM.Libera. If the wire gap source 'label' already exists, its properties are modified.

rect_gap_src

SYNTAX: rect_gap_src(string label, any rect_object, any offset, any polarity[, any amplitude, any phase, any resistance])

EXAMPLE: rect_gap_src("GAP_1","Rect_1",0,0)

DESCRIPTION: Creates a strip gap circuit source in EM.Picasso or EM.Libera. If the strip gap source 'label' already exists, its properties are modified.

probe_gap_src

SYNTAX: probe_gap_src(string label, any via_object, any polarity[, any amplitude, any phase, any resistance])

EXAMPLE: probe_gap_src("Probe_1","Via_1",0)

DESCRIPTION: Creates a probe gap circuit source in EM.Picasso. If the probe gap source 'label' already exists, its properties are modified.

wave_port

SYNTAX: wave_port(string label, any rect_object, any offset, any is_negative[, any amplitude, any phase, any resistance])

EXAMPLE: wave_port("WP_1","Rect_1",0,0)

DESCRIPTION: Creates a scattering wave port source in EM.Picasso or EM.Libera. If the wave port 'label' already exists, its properties are modified.

short_dipole

SYNTAX: short_dipole(string label, any x0, any y0, any z0, any length, any uX, any uY, any uZ, any amplitude, any phase)

EXAMPLE: short_dipole("SD_1",0,0,50,3,0,0,1,1,0)

DESCRIPTION: Creates a Hertzian short dipole source. If the short dipole source 'label' already exists, its properties are modified.

planewave

SYNTAX: planewave(string label, any theta, any phi, any polarization)

'EXAMPLE: planewave("PW_1",180,0,"tm")

DESCRIPTION: Creates a plane wave source. If the plane wave source 'label' already exists, its properties are modified.

gauss_beam

SYNTAX: gauss_beam(string label, any theta, any phi, any polarization, any focus_x, any focus_y, any focus_z, any radius, any p_mode, any q_mode)

EXAMPLE: gauss_beam("PW_1",180,0,"tm",0,0,0,20,0,0)

DESCRIPTION: Creates a Gaussian beam source in EM.Tempo. If the Gaussian beam source 'label' already exists, its properties are modified.

huygens_src

SYNTAX: huygens_src(string label, any filename[, any set_lcs, any polarization, any x0, any y0, any z0, any x_rot, any y_rot, any z_rot])

EXAMPLE: huygens_src("HS_1","Huygens_1.HUY",1,100,100,0,0,0,0)

DESCRIPTION: Creates a Huygens source. If the Huygens source 'label' already exists, its properties are modified.

transmitter_set

SYNTAX: transmitter_set(string label, any base_point_set[, any pattern_file, any rot_x, any rot_y, any rot_z)

EXAMPLE: transmitter_set("TX_1","PT_1","DPL_STD.RAD",0,90,0)

DESCRIPTION: Creates a transmitter set in EM.Terrano. If the transmitter set 'label' already exists, its properties are modified.

resistor

SYNTAX: resistor(string label, any line_object, any offset, any resistance)

EXAMPLE: resistor("Res_1","Line_1",25,50)

DESCRIPTION: Creates a resistor in EM.Tempo. If the resistor 'label' already exists, its properties are modified.

capacitor

SYNTAX: capacitor(string label, any line_object, any offset, any capacitance_pF)

EXAMPLE: capacitor("Cap_1","Line_1",25,10)

DESCRIPTION: Creates a capacitor in EM.Tempo. If the capacitor 'label' already exists, its properties are modified.

inductor

SYNTAX: inductor(string label, any line_object, any offset, any inductance_nH)

EXAMPLE: inductor("Cap_1","Line_1",25,10)

DESCRIPTION: Creates a inductor in EM.Tempo. If the inductor 'label' already exists, its properties are modified.

diode

SYNTAX: diode(string label, any line_object, any polarity, any is_fA, any temperature_K, any ideality_factor)

EXAMPLE: diode("Diode_1","Line_1",25,0,10,300,1)

DESCRIPTION: Creates a diode in EM.Tempo. If the diode 'label' already exists, its properties are modified.

EM.Cube's Python Functions for Observable Definition

port_definition_default

SYNTAX: port_definition_default(string label)

EXAMPLE: port_definition_default("PD_1")

DESCRIPTION: Creates a default port definition observable. If the observable 'label' already exists, its properties are modified.

port_definition_custom

SYNTAX: port_definition_custom(string label, (string port_1_src_1, string port_1_src_2, ..., string port_1_impedance), (string port_2_src_1, string port_2_src_2, ..., string port_2_impedance), ...)

EXAMPLE: port_definition_custom("PD_1",("LS_1","LS_2",50),,("LS_3","LS_4",50))

DESCRIPTION: Creates a custom port definition observable. If the observable 'label' already exists, its properties are modified.

farfield

SYNTAX: farfield(string label, any theta_incr, any phi_incr)

EXAMPLE: farfield("FF_1",1,1)

DESCRIPTION: Creates a far-field radiation pattern observable. If the observable 'label' already exists, its properties are modified.

rcs_bistatic

SYNTAX: rcs_bistatic(string label, any theta_incr, any phi_incr)

EXAMPLE: rcs_bistatic("RCS_1",1,1)

DESCRIPTION: Creates a bistatic RCS observable. If the observable 'label' already exists, its properties are modified.

current_dist

SYNTAX: current_dist(string label)

EXAMPLE: current_dist("CD_1")

DESCRIPTION: Creates a current distribution observable. If the observable 'label' already exists, its properties are modified.

field_sensor

SYNTAX: field_sensor(string label, any dir_coordinate, any x0, any y0, any z0, any xSize, any ySize, any zSize, any xSamples, any ySamples, any zSamples)

EXAMPLE: field_sensor("FS_1","z",0,0,0,100,100,0,25,25,0)

DESCRIPTION: Creates a near-field sensor observable. If the observable 'label' already exists, its properties are modified.

field_sensor_grid

SYNTAX: field_sensor_grid(string label, any dir_coordinate, any x0, any y0, any z0)

EXAMPLE: field_sensor_grid("FS_1","z",0,0,0)

DESCRIPTION: Creates a near-field sensor observable in EM.Tempo or EM.Ferma. If the observable 'label' already exists, its properties are modified.

field_probe

SYNTAX: field_probe(string label, any x0, any y0, any z0)

EXAMPLE: field_probe("FS_1",0,0,50)

DESCRIPTION: Creates a temporal field probe observable in EM.Tempo or EM.Ferma. If the observable 'label' already exists, its properties are modified.

receiver_set

SYNTAX: receiver_set(string label, any base_point_set[, any pattern_file, any rot_x, any rot_y, any rot_z)

EXAMPLE: receiver_set("TX_1","PT_1","DPL_STD.RAD",0,90,0)

DESCRIPTION: Creates a receiver set in EM.Terrano. If the receiver set 'label' already exists, its properties are modified.

huygens_surface

SYNTAX: huygens_surface(string label, any x1, any y1, any z1, any x2, any y2, any z2, any xSamples, any ySamples, any zSamples)

EXAMPLE: huygens_surface("HS_1",-10,-10,-10,10,10,10,40,40,40)

DESCRIPTION: Creates a Huygens surface observable. If the observable 'label' already exists, its properties are modified.

huygens_surface_grid

SYNTAX: huygens_surface_grid(string label, any x1, any y1, any z1, any x2, any y2, any z2)

EXAMPLE: huygens_surface_grid("HS_1",-10,-10,-10,10,10,10)

DESCRIPTION: Creates a Huygens surface observable in EM.Tempo. If the observable 'label' already exists, its properties are modified.

voltage_integral

SYNTAX: voltage_integral(string label, any x1, any y1, any z1, any x2, any y2, any z2)

EXAMPLE: voltage_integral("FI_1",0,0,-10,0,0,10)

DESCRIPTION: Creates a voltage integral observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.

current_integral

SYNTAX: current_integral(string label, any x1, any y1, any z1, any x2, any y2, any z2)

EXAMPLE: current_integral("FI_1",-10,-10,0,10,10,0)

DESCRIPTION: Creates a current integral observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.

conduction_current_integral

SYNTAX: conduction_current_integral(string label, any x1, any y1, any z1, any x2, any y2, any z2)

EXAMPLE: conduction_current_integral("FI_1",-10,-10,0,10,10,0)

DESCRIPTION: Creates a conduction current integral observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.

capacitance

SYNTAX: capacitance(string label, any x1, any y1, any z1, any x2, any y2, any z2, any x3, any y3, any z3, any x4, any y4, any z4)

EXAMPLE: capacitance("FI_1",-10,-10,5,10,10,10,0,0,-10,0,0,10)

DESCRIPTION: Creates a capacitance integral observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.

inductance

SYNTAX: inductance(string label, any x1, any y1, any z1, any x2, any y2, any z2, any x3, any y3, any z3, any x4, any y4, any z4)

EXAMPLE: inductance("FI_1",0,0,-10,10,0,10,2.5,-2.5,0,7.5,2.5,0)

DESCRIPTION: Creates a inductance integral observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.

resistance

SYNTAX: resistance(string label, any x1, any y1, any z1, any x2, any y2, any z2, any x3, any y3, any z3, any x4, any y4, any z4)

EXAMPLE: resistance("FI_1",0,0,-10,0,0,10,-10,-10,0,10,10,0)

DESCRIPTION: Creates a resistance integral observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.

flux_electric

SYNTAX: flux_electric(string label, any x1, any y1, any z1, any x2, any y2, any z2)

EXAMPLE: flux_electric("FI_1",-10,-10,5,10,10,10)

DESCRIPTION: Creates an electric flux integral observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.

flux_magnetic

SYNTAX: flux_magnetic(string label, any x1, any y1, any z1, any x2, any y2, any z2)

EXAMPLE: flux_magnetic("FI_1",0,0,-10,10,0,10)

DESCRIPTION: Creates a magnetic flux integral observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.

energy_electric

SYNTAX: energy_electric(string label, any x1, any y1, any z1, any x2, any y2, any z2)

EXAMPLE: energy_electric("FI_1",-10,-10,-10,10,10,10)

DESCRIPTION: Creates an electric energy integral observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.

energy_magnetic

SYNTAX: energy_magnetic(string label, any x1, any y1, any z1, any x2, any y2, any z2)

EXAMPLE: energy_magnetic("FI_1",-10,-10,-10,10,10,10)

DESCRIPTION: Creates a magnetic energy integral observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.

ohmic_loss

SYNTAX: ohmic_loss(string label, any x1, any y1, any z1, any x2, any y2, any z2)

EXAMPLE: ohmic_loss("FI_1",-10,-10,-10,10,10,10)

DESCRIPTION: Creates an ohmic loss integral observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.

solution_plane

SYNTAX: solution_plane(string label, any field_sensor_label, any is_quasi)

EXAMPLE: solution_plane("FI_1","FS_1",1)

DESCRIPTION: Creates a 2D solution plane observable in EM.Ferma. If the observable 'label' already exists, its properties are modified.

EM.Cube's Python Functions for Simulation-Related Functions & Operations

select_module

SYNTAX: select_module(string module_name)

EXAMPLE: select_module("EM.Tempo")

DESCRIPTION: Selects and sets EM.Cube's active module.

set_units

SYNTAX: set_units(string units)

EXAMPLE: set_units("meter")

DESCRIPTION: Sets EM.Cube's project length units.

set_frequency

SYNTAX: set_frequency(any value)

EXAMPLE: set_frequency(2.4e9)

DESCRIPTION: Sets EM.Cube's center frequency.

set_bandwidth

SYNTAX: set_bandwidth(any value)

EXAMPLE: set_bandwidth(1e9)

DESCRIPTION: Sets EM.Cube's frequency bandwidth.

background_layer

SYNTAX: background_layer(string label, any eps, any sigma, any mu, any thickness)

EXAMPLE: background_layer("Mid_Layer",3.3,0.001,1,1.5)

DESCRIPTION: Adds a new substrate layer to EM.Picasso's background layer stackup.

delete_background_layer

SYNTAX: delete_background_layer(string label)

EXAMPLE: delete_background_layer("Mid_Layer")

DESCRIPTION: Deletes a finite-thickness substrate layer from EM.Picasso's background layer stackup.

set_stackup_order

SYNTAX: set_stackup_order("THS", string label_1, string label_2, ..., string label_n, "BHS")

EXAMPLE: background_layer("THS","Top_Layer","Mid_Layer","Bottom_Layer","BHS")

DESCRIPTION: Sets the hierarchy of EM.Picasso's background layer stackup from top to bottom. The sequence should always start with "THS" standing for the top half-space and must end in "BHS" standing for the bottom half-space. All the intermediate finite-thickness substrate layers must be included and listed in the right order.

global_ground

SYNTAX: global_ground(any ground_on, any eps, any sigma)

EXAMPLE: global_ground(1,3.3,0.001)

DESCRIPTION: Set the state of EM.Terrano's global ground and its material properties. A zero value for ground_on means to no global ground assumed at Z = 0.

delete

SYNTAX: delete(string node_name)

EXAMPLE: delete("Box_1")

DESCRIPTION: Deletes a node name from the navigation tree. The node can be any geometric object, source, observable or material group.

rename

SYNTAX: rename(string new_label, string old_label)

EXAMPLE: rename("Box_2","Box_1")

DESCRIPTION: Deletes a node name from the navigation tree. The node can be any geometric object, source, observable or material group.

zoom_extents

SYNTAX: zoom_extents()

DESCRIPTION: Zooms to fit the extents of the physical structure into the screen.

get_domain_extent

SYNTAX: get_domain_extent(string coordinate)

EXAMPLE: get_domain_extent("x")

DESCRIPTION: Returns the size of the computational domain along the specified direction.

set_domain_offset

SYNTAX: set_domain_offset(any dxn_offset, any dxp_offset, any dyn_offset, any dyp_offset, any dzn_offset, any dzp_offset)

EXAMPLE: set_domain_offset(20,20,20,20,0,10)

DESCRIPTION: Sets the domain offset values along the ±X, ±Y and ±Z directions in project units.

set_domain_offset_lambda

SYNTAX: set_domain_offset_lambda(any dxn_offset, any dxp_offset, any dyn_offset, any dyp_offset, any dzn_offset, any dzp_offset)

EXAMPLE: set_domain_offset_lambda(0.1,0.1,0.1,0.1,0,0.25)

DESCRIPTION: Sets the domain offset values along the ±X, ±Y and ±Z directions in free-space wavelengths.

set_boundary_conditions

SYNTAX: set_boundary_conditions(string xn_type, string xp_type, string yn_type, string yp_type, string zn_type, string zp_type)

EXAMPLE: set_domain_offset_lambda("pml","pml","pml","pml","pec","pml")

DESCRIPTION: Sets EM.Tempo's domain boundary conditions domain offset on the ±X, ±Y and ±Z boundary walls. The options are "pec", "pmc" and "pml".

add_variable

SYNTAX: add_variable(string var_name, any value)

EXAMPLE: add_variable("MyVar",1)

DESCRIPTION: Adds a new variable to EM.Cube's variable list.

run_analysis

SYNTAX: run_analysis()

DESCRIPTION: Runs a simulation in the current active EM.Cube computational module.

set_periodic

SYNTAX: set_periodic(any is_periodic, any spacingX, any spacingY)

EXAMPLE: set_periodic(1,50,50)

DESCRIPTION: Designates the physical structure as periodic and sets the periods along the X and Y directions.

get_standard_output

SYNTAX: get_standard_output(string output_name)

EXAMPLE: get_standard_output("S11M")

DESCRIPTION: Returns the computed value of the specified standard output parameter at the end of a simulation.

save_data

SYNTAX: save_data(string directory_name)

EXAMPLE: save_data("Simulation_Data")

DESCRIPTION: Saves EM.Cube's output simulation data files under the specified directory.

plot_file

SYNTAX: plot_file(string filename)

EXAMPLE: plot_file("D0.DAT")

DESCRIPTION: Plots the contents of a specified data file in EM.Grid.

mesh

SYNTAX: mesh()

DESCRIPTION: Generates and displays the mesh of the physical structure.

emtempo_mesh_settings

SYNTAX: emtempo_mesh_settings(any cells_per_lambda, any ratio_contour, any ratio_thin, any ratio_abs)

EXAMPLE: emtempo_mesh_settings(30,0.1,0.1,0.02)

DESCRIPTION: Sets the parameters of EM.Tempo's adaptive mesh generator.

emillumina_mesh_settings

SYNTAX: emillumina_mesh_settings(any cells_per_lambda)

EXAMPLE: emillumina_mesh_settings(30)

DESCRIPTION: Sets the parameters of EM.Illumina's mesh generator.

empicasso_mesh_settings

SYNTAX: empicasso_mesh_settings(any cells_per_lambda)

EXAMPLE: empicasso_mesh_settings(30)

DESCRIPTION: Sets the parameters of EM.Picasso's planar hybrid mesh generator.

emlibera_mesh_settings

SYNTAX: emlibera_mesh_settings(any cells_per_lambda)

EXAMPLE: emlibera_mesh_settings(30)

DESCRIPTION: Sets the parameters of EM.Libera's mesh generator.

emferma_mesh_settings

SYNTAX: emferma_mesh_settings(any cell_size_x, any cell_size_y, any cell_size_z)

EXAMPLE: emferma_mesh_settings(0.5,0.5,0.5)

DESCRIPTION: Sets the parameters of EM.Ferma's fixed-cell mesh generator.

emterrano_mesh_settings

SYNTAX: emterrano_mesh_settings(any edge_length, any angle_tol)

EXAMPLE: emterrano_mesh_settings(5,10)

DESCRIPTION: Sets the parameters of EM.Terrano's facet mesh generator.

cubecad_mesh_settings

SYNTAX: cubecad_mesh_settings(any edge_length, any angle_tol)

EXAMPLE: cubecad_mesh_settings(5,10)

DESCRIPTION: Sets the parameters of CubeCAD's mesh generator.

emtempo_engine_settings

SYNTAX: emtempo_engine_settings(string engine, any power_threshhold, any max_timesteps)

EXAMPLE: emtempo_engine_settings("single-precision",-50,20000)

DESCRIPTION: Sets the parameters of EM.Tempo's FDTD simulation engine.

emterrano_engine_settings

SYNTAX: emterrano_engine_settings(any bounce_count, any do_edge_diffraction, any angular_resolution, any ray_threshhold)

EXAMPLE: emterrano_engine_settings(5,1,1,-100)

DESCRIPTION: Sets the parameters of EM.Terrano's SBR simulation engine.

empicasso_engine_settings

SYNTAX: empicasso_engine_settings(string matrix_solver, any error_tol, any max_iterations)

EXAMPLE: empicasso_engine_settings("bicg",1e-3,1000)

DESCRIPTION: Sets the parameters of EM.Picasso's planar MoM simulation engine.

emillumina_engine_settings

SYNTAX: emillumina_engine_settings(string engine, any is_fixed_iteration, any error_tol, any max_iterations)

EXAMPLE: emillumina_engine_settings("ipo",0,1e-2,20)

DESCRIPTION: Sets the parameters of EM.Illumina's Physical Optics simulation engine.

emferma_engine_settings

SYNTAX: emferma_engine_settings(string matrix_solver, any error_tol, any max_iterations)

EXAMPLE: emferma_engine_settings("bicg-stab",1e-3,100)

DESCRIPTION: Sets the parameters of EM.Ferma's electrostatic and magnetostatic simulation engines.

emlibera_engine_settings_wmom

SYNTAX: emlibera_engine_settings_wmom(string matrix_solver, any error_tol, any max_iterations)

EXAMPLE: emlibera_engine_settings_wmom("bicg",1e-3,1000)

DESCRIPTION: Sets the parameters of EM.Libera's wire MoM simulation engines.

emlibera_engine_settings_smom

SYNTAX: emlibera_engine_settings_smom(string matrix_solver, any error_tol, any max_iterations, any ncpus, string formulation, any alpha)

EXAMPLE: emlibera_engine_settings_smom("bicg",1e-3,1000,4,"efie",0.4)

DESCRIPTION: Sets the parameters of EM.Libera's surface MoM simulation engines.


Top icon.png Back to the Top of the Page

Back icon.png Back to EM.Cube Main Page

Retrieved from "http://www.emagtech.com/wiki/index.php?title=Glossary_of_EM.Cube%27s_Python_Functions&oldid=33888"